(file) Return to WikiWord.txt CVS log (file) (dir) Up to [RizwankCVS] / geekymedia_web / twiki / data / TWiki

 1 rizwank 1.1 %META:TOPICINFO{author="PeterThoeny" date="1042881752" format="1.0" version="1.4"}%
 2             A <nop>WikiWord consists of two or more words with initial capitals, run together.
 3             
 4             When you type a <nop>WikiWord, you establish a hyperlink. It's as easy as that.
 5             
 6             <nop>WikiWords are styled like this because:
 7             
 8             	* It makes Wiki hyperlinks instantly recognizable
 9             	* It leads to interesting Wiki topics
10             	* It avoids the need to fiddle with HTML tags
11             	* It avoids over-general topics because at least two words are required
12             
13             *Syntax of a <nop>WikiWord*
14             
15             	* Uppercase letter(s)
16             	* Lowercase letter(s)
17             	* Uppercase letter(s)
18             	* Optional lowercase or uppercase letter(s) or number(s)
19             
20             *Good examples for <nop>WikiWords:*
21             
22 rizwank 1.1 	* WikiWord
23             	* GoodStyle
24             	* AVeryLongWikiTopicNameIsAlsoPossible: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed
25             	* YearTwoThousand
26             
27             *Bad examples for <nop>WikiWords:*
28             
29             	* Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence
30             	* T5Wiki: Name with number before the uppercase, lowercase, uppercase sequence
31             	* Md5sumsAfterBurning: Name with number before the uppercase, lowercase, uppercase sequence
32             	* Know-How: Name with dashes in between
33             
34             *Hints*
35             
36             	* Insert <nop>WikiWords wherever you can. Rich linking helps to make a Wiki successful.
37             	* 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.
38             	* %H% To stop a <nop>WikiWord from being turned into a hyperlink, insert the text =&lt;nop&gt;= immediately before the <nop>WikiWord.
39             	* 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.
40             	* Sometimes you have to be creative to find a good <nop>WikiName. Examples:
41             		* To create a topic about the the *Bread Slicer 1.2* product, use =BreadSlicer1dot2= or =BreadSlicer1pt2=, but not =BreadSlicer1.2=.
42             		* To create a topic about *year 2000*, you could go for =YearTwoK= or =YearTwoThousand=, but not =Year2K= or =Y2K= or =Y2000=.
43 rizwank 1.1 	* Turn acronyms into <nop>WikiWords, i.e. take =FaqIndex= for a "FAQ index" topic.
44             	* 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]].
45             	* %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.
46             
47             __Related Topics:__ WikiSyntax, TextFormattingRules

Rizwan Kassim
Powered by
ViewCVS 0.9.2