Changes between Version 1 and Version 2 of WikiFormatting
- Timestamp:
- Apr 16, 2016, 7:53:44 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiFormatting
v1 v2 1 = WikiFormatting = 1 = WikiFormatting 2 2 3 [[TracGuideToc]] 3 4 4 5 Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole. 5 6 6 Trac has a built in small and powerful wiki rendering engine. This wiki engine implements an ever growing subset of the commands from other popular Wikis, 7 especially [http://moinmo.in/ MoinMoin] and [trac:WikiCreole]. 8 7 Trac has a built in small and powerful wiki rendering engine. This wiki engine implements an ever growing subset of the commands from other popular Wikis, especially [http://moinmo.in/ MoinMoin] and [trac:WikiCreole]. 9 8 10 9 This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed. 11 10 12 The ''Cheat sheet'' below gives you a quickoverview for the most common syntax, each link in the ''Category'' column will lead you to the more detailed explanation later in this page.11 The sections below provide an overview for the most common syntax, each link in the ''Category'' column will lead you to the more detailed explanation later in this page. 13 12 14 13 A few other wiki pages present the advanced features of the Trac wiki markup in more depth: 15 - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof ,16 - WikiPageNames talks aboutthe various names a wiki page can take, CamelCase or not17 - WikiMacros lists the macros available for generating dynamic content ,14 - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof 15 - WikiPageNames covers the various names a wiki page can take, CamelCase or not 16 - WikiMacros lists the macros available for generating dynamic content 18 17 - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways 19 20 21 == C heat sheet ==18 - [trac:wiki:TracDev/Proposals/AdvancedWikiOperations AdvancedWikiOperations] provides some operations in uncommon or administrative scenarios 19 20 == Common wiki markup 22 21 23 22 ||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =|| … … 182 181 || `!wiki:WikiFormatting`, `!WikiFormatting` ||\ 183 182 || !wiki:WikiFormatting, !WikiFormatting || 184 || {{{`}}}`{{{-}}}`{{{`}}}` triple curly brackets`||\183 || [[html(<code>`{{{-}}}` triple curly brackets</code>)]] ||\ 185 184 || `{{{-}}}` triple curly brackets || 186 185 |----------------------------------------------------------- … … 243 242 }}} 244 243 245 246 == Font Styles == 244 == Font Styles 247 245 248 246 The Trac wiki supports the following font styles: … … 264 262 * **also bold**, //italic as well//, 265 263 and **'' bold italic **'' //(since 0.12)// 264 * [[span(style=color: #FF0000, a red text )]] 266 265 }}} 267 266 }}} … … 281 280 * **also bold**, //italic as well//, 282 281 and **'' bold italic **'' //(since 0.12)// 282 * [[span(style=color: #FF0000, a red text )]] 283 283 }}} 284 284 … … 290 290 with a `//` one, and `'''` can't be paired with `**`) 291 291 292 293 == Headings == 294 295 You can create heading by starting a line with one up to six ''equal'' characters ("=") 296 followed by a single space and the headline text. 292 == Headings 293 294 You can create heading by starting a line with one up to six ''equal'' characters ("=") followed by a single space and the headline text. 297 295 298 296 [=#hn] … … 322 320 }}} 323 321 324 == Paragraphs ==322 == Paragraphs 325 323 326 324 A new text paragraph is created whenever two blocks of text are separated by one or more empty lines. … … 350 348 }}} 351 349 352 == Lists ==350 == Lists 353 351 354 352 The wiki supports both ordered/numbered and unordered lists. … … 406 404 }}} 407 405 408 409 == Definition Lists == 406 == Definition Lists 410 407 411 408 The wiki also supports definition lists. … … 431 428 Note that you need a space in front of the defined term. 432 429 433 434 == Preformatted Text == 430 == Preformatted Text 435 431 436 432 Block containing preformatted text are suitable for source code snippets, notes and examples. Use three ''curly braces'' wrapped around the text to define a block quote. The curly braces need to be on a separate line. … … 454 450 Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors. 455 451 456 == Blockquotes ==452 == Blockquotes 457 453 458 454 In order to mark a paragraph as blockquote, indent that paragraph with two spaces. … … 470 466 }}} 471 467 472 == Discussion Citations ==468 == Discussion Citations 473 469 474 470 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. … … 490 486 }}} 491 487 492 493 == Tables ==494 === Simple Tables === 488 == Tables 489 === Simple Tables 490 495 491 Simple tables can be created like this: 496 492 ||= Wiki Markup =||= Display =|| … … 582 578 }}} 583 579 584 === Complex Tables ===580 === Complex Tables 585 581 586 582 If the possibilities offered by the simple "pipe"-based markup for tables described above are not enough for your needs, you can create more elaborated tables by using [#Processors-example-tables WikiProcessor based tables]. 587 583 588 589 == Links == 584 == Links 590 585 591 586 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}. … … 641 636 }}} 642 637 643 '''Note''': the [trac:WikiCreole] style for links is quick to type and 644 certainly looks familiar as it's the one used on Wikipedia and in many 645 other wikis. Unfortunately it conflicts with the syntax for [#Macros macros]. 646 So in the rare case when you need to refer to a page which is named after 647 a macro (typical examples being TitleIndex, InterTrac and InterWiki), 648 by writing `[[TitleIndex]]` you will actually call the macro instead of linking 649 to the page. 650 651 == Trac Links == 638 '''Note''': the [trac:WikiCreole] style for links is quick to type and certainly looks familiar as it is the one used on Wikipedia and in many other wikis. Unfortunately it conflicts with the syntax for [#Macros macros]. 639 So in the rare case when you need to refer to a page which is named after a macro (typical examples being TitleIndex, InterTrac and InterWiki), by writing `[[TitleIndex]]` you will actually call the macro instead of linking to the page. 640 641 == Trac Links 652 642 653 643 Wiki pages can link directly to other parts of the Trac system. Pages can refer to tickets, reports, changesets, milestones, source files and other Wiki pages using the following notations: … … 679 669 There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers. 680 670 681 682 == Setting Anchors == 671 == Setting Anchors 683 672 684 673 An anchor, or more correctly speaking, an [http://www.w3.org/TR/REC-html40/struct/links.html#h-12.2.1 anchor name] can be added explicitly at any place in the Wiki page, in order to uniquely identify a position in the document: … … 724 713 For more complex anchors (e.g. when a custom title is wanted), one can use the Span macro, e.g. `[[span(id=point2, class=wikianchor, title=Point 2, ^(2)^)]]`. 725 714 726 727 715 == Escaping Links, WikiPageNames and other Markup == #Escaping 728 716 … … 737 725 {{{ 738 726 Various forms of escaping for list markup: 739 `-`escaped minus sign \\740 ``1. escaped number \\741 {{{*}}}escaped asterisk sign727 ^^- escaped minus sign \\ 728 ^^1. escaped number \\ 729 ^^* escaped asterisk sign 742 730 }}} 743 731 }}} … … 747 735 748 736 Various forms of escaping for list markup: 749 `-`escaped minus sign \\750 ``1. escaped number \\751 {{{*}}}escaped asterisk sign752 }}} 753 754 == Images ==737 ^^- escaped minus sign \\ 738 ^^1. escaped number \\ 739 ^^* escaped asterisk sign 740 }}} 741 742 == Images 755 743 756 744 Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags. … … 776 764 See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.) 777 765 778 779 == Macros == 766 == Macros 780 767 781 768 Macros are ''custom functions'' to insert dynamic content in a page. … … 805 792 }}} 806 793 807 808 == Processors == 794 == Processors 809 795 810 796 Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in … … 943 929 See WikiProcessors for more information. 944 930 945 946 == Comments == 931 == Comments 947 932 948 933 Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text. … … 968 953 }}} 969 954 970 == Miscellaneous ==955 == Miscellaneous 971 956 972 957 An horizontal line can be used to separated different parts of your page: … … 1005 990 !WikiCreole style \\ line\\break 1006 991 }}} 1007
