Changes between Version 1 and Version 2 of WikiFormatting
- Timestamp:
- Jul 17, 2018, 2:11:03 PM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiFormatting
v1 v2 5 5 Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole. 6 6 7 Trac has a built in small and powerful wiki rendering engine. This wiki engine implements an evergrowing subset of the commands from other popular Wikis, especially [http://moinmo.in/ MoinMoin] and [trac:WikiCreole].7 Trac has a built-in small and powerful wiki rendering engine. This wiki engine implements a growing subset of the commands from other popular Wikis, especially [http://moinmo.in/ MoinMoin] and [trac:WikiCreole]. 8 8 9 9 This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed. … … 12 12 13 13 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 covers the various names a wiki page can take, CamelCase or not16 - WikiMacros lists the macros available for generating dynamic content 17 - 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 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, whether in CamelCase or not. 16 - WikiMacros lists the macros available for generating dynamic content. 17 - 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 19 20 20 == Common wiki markup … … 35 35 {{{#!td 36 36 {{{ 37 == Level 2 ==37 == Level 2 38 38 === Level 3 ^([#hn note])^ 39 39 }}} 40 40 }}} 41 41 {{{#!td style="padding-left: 2em" 42 == Level 2 ==42 == Level 2 43 43 === Level 3 ^([#hn note])^ 44 44 }}} … … 63 63 {{{#!td 64 64 {{{ 65 * bullet slist65 * bullet list 66 66 on multiple lines 67 67 1. nested list … … 71 71 }}} 72 72 {{{#!td 73 * bullet slist73 * bullet list 74 74 on multiple lines 75 75 1. nested list … … 159 159 || `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\ 160 160 || #1 (ticket), [1] (changeset), {1} (report) || 161 || `ticket:1, ticket:1#comment:1 ` ||\162 || ticket:1, ticket:1#comment:1 ||161 || `ticket:1, ticket:1#comment:1, comment:1:ticket:1` ||\ 162 || ticket:1, ticket:1#comment:1, comment:1:ticket:1 || 163 163 || `Ticket [ticket:1]`, `[ticket:1 ticket one]` ||\ 164 164 || Ticket [ticket:1], [ticket:1 ticket one] || … … 287 287 * {{{ ! }}} tells wiki parser to not take the following characters as wiki format, so pay attention to put a space after !, e.g. when ending bold. 288 288 * all the font styles marks have to be used in opening/closing pairs, 289 and they must nest properly (in particular, an `''` italic can't be paired290 with a `//` one, and `'''` can't be paired with `**` )289 and they must nest properly; in particular, an `''` italic can't be paired 290 with a `//` one, and `'''` can't be paired with `**`. 291 291 292 292 == Headings … … 295 295 296 296 [=#hn] 297 The headline text can be followed by the same number of "=" characters, but this is no longer mandatory.297 The headline text can be followed by the same number of "=" characters, but this is not mandatory. That is, `=== Section3 ===` is identical to `=== Section3`. 298 298 299 299 Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated. … … 468 468 == Discussion Citations 469 469 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.470 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (">", ">>", etc.) may be used. 471 471 472 472 ||= Wiki Markup =||= Display =|| … … 580 580 === Complex Tables 581 581 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 elaboratedtables by using [#Processors-example-tables WikiProcessor based tables].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 elaborate tables by using [#Processors-example-tables WikiProcessor based tables]. 583 583 584 584 == Links 585 585 586 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.586 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark ('!'), such as {{{!WikiPageLink}}}. 587 587 588 588 ||= Wiki Markup =||= Display =|| … … 682 682 }}} 683 683 684 It 's also very close to the syntax for the corresponding link to that anchor:684 It is also very close to the syntax for the corresponding link to that anchor: 685 685 {{{ 686 686 [#point1] … … 689 689 Optionally, a label can be given to the anchor: 690 690 {{{ 691 [ [=#point1 '''Point 1''']]691 [=#point1 '''Point 1'''] 692 692 }}} 693 693 … … 711 711 }}} 712 712 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)^)]]`.713 For more complex anchors (eg when a custom title is wanted), you can use the Span macro: `[[span(id=point2, class=wikianchor, title=Point 2, ^(2)^)]]`. 714 714 715 715 == Escaping Links, WikiPageNames and other Markup == #Escaping 716 716 717 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).717 You may avoid making hyperlinks out of TracLinks by preceding an expression with a single exclamation mark ('!'). 718 718 719 719 ||= Wiki Markup =||= Display =|| … … 941 941 Your comment for editors here 942 942 }}} 943 see ;-)943 see. 944 944 }}} 945 945 }}} … … 950 950 Your comment for editors here 951 951 }}} 952 see ;-)952 see. 953 953 }}} 954 954 955 955 == Miscellaneous 956 956 957 An horizontal line can be used to separated different parts of your page: 958 959 ||= Wiki Markup =||= Display =|| 960 {{{#!td 957 ||= Wiki Markup =||= Display =|| 958 {{{#!td 959 Horizontal line: 961 960 {{{ 962 961 Four or more dashes will be replaced 963 by a nhorizontal line (<HR>)962 by a horizontal line (<HR>) 964 963 ---- 965 964 See? … … 968 967 {{{#!td 969 968 Four or more dashes will be replaced 970 by a nhorizontal line (<HR>)969 by a horizontal line (<HR>) 971 970 ---- 972 971 See? … … 974 973 |---------------------------------- 975 974 {{{#!td 976 {{{ 977 "macro" style [[br]] line break 978 }}} 979 }}} 980 {{{#!td 981 "macro" style [[br]] line break 975 Two examples of line breaks: 976 {{{ 977 "macro" style [[BR]] line break 978 }}} 979 or: 980 {{{ 981 !WikiCreole style \\ line\\break 982 }}} 983 }}} 984 {{{#!td 985 "macro" style [[BR]] line break 986 987 !WikiCreole style \\ line\\break 982 988 }}} 983 989 |---------------------------------- 984 {{{#!td985 {{{986 !WikiCreole style \\ line\\break987 }}}988 }}}989 {{{#!td990 !WikiCreole style \\ line\\break991 }}}