Personal tools

HaskellWiki:Guidelines

From HaskellWiki

Revision as of 18:45, 21 February 2006 by Wolfgang Jeltsch (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Currently, there are no “official” guidelines for this wiki.

What follows are some guidelines for page titles which were developed by Wolfgang Jeltsch. Currently, the page titles on this wiki adhere more or less to these guidelines.

Unofficial guidelines for page titles

  1. Page titles not only affect a page's URL but they are also shown at the top of the page. Therefore, it is important that a page title is a title, not a mnemonic “path name”. I strongly doubt that we need such mnemonic names but if they are introduced they should denote only redirects to the actual page.
  2. On the other hand, it is good if titles are not unnecessarily long so that URLs have reasonable size. Especially, redundant occurences of the word “Haskell” in titles should be avoided. If a page on HaskellWiki is just named “Compilers and interpreters”, it should be clear that it refers to “Haskell compilers and interpreters”, so the extra “Haskell” is not needed.
  3. Titles should use sentence-style capitalization (see [1]). Capitalizing more words seems to be only appropriate in larger documents like books. If slashes are used to denote hierarchy, each part of the hierarchical title should be handled as if it were a title itself, i.e., its first word should be capitalized.