(r2) WikiWord < TWiki

Tags: view all tags

A <nop>WikiWord consists of two or more words with initial capitals, run together.

When you type a <nop>WikiWord, you establish a hyperlink. It's as easy as that.

<nop>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 <nop>WikiWord*

	* Uppercase letter(s)
	* Lowercase letter(s)
	* Uppercase letter(s)
	* Optional lowercase or uppercase letter(s) or number(s)

*Good examples for <nop>WikiWords:*

	* WikiWord
	* GoodStyle
	* AVeryLongWikiTopicNameIsAlsoPossible
	* YearTwoThousand

*Bad examples for <nop>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 <nop>WikiWords wherever you can. Rich linking helps to make a Wiki successful.
	* To stop a <nop>WikiWord from being turned into a hyperlink, insert the text =&lt;nop&gt;= immediately before the <nop>WikiWord.
	* A topic is usually presented in the singular. Plural <nop>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 <nop>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 <nop>WikiWords, i.e. take =FaqIndex= for a "FAQ index" topic.
	* You can create nicer looking links by using double square brackets, i.e. write =[<nop>[TWiki access control]]= to get a link to TWikiAccessControl that looks like [[TWiki access control]].

__Related Topics:__ WikiSyntax, TextFormattingRules

Topic revision: r2 - 2001-01-30 - PeterThoeny

Account
- Log In
- Register User

~~Edit~~
~~Attach~~

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.WikiWord.