wiki/doc/omawiki-style-guide.md

title	description	published	date	tags	editor	dateCreated
OpenMandriva wiki specific style guide		true	2020-12-21T23:52:16.864Z		undefined	2020-03-13T11:27:11.684Z

OpenMandriva wiki specific style guide

Read first general wiki style guide {.is-danger}

OpenMandriva wiki specific rules

This page is a work in progress, it will be updated over time as soon as I find any reason to add more hints. {.is-info}

Images

Screenshots and common images which are inserted in wiki pages must be uploaded only to /images folder. It is what the folder has been created for.

Images file name should not contain:

• Space (use dashes instead)
• Underscore (use dashes instead)
• Period (reserved for file extensions)
• Unsafe URL characters (such as punctuation marks, quotes, math symbols, etc.)

When at all possible, rename your image filename to something meaningful related to the page or to what you are showing.

Paths

Paths must be lowercase. Use dashes to separate the words. No punctuation allowed except dashes/hyphens and/or underscores. -- Note: even if technically permitted, OpenMandriva wiki standard is to use dashes instead of underscores. No need for full title of the page in the path: it can, and should when possible, be shortened.

Paths cannot contain the following characters:

• Space (use dashes instead)
• Period (reserved for file extensions)
• Unsafe URL characters (such as punctuation marks, quotes, math symbols, etc.)

As we often have to write release version number (4.0, 4.1, 4.2, etc.), while creating new pages just convert it into 40, 41, 42, etc. by omitting the dot in the path.

If the page is called "How to foo bar whatever" the path must be /doc/guides/howto-something No how-to, no howtos, no how-tos, etc.

Translation workflow

For the best organization, keep the original English path unchanged, just change the language code prefix. So en/home will become fr/home, it/home, etc. As another example /en/doc/guides/howto-list-packages-iso will become /it/doc/guides/howto-list-packages-iso and your translated page title (which is quite another thing from path) will be "Come ottenere una lista di tutti i pacchetti presenti nella ISO" Keep in mind that the path is a convention, the page title can be whatever in own language. The above action however is simplified and automatically performed by clicking the Language icon on top right of the page.

-