Difference between revisions of "Manual of Style"

From TTWiki
Jump to navigationJump to search
m (8 revisions)
(Add basic guide for updating TTDPatch pages)
Line 1: Line 1:
 
Welcome to the TT-Wiki '''Manual of Style'''. Here you can learn what style to use when editing articles.
 
Welcome to the TT-Wiki '''Manual of Style'''. Here you can learn what style to use when editing articles.
  +
  +
==Updating pages from TTDPatch Wiki==
  +
  +
Pages imported from the TTDPatch Wiki will often be in bad shape. In tidying them up, we recommend the following actions be taken:
  +
  +
* Remove the "strapline" (typically the first line) which was used in TikiWiki for a page description. This is generally redundant.
  +
* Remove the page header. Again, this is redundant.
  +
* Replace any instances of " " or """ with normal spaces and quotes, unless required for formatting reasons.
  +
* Migrate wikicode.
  +
* Add categories (typically, add all pages to the TTDPatch category, and add a general category for each section (e.g., Introduction, Usage, Patches, etc)
  +
* Fix links - TikiWiki would automatically wikify CamelCase links. We have to explicitly create links.
  +
  +
In the future, the intention will also be to mass rename pages to remove the ugly CamelCase. It'll be easier to do it all at once and send a bot to go and rename all the links, though, rather than trying to do it manually.
  +
  +
For more complex pages, you may wish to use [http://devs.openttd.org/~planetmaker/patches/fixwiki.sh this script] with [http://devs.openttd.org/~planetmaker/patches/wikised this data file] to try to tidy up the page first.
  +
  +
Always compare the page against the original page on the [http://wiki.ttdpatch.net/ old wiki[/url] to ensure all content is transferred. Pictures will need to be re-uploaded.

Revision as of 12:24, 13 June 2011

Welcome to the TT-Wiki Manual of Style. Here you can learn what style to use when editing articles.

Updating pages from TTDPatch Wiki

Pages imported from the TTDPatch Wiki will often be in bad shape. In tidying them up, we recommend the following actions be taken:

  • Remove the "strapline" (typically the first line) which was used in TikiWiki for a page description. This is generally redundant.
  • Remove the page header. Again, this is redundant.
  • Replace any instances of " " or """ with normal spaces and quotes, unless required for formatting reasons.
  • Migrate wikicode.
  • Add categories (typically, add all pages to the TTDPatch category, and add a general category for each section (e.g., Introduction, Usage, Patches, etc)
  • Fix links - TikiWiki would automatically wikify CamelCase links. We have to explicitly create links.

In the future, the intention will also be to mass rename pages to remove the ugly CamelCase. It'll be easier to do it all at once and send a bot to go and rename all the links, though, rather than trying to do it manually.

For more complex pages, you may wish to use this script with this data file to try to tidy up the page first.

Always compare the page against the original page on the old wiki[/url to ensure all content is transferred. Pictures will need to be re-uploaded.