Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
View   r2  >  r1  ...
WikiWord 2 - 30 Jan 2001 - Main.PeterThoeny
Line: 7 to 7
 
  • It makes Wiki hyperlinks instantly recognizable
  • It leads to interesting Wiki topics
  • It avoids the need to fiddle with HTML tags
Changed:
<
<
  • It avoids over-general topics, because at least two words are required
>
>
  • It avoids over-general topics because at least two words are required
 Syntax of a WikiWord
Line: 21 to 21
 
Changed:
<
<
  • ProblemY2K?
>
>
  • YearTwoThousand?
 Bad examples for WikiWords:
Line: 34 to 34
 
  • Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful.
  • 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.
Changed:
<
<
  • 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.
>
>
  • 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 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.

Related Topics: WikiSyntax, TextFormattingRules


WikiWord 1 - 01 Jul 2000 - Main.PeterThoeny
Line: 1 to 1
Added:
>
>
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:

Bad examples for WikiWords:

  • Web: Name with no uppercase letter in between
  • T5Wiki? : Name with number before the first lowercase letter
  • Know-How: Name with dashes in between

Hints

  • Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful.
  • 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.
  • 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.

Revision 2r2 - 30 Jan 2001 - 23:51:33 - PeterThoeny?
Revision 1r1 - 01 Jul 2000 - 05:05:30 - PeterThoeny?
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM