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]]
  24 - [[ProblemY2K]]
  25
  26 **Bad examples for WikiWords:**
  27
  28 - Web: Name with no uppercase letter in between
  29 - [[T5Wiki]]: Name with number before the first lowercase letter
  30 - Know-How: Name with dashes in between
  31
  32 **Hints**
  33
  34 - Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful.
  35 - To stop a WikiWord from being turned into a hyperlink, insert the text `<nop>` immediately before the WikiWord.
  36 - 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]].
  37 - 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.
  38 - Turn acronyms into WikiWords, i.e. take [[FaqIndex]] for a "FAQ index" topic.