1head 1.11; 2access; 3symbols; 4locks; strict; 5comment @# @; 6 7 81.11 9date 2018.07.14.11.50.57; author TWikiContributor; state Exp; 10branches; 11next 1.10; 12 131.10 14date 2015.09.16.07.58.15; author TWikiContributor; state Exp; 15branches; 16next 1.9; 17 181.9 19date 2014.06.05.07.47.01; author TWikiContributor; state Exp; 20branches; 21next 1.8; 22 231.8 24date 2013.03.19.02.30.13; author TWikiContributor; state Exp; 25branches; 26next 1.7; 27 281.7 29date 2011.06.05.02.52.13; author TWikiContributor; state Exp; 30branches; 31next 1.6; 32 331.6 34date 2010.11.11.23.00.36; author TWikiContributor; state Exp; 35branches; 36next 1.5; 37 381.5 39date 2010.06.12.03.27.00; author TWikiContributor; state Exp; 40branches; 41next 1.4; 42 431.4 44date 2010.05.29.14.44.13; author TWikiContributor; state Exp; 45branches; 46next 1.3; 47 481.3 49date 2008.01.22.03.21.30; author TWikiContributor; state Exp; 50branches; 51next 1.2; 52 531.2 54date 2007.01.16.04.11.58; author TWikiContributor; state Exp; 55branches; 56next 1.1; 57 581.1 59date 2006.06.25.16.26.26; author TWikiContributor; state Exp; 60branches; 61next ; 62 63 64desc 65@buildrelease 66@ 67 68 691.11 70log 71@buildrelease 72@ 73text 74@%META:TOPICINFO{author="TWikiContributor" date="1531569057" format="1.1" version="11"}% 75---+ TWiki Editing Shorthand 76 77_These instructions are for contributors who prefer to use the Raw Edit over the default WYSIWYG editor._ 78 79%STARTINCLUDE% 80<style type='text/css' media='all'> 81/* Item7507: to avoid Chrome/Safari font baseline bug under some skins */ 82table td img { 83 vertical-align: top; 84} 85</style> 86<table class="twikiTable" border="1" cellpadding="3" bgcolor="#ffffff"> 87<tr bgcolor="#ffffff"> 88<th width="50%" class="twikiFirstCol"> 89 Formatting Command: 90</th> 91<th width="25%"> 92 You write: 93</th> 94<th width="25%"> 95 You get: 96</th> 97</tr> 98<tr valign="top"> 99<td> 100#TheParagraphs 101 *Paragraphs:* %BR% 102 Blank lines will create new paragraphs. 103</td><td> 104<verbatim> 1051st paragraph 106 1072nd paragraph 108</verbatim> 109</td><td> 110<!-- TWikibugs:Item7687 --> 111%IF{"{OpenClosePTags}" then="<nop>"}% 1121st paragraph 113 1142nd paragraph 115</td> 116</tr> 117<tr valign="top"> 118<td> 119#TheHeadings 120 *Headings:* %BR% 121Three or more dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a top level heading, two pluses a second level heading, etc. The maximum heading depth is 6. 122 123 * icon:tip You can create a table of contents with the [[VarTOC][%<nop>TOC%]] variable. 124 * icon:tip If you want to *exclude* a heading from the TOC, put =!!= after the =---+=. 125 * icon:warning Empty headings are allowed and won't appear in the table of contents. 126</td><td> 127<verbatim> 128---++ Sushi 129---+++ Maguro 130---+++!! Not in TOC 131</verbatim> 132</td><td> 133%IF{"{OpenClosePTags}" then="<nop>"}% 134<nop><h2>Sushi</h2> 135<nop><h3>Maguro</h3> 136<nop><h3>Not in TOC</h3> 137</td> 138</tr> 139<tr valign="top"> 140<td> 141#BoldText 142 *Bold Text:* %BR% 143 Words get shown in *bold* by enclosing them in =*= asterisks. 144</td><td> 145<verbatim> 146*Bold* 147</verbatim> 148</td><td> 149%IF{"{OpenClosePTags}" then="<nop>"}% 150*Bold* 151</td> 152</tr> 153<tr valign="top"> 154<td> 155#ItalicText 156 *Italic Text:* %BR% 157 Words get shown in _italic_ by enclosing them in =_= underscores. 158</td><td> 159<verbatim> 160_Italic_ 161</verbatim> 162</td><td> 163%IF{"{OpenClosePTags}" then="<nop>"}% 164_Italic_ 165</td> 166</tr> 167<tr valign="top"> 168<td> 169#BoldItalic 170 *Bold Italic:* %BR% 171 Words get shown in __bold italic__ by enclosing them in =__= double-underscores. 172</td><td> 173<verbatim> 174__Bold italic__ 175</verbatim> 176</td><td> 177%IF{"{OpenClosePTags}" then="<nop>"}% 178__Bold italic__ 179</td> 180</tr> 181<tr valign="top"> 182<td> 183#FixedFont 184 *Fixed Font:* %BR% 185 Words get shown in =fixed font= by enclosing them in =<nop>=<nop>= equal signs. 186</td><td> 187<verbatim> 188=Fixed font= 189</verbatim> 190</td><td> 191%IF{"{OpenClosePTags}" then="<nop>"}% 192=Fixed font= 193 194</td> 195</tr> 196<tr valign="top"> 197<td> 198#BoldFixedFont 199 *Bold Fixed Font:* %BR% 200 Words get shown in ==bold fixed font== by enclosing them in ==<nop>== double equal signs. 201</td><td> 202<verbatim> 203==Bold fixed== 204</verbatim> 205</td><td> 206%IF{"{OpenClosePTags}" then="<nop>"}% 207==Bold fixed== 208</td> 209</tr> 210<tr valign="top"> 211<td> 212 * icon:tip You can follow the closing bold, italic, or other (=* _ __ = ===) indicator with normal punctuation, such as commas and full stops. 213 * icon:warning Make sure there is no space between the text and the indicators. 214 * icon:warning All words enclosed by the indicators need to be on the same line. 215</td><td> 216<verbatim> 217_This works_, 218_this does not _ 219_this fails 220too_ 221</verbatim> 222</td><td> 223%IF{"{OpenClosePTags}" then="<nop>"}% 224_This works_, %BR% 225_this does not _ %BR% 226_this fails 227too_ 228</td> 229</tr> 230<tr valign="top"> 231<td> 232#HorizontalRule 233 *Separator (Horizontal Rule):* %BR% 234Three or more three dashes at the beginning of a line.. 235</td><td> 236<verbatim> 237------- 238</verbatim> 239</td><td> 240%IF{"{OpenClosePTags}" then="<nop>"}% 241------- 242</td> 243</tr> 244<tr valign="top"> 245<td> 246#BulletedList 247 *Bulleted List:* %BR% 248Multiple of three spaces, an asterisk, and another space. 249 * icon:help For all the list types, you can break a list item over several lines by indenting lines after the first one by *at least 3 spaces*. 250</td><td> 251<verbatim> 252 * level 1 253 * level 2 254 * back on 1 255 * A bullet 256 broken over 257 three lines 258 * last bullet 259</verbatim> 260</td><td> 261%IF{"{OpenClosePTags}" then="<nop>"}% 262 * level 1 263 * level 2 264 * back on 1 265 * A bullet 266 broken over 267 three lines 268 * last bullet 269</td> 270</tr> 271<tr valign="top"> 272<td> 273#IconList 274 *Icon List:* %BR% 275Multiple of three spaces, an asterisk, text =icon:name= and another space. 276 * icon:help Use the =name= of any TWikiDocGraphics icon. 277</td><td> 278<verbatim> 279 * icon:tip Icon list 280 * icon:led-red Full 281 * icon:led-green OK 282 * icon:unchecked Item 1 283 * icon:checked Item 2 284 * icon:empty No bullet 285</verbatim> 286</td><td> 287%IF{"{OpenClosePTags}" then="<nop>"}% 288 * icon:tip Icon list 289 * icon:led-red Full 290 * icon:led-green OK 291 * icon:unchecked Item 1 292 * icon:checked Item 2 293 * icon:empty No bullet 294</td> 295</tr> 296<tr valign="top"> 297<td> 298#NumberedList 299 *Numbered List:* %BR% 300 Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number: 301| *Type* | *Generated Style* | *Sample Sequence* | 302| 1. | Arabic numerals | 1, 2, 3, 4... | 303| A. | Uppercase letters | A, B, C, D... | 304| a. | Lowercase letters | a, b, c, d... | 305| I. | Uppercase Roman Numerals | I, II, III, IV... | 306| i. | Lowercase Roman Numerals | i, ii, iii, iv... | 307</td><td> 308<verbatim> 309 1. Sushi 310 1. Dim Sum 311 1. Fondue 312 313 A. Sushi 314 A. Dim Sum 315 A. Fondue 316 317 i. Sushi 318 i. Dim Sum 319 i. Fondue 320</verbatim> 321</td><td> 322%IF{"{OpenClosePTags}" then="<nop>"}% 323 1. Sushi 324 1. Dim Sum 325 1. Fondue 326 327 A. Sushi 328 A. Dim Sum 329 A. Fondue 330 331 i. Sushi 332 i. Dim Sum 333 i. Fondue 334</td> 335</tr> 336<tr valign="top"> 337<td> 338#DefinitionList 339 *Definition List:* %BR% 340 Three spaces, a dollar sign, the term, a colon, a space, followed by the definition. 341 342 Deprecated syntax: Three spaces, the term with no spaces, a colon, a space, followed by the definition. 343</td><td> 344<verbatim> 345 $ Sushi: Japan 346 $ Dim Sum: S.F. 347</verbatim> 348</td><td> 349%IF{"{OpenClosePTags}" then="<nop>"}% 350 $ Sushi: Japan 351 $ Dim Sum: S.F. 352</td> 353</tr> 354<tr valign="top"> 355<td> 356#TheTable 357 *Table:* %BR% 358Each row of the table is a line containing of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored. 359 * =| <nop>*bold*<nop> |= header cell with text in asterisks 360 * =| center-aligned |= cell with two or more spaces on both sides. The number of spaces may be different between sides 361 * =| right-aligned |= cell with two or more spaces on the left and one or zero space on the right 362 * =| 2 colspan ||= and multi-span columns with multiple <tt>|</tt>'s right next to each other 363 * =|^|= cell with caret indicating follow-up row of multi-span rows 364 * =|>> ... <<|= cell enclosed in double-square brackets can span multiple lines - useful for bullets and nested tables 365 * You can split rows over multiple lines by putting a backslash ='\'= at the end of each line 366 * Contents of table cells wrap automatically as determined by the browser 367 * Use =%<nop>VBAR%= or =&#124;= to add =|= characters in tables. 368 * Use =%<nop>CARET%= or =&#94;= to add =^= characters in tables. 369 * icon:tip The %SYSTEMWEB%.TablePlugin provides the =|^|= multiple-span row functionality, =|>> ... <<|= multi-line syntax, and additional rendering features 370</td><td> 371<verbatim> 372| *L* | *C* | *R* | 373| A2 | B2 | C2 | 374| A3 | B3 | C3 | 375| multi span ||| 376| A5-7 | 5 | 5 | 377|^| six | six | 378|^| seven | seven | 379| split\ 380 | over\ 381 | 3 lines | 382| A9 |>> 383 | Nested | 384 | table | 385<<| C9 | 386</verbatim> 387</td><td> 388%IF{"{OpenClosePTags}" then="<nop>"}% 389| *L* | *C* | *R* | 390| A2 | B2 | C2 | 391| A3 | B3 | C3 | 392| multi span ||| 393| A5-7 | 5 | 5 | 394|^| six | six | 395|^| seven | seven | 396| split\ 397 | over\ 398 | 3 lines | 399| A9 |>> 400 | Nested | 401 | table | 402<<| C9 | 403</td> 404</tr> 405<tr valign="top"> 406<td> 407#WikiWordLinks 408 *<nop>WikiWord Links:* %BR% 409 <nop>CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis. 410 * icon:tip If you want to link to a topic in a different web write =Otherweb.TopicName=. 411 * icon:tip To link to a topic in a subweb write =Otherweb.Subweb.TopicName=. 412 * icon:help The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the <nop>%HOMETOPIC% topic. 413 * icon:warning Dots ='.'= are used to separate webs and subwebs from topic names and therefore cannot be used in topic names. 414 * icon:tip Links can be prevented with an =!= exclamation point prefix. 415 416It's generally a good idea to use the TWikiVariables %<nop>SYSTEMWEB% and %<nop>USERSWEB% instead of TWiki and Main. 417</td><td> 418<verbatim> 419WebStatistics 420 421Sandbox.WebNotify 422 423Sandbox.WebHome 424 425Sandbox.Subweb.TopicName 426 427!EscapedWikiWord 428</verbatim> 429</td><td> 430%IF{"{OpenClosePTags}" then="<nop>"}% 431WebStatistics 432 433Sandbox.WebNotify 434 435Sandbox.%HOMETOPIC% 436 437<a href="#MyAnchor" title="simulated link">TopicName</a> 438 439!EscapedWikiWord 440</td> 441</tr> 442<tr valign="top"> 443<td> 444#TheAnchors 445 *Anchors:* %BR% 446 You can define a reference inside a TWiki topic (called an anchor name) and link to that. To __define__ an anchor write =#AnchorName= at the beginning of a line. The anchor name must be a WikiWord of no more than 32 characters. To __link__ to an anchor name use the =[<nop>[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic. 447</td><td> 448<verbatim> 449[[WikiWord#NotThere]] 450 451[[#MyAnchor][Jump]] 452 453#MyAnchor 454To here 455</verbatim> 456</td><td> 457%IF{"{OpenClosePTags}" then="<nop>"}% 458[[WikiWord#NotThere]] 459 460[[#MyAnchor][Jump]] 461 462#MyAnchor 463To here 464</td> 465</tr> 466<tr valign="top"> 467<td> 468#ExternalLinks 469 *External Links:* %BR% 470 URLs starting with =file=, =ftp=, =gopher=, =http=, =https=, =irc=, =mailto=, =news=, =nntp= and =telnet= are linked automatically if preceded by whitespace or parenthesis. External links are indicated with a trailing %ICON{external-link}% icon, and open up in a new browser tab or window; the behavior of both can be set in configure or preferences variables (see TWikiExternalLinks for details). Links can be prevented with an =!= exclamation point prefix. 471</td><td> 472<verbatim> 473http://twiki.org 474 475https://google.com 476 477!http://escaped-link 478</verbatim> 479</td><td> 480%IF{"{OpenClosePTags}" then="<nop>"}% 481http://twiki.org 482 483https://google.com 484 485!http://escaped-link 486</td> 487</tr> 488<tr valign="top"> 489<td> 490#ForcedLinks 491#HeRe 492 *Forced Links:* %BR% 493 Use double square brackets to create forced links: Write =[<nop>[link]]= or =[<nop>[link][label]]= to force a link. Use the former for singleton words and if [[#DisableLinks][automatic linking is disabled]]. Use the latter one to specify a link label other than the link. For the link, you can use internal link references (e.g. WikiWords) and URLs (e.g. !http://TWiki.org/). 494 * icon:tip URL parameters can follow a WikiWord 495 * icon:tip Anchor names can be added to create a link to a specific place in a document. 496 * icon:tip To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point. 497 * icon:tip The [[VarTOPICTITLE][topic title]] instead of the topic name is shown for =[<nop>[WikiWord]]= links if the SHOWTOPICTITLELINK preferences setting is enabled. 498</td><td> 499<verbatim> 500[[WikiWord]] 501 502[[WikiWord?n1=v1;n2=v2]] 503 504[[WikiWord#TheAnchor]] 505 506[[WikiWord?n=5#TheAnchor]] 507 508[[WikiSyntax][wiki syntax]] 509 510[[http://gnu.org/][GNU]] 511 512[[Singleton]] 513 514escaped: 515![[WikiSyntax]] 516</verbatim> 517</td><td> 518%IF{"{OpenClosePTags}" then="<nop>"}% 519[[WikiWord]] 520 521[[WikiWord?n1=v1;n2=v2]] 522 523[[WikiWord#TheAnchor]] 524 525[[WikiWord?n=5#TheAnchor]] 526 527[[WikiSyntax][wiki syntax]] 528 529[[http://gnu.org/][GNU]] 530 531[[Singleton]] 532 533escaped: 534![[WikiSyntax]] 535</td> 536</tr> 537<tr valign="top"> 538<td> 539#TopicTitleLinks 540 *Topic Title Links:* %BR% 541 Use double square brackets and a plus sign to create links with topic title: Write =[<nop>[+TopicName]]= or =[<nop>[+Web.TopicName]]= to show the [[VarTOPICTITLE][topic title]] instead of the topic name. The topic title is defined by the form field named "Title", the topic preferences setting named TITLE, or the topic name if neither exists. 542 * icon:tip An alternative syntax is =[<nop>[TopicName][$topictitle]]= or =[<nop>[Web.TopicName][$topictitle]]=. 543</td><td> 544<verbatim> 545[[+BugN1234]] 546 547[[+Bugs.BugN1234]] 548 549[[BugN1234][$topictitle]] 550</verbatim> 551</td><td> 552%IF{"{OpenClosePTags}" then="<nop>"}% 553[[%TOPIC%][The sky is falling]] 554 555[[%TOPIC%][The sky is falling]] 556 557[[%TOPIC%][The sky is falling]] 558</td> 559</tr> 560<tr valign="top"> 561<td> 562#ReferToTopicOrAttachmentName 563 *Refer to Topic or Attachment Name in Double Square Brackets:* %BR% 564 =$name= in the link label in the double square brackets notation refers to the topic name or the attachment file name. 565 566=$name= is used for consistency with QuerySearch, in which =name= refers to the topic name and the attachment file name, respectively. 567</td><td> 568<verbatim> 569[[%SYSTEMWEB%.WikiWord\ 570#TheSyntax][$name]] 571 572[[%PUBURL%/%WEB%/WabiSabi\ 573/wabisabi.gif][$name]] 574</verbatim> 575</td><td> 576%IF{"{OpenClosePTags}" then="<nop>"}% 577[[%SYSTEMWEB%.WikiWord#TheSyntax][$name]] 578 579[[%PUBURL%/%WEB%/WabiSabi/wabisabi.gif][$name]] 580</td> 581</tr> 582<tr valign="top"> 583<td> 584#PreventLink 585 *Prevent a Link:* %BR% 586 Prevent a WikiWord from being linked by prepending it with an exclamation point. 587</td><td> 588<verbatim> 589!RedHat 590</verbatim> 591</td><td> 592!RedHat 593</td> 594</tr> 595<tr valign="top"> 596<td> 597#DisableLinks 598 *Disable Links:* %BR% 599 You can disable automatic linking of WikiWords by surrounding text with =<noautolink>= and =</noautolink>= tags. 600 * icon:help It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting. 601</td><td> 602<verbatim> 603 <noautolink> 604 RedHat & SuSE 605 </noautolink> 606</verbatim> 607</td><td> 608%IF{"{OpenClosePTags}" then="<nop>"}% 609 <noautolink> 610 RedHat & SuSE 611 </noautolink> 612</td> 613</tr> 614<tr valign="top"> 615<td> 616#MailtoLinks 617 *Mailto Links:* %BR% 618 E-mail addresses are linked automatically. To create e-mail links that have more descriptive link text, specify subject lines or message bodies, or omit the e-mail address, you can write =[<nop>[mailto:user@@domain][descriptive text]]=. 619</td><td> 620<verbatim> 621a@@b.com 622 623[[mailto:a@@b.com]\ 624[Mail]] 625 626[[mailto:?subject=\ 627Hi][Hi]] 628</verbatim> 629</td><td> 630%IF{"{OpenClosePTags}" then="<nop>"}% 631a@@b.com 632 633[[mailto:a@@b.com]\ 634[Mail]] 635 636[[mailto:?subject=Hi][Hi]] 637</td> 638</tr> 639<tr valign="top"> 640<td> 641#TwitterLinks 642 *Twitter Links:* %BR% 643 <nop>@@twitter IDs are linked automatically. The link rule is defined by the ={Links}{TwitterUrlPattern}= configure setting. 644</td><td> 645<verbatim> 646@@twiki 647 648!@@escaped 649</verbatim> 650</td><td> 651%IF{"{OpenClosePTags}" then="<nop>"}% 652@@twiki 653 654!@@escaped 655</td> 656</tr> 657<tr valign="top"> 658<td> 659#VerbatimText 660 *Verbatim Text:* %BR% 661 Surround code excerpts and other formatted text with =<verbatim>= and =</verbatim>= tags. 662 * icon:tip The =verbatim= tag disables HTML code. Use =<pre>= and =</pre>= tags instead if you want the HTML code within the tags to be interpreted. 663 * icon:warning Preferences variables (* Set NAME = value) are set within verbatim tags. 664</td><td> 665<verbatim> 666<verbatim> 667class CatAnimal { 668 void purr() { 669 <code here> 670 } 671} 672</verbatim> 673</verbatim> 674</td><td> 675<verbatim> 676class CatAnimal { 677 void purr() { 678 <code here> 679 } 680} 681</verbatim> 682</td> 683</tr> 684<tr valign="top"> 685<td> 686#LiteralText 687 *Literal Text:* %BR% 688 TWiki generates HTML code from TWiki shorthand. 689 *Experts* surround anything that must be output literally in the HTML code, without the application of 690 TWiki shorthand rules, with =<literal>..</literal>= tags. 691 * icon:warning Any HTML within literal tags *must* be well formed i.e. all tags must be properly closed before the end of the literal block. 692 * icon:tip TWiki Variables are expanded within literal blocks. 693</td><td> 694<pre> 695<literal> 696| Not | A | Table | 697<literal> 698</pre> 699</td> 700<td> 701<literal> 702| Not | A | Table | 703</literal> 704</td> 705</tr> 706<tr valign="top"> 707<td> 708#ProtectedText 709 *Protected Text:* %BR% 710 *Experts* protect text from mangling by WYSIWYG editors using 711 =<sticky>..</sticky>= tags. Sticky tags don't have any effect on normal 712 topic display; they are only relevant when content has to be 713 protected from a WYSIWYG editor (usually because it isn't well-formed HTML, or because it 714 is HTML that WYSIWYG would normally filter out or modify). Protected 715 content appears as plain text in the WYSIWYG editor. 716</td><td> 717<pre> 718<sticky> 719<div> 720This div is required 721</div> 722</sticky> 723</pre> 724</td> 725<td> 726<sticky> 727<div> 728This div is required 729</div> 730</sticky> 731</td> 732</tr> 733</table> 734%STOPINCLUDE% 735__Related topics:__ WikiSyntax, WikiWord, WikiNotation, TextFormattingRules, TWikiRenderingShortcut, TWikiShorthand 736@ 737 738 7391.10 740log 741@buildrelease 742@ 743text 744@d1 1 745a1 1 746%META:TOPICINFO{author="TWikiContributor" date="1442390295" format="1.1" version="10"}% 747d50 3 748a52 3 749%T% You can create a table of contents with the [[VarTOC][%<nop>TOC%]] variable. 750%BR% %T% If you want to *exclude* a heading from the TOC, put =!!= after the =---+=. 751%BR% %X% Empty headings are allowed and won't appear in the table of contents. 752d139 3 753a141 4 754%T% You can follow the closing bold, italic, or other (=* _ __ = ===) indicator 755with normal punctuation, such as commas and full stops. 756%BR%%X% Make sure there is no space between the text and the indicators. 757%BR%%X% All words enclosed by the indicators need to be on the same line. 758d176 1 759a176 1 760%BR%%H% For all the list types, you can break a list item over several lines by indenting lines after the first one by *at least 3 spaces*. 761d203 1 762a203 1 763%BR%%H% Use the =name= of any TWikiDocGraphics icon. 764d287 2 765a288 2 766 * =| center-aligned |= cell with at least two, and equal number of spaces on either side 767 * =| right-aligned |= cell with more spaces on the left 768d296 1 769a296 1 770%T% The %SYSTEMWEB%.TablePlugin provides the =|^|= multiple-span row functionality, =|>> ... <<|= multi-line syntax, and additional rendering features 771d337 5 772a341 4 773%BR%%T% If you want to link to a topic in a different web write =Otherweb.TopicName=. 774%BR%%T% To link to a topic in a subweb write =Otherweb.Subweb.TopicName=. 775%BR%%H% The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the <nop>%HOMETOPIC% topic. 776%BR%%X% Dots ='.'= are used to separate webs and subwebs from topic names and therefore cannot be used in topic names. 777d353 2 778d365 2 779d421 4 780a424 4 781 %BR%%T% URL parameters can follow a WikiWord 782 %BR%%T% Anchor names can be added to create a link to a specific place in a document. 783 %BR%%T% To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point. 784 %BR%%T% The [[VarTOPICTITLE][topic title]] instead of the topic name is shown for =[<nop>[WikiWord]]= links if the SHOWTOPICTITLELINK preferences setting is enabled. 785d469 1 786a469 1 787 %BR%%T% An alternative syntax is =[<nop>[TopicName][$topictitle]]= or =[<nop>[Web.TopicName][$topictitle]]=. 788d489 22 789d516 1 790a516 1 791!SunOS 792d519 1 793a519 1 794!SunOS 795d527 1 796a527 1 797%BR%%H% It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting. 798d574 2 799d580 2 800d589 2 801a590 2 802%BR%%T% The =verbatim= tag disables HTML code. Use =<pre>= and =</pre>= tags instead if you want the HTML code within the tags to be interpreted. 803%BR%%X% Preferences variables (* Set NAME = value) are set within verbatim tags. 804d618 2 805a619 2 806 %BR%%X% Any HTML within literal tags *must* be well formed i.e. all tags must be properly closed before the end of the literal block. 807 %BR%%I% TWiki Variables are expanded within literal blocks. 808@ 809 810 8111.9 812log 813@buildrelease 814@ 815text 816@d1 1 817a1 1 818%META:TOPICINFO{author="TWikiContributor" date="1401954421" format="1.1" version="9"}% 819d37 2 820a38 1 821 822d60 1 823a60 1 824 825d76 1 826a76 1 827 828d90 1 829a90 1 830 831d104 1 832a104 1 833 834d118 1 835a118 1 836 837d133 1 838a133 1 839 840d151 1 841a151 1 842 843d168 1 844a168 1 845 846d189 1 847a189 1 848 849d215 1 850a215 1 851 852d250 1 853a250 1 854 855d277 1 856a277 1 857 858d292 1 859d297 1 860a297 1 861%T% The %SYSTEMWEB%.TablePlugin provides the =|^|= multiple-span row functionality and additional rendering features 862d310 4 863a313 1 864| A9 | B9 | C9 | 865d316 1 866a316 1 867 868d327 4 869a330 1 870| A9 | B9 | C9 | 871d355 1 872a355 1 873 874d380 1 875a380 1 876 877d403 1 878a403 1 879 880d425 1 881a425 1 882[[WikiWord?name1=value1;name2=value2]] 883d427 1 884a427 1 885[[WikiWord#TheSyntax]] 886d429 1 887a429 1 888[[WikiWord?foo=bar#TheSyntax]] 889d441 2 890d444 3 891a446 1 892[[WikiWord]] 893d448 1 894a448 1 895[[WikiWord#TheSyntax]] 896d475 1 897a475 1 898 899d509 1 900a509 1 901 902d531 1 903a531 1 904 905d550 1 906a550 1 907 908@ 909 910 9111.8 912log 913@buildrelease 914@ 915text 916@d1 1 917a1 1 918%META:TOPICINFO{author="TWikiContributor" date="1363660213" format="1.1" version="8"}% 919d7 6 920d409 1 921d417 2 922d421 2 923@ 924 925 9261.7 927log 928@buildrelease 929@ 930text 931@d1 1 932a1 1 933%META:TOPICINFO{author="TWikiContributor" date="1307242333" format="1.1" version="7"}% 934d169 2 935a170 2 936Multiple of three spaces, an asterisk, and another space.%BR% 937%H% For all the list types, you can break a list item over several lines by indenting lines after the first one by *at least 3 spaces*. 938d194 25 939d323 5 940a327 5 941 <nop>CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis. %BR% 942%T% If you want to link to a topic in a different web write =Otherweb.TopicName=. %BR% 943To link to a topic in a subweb write =Otherweb.Subweb.TopicName=.%BR% 944%H% The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the <nop>%HOMETOPIC% topic. %BR% 945%X% Dots ='.'= are used to separate webs and subwebs from topic names and therefore cannot be used in topic names. 946d377 22 947d402 4 948a405 3 949 Use double square brackets to create forced links: Write =[<nop>[link]]= or =[<nop>[link][label]]= to force a link. Use the former for singleton words and if [[#DisableLinks][automatic linking is disabled]]. Use the latter one to specify a link label other than the link. For the link, you can use internal link references (e.g. WikiWords) and URLs (e.g. http://TWiki.org/). 950 %BR% %T% Anchor names can be added to create a link to a specific place in a document. 951 %BR% %T% To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point. 952d439 23 953d477 2 954a478 2 955 You can disable automatic linking of WikiWords by surrounding text with =<noautolink>= and =</noautolink>= tags.%BR% 956%H% It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting. 957d519 14 958d535 3 959a537 3 960 Surround code excerpts and other formatted text with =<verbatim>= and =</verbatim>= tags.%BR% 961%T% =verbatim= tags disable HTML code. Use =<pre>= and =</pre>= tags instead if you want the HTML code within the tags to be interpreted.%BR% 962__%X% NOTE:__ Preferences variables (* Set NAME = value) are set within verbatim tags. 963d564 3 964a566 3 965 TWiki shorthand rules, with =<literal>..</literal>= tags. %X% any HTML 966 within literal tags *must* be well formed i.e. all tags must be properly closed before 967 the end of the literal block. %I% TWiki Variables are expanded within literal blocks. 968@ 969 970 9711.6 972log 973@buildrelease 974@ 975text 976@d1 1 977a1 1 978%META:TOPICINFO{author="TWikiContributor" date="1289516436" format="1.1" version="6"}% 979d21 1 980d39 1 981d43 3 982a45 3 983You can create a table of contents with the [[VarTOC][%<nop>TOC%]] variable. If you want to *exclude* a heading from the TOC, put =!!= after the =---+=. 984 985%X% Empty headings are allowed, but won't appear in the table of contents. 986d61 1 987d75 1 988d89 1 989d103 1 990d118 1 991d134 2 992a135 2 993 994%X% Make sure there is no space between the text and the indicators. 995d140 2 996d145 4 997a148 28 998_This works_,%BR% 999_this does not _ 1000</td> 1001</tr> 1002<tr valign="top"> 1003<td> 1004 *Verbatim (Literal) Text:* %BR% 1005 Surround code excerpts and other formatted text with =<verbatim>= and =</verbatim>= tags.%BR% 1006%T% =verbatim= tags disable HTML code. Use =<pre>= and =</pre>= tags instead if you want the HTML code within the tags to be interpreted.%BR% 1007__%X% NOTE:__ Preferences variables (* Set NAME = value) are set within verbatim tags. 1008</td><td> 1009<verbatim> 1010<verbatim> 1011class CatAnimal { 1012 void purr() { 1013 <code here> 1014 } 1015} 1016</verbatim> 1017</verbatim> 1018</td><td> 1019<verbatim> 1020class CatAnimal { 1021 void purr() { 1022 <code here> 1023 } 1024} 1025</verbatim> 1026d153 1 1027d167 1 1028d194 3 1029a196 2 1030*Numbered List:* %BR% 1031Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number: 1032d234 1 1033d252 1 1034d296 1 1035d328 1 1036d330 1 1037a330 1 1038 You can define a reference inside a TWiki topic (called an anchor name) and link to that. To __define__ an anchor write =#AnchorName= at the beginning of a line. The anchor name must be a WikiWord of no more than 32 characters. To __link to__ an anchor name use the =[<nop>[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic. 1039d337 2 1040a338 1 1041#MyAnchor To here 1042d346 2 1043a347 1 1044#MyAnchor To here 1045d352 1 1046d355 3 1047a357 5 1048 You can create a forced internal link by enclosing words in double square brackets. 1049%BR% 1050Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; for example, =[<nop>[text formatting FAQ]]= links to topic TextFormattingFAQ. You can also refer to a different web and use anchors. 1051%BR% 1052%T% To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point. 1053d360 5 1054a364 1 1055[[wiki syntax]] 1056d366 3 1057a368 1 1058[[Main.TWiki groups]] 1059d371 1 1060a371 1 1061![[wiki syntax]] 1062d375 1 1063a375 1 1064[[wiki syntax]] 1065d377 1 1066a377 1 1067[[%USERSWEB%.TWiki groups]] 1068a378 12 1069escaped: 1070![[wiki syntax]] 1071</td> 1072</tr> 1073<tr valign="top"> 1074<td> 1075 *Specific Links:* %BR% 1076 You can create a link where you specify the link text and the URL separately using nested square brackets =[<nop>[reference][text]]=. Internal link references (e.g. WikiSyntax) and URLs (e.g. http://TWiki.org/) are both supported. 1077The rules described under __Forced Links__ apply for internal link references. 1078 %BR% %T% Anchor names can be added as well, to create a link to a specific place in a topic. 1079</td><td> 1080<verbatim> 1081d381 1 1082a381 3 1083[[http://gnu.org][GNU]] 1084</verbatim> 1085</td><td> 1086d383 1 1087a383 1 1088[[WikiSyntax][wiki syntax]] 1089d385 2 1090a386 1 1091[[http://gnu.org][GNU]] 1092d391 1 1093d404 1 1094d423 3 1095a425 2 1096*Mailto Links:* %BR% 1097E-mail addresses are linked automatically. To create e-mail links that have more descriptive link text, specify subject lines or message bodies, or omit the e-mail address, you can write =[<nop>[mailto:user@@domain][descriptive text]]=. 1098d446 1 1099a446 1 1100<tr> 1101d448 29 1102a476 1 1103 *Literal content:* %BR% 1104d495 1 1105a495 1 1106<tr> 1107d497 2 1108a498 1 1109 *Protected content:* %BR% 1110@ 1111 1112 11131.5 1114log 1115@buildrelease 1116@ 1117text 1118@d1 1 1119a1 1 1120%META:TOPICINFO{author="TWikiContributor" date="1276313220" format="1.1" version="5"}% 1121d4 2 1122@ 1123 1124 11251.4 1126log 1127@buildrelease 1128@ 1129text 1130@d1 2 1131a2 2 1132%META:TOPICINFO{author="TWikiContributor" date="1259170824" format="1.1" version="4"}% 1133---++ TWiki Editing Shorthand 1134a4 2 1135 1136%TABLE{}% 1137a502 1 1138 1139d504 1 1140@ 1141 1142 11431.3 1144log 1145@buildrelease 1146@ 1147text 1148@d1 1 1149a1 1 1150%META:TOPICINFO{author="TWikiContributor" date="1176595977" format="1.1" version="3"}% 1151d142 1 1152a142 1 1153 *Verbatim Text:* %BR% 1154d488 3 1155a490 3 1156=<sticky>= 1157<verbatim> 1158<div> 1159d492 3 1160a494 3 1161</div> 1162</verbatim> 1163=<sticky>= 1164@ 1165 1166 11671.2 1168log 1169@buildrelease 1170@ 1171text 1172@d1 1 1173a1 1 1174%META:TOPICINFO{author="TWikiContributor" date="1153796460" format="1.1" version="2"}% 1175d9 1 1176a9 1 1177<th width="50%"> 1178d30 1 1179d51 1 1180d66 1 1181d79 1 1182d92 1 1183d105 1 1184d119 1 1185d135 1 1186d142 1 1187a142 1 1188 *Verbatim (Literal) Text:* %BR% 1189d175 1 1190d195 1 1191d230 1 1192d248 2 1193d256 1 1194d272 3 1195a274 2 1196 * Use =&#124;= or =%<nop>VBAR%= to add =|= characters in tables. 1197%T% The %TWIKIWEB%.TablePlugin provides the =|^|= multiple-span row functionality and additional rendering features 1198d290 1 1199d309 3 1200a311 1 1201%H% The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the <nop>%HOMETOPIC% topic. 1202d313 1 1203a313 1 1204It's generally a good idea to use the TWikiVariables %<nop>TWIKIWEB% and %<nop>MAINWEB% instead of TWiki and Main. 1205d321 2 1206d325 1 1207d331 2 1208d338 1 1209a338 1 1210 You can define a reference inside a TWiki topic (called an anchor name) and link to that. To __define__ an anchor write =#AnchorName= at the beginning of a line. The anchor name must be a WikiWord. To __link to__ an anchor name use the =[<nop>[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic. 1211d348 1 1212d369 1 1213a369 1 1214[[Main.TWiki users]] 1215d375 1 1216d378 1 1217a378 1 1218[[%MAINWEB%.TWiki users]] 1219d397 1 1220d423 1 1221a423 2 1222 RedHat & 1223 SuSE 1224d427 1 1225d429 1 1226a429 2 1227 RedHat & 1228 SuSE 1229d448 1 1230d457 47 1231@ 1232 1233 12341.1 1235log 1236@buildrelease 1237@ 1238text 1239@d1 2 1240a2 2 1241%META:TOPICINFO{author="TWikiContributor" date="1141755719" format="1.1" version="1"}% 1242---++ TWiki Editing Shorthand' 1243d258 1 1244@ 1245
