Changes between Version 8 and Version 9 of WikiFormatting
- Timestamp:
- Jan 12, 2016, 11:21:52 PM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiFormatting
v8 v9 1 = WikiFormatting 2 1 = WikiFormatting = 3 2 [[TracGuideToc]] 4 3 5 4 Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole. 6 5 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]. 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 8 9 9 10 This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed. 10 11 11 The sections below provide anoverview for the most common syntax, each link in the ''Category'' column will lead you to the more detailed explanation later in this page.12 The ''Cheat sheet'' below gives you a quick overview for the most common syntax, each link in the ''Category'' column will lead you to the more detailed explanation later in this page. 12 13 13 14 A few other wiki pages present the advanced features of the Trac wiki markup in more depth: 14 - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof 15 - WikiPageNames coversthe various names a wiki page can take, CamelCase or not16 - WikiMacros lists the macros available for generating dynamic content 15 - TracLinks covers all the possible ways to refer precisely to any Trac resource or parts thereof, 16 - WikiPageNames talks about the various names a wiki page can take, CamelCase or not 17 - WikiMacros lists the macros available for generating dynamic content, 17 18 - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways 18 - [trac:wiki:TracDev/Proposals/AdvancedWikiOperations AdvancedWikiOperations] provides some operations in uncommon or administrative scenarios 19 20 == C ommon wiki markup19 20 21 == Cheat sheet == 21 22 22 23 ||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =|| … … 181 182 || `!wiki:WikiFormatting`, `!WikiFormatting` ||\ 182 183 || !wiki:WikiFormatting, !WikiFormatting || 183 || [[html(<code>`{{{-}}}` triple curly brackets</code>)]]||\184 || {{{`}}}`{{{-}}}`{{{`}}}` triple curly brackets` ||\ 184 185 || `{{{-}}}` triple curly brackets || 185 186 |----------------------------------------------------------- … … 242 243 }}} 243 244 244 == Font Styles 245 246 == Font Styles == 245 247 246 248 The Trac wiki supports the following font styles: … … 262 264 * **also bold**, //italic as well//, 263 265 and **'' bold italic **'' //(since 0.12)// 264 * [[span(style=color: #FF0000, a red text )]]265 266 }}} 266 267 }}} … … 280 281 * **also bold**, //italic as well//, 281 282 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 == 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. 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. 295 297 296 298 [=#hn] … … 320 322 }}} 321 323 322 == Paragraphs 324 == Paragraphs == 323 325 324 326 A new text paragraph is created whenever two blocks of text are separated by one or more empty lines. … … 348 350 }}} 349 351 350 == Lists 352 == Lists == 351 353 352 354 The wiki supports both ordered/numbered and unordered lists. … … 404 406 }}} 405 407 406 == Definition Lists 408 409 == Definition Lists == 407 410 408 411 The wiki also supports definition lists. … … 428 431 Note that you need a space in front of the defined term. 429 432 430 == Preformatted Text 433 434 == Preformatted Text == 431 435 432 436 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. … … 450 454 Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors. 451 455 452 == Blockquotes 456 == Blockquotes == 453 457 454 458 In order to mark a paragraph as blockquote, indent that paragraph with two spaces. … … 466 470 }}} 467 471 468 == Discussion Citations 472 == Discussion Citations == 469 473 470 474 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. … … 486 490 }}} 487 491 488 == Tables 489 == = Simple Tables490 492 493 == Tables == 494 === Simple Tables === 491 495 Simple tables can be created like this: 492 496 ||= Wiki Markup =||= Display =|| … … 578 582 }}} 579 583 580 === Complex Tables 584 === Complex Tables === 581 585 582 586 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]. 583 587 584 == Links 588 589 == Links == 585 590 586 591 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}. … … 636 641 }}} 637 642 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 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 == 642 652 643 653 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: … … 669 679 There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers. 670 680 671 == Setting Anchors 681 682 == Setting Anchors == 672 683 673 684 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: … … 713 724 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)^)]]`. 714 725 726 715 727 == Escaping Links, WikiPageNames and other Markup == #Escaping 716 728 … … 725 737 {{{ 726 738 Various forms of escaping for list markup: 727 ^^-escaped minus sign \\728 ^^1. escaped number \\729 ^^*escaped asterisk sign739 `-` escaped minus sign \\ 740 ``1. escaped number \\ 741 {{{*}}} escaped asterisk sign 730 742 }}} 731 743 }}} … … 735 747 736 748 Various forms of escaping for list markup: 737 ^^-escaped minus sign \\738 ^^1. escaped number \\739 ^^*escaped asterisk sign740 }}} 741 742 == Images 749 `-` escaped minus sign \\ 750 ``1. escaped number \\ 751 {{{*}}} escaped asterisk sign 752 }}} 753 754 == Images == 743 755 744 756 Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags. … … 764 776 See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.) 765 777 766 == Macros 778 779 == Macros == 767 780 768 781 Macros are ''custom functions'' to insert dynamic content in a page. … … 792 805 }}} 793 806 794 == Processors 807 808 == Processors == 795 809 796 810 Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in … … 929 943 See WikiProcessors for more information. 930 944 931 == Comments 945 946 == Comments == 932 947 933 948 Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text. … … 953 968 }}} 954 969 955 == Miscellaneous 970 == Miscellaneous == 956 971 957 972 An horizontal line can be used to separated different parts of your page: … … 990 1005 !WikiCreole style \\ line\\break 991 1006 }}} 1007
