docs: update doc/omawiki-style-guide
This commit is contained in:
parent
2f9e24a5b8
commit
51ebd249b1
|
@ -2,7 +2,7 @@
|
||||||
title: OpenMandriva wiki specific style guide
|
title: OpenMandriva wiki specific style guide
|
||||||
description:
|
description:
|
||||||
published: true
|
published: true
|
||||||
date: 2020-03-13T11:27:43.318Z
|
date: 2020-03-13T11:56:40.455Z
|
||||||
tags: howto
|
tags: howto
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -16,3 +16,30 @@ tags: howto
|
||||||
{.is-info}
|
{.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 dashed to separate the words.
|
||||||
|
No punctuation allowed except dashes/hyphens and/or 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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue