// recovered archive

pgmfi.org wiki

honda / acura ecu development · TWiki library capture · forum archive →

Wiki Word

Library.WikiWord · r1.1 · · guest

A Wiki Word consists of two or more words with initial capitals, run together.

When you type a Wiki Word, you establish a hyperlink. It's as easy as that.

Wiki Words 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 Wiki Word

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

Good examples for Wiki Words:

  • Wiki Word
  • Good Style
  • 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
  • Year Two Thousand?

Bad examples for Wiki Words:

  • 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
  • Know-How: Name with dashes in between

Hints

Insert Wiki Words wherever you can. Rich linking helps to make a Wiki successful. Be specific. All topics in a web share one name space. For example, instead of Functional Spec write Bread Slicer Functional Spec because other projects might also have a functional spec topic.

  • Sometimes you have to be creative to find a good Wiki Name. Examples:
  • *To create a topic about the the Bread Slicer 1.2 product, use Bread Slicer1dot2 or Bread Slicer1pt2, but not Bread Slicer1.2.
  • *To create a topic about year 2000, you could go for Year Two K or Year Two Thousand, but not Year2K or Y2K or Y2000.
  • Turn acronyms into Wiki Words, i.e. take Faq Index for a "FAQ index" topic.
  • You can specify any link label by using square brackets and a vertical bar, e.g. write !:home page to get a link to Home Page that looks like home page.
  • The topic is assumed to be in the current Wiki web. Prepending the name of a Wiki web and a period links to a topic in another web.