Changes between Version 7 and Version 8 of WikiFormatting
- Timestamp:
- Jul 25, 2015, 7:08:55 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiFormatting
v7 v8 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''' =|| … … 242 243 }}} 243 244 244 == Font Styles 245 246 == Font Styles == 245 247 246 248 The Trac wiki supports the following font styles: … … 290 292 with a `//` one, and `'''` can't be paired with `**`) 291 293 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. 294 295 == Headings == 296 297 You can create heading by starting a line with one up to six ''equal'' characters ("=") 298 followed by a single space and the headline text. 295 299 296 300 [=#hn] … … 320 324 }}} 321 325 322 == Paragraphs 326 == Paragraphs == 323 327 324 328 A new text paragraph is created whenever two blocks of text are separated by one or more empty lines. … … 348 352 }}} 349 353 350 == Lists 354 == Lists == 351 355 352 356 The wiki supports both ordered/numbered and unordered lists. … … 404 408 }}} 405 409 406 == Definition Lists 410 411 == Definition Lists == 407 412 408 413 The wiki also supports definition lists. … … 428 433 Note that you need a space in front of the defined term. 429 434 430 == Preformatted Text 435 436 == Preformatted Text == 431 437 432 438 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 456 Note that this kind of block is also used for selecting lines that should be processed through WikiProcessors. 451 457 452 == Blockquotes 458 == Blockquotes == 453 459 454 460 In order to mark a paragraph as blockquote, indent that paragraph with two spaces. … … 466 472 }}} 467 473 468 == Discussion Citations 474 == Discussion Citations == 469 475 470 476 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 492 }}} 487 493 488 == Tables 489 == = Simple Tables490 494 495 == Tables == 496 === Simple Tables === 491 497 Simple tables can be created like this: 492 498 ||= Wiki Markup =||= Display =|| … … 578 584 }}} 579 585 580 === Complex Tables 586 === Complex Tables === 581 587 582 588 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 589 584 == Links 590 591 == Links == 585 592 586 593 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}. … … 636 643 }}} 637 644 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 645 '''Note''': the [trac:WikiCreole] style for links is quick to type and 646 certainly looks familiar as it's the one used on Wikipedia and in many 647 other wikis. Unfortunately it conflicts with the syntax for [#Macros macros]. 648 So in the rare case when you need to refer to a page which is named after 649 a macro (typical examples being TitleIndex, InterTrac and InterWiki), 650 by writing `[[TitleIndex]]` you will actually call the macro instead of linking 651 to the page. 652 653 == Trac Links == 642 654 643 655 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 681 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 682 671 == Setting Anchors 683 684 == Setting Anchors == 672 685 673 686 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: … … 712 725 713 726 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)^)]]`. 727 714 728 715 729 == Escaping Links, WikiPageNames and other Markup == #Escaping … … 740 754 }}} 741 755 742 == Images 756 == Images == 743 757 744 758 Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags. … … 764 778 See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.) 765 779 766 == Macros 780 781 == Macros == 767 782 768 783 Macros are ''custom functions'' to insert dynamic content in a page. … … 792 807 }}} 793 808 794 == Processors 809 810 == Processors == 795 811 796 812 Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in … … 929 945 See WikiProcessors for more information. 930 946 931 == Comments 947 948 == Comments == 932 949 933 950 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 970 }}} 954 971 955 == Miscellaneous 972 == Miscellaneous == 956 973 957 974 An horizontal line can be used to separated different parts of your page:
