Usage

WikiWords are used to link between related subjects/ words
so a reader can look up subjects he/ she is not familiar with.

One should try to make as many links as it makes sense
so one exhaustes the possibilities of the Wiki/ Internet technology.

But putting too many links up means that you create obstacles
that make your text harder to read.

Syntax

1. UPPERCASE character,
2. lowercase character(s),
3. UPPERCASE character,
4. lowercase character(s)/ number(s)

Only characters contained in [a-zA-Z] are allowed.

Prevention

To prevent creating a link write text <nop> before a potential WikiWord

Examples

Wiki Word,
Good Style

• AVery Long Wiki Topic Name Is Also Possible?

• AVery Long Wiki Topic Name Is Also Possible?: wherever an uppercase or lowercase letter is allowed, a group of letters of the same case is allowed

• Web: Name with no uppercase letter in between
• T5Wiki: Name with number before the first lowercase letter

• Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence
• T5Wiki: Name with number before the uppercase, lowercase, uppercase sequence
• Md5sumsAfterBurning: Name with number before the uppercase, lowercase, uppercase sequence

• 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 Wiki Words links to the topic Wiki Word.

• To stop a WikiWord from being turned into a hyperlink, insert the text <nop> immediately before the WikiWord.
• It is recommended to create topics with singular names. Plural WikiWords are automatically linked to the singular topic, i.e. the link Wiki Words links to the topic Wiki Word.

• 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.

• 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.

• You can create nicer looking links by using double square brackets, i.e. write [[TWiki access control]] to get a link to TWiki Access Control that looks like TWiki access control.

• You can specify any link label by using double square brackets, e.g. write [[TWikiAccessControl][access control]] to get a link to TWiki Access Control that looks like access control.

• It avoids over-general topics, because at least two words are required

• It avoids over-general topics because at least two words are required

• Problem Y 2 K?

• Year Two Thousand?

• 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 Fix Y 2 K? or Year Two K? or Year Two Thousand?, but not Year2K or Y2K or Y2000.
• Turn acronyms into WikiWords, i.e. take Faq Index? 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 TWiki Access Control that looks like TWiki access control.

Related Topics: Wiki Syntax, Text Formatting Rules

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:

• Wiki Word
• Good Style
• AVery Long Wiki Topic Name Is Also Possible?
• Problem Y 2 K?

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 Wiki Words links to the topic Wiki Word.
• 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 Fix Y 2 K? or Year Two K? or Year Two Thousand?, but not Year2K or Y2K or Y2000.
• Turn acronyms into WikiWords, i.e. take Faq Index? for a "FAQ index" topic.