writer-guidelines
Differences
This shows you the differences between two versions of the page.
Previous revision | |||
— | writer-guidelines [2020/11/22 04:21] (current) – [Sections] rainerk | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Wiki writer guidelines ====== | ||
+ | [[: | ||
+ | \\ | ||
+ | \\ | ||
+ | ===== Main rules ===== | ||
+ | - The English translation is leading. | ||
+ | - If pages are added in an other translation then those new pages should be added in the English translation too. | ||
+ | - Updating a translation other then English should update the English page too if necessary. | ||
+ | - 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 **' | ||
+ | |||
+ | \\ | ||
+ | |||
+ | ===== Page header example ===== | ||
+ | |||
+ | < | ||
+ | ====== (H1)Page Title ====== | ||
+ | [[: | ||
+ | [[: | ||
+ | |||
+ | \\ | ||
+ | //Optional small introduction about this page.// | ||
+ | |||
+ | \\ | ||
+ | ===== (H2)Paragraph 1 ===== | ||
+ | Text... | ||
+ | |||
+ | \\ | ||
+ | ===== (H2)Paragraph n ===== | ||
+ | Text... | ||
+ | |||
+ | </ | ||
+ | Replace **'' | ||
+ | |||
+ | |||
+ | \\ | ||
+ | ===== 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. | ||
+ | Photos are shown in tables next to each other, they should be formatted to a uniform height if possible: | ||
+ | < | ||
+ | {{...? | ||
+ | {{...? | ||
+ | </ | ||
+ | |||
+ | \\ | ||
+ | ===== External Documents===== | ||
+ | Avoid writing documentation in 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 most likely very fast out of date.\\ | ||
+ | |||
+ | |||
+ | \\ | ||
+ | |||
+ | =====Page file names===== | ||
+ | Rocview uses for help Wiki links, and depends on the selected language. (If available.)\\ | ||
+ | Translations must follow the page filename scheme of the English part of the Wiki. Any other scheme will break the help for this translation.\\ | ||
+ | | Wiki file name || | ||
+ | ^ Rocview reference ^ Suffixes ^ | ||
+ | | object-tab | -en, -de, -it, -nl((The NL Wiki does not follow the English scheme and will have many broken links.)) | | ||
+ | Its important not to change the file name of the page if translating for a specific language; | ||
+ | :!: Do not use underscores in file names.\\ | ||
+ | \\ | ||
+ | __**[[: | ||
+ | |||
+ | |||
+ | ====Sections==== | ||
+ | Mostly the section header names are for each language different.\\ | ||
+ | To use section links the header must be prefixed with the following HTML: | ||
+ | <code html> | ||
+ | < | ||
+ | =====Ereignisse===== | ||
+ | </ | ||
+ | The **name** attribute must contain the English section header name in lower case and without blanks: "Port setup" -> " | ||
+ | A help link like " | ||
+ | |||
+ | * **Note:** HTML jump labels can also be used if positions are to be linked that are not marked with the headings '' | ||
+ | |||
+ | |||