source: wiki/pages/WikiFormatting @ 43267

Last change on this file since 43267 was 40558, checked in by obi, 2 years ago

reset wiki

File size: 24.4 KB
Line 
1= WikiFormatting
2
3[[TracGuideToc]]
4
5Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
6
7Trac 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].
8
9This page will give you an in-depth explanation of the wiki markup available anywhere WikiFormatting is allowed.
10
11The 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.
12
13A 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 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
20== Common wiki markup
21
22||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =||
23|-----------------------------------------------------------
24{{{#!th rowspan=3
25[#FontStyles Font Styles]
26}}}
27|| `'''bold'''`, `''italic''`, `'''''Wikipedia style'''''` || \
28|| '''bold''', ''italic'', '''''Wikipedia style''''' ||
29|| {{{`monospaced (''other markup ignored'')`}}} || \
30|| `monospaced (''other markup ignored'')` ||
31|| `**bold**`, `//italic//`, `**//!WikiCreole style//**` || \
32|| **bold**, //italic//, **//!WikiCreole style//** ||
33|-----------------------------------------------------------
34||= [#Headings Headings] =||\
35{{{#!td
36 {{{
37 == Level 2 ==
38 === Level 3 ^([#hn note])^
39 }}}
40}}}
41{{{#!td style="padding-left: 2em"
42== Level 2 ==
43=== Level 3 ^([#hn note])^
44}}}
45|-----------------------------------------------------------
46||= [#Paragraphs Paragraphs]  =||\
47{{{#!td
48 {{{
49 First paragraph
50 on multiple lines.
51
52 Second paragraph.
53 }}}
54}}}
55{{{#!td
56First paragraph
57on multiple lines.
58
59Second paragraph.
60}}}
61|-----------------------------------------------------------
62||= [#Lists Lists] =||\
63{{{#!td
64 {{{
65 * bullets list
66   on multiple lines
67   1. nested list
68     a. different numbering
69        styles
70 }}}
71}}}
72{{{#!td
73* bullets list
74  on multiple lines
75  1. nested list
76    a. different numbering
77       styles
78}}}
79|-----------------------------------------------------------
80{{{#!th
81[#DefinitionLists Definition Lists]
82}}}
83{{{#!td
84 {{{
85  term:: definition on
86         multiple lines
87 }}}
88}}}
89{{{#!td
90 term:: definition on
91        multiple lines
92}}}
93|-----------------------------------------------------------
94||= [#PreformattedText Preformatted Text] =||\
95{{{#!td
96 {{{
97 {{{
98 multiple lines, ''no wiki''
99       white space respected
100 }}}
101 }}}
102}}}
103{{{#!td
104 {{{
105 multiple lines, ''no wiki''
106       white space respected
107 }}}
108}}}
109|-----------------------------------------------------------
110||= [#Blockquotes Blockquotes] =||\
111{{{#!td
112 {{{
113   if there's some leading
114   space the text is quoted
115 }}}
116}}}
117{{{#!td
118 if there's some leading
119 space the text is quoted
120}}}
121|-----------------------------------------------------------
122||= [#DiscussionCitations Discussion Citations] =||\
123{{{#!td
124 {{{
125 >> ... (I said)
126 > (he replied)
127 }}}
128}}}
129{{{#!td
130>>... (I said)
131> (he replied)
132}}}
133|-----------------------------------------------------------
134||= [#Tables Tables] =||\
135{{{#!td
136 {{{
137 ||= Table Header =|| Cell ||
138 ||||  (details below)  ||
139 }}}
140}}}
141{{{#!td
142||= Table Header =|| Cell ||
143||||  (details below)  ||
144}}}
145|-----------------------------------------------------------
146{{{#!th rowspan=2
147[#Links Links]
148}}}
149|| `http://trac.edgewall.org` ||\
150|| http://trac.edgewall.org ||
151|| `WikiFormatting (CamelCase)` ||\
152|| WikiFormatting (CamelCase) ||
153|-----------------------------------------------------------
154{{{#!th rowspan=5
155[#TracLinks TracLinks]
156}}}
157|| `wiki:WikiFormatting`, `wiki:"WikiFormatting"` ||\
158|| wiki:WikiFormatting, wiki:"WikiFormatting" ||
159|| `#1 (ticket)`, `[1] (changeset)`, `{1} (report)` ||\
160|| #1 (ticket), [1] (changeset), {1} (report) ||
161|| `ticket:1, ticket:1#comment:1` ||\
162|| ticket:1, ticket:1#comment:1 ||
163|| `Ticket [ticket:1]`, `[ticket:1 ticket one]` ||\
164|| Ticket [ticket:1], [ticket:1 ticket one] ||
165|| `Ticket [[ticket:1]]`, `[[ticket:1|ticket one]]` ||\
166|| Ticket [[ticket:1]], [[ticket:1|ticket one]] ||
167|-----------------------------------------------------------
168{{{#!th rowspan=2
169[#SettingAnchors Setting Anchors]
170}}}
171|| `[=#point1 (1)] First...` ||\
172|| [=#point1 (1)] First... ||
173|| `see [#point1 (1)]` ||\
174|| see [#point1 (1)] ||
175|-----------------------------------------------------------
176{{{#!th rowspan=3
177[#Escaping Escaping Markup]
178}}}
179|| `!'' doubled quotes` ||\
180|| !'' doubled quotes ||
181|| `!wiki:WikiFormatting`, `!WikiFormatting` ||\
182|| !wiki:WikiFormatting, !WikiFormatting ||
183|| [[html(<code>`{{{-}}}` triple curly brackets</code>)]] ||\
184|| `{{{-}}}` triple curly brackets ||
185|-----------------------------------------------------------
186||= [#Images Images] =|| `[[Image(`''link''`)]]` || [[Image(htdocs:../common/trac_logo_mini.png)]] ||
187|-----------------------------------------------------------
188{{{#!th rowspan=2
189[#Macros Macros]
190}}}
191|| `[[MacroList(*)]]` ||  ''(short list of all available macros)''  ||
192|| `[[Image?]]` ||  ''(help for the Image macro)''  ||
193|-----------------------------------------------------------
194||= [#Processors Processors] =||\
195{{{#!td
196 {{{
197 {{{
198 #!div style="font-size: 80%"
199 Code highlighting:
200   {{{#!python
201   hello = lambda: "world"
202   }}}
203 }}}
204 }}}
205}}}
206{{{#!td style="padding-left: 2em"
207 {{{
208 #!div style="font-size: 80%"
209 Code highlighting:
210   {{{#!python
211   hello = lambda: "world"
212   }}}
213 }}}
214}}}
215|-----------------------------------------------------------
216||= [#Comments Comments] =||\
217{{{#!td
218 {{{
219 {{{#!comment
220 Note to Editors: ...
221 }}}
222 }}}
223}}}
224{{{#!td style="padding-left: 2em"
225 {{{#!comment
226 Note to Editors: ...
227 }}}
228}}}
229|-----------------------------------------------------------
230||= [#Miscellaneous Miscellaneous] =||\
231{{{#!td
232 {{{
233 Line [[br]] break
234 Line \\ break
235 ----
236 }}}
237}}}
238{{{#!td style="padding-left: 2em"
239Line [[br]] break
240Line \\ break
241----
242}}}
243
244== Font Styles
245
246The Trac wiki supports the following font styles:
247||= Wiki Markup =||= Display =||
248{{{#!td
249  {{{
250   * '''bold''',
251     ''' triple quotes !'''
252     can be bold too if prefixed by ! ''',
253   * ''italic''
254   * '''''bold italic''''' or ''italic and
255     ''' italic bold ''' ''
256   * __underline__
257   * {{{monospace}}} or `monospace`
258     (hence `{{{` or {{{`}}} quoting)
259   * ~~strike-through~~
260   * ^superscript^
261   * ,,subscript,,
262   * **also bold**, //italic as well//,
263     and **'' bold italic **'' //(since 0.12)//
264   * [[span(style=color: #FF0000, a red text )]]
265  }}}
266}}}
267{{{#!td
268 * '''bold''',
269   ''' triple quotes !'''
270   can be bold too if prefixed by ! ''',
271 * ''italic''
272 * '''''bold italic''''' or ''italic and
273   ''' italic bold ''' ''
274 * __underline__
275 * {{{monospace}}} or `monospace`
276   (hence `{{{` or {{{`}}} quoting)
277 * ~~strike-through~~
278 * ^superscript^
279 * ,,subscript,,
280 * **also bold**, //italic as well//,
281   and **'' bold italic **'' //(since 0.12)//
282 * [[span(style=color: #FF0000, a red text )]]
283}}}
284
285Notes:
286 * `{{{...}}}` and {{{`...`}}} commands not only select a monospace font, but also treat their content as verbatim text, meaning that no further wiki processing is done on this text.
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 * 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 paired
290   with a `//` one, and `'''` can't be paired with `**`)
291
292== Headings
293
294You can create heading by starting a line with one up to six ''equal'' characters ("=") followed by a single space and the headline text.
295
296[=#hn]
297The headline text can be followed by the same number of "=" characters, but this is no longer mandatory.
298
299Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
300
301||= Wiki Markup =||= Display =||
302{{{#!td
303  {{{
304  = Heading =
305  == Subheading
306  === About ''this'' ===
307  === Explicit id === #using-explicit-id-in-heading
308  == Subheading #sub2
309}}}
310}}}
311{{{#!td style="padding: 1em;"
312  {{{
313  #!div
314  = Heading =
315  == Subheading
316  === About ''this'' ===
317  === Explicit id === #using-explicit-id-in-heading
318  == Subheading #sub2
319  }}}
320}}}
321
322== Paragraphs
323
324A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
325
326A forced line break can also be inserted, using:
327||= Wiki Markup =||= Display =||
328{{{#!td
329  {{{
330  Line 1[[BR]]Line 2
331  }}}
332  {{{
333  Paragraph
334  one
335
336  Paragraph
337  two
338  }}}
339}}}
340{{{#!td
341  Line 1[[BR]]Line 2
342
343  Paragraph
344  one
345
346  Paragraph
347  two
348}}}
349
350== Lists
351
352The wiki supports both ordered/numbered and unordered lists.
353
354Example:
355||= Wiki Markup =||= Display =||
356{{{#!td
357  {{{
358   * Item 1
359     * Item 1.1
360        * Item 1.1.1   
361        * Item 1.1.2
362        * Item 1.1.3
363     * Item 1.2
364   * Item 2
365  - items can start at the beginning of a line
366    and they can span multiple lines
367    - be careful though to continue the line
368    with the appropriate indentation, otherwise
369  that will start a new paragraph...
370 
371   1. Item 1
372     a. Item 1.a
373     a. Item 1.b
374        i. Item 1.b.i
375        i. Item 1.b.ii
376   1. Item 2
377  And numbered lists can also be restarted
378  with an explicit number:
379   3. Item 3
380  }}}
381}}}
382{{{#!td
383 * Item 1
384   * Item 1.1
385      * Item 1.1.1   
386      * Item 1.1.2
387      * Item 1.1.3
388   * Item 1.2
389 * Item 2
390- items can start at the beginning of a line
391  and they can span multiple lines
392  - be careful though to continue the line
393  with the appropriate indentation, otherwise
394that will start a new paragraph...
395
396 1. Item 1
397   a. Item 1.a
398   a. Item 1.b
399      i. Item 1.b.i
400      i. Item 1.b.ii
401 1. Item 2
402And numbered lists can also be restarted with an explicit number:
403 3. Item 3
404}}}
405
406== Definition Lists
407
408The wiki also supports definition lists.
409
410||= Wiki Markup =||= Display =||
411{{{#!td
412  {{{
413   llama::
414     some kind of mammal, with hair
415   ppython::
416     some kind of reptile, without hair
417     (can you spot the typo?)
418  }}}
419}}}
420{{{#!td
421 llama::
422   some kind of mammal, with hair
423 ppython::
424   some kind of reptile, without hair
425   (can you spot the typo?)
426}}}
427
428Note that you need a space in front of the defined term.
429
430== Preformatted Text
431
432Block 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.
433 
434||= Wiki Markup =||= Display =||
435{{{#!td
436  {{{
437  {{{
438  def HelloWorld():
439      print '''Hello World'''
440  }}}
441  }}}
442}}}
443{{{#!td
444  {{{
445  def HelloWorld():
446      print '''Hello World'''
447  }}}
448}}}
449
450Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors.
451
452== Blockquotes
453
454In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
455
456||= Wiki Markup =||= Display =||
457{{{#!td
458{{{
459Paragraph
460  This text is a quote from someone else.
461}}}
462}}}
463{{{#!td
464Paragraph
465  This text is a quote from someone else.
466}}}
467
468== Discussion Citations
469
470To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used. 
471
472||= Wiki Markup =||= Display =||
473{{{#!td
474  {{{
475  >> Someone's original text
476  > Someone else's reply text
477  >  - which can be any kind of Wiki markup
478  My reply text
479  }}}
480}}}
481{{{#!td
482>> Someone's original text
483> Someone else's reply text
484>  - which can be any kind of Wiki markup
485My reply text
486}}}
487
488== Tables
489=== Simple Tables
490
491Simple tables can be created like this:
492||= Wiki Markup =||= Display =||
493{{{#!td
494  {{{
495  ||Cell 1||Cell 2||Cell 3||
496  ||Cell 4||Cell 5||Cell 6||
497  }}}
498}}}
499{{{#!td style="padding: 2em;"
500||Cell 1||Cell 2||Cell 3||
501||Cell 4||Cell 5||Cell 6||
502}}}
503
504Cell headings can be specified by wrapping the content in a pair of '=' characters.
505Note that the '=' characters have to stick to the cell separators, like this:
506||= Wiki Markup =||= Display =||
507{{{#!td
508  {{{
509  ||        ||= stable =||= latest =||
510  ||= 0.10 =||  0.10.5  || 0.10.6dev||
511  ||= 0.11 =||  0.11.6  || 0.11.7dev||
512  }}}
513}}}
514{{{#!td style="padding: 2em;"
515||        ||= stable =||= latest =||
516||= 0.10 =||  0.10.5  || 0.10.6dev||
517||= 0.11 =||  0.11.6  || 0.11.7dev||
518}}}
519
520Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example:
521||= Wiki Markup =||= Display =||
522{{{#!td
523  {{{
524  || 1 || 2 || 3 ||
525  |||| 1-2 || 3 ||
526  || 1 |||| 2-3 ||
527  |||||| 1-2-3 ||
528  }}}
529}}}
530{{{#!td style="padding: 2em;"
531|| 1 || 2 || 3 ||
532|||| 1-2 || 3 ||
533|| 1 |||| 2-3 ||
534|||||| 1-2-3 ||
535}}}
536
537Note that if the content of a cell "sticks" to one side of the cell and only one, then the text will be aligned on that side. Example:
538||= Wiki Markup =||= Display =||
539{{{#!td
540  {{{
541  ||=Text =||= Numbers =||
542  ||left align    ||        1.0||
543  ||  center      ||        4.5||
544  ||      right align||     4.5||
545  || default alignment ||   2.5||
546  ||default||         2.5||
547  ||  default ||      2.5||
548  || default ||       2.5||
549  }}}
550}}}
551{{{#!td style="padding: 2em;"
552||=Text =||= Numbers =||
553||left align    ||        1.0||
554||  center      ||        4.5||
555||      right align||     4.5||
556|| default alignment ||   2.5||
557||default||         2.5||
558||  default ||      2.5||
559|| default ||       2.5||
560}}}
561
562If contrary to the example above, the cells in your table contain more text, it might be convenient to spread a table row over multiple lines of markup. The `\` character placed at the end of a line after a cell separator tells Trac to not start a new row for the cells on the next line.
563
564||= Wiki Markup =||
565{{{#!td
566  {{{
567  || this is column 1 [http://trac.edgewall.org/newticket new ticket] || \
568  || this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \
569  || that's column 3 and last one ||
570  }}}
571}}}
572|-------------
573||= Display =||
574{{{#!td style="padding: 2em;"
575|| this is column 1 [http://trac.edgewall.org/newticket new ticket] || \
576|| this is column 2 [http://trac.edgewall.org/roadmap the road ahead] || \
577|| that's column 3 and last one ||
578}}}
579
580=== Complex Tables
581
582If 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
584== Links
585
586Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
587
588||= Wiki Markup =||= Display =||
589{{{#!td
590  {{{
591  TitleIndex, http://www.edgewall.com/, !NotAlink
592  }}}
593}}}
594{{{#!td
595TitleIndex, http://www.edgewall.com/, !NotAlink
596}}}
597
598Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets.
599If the descriptive title is omitted, then the explicit prefix is discarded, unless the link is an external link. This can be useful for wiki pages not adhering to the WikiPageNames convention.
600
601||= Wiki Markup =||= Display =||
602{{{#!td
603  {{{
604   * [http://www.edgewall.com Edgewall Software]
605   * [wiki:TitleIndex Title Index]
606   * [wiki:TitleIndex]
607   * [wiki:ISO9000]
608  }}}
609}}}
610{{{#!td
611   * [http://www.edgewall.com Edgewall Software]
612   * [wiki:TitleIndex Title Index]
613   * [wiki:TitleIndex]
614   * [wiki:ISO9000]
615}}}
616
617Following the [trac:WikiCreole] trend, the descriptive title can also be specified by writing the link followed by a pipe ('|') and a title and all this inside //double// square brackets.
618
619{{{#!td
620  {{{
621   * [[http://www.edgewall.com|Edgewall Software]]
622   * [[wiki:TitleIndex|Title Index]]
623     or even [[TitleIndex|Title Index]]
624   * [[wiki:TitleIndex]]
625     ''' but not ![[TitleIndex]]! '''
626   * [[ISO9000]]
627  }}}
628}}}
629{{{#!td
630   * [[http://www.edgewall.com|Edgewall Software]]
631   * [[wiki:TitleIndex|Title Index]]
632     or even [[TitleIndex|Title Index]]
633   * [[wiki:TitleIndex]]
634     ''' but not ![[TitleIndex]]! '''
635   * [[ISO9000]]
636}}}
637
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].
639So 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
642
643Wiki 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:
644
645||= Wiki Markup =||= Display =||
646{{{#!td
647  {{{
648   * Tickets: #1 or ticket:1
649   * Reports: {1} or report:1
650   * Changesets: r1, [1] or changeset:1
651   * ...
652   * targeting other Trac instances,
653     so called InterTrac links:
654     - Tickets: #Trac1 or Trac:ticket:1
655     - Changesets: [Trac1] or Trac:changeset:1
656  }}}
657}}}
658{{{#!td
659 * Tickets: #1 or ticket:1
660 * Reports: {1} or report:1
661 * Changesets: r1, [1] or changeset:1
662 * ...
663 * targeting other Trac instances,
664   so called InterTrac links:
665   - Tickets: #Trac1 or Trac:ticket:1
666   - Changesets: [Trac1] or Trac:changeset:1
667}}}
668
669There are many more flavors of Trac links, see TracLinks for more in-depth information and a reference for all the default link resolvers.
670
671== Setting Anchors
672
673An 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:
674
675{{{
676[=#point1]
677}}}
678
679This syntax was chosen to match the format for explicitly naming the header id [#Headings documented above]. For example:
680{{{
681== Long title == #title
682}}}
683
684It's also very close to the syntax for the corresponding link to that anchor:
685{{{
686[#point1]
687}}}
688
689Optionally, a label can be given to the anchor:
690{{{
691[[=#point1 '''Point 1''']]
692}}}
693
694||= Wiki Markup =||= Display =||
695|----------------------------------
696{{{#!td
697  {{{
698  [#point2 jump to the second point]
699
700  ...
701
702  Point2:  [=#point2] Jump here
703  }}}
704}}}
705{{{#!td
706  [#point2 jump to the second point]
707
708  ...
709
710  Point2:  [=#point2] Jump here
711}}}
712
713For 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
715== Escaping Links, WikiPageNames and other Markup == #Escaping
716
717You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
718
719||= Wiki Markup =||= Display =||
720{{{#!td
721  {{{
722   !NoHyperLink
723   !#42 is not a link
724  }}}
725  {{{
726Various forms of escaping for list markup:
727 ^^- escaped minus sign \\
728 ^^1. escaped number  \\
729 ^^* escaped asterisk sign
730  }}}
731}}}
732{{{#!td
733 !NoHyperLink
734 !#42 is not a link
735
736Various forms of escaping for list markup:
737 ^^- escaped minus sign \\
738 ^^1. escaped number  \\
739 ^^* escaped asterisk sign
740}}}
741
742== Images
743
744Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
745
746You now have to use the ![[Image]] macro. The simplest way to include an image is to upload it as attachment to the current page, and put the filename in a macro call like `[[Image(picture.gif)]]`.
747
748In addition to the current page, it is possible to refer to other resources:
749 * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page)
750 * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket)
751 * `[[Image(htdocs:picture.gif)]]` (referring to a file inside the [TracEnvironment environment] `htdocs` directory)
752 * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository)
753
754||= Wiki Markup =||= Display =||
755{{{#!td
756  {{{
757  [[Image(htdocs:../common/trac_logo_mini.png)]]
758  }}}
759}}}
760{{{#!td
761[[Image(htdocs:../common/trac_logo_mini.png)]]
762}}}
763
764See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.)
765
766== Macros
767
768Macros are ''custom functions'' to insert dynamic content in a page.
769
770||= Wiki Markup =||= Display =||
771{{{#!td
772  {{{
773  [[RecentChanges(Trac,3)]]
774  }}}
775}}}
776{{{#!td style="padding-left: 2em"
777[[RecentChanges(Trac,3)]]
778}}}
779
780See WikiMacros for more information, and a list of installed macros.
781
782The detailed help for a specific macro can also be obtained more directly by appending a "?" to the macro name.
783
784||= Wiki Markup =||= Display =||
785{{{#!td
786  {{{
787  [[MacroList?]]
788  }}}
789}}}
790{{{#!td style="padding-left: 2em"
791[[MacroList?]]
792}}}
793
794== Processors
795
796Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
797[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].
798
799||= Wiki Markup =||= Display =||
800|--------------------------------------------------------
801{{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%"
802
803   [=#Processors-example-html Example 1:] HTML
804
805}}}
806|--------------------------------------------------------
807{{{#!td style="border: 0px"
808  {{{
809  {{{
810  #!html
811  <h1 style="text-align: right; color: blue">
812   HTML Test
813  </h1>
814  }}}
815  }}}
816}}}
817{{{#!td valign="top"  style="border: 0px"
818
819{{{
820#!html
821<h1 style="text-align: right; color: blue">HTML Test</h1>
822}}}
823
824}}}
825|--------------------------------------------------------
826{{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%"
827
828   [=#Processors-example-highlight Example 2:] Code Highlighting
829
830}}}
831|--------------------------------------------------------
832{{{#!td style="border: 0px"
833  {{{
834  {{{
835  #!python
836  class Test:
837 
838      def __init__(self):
839          print "Hello World"
840  if __name__ == '__main__':
841     Test()
842  }}}
843  }}}
844}}}
845{{{
846#!td valign="top"  style="border: 0px"
847
848{{{
849#!python
850class Test:
851    def __init__(self):
852        print "Hello World"
853if __name__ == '__main__':
854   Test()
855}}}
856
857}}}
858|--------------------------------------------------------
859{{{#!td align="center" colspan=2 style="border: 0px; font-size: 90%"
860
861       [=#Processors-example-tables Example 3:] Complex Tables
862
863}}}
864|--------------------------------------------------------
865{{{#!td style="border: 0px"
866  {{{
867  {{{#!th rowspan=4 align=justify
868  With the `#td` and `#th` processors,
869  table cells can contain any content:
870  }}}
871  |----------------
872  {{{#!td
873    - lists
874    - embedded tables
875    - simple multiline content
876  }}}
877  |----------------
878  {{{#!td
879  As processors can be easily nested,
880  so can be tables:
881    {{{#!th
882    Example:
883    }}}
884    {{{#!td style="background: #eef"
885    || must be at the third level now... ||
886    }}}
887  }}}
888  |----------------
889  {{{#!td
890  Even when you don't have complex markup,
891  this form of table cells can be convenient
892  to write content on multiple lines.
893  }}}
894  }}}
895}}}
896{{{
897#!td  valign="top"  style="border: 0px"
898
899  {{{#!th rowspan=4 align=justify
900  With the `#td` and `#th` processors,
901  table cells can contain any content:
902  }}}
903  |----------------
904  {{{#!td
905    - lists
906    - embedded tables
907    - simple multiline content
908  }}}
909  |----------------
910  {{{#!td
911  As processors can be easily nested,
912  so can be tables:
913    {{{#!th
914    Example:
915    }}}
916    {{{#!td style="background: #eef"
917    || must be at the third level now... ||
918    }}}
919  }}}
920  |----------------
921  {{{#!td
922  Even when you don't have complex markup,
923  this form of table cells can be convenient
924  to write content on multiple lines.
925  }}}
926
927}}}
928
929See WikiProcessors for more information.
930
931== Comments
932
933Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
934
935||= Wiki Markup =||= Display =||
936{{{#!td
937  {{{
938  Nothing to
939  {{{
940  #!comment
941  Your comment for editors here
942  }}}
943  see ;-)
944  }}}
945}}}
946{{{#!td
947  Nothing to
948  {{{
949  #!comment
950  Your comment for editors here
951  }}}
952  see ;-)
953}}}
954
955== Miscellaneous
956
957An horizontal line can be used to separated different parts of your page:
958
959||= Wiki Markup =||= Display =||
960{{{#!td
961  {{{
962  Four or more dashes will be replaced
963  by an horizontal line (<HR>)
964  ----
965  See?
966  }}}
967}}}
968{{{#!td
969Four or more dashes will be replaced
970by an horizontal line (<HR>)
971----
972See?
973}}}
974|----------------------------------
975{{{#!td
976  {{{
977  "macro" style [[br]] line break
978  }}}
979}}}
980{{{#!td
981"macro" style [[br]] line break
982}}}
983|----------------------------------
984{{{#!td
985  {{{
986  !WikiCreole style \\ line\\break
987  }}}
988}}}
989{{{#!td
990!WikiCreole style \\ line\\break
991}}}
Note: See TracBrowser for help on using the repository browser.