Documentation Writer Guide

Contents 1 Jajuk Manual 1.1 General Rules 1.2 Rules for non English manual 1.3 HTML manual creation 2 See also

Jajuk Manual

The following describe the rules to use to write/maintain the Jajuk Manuals.

All documentation has to be done from the wiki (HTML files found in trunk are generated from the wiki and should not be edited)

Note that mediawiki is not designed to support different languages on the same wiki but is actually design to support interconnect of single wikis, each written in one different language. To make it simple Jajuk Team decided to use only one wiki for all languages but this is having some limitation and therefore making it important to use the following rules.

General Rules

• The English Manual is seen as the reference manual
• The title of the page should be self explicit
• The title of the page should be at least two words
• The title of the page should not contain accents (regex: [aA-zZ]). It is strongly encouraged to use only lowercase (regex: [a-z]) to make sure that internal links will be in lowercase only
• Internal links must be in lowercase (regex: [a-z])
• Internal links must have the same name to what there are linking to. No [[one_link | another_place]]
• New pages must be referenced into trunk/jajuk/src/doc/jajuk-hs/default/jajukToc.xml and and Map.jhm (if you don't have commit rights, please contact a developer)
• Each page of the manual should be tag at the bottom of the page using [[Category:language Manual]] (change language by the language the manual is, i.e: English, French)
• All manuals share the same images, hence no text inside images
• Prefer to use icons alone to document an action than more global screenshots to make the documentation task simpler and more resilient to the application changes
• * don't have . at the end of last sentence
• Use bold ''' to highlight most important key word related to this page
• Use italics '' to highlight important key word and key word related to other pages
• In English, you don't have space before a column (:), it is word, column, space, word. (E.g.: word1: word2)
• Use English words before American words (E.g.: use favourite (Commonwealth English) and not favourite (US))
• Refrain from using acronyms and abbreviation
• Don't start word with a capital if they are not the first word of a sentence. Refrain from using caps for keyword
• Use character , and not / do explain different events. E.g: go in menu, view, etc... and not go in menu/view/etc...
• Refrain from using ", prefer the use of '' and '''

Rules for non English manual

• The title of the documentation page must be in the language

HTML manual creation

• Wiki2XML is used to convert from mediawiki to HTML
• The name of the title of the manual page will be converted to lowercase and space to underscore during the HTML conversion.
• Categories are not kept
• Title will be converted to lowercase

See also

• Jajuk Members Guide