Table of Contents
Wiki writer guidelines
Main rules
- Do not try to optimize the layout for your current web browser.
- A page starts always with a H1 title followed by H2 paragraphs.
This is very important for future processing like offline Wiki versions! - Do not try to communicate with the Wiki reader! Avoid using the 'you' word!
Page header example
====== (H1)Page Title ======
[[:english#SECTION|{{ :SECTION.png}}]][[:english|{{ :rocrail-logo-35.png}}]]
[[:english|Content]] -> [[:english#SECTION|SECTION]] -> **SUBSECTION**
\\
//Optional small introduction about this page.//
\\
===== (H2)Paragraph 1 =====
Text...
\\
===== (H2)Paragraph n =====
Text...
Replace SECTION and SUBSECTION appropriated.
Screen shots & Photos
- Down scale screen shots to 75% before uploading.
- Down scale photos to 800 pixels if they are larger then 800 pixels in width or in height before uploading.
External Documents
Avoid writing documentation int PDF or other external formats: Write it in the Wiki so everybody can read it and change it at once.
external documents are only snapshots and are mot likely very fast out of sync.
Trace: » mgv105-en » operator-loco-en » writer-guidelines



