data/TWiki/WikiWord.txt,v
changeset 0 414e01d06fd5
equal deleted inserted replaced
-1:000000000000 0:414e01d06fd5
       
     1 head	1.8;
       
     2 access;
       
     3 symbols;
       
     4 locks; strict;
       
     5 comment	@# @;
       
     6 
       
     7 
       
     8 1.8
       
     9 date	2008.01.22.03.21.27;	author TWikiContributor;	state Exp;
       
    10 branches;
       
    11 next	1.7;
       
    12 
       
    13 1.7
       
    14 date	2007.01.16.04.12.03;	author TWikiContributor;	state Exp;
       
    15 branches;
       
    16 next	1.6;
       
    17 
       
    18 1.6
       
    19 date	2006.04.01.05.55.28;	author TWikiContributor;	state Exp;
       
    20 branches;
       
    21 next	1.5;
       
    22 
       
    23 1.5
       
    24 date	2006.02.01.12.01.22;	author TWikiContributor;	state Exp;
       
    25 branches;
       
    26 next	1.4;
       
    27 
       
    28 1.4
       
    29 date	2003.01.18.09.22.32;	author PeterThoeny;	state Exp;
       
    30 branches;
       
    31 next	1.3;
       
    32 
       
    33 1.3
       
    34 date	2002.05.11.22.16.13;	author PeterThoeny;	state Exp;
       
    35 branches;
       
    36 next	1.2;
       
    37 
       
    38 1.2
       
    39 date	2001.01.30.23.51.33;	author PeterThoeny;	state Exp;
       
    40 branches;
       
    41 next	1.1;
       
    42 
       
    43 1.1
       
    44 date	2000.07.01.05.05.30;	author PeterThoeny;	state Exp;
       
    45 branches;
       
    46 next	;
       
    47 
       
    48 
       
    49 desc
       
    50 @none
       
    51 @
       
    52 
       
    53 
       
    54 1.8
       
    55 log
       
    56 @buildrelease
       
    57 @
       
    58 text
       
    59 @%META:TOPICINFO{author="TWikiContributor" date="1184734707" format="1.1" version="8"}%
       
    60 ---+!! What is a !WikiWord?
       
    61 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.
       
    62 
       
    63 When you type a !WikiWord, you establish a hyperlink. It's as easy as that.
       
    64 
       
    65 !WikiWord linking is easy to use:
       
    66    * You don't have to know the full path to where the topic is stored - you just type the name
       
    67    * You don't need to write HTML
       
    68    * Without HTML, the topic text is easier to read when editing
       
    69    * Easy linking leads to interesting texts with links placed in context
       
    70 
       
    71 !WikiWords are styled like this because:
       
    72    * It makes Wiki hyperlinks instantly recognizable
       
    73    * It leads to interesting Wiki topics
       
    74    * It avoids the need to fiddle with HTML tags
       
    75    * It avoids over-general topics because at least two words are required
       
    76 
       
    77 ---++ Syntax of a !WikiWord
       
    78 
       
    79    * Uppercase letter(s)
       
    80    * Lowercase letter(s) or numbers(s)
       
    81    * Uppercase letter(s)
       
    82    * Optional lowercase or uppercase letter(s) or number(s)
       
    83 
       
    84 !WikiWord syntax in [[Wikipedia:Extended_Backus_Naur_Form][Extended Backus.Naur form]] (EBNF):
       
    85 
       
    86 <verbatim>
       
    87     wikiWord        = upperLetters , lowerNumLetters , upperLetters , { alphaNum } ;
       
    88     upperLetters    = upperCase , { upperCase } ;
       
    89     lowerNumLetters = lowerNum , { lowerNum } ;
       
    90     alphaNum        = upperCase | lowerCase | digit ;
       
    91     lowerNum        = lowerCase | digit ;
       
    92     lowerCase       = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i"
       
    93                     | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r"
       
    94                     | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" ;
       
    95     upperCase       = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I"
       
    96                     | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R"
       
    97                     | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" ;
       
    98     digit           = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;
       
    99 </verbatim>
       
   100 
       
   101 ---++ Good examples of !WikiWords
       
   102 
       
   103    * WikiWord
       
   104    * GoodStyle
       
   105    * VersionFiveDotThree
       
   106    * ReleaseVersion5dot3
       
   107    * AVeryLongWikiTopicNameIsAlsoPossible: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed
       
   108    * YearTwoThousand
       
   109    * Nine2Five: Note that numbers are considered to be lowercase letters in !WikiWords
       
   110 
       
   111 ---++ Bad examples of !WikiWords:
       
   112 
       
   113    * Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence
       
   114    * 5TWiki: Name beginning with a number
       
   115    * Know-How: Name with dashes in between
       
   116 
       
   117 ---++ Variations in linking
       
   118 
       
   119 When you write the name of a topic, it becomes a link. There are more ways
       
   120 
       
   121    * To write a custom *link label*, use bracket notation: =[<nop>[TWikiAccessControl][access control]]= - this becomes: [[TWikiAccessControl][access control]]
       
   122    * To link to a topic in *another web*, write: =Sandbox.WebSearch= - this becomes: Sandbox.WebSearch
       
   123    * To link to a topic in *another subweb* write: =Sandbox.Subweb.WebSearch=.
       
   124    * To show the web name in the link use bracket notation: =[<nop>[Sandbox.%HOMETOPIC%]]= - this becomes: [[Sandbox.%HOMETOPIC%]]
       
   125    * To link to a topic on *another Wiki site*, use: =TWiki:Main/WebHome= - this becomes: TWiki:Main/WebHome (sites are defined in the InterwikiPlugin)
       
   126    * 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: =%SYSTEMWEB%.%HOMETOPIC%#MyAnchor=.
       
   127    * To link to a header on the *same page*, write a "#" followed by the header text, with spaces replaced by underscores (and =!= removed): =[<nop>[#Good_examples_of_WikiWords]]= becomes: [[#Good_examples_of_WikiWords]]. You can also link to a header on another page: =%SYSTEMWEB%.%HOMETOPIC%#Disclaimer= becomes: %SYSTEMWEB%.%HOMETOPIC%#Disclaimer.
       
   128 
       
   129 ---++ Hints
       
   130    * Insert !WikiWords wherever you can. Rich linking helps to make a Wiki successful.
       
   131    * 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.
       
   132    * To stop a !WikiWord from being turned into a hyperlink, insert an exclamation point immediately before the !WikiWord. For example, write =!<nop>SunOS= to get !SunOS.
       
   133    * Create topics with singular names. Plural <nop>WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord (works only in English).
       
   134    * Sometimes you have to be creative to find a good <nop>WikiName. Examples:
       
   135       * To create a topic about the the *Bread Slicer 1.2* product, use =BreadSlicer1dot2= or =BreadSlicer1pt2=, but not =BreadSlicer1.2=.
       
   136       * Numbers are considered lowercase which makes =Year2K= and =Y2K= !WikiWords but not =Y2000= and =Y2k=.
       
   137    * Turn acronyms into !WikiWords, i.e. take =FaqIndex= for a "FAQ index" topic.
       
   138    * 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.
       
   139    * %X% When linking to a <nop>%HOMETOPIC% topic _in another web_, the link will be rendered as the name of the web, e.g. =Sandbox.%HOMETOPIC%= becomes Sandbox.%HOMETOPIC%.
       
   140    * %X% Dots (.) are used as seperators between webs, subwebs, and topics. It is not possible to use dots in topic names. TWiki does not attempt to guess if a dot could be part of a topic name.
       
   141 
       
   142 __Related Topics:__ WikiSyntax, TextFormattingRules
       
   143 %STOPINCLUDE%
       
   144 
       
   145 -- __Contributors:__ TWiki:Main.PeterThoeny, TWiki:Main.ArthurClemens, TWiki:Main.CrawfordCurrie
       
   146 @
       
   147 
       
   148 
       
   149 1.7
       
   150 log
       
   151 @buildrelease
       
   152 @
       
   153 text
       
   154 @d1 1
       
   155 a1 1
       
   156 %META:TOPICINFO{author="TWikiContributor" date="1159992769" format="1.0" version="7"}%
       
   157 d26 17
       
   158 d65 1
       
   159 d68 2
       
   160 a69 2
       
   161    * 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=.
       
   162    * To link to a header on the *same page*, write a "#" followed by the header text, with spaces replaced by underscores (and =!= removed): =[<nop>[#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.
       
   163 d82 1
       
   164 d85 3
       
   165 @
       
   166 
       
   167 
       
   168 1.6
       
   169 log
       
   170 @buildrelease
       
   171 @
       
   172 text
       
   173 @d1 1
       
   174 a1 1
       
   175 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="6"}%
       
   176 d22 1
       
   177 a22 1
       
   178    * Lowercase letter(s)
       
   179 d34 1
       
   180 d39 1
       
   181 a39 2
       
   182    * T5Wiki: Name with number before the uppercase, lowercase, uppercase sequence
       
   183    * Md5sumsAfterBurning: Name with number before the uppercase, lowercase, uppercase sequence
       
   184 d50 2
       
   185 a51 1
       
   186    * 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): =[<nop>[#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.
       
   187 d57 1
       
   188 a57 1
       
   189    * Create topics with singular names. Plural <nop>WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord.
       
   190 d60 1
       
   191 a60 1
       
   192       * To create a topic about *year 2000*, you could go for =YearTwoK= or =YearTwoThousand=, but not =Year2K= or =Y2K= or =Y2000=.
       
   193 @
       
   194 
       
   195 
       
   196 1.5
       
   197 log
       
   198 @buildrelease
       
   199 @
       
   200 text
       
   201 @d1 1
       
   202 a1 1
       
   203 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="5"}%
       
   204 d8 4
       
   205 a11 4
       
   206 	* You don't have to know the full path to where the topic is stored - you just type the name
       
   207 	* You don't need to write HTML
       
   208 	* Without HTML, the topic text is easier to read when editing
       
   209 	* Easy linking leads to interesting texts with links placed in context
       
   210 d14 4
       
   211 a17 4
       
   212 	* It makes Wiki hyperlinks instantly recognizable
       
   213 	* It leads to interesting Wiki topics
       
   214 	* It avoids the need to fiddle with HTML tags
       
   215 	* It avoids over-general topics because at least two words are required
       
   216 d21 4
       
   217 a24 4
       
   218 	* Uppercase letter(s)
       
   219 	* Lowercase letter(s)
       
   220 	* Uppercase letter(s)
       
   221 	* Optional lowercase or uppercase letter(s) or number(s)
       
   222 d28 6
       
   223 a33 6
       
   224 	* WikiWord
       
   225 	* GoodStyle
       
   226 	* VersionFiveDotThree
       
   227 	* ReleaseVersion5dot3
       
   228 	* AVeryLongWikiTopicNameIsAlsoPossible: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed
       
   229 	* YearTwoThousand
       
   230 d37 4
       
   231 a40 4
       
   232 	* Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence
       
   233 	* T5Wiki: Name with number before the uppercase, lowercase, uppercase sequence
       
   234 	* Md5sumsAfterBurning: Name with number before the uppercase, lowercase, uppercase sequence
       
   235 	* Know-How: Name with dashes in between
       
   236 d46 5
       
   237 a50 5
       
   238 	* To write a custom *link label*, use bracket notation: =[<nop>[TWikiAccessControl][access control]]= - this becomes: [[TWikiAccessControl][access control]]
       
   239 	* To link to a topic in *another web*, write: =Sandbox.WebSearch= - this becomes: Sandbox.WebSearch
       
   240 	* To show the web name in the link use bracket notation: =[<nop>[Sandbox.%HOMETOPIC%]]= - this becomes: [[Sandbox.%HOMETOPIC%]]
       
   241 	* To link to a topic on *another Wiki site*, use: =TWiki:Main/WebHome= - this becomes: TWiki:Main/WebHome (sites are defined in the InterwikiPlugin)
       
   242 	* 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): =[<nop>[#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.
       
   243 d53 10
       
   244 a62 10
       
   245 	* Insert !WikiWords wherever you can. Rich linking helps to make a Wiki successful.
       
   246 	* 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.
       
   247 	* To stop a !WikiWord from being turned into a hyperlink, insert an exclamation point immediately before the !WikiWord. For example, write =!<nop>SunOS= to get !SunOS.
       
   248 	* Create topics with singular names. Plural <nop>WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord.
       
   249 	* Sometimes you have to be creative to find a good <nop>WikiName. Examples:
       
   250 		* To create a topic about the the *Bread Slicer 1.2* product, use =BreadSlicer1dot2= or =BreadSlicer1pt2=, but not =BreadSlicer1.2=.
       
   251 		* To create a topic about *year 2000*, you could go for =YearTwoK= or =YearTwoThousand=, but not =Year2K= or =Y2K= or =Y2000=.
       
   252 	* Turn acronyms into !WikiWords, i.e. take =FaqIndex= for a "FAQ index" topic.
       
   253 	* 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.
       
   254 	* %X% When linking to a <nop>%HOMETOPIC% topic _in another web_, the link will be rendered as the name of the web, e.g. =Sandbox.%HOMETOPIC%= becomes Sandbox.%HOMETOPIC%.
       
   255 @
       
   256 
       
   257 
       
   258 1.4
       
   259 log
       
   260 @none
       
   261 @
       
   262 text
       
   263 @d1 64
       
   264 a64 47
       
   265 %META:TOPICINFO{author="PeterThoeny" date="1042881752" format="1.0" version="1.4"}%
       
   266 A <nop>WikiWord consists of two or more words with initial capitals, run together.
       
   267 
       
   268 When you type a <nop>WikiWord, you establish a hyperlink. It's as easy as that.
       
   269 
       
   270 <nop>WikiWords are styled like this because:
       
   271 
       
   272 	* It makes Wiki hyperlinks instantly recognizable
       
   273 	* It leads to interesting Wiki topics
       
   274 	* It avoids the need to fiddle with HTML tags
       
   275 	* It avoids over-general topics because at least two words are required
       
   276 
       
   277 *Syntax of a <nop>WikiWord*
       
   278 
       
   279 	* Uppercase letter(s)
       
   280 	* Lowercase letter(s)
       
   281 	* Uppercase letter(s)
       
   282 	* Optional lowercase or uppercase letter(s) or number(s)
       
   283 
       
   284 *Good examples for <nop>WikiWords:*
       
   285 
       
   286 	* WikiWord
       
   287 	* GoodStyle
       
   288 	* AVeryLongWikiTopicNameIsAlsoPossible: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed
       
   289 	* YearTwoThousand
       
   290 
       
   291 *Bad examples for <nop>WikiWords:*
       
   292 
       
   293 	* Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence
       
   294 	* T5Wiki: Name with number before the uppercase, lowercase, uppercase sequence
       
   295 	* Md5sumsAfterBurning: Name with number before the uppercase, lowercase, uppercase sequence
       
   296 	* Know-How: Name with dashes in between
       
   297 
       
   298 *Hints*
       
   299 
       
   300 	* Insert <nop>WikiWords wherever you can. Rich linking helps to make a Wiki successful.
       
   301 	* 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.
       
   302 	* %H% To stop a <nop>WikiWord from being turned into a hyperlink, insert the text =&lt;nop&gt;= immediately before the <nop>WikiWord.
       
   303 	* It is recommended to create topics with singular names. Plural <nop>WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord.
       
   304 	* Sometimes you have to be creative to find a good <nop>WikiName. Examples:
       
   305 		* To create a topic about the the *Bread Slicer 1.2* product, use =BreadSlicer1dot2= or =BreadSlicer1pt2=, but not =BreadSlicer1.2=.
       
   306 		* To create a topic about *year 2000*, you could go for =YearTwoK= or =YearTwoThousand=, but not =Year2K= or =Y2K= or =Y2000=.
       
   307 	* Turn acronyms into <nop>WikiWords, i.e. take =FaqIndex= for a "FAQ index" topic.
       
   308 	* You can specify any link label by using double square brackets, e.g. write =[<nop>[TWikiAccessControl][access control]]= to get a link to TWikiAccessControl that looks like [[TWikiAccessControl][access control]].
       
   309 	* %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.
       
   310 
       
   311 __Related Topics:__ WikiSyntax, TextFormattingRules
       
   312 @
       
   313 
       
   314 
       
   315 1.3
       
   316 log
       
   317 @none
       
   318 @
       
   319 text
       
   320 @d1 1
       
   321 a1 1
       
   322 %META:TOPICINFO{author="PeterThoeny" date="1021155373" format="1.0" version="1.3"}%
       
   323 d24 1
       
   324 a24 1
       
   325 	* AVeryLongWikiTopicNameIsAlsoPossible
       
   326 d29 3
       
   327 a31 2
       
   328 	* Web: Name with no uppercase letter in between
       
   329 	* T5Wiki: Name with number before the first lowercase letter
       
   330 d38 2
       
   331 a39 2
       
   332 	* To stop a <nop>WikiWord from being turned into a hyperlink, insert the text =&lt;nop&gt;= immediately before the <nop>WikiWord.
       
   333 	* A topic is usually presented in the singular. Plural <nop>WikiWords are automatically linked to the singular topic, i.e. the link WikiWords links to the topic WikiWord.
       
   334 d45 1
       
   335 @
       
   336 
       
   337 
       
   338 1.2
       
   339 log
       
   340 @none
       
   341 @
       
   342 text
       
   343 @d1 1
       
   344 d36 1
       
   345 d43 1
       
   346 a43 1
       
   347 	* You can create nicer looking links by using double square brackets, i.e. write =[<nop>[TWiki access control]]= to get a link to TWikiAccessControl that looks like [[TWiki access control]].
       
   348 @
       
   349 
       
   350 
       
   351 1.1
       
   352 log
       
   353 @none
       
   354 @
       
   355 text
       
   356 @d10 1
       
   357 a10 1
       
   358 	* It avoids over-general topics, because at least two words are required
       
   359 d24 1
       
   360 a24 1
       
   361 	* ProblemY2K
       
   362 d37 7
       
   363 a43 2
       
   364 	* Sometimes you have to be creative to find a good <nop>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.
       
   365 	* Turn acronyms into <nop>WikiWords, i.e. take FaqIndex for a "FAQ index" topic.
       
   366 @