developer.jelix.org is not used any more and exists only for
history. Post new tickets on the Github account.
developer.jelix.org n'est plus utilisée, et existe uniquement pour son historique. Postez les nouveaux tickets sur le compte github.
developer.jelix.org n'est plus utilisée, et existe uniquement pour son historique. Postez les nouveaux tickets sur le compte github.
Changes between Version 8 and Version 9 of WikiFormatting
- Timestamp:
- May 12, 2017, 2:16:00 PM (4 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiFormatting
v8 v9 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 a 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 about the various names a wiki page can take, CamelCase or not17 - WikiMacros lists the macros available for generating dynamic content ,18 - WikiProcessors and WikiHtml details how parts of the wiki text can be processed in special ways 19 20 21 == C heat sheet ==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 20 == Common wiki markup 22 21 23 22 ||= '''Category''' =||= '''Wiki Markup''' =||= '''Display''' =|| … … 36 35 {{{#!td 37 36 {{{ 38 == Level 2 ==37 == Level 2 39 38 === Level 3 ^([#hn note])^ 40 39 }}} 41 40 }}} 42 41 {{{#!td style="padding-left: 2em" 43 == Level 2 ==42 == Level 2 44 43 === Level 3 ^([#hn note])^ 45 44 }}} … … 64 63 {{{#!td 65 64 {{{ 66 * bullet slist65 * bullet list 67 66 on multiple lines 68 67 1. nested list … … 72 71 }}} 73 72 {{{#!td 74 * bullet slist73 * bullet list 75 74 on multiple lines 76 75 1. nested list … … 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 … … 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 paired 290 with a `//` one, and `'''` can't be paired with `**`) 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. 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 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] 299 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`. 300 298 301 299 Finally, the heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated. … … 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. … … 414 411 {{{#!td 415 412 {{{ 416 ll ''am''a::417 some kind of '''mammal''', with hair413 llama:: 414 some kind of mammal, with hair 418 415 ppython:: 419 416 some kind of reptile, without hair … … 422 419 }}} 423 420 {{{#!td 424 ll ''am''a::425 some kind of '''mammal''', with hair421 llama:: 422 some kind of mammal, with hair 426 423 ppython:: 427 424 some kind of reptile, without hair … … 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. … … 462 458 {{{ 463 459 Paragraph 464 This text is a quote 465 from someone else. 460 This text is a quote from someone else. 466 461 }}} 467 462 }}} 468 463 {{{#!td 469 464 Paragraph 470 This text is a quote 471 from someone else. 472 }}} 473 474 == Discussion Citations == 475 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. 465 This text is a quote from someone else. 466 }}} 467 468 == Discussion Citations 469 470 To delineate a citation in an ongoing discussion thread, such as the ticket comment area, email-like citation marks (">", ">>", etc.) may be used. 477 471 478 472 ||= Wiki Markup =||= Display =|| … … 492 486 }}} 493 487 494 495 == Tables ==496 === Simple Tables === 488 == Tables 489 === Simple Tables 490 497 491 Simple tables can be created like this: 498 492 ||= Wiki Markup =||= Display =|| … … 584 578 }}} 585 579 586 === Complex Tables === 587 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]. 589 590 591 == Links == 592 593 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}. 580 === Complex Tables 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 elaborate tables by using [#Processors-example-tables WikiProcessor based tables]. 583 584 == Links 585 586 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark ('!'), such as {{{!WikiPageLink}}}. 594 587 595 588 ||= Wiki Markup =||= Display =|| … … 643 636 }}} 644 637 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 == 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 654 642 655 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: … … 681 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. 682 670 683 684 == Setting Anchors == 671 == Setting Anchors 685 672 686 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: … … 695 682 }}} 696 683 697 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: 698 685 {{{ 699 686 [#point1] … … 714 701 715 702 Point2: [=#point2] Jump here 703 }}} 704 }}} 705 {{{#!td 706 [#point2 jump to the second point] 716 707 717 708 ... 718 709 719 Point3: [=#point3 '''Point 3''']720 721 Point4: [[=#point4|Point 4]]722 723 724 }}}725 }}}726 {{{#!td727 [#point2 jump to the second point]728 729 ...730 731 710 Point2: [=#point2] Jump here 732 733 ... 734 735 Point3: [=#point3 '''Point 3'''] 736 737 Point4: [[=#point4|Point 4]] 738 739 }}} 740 741 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)^)]]`. 742 711 }}} 712 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)^)]]`. 743 714 744 715 == Escaping Links, WikiPageNames and other Markup == #Escaping 745 716 746 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 ('!'). 747 718 748 719 ||= Wiki Markup =||= Display =|| … … 754 725 {{{ 755 726 Various forms of escaping for list markup: 756 `-`escaped minus sign \\757 ``1. escaped number \\758 {{{*}}}escaped asterisk sign727 ^^- escaped minus sign \\ 728 ^^1. escaped number \\ 729 ^^* escaped asterisk sign 759 730 }}} 760 731 }}} … … 764 735 765 736 Various forms of escaping for list markup: 766 `-`escaped minus sign \\767 ``1. escaped number \\768 {{{*}}}escaped asterisk sign769 }}} 770 771 == Images ==737 ^^- escaped minus sign \\ 738 ^^1. escaped number \\ 739 ^^* escaped asterisk sign 740 }}} 741 742 == Images 772 743 773 744 Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags. … … 793 764 See WikiMacros for further documentation on the `[[Image()]]` macro, which has several useful options (`title=`, `link=`, etc.) 794 765 795 796 == Macros == 766 == Macros 797 767 798 768 Macros are ''custom functions'' to insert dynamic content in a page. … … 822 792 }}} 823 793 824 825 == Processors == 794 == Processors 826 795 827 796 Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in … … 960 929 See WikiProcessors for more information. 961 930 962 963 == Comments == 931 == Comments 964 932 965 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. … … 973 941 Your comment for editors here 974 942 }}} 975 see ;-)943 see. 976 944 }}} 977 945 }}} … … 982 950 Your comment for editors here 983 951 }}} 984 see ;-) 985 }}} 986 987 == Miscellaneous == 988 989 An horizontal line can be used to separated different parts of your page: 990 991 ||= Wiki Markup =||= Display =|| 992 {{{#!td 952 see. 953 }}} 954 955 == Miscellaneous 956 957 ||= Wiki Markup =||= Display =|| 958 {{{#!td 959 Horizontal line: 993 960 {{{ 994 961 Four or more dashes will be replaced 995 by a nhorizontal line (<HR>)962 by a horizontal line (<HR>) 996 963 ---- 997 964 See? … … 1000 967 {{{#!td 1001 968 Four or more dashes will be replaced 1002 by a nhorizontal line (<HR>)969 by a horizontal line (<HR>) 1003 970 ---- 1004 971 See? … … 1006 973 |---------------------------------- 1007 974 {{{#!td 1008 {{{ 1009 "macro" style [[br]] line break 1010 }}} 1011 }}} 1012 {{{#!td 1013 "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 1014 988 }}} 1015 989 |---------------------------------- 1016 {{{#!td1017 {{{1018 !WikiCreole style \\ line\\break1019 }}}1020 }}}1021 {{{#!td1022 !WikiCreole style \\ line\\break1023 }}}1024
