Gentoo-wiki nedávno přišla o svou databázi; toto je od základu přepsaná stránka. Jak můžete pomoci se dozvíte na Hlavní stránce.
(Editace je v současné době omezena, připojte se prosím na online chat, pokud chcete práva powereditora)
Gentoo Linux Wiki:Příručka stylu
Z Gentoo Linux Wiki
Obsah: Oficiální dokumenty
- Nápověda
- FAQ
- Editace
- Příručka stylu
- Příručka pro editaci Mediawiki
- Zásady pojmenování
- Wikifikace
- Web
- Ostatní
Články v Gentoo Wiki jsou primárně návody ("howto") obsahující instrukce pro instalaci, konfiguraci a užívání softwaru a hardwaru.
Obsah |
Použitý jazyk
Pro editaci Gentoo Wiki používejte jednoduchou češtinu pokud možno nezatíženou technickými výrazy. Jestliže používáte technické výrazy, tak je nutné je dostatečně definovat (odkazem na příslušné stránky nebo články).
Články by měly být napsané ve třetí osobě. Nikdy nereferujte o sobě a nepoužívejte ICH formu. Namísto toho referujte ke čtenáři Wiki ve druhé osobě (nainstalujte, zkompilujte, ...).
Styl stránek
Vzhled článků by měl být jednoduchý se zvýrazněním v místech, kde je to potřeba. Cílem této Wiki je poskytovat instrukce, nikoliv vypadat hezky. Neměly by se používat obrázky jen na ozdobu článku.
Formátování
Články by měly obsahovat následující části v uvedeném pořadí.
- Začněte shrnutím obsahu článku.
- Udejte podrobnosti o cílech článku a o předpokladech (jak softwarových, tak znalostních). Bylo by také dobré zmínit příbuzná témata, která článek nepokrývá a zmínit, kde se o nich dozvědět více.
- Proveďte uživatele procesem krok za krokem, vysvětlete význam jednotlivých příkazů, zejména tam, kde to není úplně jasné.
- Tam, kde je to vhodné, uveďte část pro řešení problémů - tato část by měla obsahovat obvyklé problémy a chyby, na které může uživatel narazit, a také popis jejich řešení.
- Uveďte všechny odkazy na příbuzné články, i kdyby na ně bylo již odkazováno uvnitř samotného článku. Seznam může obsahovat i odkazy na jiné stránky.
- Ujistěte se, že používáte příslušné šablony.
Hardwarové články
Hardwarové články by navíc měly obsahovat:
- Kde je to vhodné uveďte výstup lspci -nn nebo lsusb vztahující se k zařízení.
- Další názvy pod kterými je hardware známý. Neuvádějte však výčet všech zařízení (např. notebooky, bezdrátová zařízení) ve kterých můžete hardware (např. zvukovou kartu nebo wireless chipset) najít.
Diskuze
Veškerá diskuze probíhá na diskuzní stránce článku, nikoliv v článku samotném.
Nadpisy
Pro nadpisy se používá standardní Mediawiki konvence a začínají == (ne =).
Kategorie
Kategorie ([[Category:Foo]]) by měly být umístěny na konci článku. Každý článek by měl být alespoň v jedné kategorii.
