head 1.7; access; symbols; locks; strict; comment @# @; 1.7 date 2007.01.16.04.12.03; author TWikiContributor; state Exp; branches; next 1.6; 1.6 date 2006.04.01.05.55.28; author TWikiContributor; state Exp; branches; next 1.5; 1.5 date 2006.02.01.12.01.22; author TWikiContributor; state Exp; branches; next 1.4; 1.4 date 2003.01.18.09.22.32; author PeterThoeny; state Exp; branches; next 1.3; 1.3 date 2002.05.11.22.16.13; author PeterThoeny; state Exp; branches; next 1.2; 1.2 date 2001.01.30.23.51.33; author PeterThoeny; state Exp; branches; next 1.1; 1.1 date 2000.07.01.05.05.30; author PeterThoeny; state Exp; branches; next ; desc @none @ 1.7 log @buildrelease @ text @%META:TOPICINFO{author="TWikiContributor" date="1159992769" format="1.0" version="7"}% ---+!! What is a !WikiWord? A !WikiWord consists of two or more words with initial capitals, run together. *WikiWords are topic names.* A TWiki topic name always has a fixed format: two or more words with initial capitals, run together. Like the name of the current topic: *WikiWord*. When you type the name of a topic, you create a link to that topic. You type =%HOMETOPIC%= and on saving the page this becomes %HOMETOPIC%. It's as easy as that. When you type a !WikiWord, you establish a hyperlink. It's as easy as that. !WikiWord linking is easy to use: * You don't have to know the full path to where the topic is stored - you just type the name * You don't need to write HTML * Without HTML, the topic text is easier to read when editing * Easy linking leads to interesting texts with links placed in context !WikiWords are styled like this because: * It makes Wiki hyperlinks instantly recognizable * It leads to interesting Wiki topics * It avoids the need to fiddle with HTML tags * It avoids over-general topics because at least two words are required ---++ Syntax of a !WikiWord * Uppercase letter(s) * Lowercase letter(s) or numbers(s) * Uppercase letter(s) * Optional lowercase or uppercase letter(s) or number(s) ---++ Good examples of !WikiWords * WikiWord * GoodStyle * VersionFiveDotThree * ReleaseVersion5dot3 * AVeryLongWikiTopicNameIsAlsoPossible: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed * YearTwoThousand * Nine2Five: Note that numbers are considered to be lowercase letters in !WikiWords ---++ Bad examples of !WikiWords: * Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence * 5TWiki: Name beginning with a number * Know-How: Name with dashes in between ---++ Variations in linking When you write the name of a topic, it becomes a link. There are more ways * To write a custom *link label*, use bracket notation: =[[TWikiAccessControl][access control]]= - this becomes: [[TWikiAccessControl][access control]] * To link to a topic in *another web*, write: =Sandbox.WebSearch= - this becomes: Sandbox.WebSearch * To show the web name in the link use bracket notation: =[[Sandbox.%HOMETOPIC%]]= - this becomes: [[Sandbox.%HOMETOPIC%]] * To link to a topic on *another Wiki site*, use: =TWiki:Main/WebHome= - this becomes: TWiki:Main/WebHome (sites are defined in the InterwikiPlugin) * To link to a part on the *same page*, write a "#" followed by the name of an anchor. The anchor is a "#" followed by a name which must be a !WikiName. Example =#MyAnchor=. You can also link to an anchor on another page: =%TWIKIWEB%.%HOMETOPIC%#MyAnchor=. * To link to a header on the *same page*, write a "#" followed by the header text, with spaces replaced by underscores (and =!= removed): =[[#Good_examples_of_WikiWords]]= becomes: [[#Good_examples_of_WikiWords]]. You can also link to a header on another page: =%TWIKIWEB%.%HOMETOPIC%#Disclaimer= becomes: %TWIKIWEB%.%HOMETOPIC%#Disclaimer. ---++ Hints * Insert !WikiWords wherever you can. Rich linking helps to make a Wiki successful. * Be specific. All topics in a web share one name space. For example, instead of =FunctionalSpec= write =BreadSlicerFunctionalSpec= because other projects might also have a functional spec topic. * To stop a !WikiWord from being turned into a hyperlink, insert an exclamation point immediately before the !WikiWord. For example, write =!SunOS= to get !SunOS. * Create topics with singular names. Plural WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord (works only in English). * Sometimes you have to be creative to find a good WikiName. Examples: * To create a topic about the the *Bread Slicer 1.2* product, use =BreadSlicer1dot2= or =BreadSlicer1pt2=, but not =BreadSlicer1.2=. * Numbers are considered lowercase which makes =Year2K= and =Y2K= !WikiWords but not =Y2000= and =Y2k=. * Turn acronyms into !WikiWords, i.e. take =FaqIndex= for a "FAQ index" topic. * It is possible to turn off the auto-linking of !WikiWords and to rely only on the bracket notation. See NOAUTOLINK setting in TWikiPreferences#Default_Web_Preferences. * %X% When linking to a %HOMETOPIC% topic _in another web_, the link will be rendered as the name of the web, e.g. =Sandbox.%HOMETOPIC%= becomes Sandbox.%HOMETOPIC%. __Related Topics:__ WikiSyntax, TextFormattingRules @ 1.6 log @buildrelease @ text @d1 1 a1 1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="6"}% d22 1 a22 1 * Lowercase letter(s) d34 1 d39 1 a39 2 * T5Wiki: Name with number before the uppercase, lowercase, uppercase sequence * Md5sumsAfterBurning: Name with number before the uppercase, lowercase, uppercase sequence d50 2 a51 1 * To link to a part on the *same page*, write a dash and the name of the header, with spaces replaced by underscores (and =!= removed): =[[#Good_examples_of_WikiWords]]= becomes: [[#Good_examples_of_WikiWords]]. You can also link to a part on another page: =%TWIKIWEB%.%HOMETOPIC%#Disclaimer= becomes: %TWIKIWEB%.%HOMETOPIC%#Disclaimer. d57 1 a57 1 * Create topics with singular names. Plural WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord. d60 1 a60 1 * To create a topic about *year 2000*, you could go for =YearTwoK= or =YearTwoThousand=, but not =Year2K= or =Y2K= or =Y2000=. @ 1.5 log @buildrelease @ text @d1 1 a1 1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="5"}% d8 4 a11 4 * You don't have to know the full path to where the topic is stored - you just type the name * You don't need to write HTML * Without HTML, the topic text is easier to read when editing * Easy linking leads to interesting texts with links placed in context d14 4 a17 4 * It makes Wiki hyperlinks instantly recognizable * It leads to interesting Wiki topics * It avoids the need to fiddle with HTML tags * It avoids over-general topics because at least two words are required d21 4 a24 4 * Uppercase letter(s) * Lowercase letter(s) * Uppercase letter(s) * Optional lowercase or uppercase letter(s) or number(s) d28 6 a33 6 * WikiWord * GoodStyle * VersionFiveDotThree * ReleaseVersion5dot3 * AVeryLongWikiTopicNameIsAlsoPossible: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed * YearTwoThousand d37 4 a40 4 * Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence * T5Wiki: Name with number before the uppercase, lowercase, uppercase sequence * Md5sumsAfterBurning: Name with number before the uppercase, lowercase, uppercase sequence * Know-How: Name with dashes in between d46 5 a50 5 * To write a custom *link label*, use bracket notation: =[[TWikiAccessControl][access control]]= - this becomes: [[TWikiAccessControl][access control]] * To link to a topic in *another web*, write: =Sandbox.WebSearch= - this becomes: Sandbox.WebSearch * To show the web name in the link use bracket notation: =[[Sandbox.%HOMETOPIC%]]= - this becomes: [[Sandbox.%HOMETOPIC%]] * To link to a topic on *another Wiki site*, use: =TWiki:Main/WebHome= - this becomes: TWiki:Main/WebHome (sites are defined in the InterwikiPlugin) * To link to a part on the *same page*, write a dash and the name of the header, with spaces replaced by underscores (and =!= removed): =[[#Good_examples_of_WikiWords]]= becomes: [[#Good_examples_of_WikiWords]]. You can also link to a part on another page: =%TWIKIWEB%.%HOMETOPIC%#Disclaimer= becomes: %TWIKIWEB%.%HOMETOPIC%#Disclaimer. d53 10 a62 10 * Insert !WikiWords wherever you can. Rich linking helps to make a Wiki successful. * Be specific. All topics in a web share one name space. For example, instead of =FunctionalSpec= write =BreadSlicerFunctionalSpec= because other projects might also have a functional spec topic. * To stop a !WikiWord from being turned into a hyperlink, insert an exclamation point immediately before the !WikiWord. For example, write =!SunOS= to get !SunOS. * Create topics with singular names. Plural WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord. * Sometimes you have to be creative to find a good WikiName. Examples: * To create a topic about the the *Bread Slicer 1.2* product, use =BreadSlicer1dot2= or =BreadSlicer1pt2=, but not =BreadSlicer1.2=. * To create a topic about *year 2000*, you could go for =YearTwoK= or =YearTwoThousand=, but not =Year2K= or =Y2K= or =Y2000=. * Turn acronyms into !WikiWords, i.e. take =FaqIndex= for a "FAQ index" topic. * It is possible to turn off the auto-linking of !WikiWords and to rely only on the bracket notation. See NOAUTOLINK setting in TWikiPreferences#Default_Web_Preferences. * %X% When linking to a %HOMETOPIC% topic _in another web_, the link will be rendered as the name of the web, e.g. =Sandbox.%HOMETOPIC%= becomes Sandbox.%HOMETOPIC%. @ 1.4 log @none @ text @d1 64 a64 47 %META:TOPICINFO{author="PeterThoeny" date="1042881752" format="1.0" version="1.4"}% A WikiWord consists of two or more words with initial capitals, run together. When you type a WikiWord, you establish a hyperlink. It's as easy as that. WikiWords are styled like this because: * It makes Wiki hyperlinks instantly recognizable * It leads to interesting Wiki topics * It avoids the need to fiddle with HTML tags * It avoids over-general topics because at least two words are required *Syntax of a WikiWord* * Uppercase letter(s) * Lowercase letter(s) * Uppercase letter(s) * Optional lowercase or uppercase letter(s) or number(s) *Good examples for WikiWords:* * WikiWord * GoodStyle * AVeryLongWikiTopicNameIsAlsoPossible: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed * YearTwoThousand *Bad examples for WikiWords:* * Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence * T5Wiki: Name with number before the uppercase, lowercase, uppercase sequence * Md5sumsAfterBurning: Name with number before the uppercase, lowercase, uppercase sequence * Know-How: Name with dashes in between *Hints* * Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful. * Be specific. All topics in a web share one name space. For example, instead of =FunctionalSpec= write =BreadSlicerFunctionalSpec= because other projects might also have a functional spec topic. * %H% To stop a WikiWord from being turned into a hyperlink, insert the text =<nop>= immediately before the WikiWord. * It is recommended to create topics with singular names. Plural WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord. * Sometimes you have to be creative to find a good WikiName. Examples: * To create a topic about the the *Bread Slicer 1.2* product, use =BreadSlicer1dot2= or =BreadSlicer1pt2=, but not =BreadSlicer1.2=. * To create a topic about *year 2000*, you could go for =YearTwoK= or =YearTwoThousand=, but not =Year2K= or =Y2K= or =Y2000=. * Turn acronyms into WikiWords, i.e. take =FaqIndex= for a "FAQ index" topic. * You can specify any link label by using double square brackets, e.g. write =[[TWikiAccessControl][access control]]= to get a link to TWikiAccessControl that looks like [[TWikiAccessControl][access control]]. * %X% The topic is assumed to be in the current TWiki web. Prepending the name of a TWiki web and a period links to a topic in another web. __Related Topics:__ WikiSyntax, TextFormattingRules @ 1.3 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1021155373" format="1.0" version="1.3"}% d24 1 a24 1 * AVeryLongWikiTopicNameIsAlsoPossible d29 3 a31 2 * Web: Name with no uppercase letter in between * T5Wiki: Name with number before the first lowercase letter d38 2 a39 2 * To stop a WikiWord from being turned into a hyperlink, insert the text =<nop>= immediately before the WikiWord. * A topic is usually presented in the singular. Plural WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord. d45 1 @ 1.2 log @none @ text @d1 1 d36 1 d43 1 a43 1 * You can create nicer looking links by using double square brackets, i.e. write =[[TWiki access control]]= to get a link to TWikiAccessControl that looks like [[TWiki access control]]. @ 1.1 log @none @ text @d10 1 a10 1 * It avoids over-general topics, because at least two words are required d24 1 a24 1 * ProblemY2K d37 7 a43 2 * Sometimes you have to be creative to find a good WikiName. For example, if you want to create a topic about the year 2000 problem, you could go for FixY2K or YearTwoK or YearTwoThousand, but not Year2K or Y2K or Y2000. * Turn acronyms into WikiWords, i.e. take FaqIndex for a "FAQ index" topic. @