TWiki/WikiWord.mdwn

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