SDB:Howto
Obsah
Účel
Tento SDB (support database) článek obsahuje informace, jak psát SDB články.
Postup
SDB články jsou určeny k tomu, aby ostatní uživatelé získali informace o řešení problémů v systému SUSE Linux nebo podrobnější informace o určitých tématech. Jestliže jste v SUSE Linuxu narazili na problém, se kterým si nevíte rady, měla by SDB být prvním místem, kde budete hledat řešení.
SDB by měl obsahovat následující části:
- Popis problému
- Řešení popsaného problému
- Odkazy
nebo
- Symptom
- Příčinu
- Řešení
- Odkazy
Pokud je to jen trochu možné, snažte se, aby články obsahovaly to nejsnadnější řešení určitého problému. Někdy je ovšem užitečné poskytnout návod i pro nejrychlejší řešení. Pokud má určitý problém více způsobů řešení, rozdělte je do jednotlivých částí. Než se vrhneme na syntaxy, ukážeme si příklad SDB článku (pokud chcete vidět výsledný článek, otevřete si en:SDB:Changing NTP Server - SDB Example.)
Příklad článku
<!-- SDB information SDB:title: Changing NTP Server - SDB Example SDB:author: mlasars SDB:date: 2005-10-17 --> Version: 9.0 [[Category:SDB:Network|N]] [[Category:SDB:9.0|N]] Tento článek je příkladem SDB článku. == Situation == You set the clock on your computer using ntp, but the server you are using is no longer working. == Procedure == This article describes several solutions: === with YaST2 === Start YaST2, select "Network Services" and start the module "NTP Client". In "Select" choose "public server". Choose your country from the list, or one that is closest to you, and in the second panel choose a different server. Then click "Test", and if the test was successful, "Ok". Complete the configuration with "Finish". === on the command line === Open the file <code>/etc/sysconfig/ntp</code> and change the variable <code>NTPD_INITIAL_NTPDATE=""</code> to the server of your choice. Then restart ntp with rcntpd restart == Links == [[SDB:Time Synchronization Through the Network]] <keyword>ntp,xntp,time,synchronize</keyword> [[en:SDB:ntp_server_change(example)]]
Vytvoření nového článku
Ve svém webovém prohlížeči zadejte adresu cs.opensuse.org/SDB:jmeno_clanku. Pokud článek ještě needituje, klikněte na "upravit" a vložte článek. Nepřepisujte již existující články. Pokuste se pro svůj článek najít jiné jméno. V případě, že článek popisuje stejný problém, ale neobsahuje potřebné informace, po dohodě s původnímu autory je doplňte.
Všechny články musí obsahovat SDB:. To umožňuje je jednoduše odlišit od ostatních částí Wiki.
Pravidla
Historie
Pokud dokončíte článek, zadejte ho také do SDB:Historie. Vložení článku provedete následujícím způsobem:
YYYYMMDD [[SDB:<jmeno_clanku>]]
např.:
20051016 [[SDB:Howto]]
Použijte mezinárodní formát data. Seznam je serazen od nejnovějsího clánku k nejstaršímu, takže nejnovější články jsou hezky nahoře.
Do historie vkládejte i články, které jste změnili. To se netýká oprav, které nemění význam nebo nepřidávají obsah.
Překlady
V současné době openSUSE wiki podporuje mimo angličtiny, němčinu, francouzštinu a španělštinu. Pokud chcete a ovládáte jeden z těchto jazyků, můžete se podílet na překladech. Pokud si nejste jistí, zda dokážete provést překlad kvalitně, napište do konference opensuse-wiki žádost o překlad článku.
Jestliže vkládáte překlad, nezapomeňte připojit "Interwiki" odkazy na konec článku. Pokud jste například přeložili článek z angličtiny do češtiny, vložte do českého článku:
[[en:SDB:<anglicke_jmeno_clanku>]]
A do anglické verze:
[[cs:SDB:<ceske_jmeno_clanku>]]
V současné době jsou podporovány odkazy:
de Němčina en Angličtina fr Francouzština es Španělština
Změna existujícího článku
Migrace SDB do openSUSE Wiki umožňuje všem přihlášeným uživatelům editovat existující články. Pokud chcete změnit již existující článek, je vhodné kontaktovat původní autory. Použijte k tomu odkaz "diskuze" pod článkem.
Tento postup není povinný, ale usnadní všem práci s Wiki. Pokud se s původními autory nedokážete dohodnout na změně, můžete se obrátit na konferenci opensuse-wiki a požádat o názor ostatní uživatele.
Drobné změny a opravy překlepů není nutné konzultovat.
SDB značky
Obsah
Pokud se v článku vyskytují více než tři části označené === Část ===, wiki automaticky generuje obsah. To znamená, že pokud vytvoříte standardní SDB článek, vytvoří se obsah automaticky.
SDB meta informace
Meta informace vkládejte na začátek nového článku. Tyto informace nebudou zobrazeny.
<!-- SDB information SDB:title: Changing NTP Servers - SDB Example SDB:author: mlasars SDB:date: 2005-10-17 -->
V případě, že v článku provedete větší změny, přidejte své jméno do řádky author. Žádné další údaje, především SDB:date nemažte nebo needitujte. Všechny změny se zobrazí v Historii článku. Meta informace jsou v článcích kvůli snadnější manipulaci s články v budoucnosti.
Verze
Na začátku každého článku také zadejte verzi SUSE Linuxu, o které článek pojednává. Zápis můžete zadat různými způsoby:
Version: 8.0 Version: - 8.0 Version: 8.0 - Version: 8.0 - 8.1
Pokud je SDB článek určen pro všechny verze, jednoduše značku pro verzi nepoužívejte.
V případě, že jde o problém specifický pro určitou architekturu, zadejte ji následujícím způsobem:
Version: 9.2 x86_64 Version: 9.1 DVD Version: 10.0 ppc
SUSE Linux podporuje následující architektury: i386, x86_64 (64bit, AMD64 a Intel EM64T) a ppc (PowerPC (Mac)).
Upřesnit můžete i verzi SUSE Linuxu: Box (prodejní verze), FTP, CD, DVD and OSS.
Značky pro verze používejte pouze v případě, že je to nutné.
Poznámka: Za dvojtečkou vždy udělejte před zadáním verze mezeru.
Kategorie
Každý SDB článek by měl být dostupný přes kategorie. Seznam kategorií najdete na en:Category:SDB. Kategorie zadávejte opět na začátek článku následujícím způsobem:
[[Category:SDB:8.0|C]] [[Category:SDB:Network|C]]
Kategorie je ukončena svislou čárou a prvním písmenem názvu článku. Vzorový článek "Changing NTP Servers", začíná na "C", proto je použito v příkladu C.
Klíčová slova
Na konec článku zadejte klíčová slova, která se budou používat při vyhledávání. Klíčová slova zadejte následujícím způsobem:
<keyword>ntp,time,xntp,synchronize</keyword>
Klíčové slovo může být libovolné.
Syntaxe
Mimo Wiki syntaxe, MediaWiki podporuje také plain HTML značky. Přesto se snažte upřednostňovat Wiki syntaxi, protože je pak snadnější vaše články číst i editovat. nejdůležitější pravidla jsou uvedena níže. Podrobnosti najdete v http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page.
Sekce
- Level 1: == 1. úroveň == (pro postupy, odkazy)
- Level 2: === 2. úroveň === (např. pro YaST2, příkazovou řádku)
- Level 3: ==== one level below ==== (další podsekce, např. rozdílné verze)
Hlavní doporučené části jako Popis problému nebo Řešení by vždy měly mít první úroveň.
Formátování
Odstavce ve wiki nemají zvláštní značku <p>paragraph</p> jako v HTML, ale vytvářejí se automaticky, když text oddělíte prázdnou řádkou.
| Wiki zápis | Zobrazení |
Toto je první odstavec. Toto je druhý odstavec. |
Toto je první odstavec.
|
Text (tučně, kurziva,kód)
K zvýraznění textu použijte následující značky:
| Styl | Wiki zápis | Zobrazení |
| tučně | '''Používejte pouze pro důležité odstavce nebo slova.''' | Používejte pouze pro důležité odstavce nebo slova. |
| kurziva | ''Toto je kurziva'' | Toto je kurziva |
| kód | Pro příkazy použijte: <code>rcapache2</code> | Pro příkazy použijte: rcapache2
|
Seznamy a výčty
Příklady seznamů a výčtů:
| Wiki zápis | Zobrazení |
* Planety ** Mars ** Země *** Měsíc |
|
#Cestování ## Letadlem ## Autem ### Taxi |
|
Pro odkazy na konci článku použijte * Link bez dalších značek.
Příkazy a části kódu a konfiguračních souborů
Řádky obsahující jednoduchý příkaz začněte mezerou:
rcapache2 restart
U příkazů v textu použijte HTML značky <code>command</code>.
Pro výpisu kódu použijte značky:
| Wiki zápis | Zobrazení |
<pre> ## Path: Network/Remote access/SSH ## Description: SSH server settings ## Type: string ## Default: "" ## ServiceRestart: sshd # # Options for sshd # SSHD_OPTS="" <nowiki></nowiki> </pre> |
## Path: Network/Remote access/SSH ## Description: SSH server settings ## Type: string ## Default: "" ## ServiceRestart: sshd # # Options for sshd # SSHD_OPTS="" |
nowiki
V některých případech se hodí vypnout wiki formátování. K tomu se použije:
| Wiki zápis | Zobrazení | Without nowiki |
|
<nowiki>no '''Bold''', no ''Italic''</nowiki> |
no '''Bold''', no ''Italic'' |
no Bold, no Italic |
Odkazy
Odkazy na jiné SDB články začínající na SDB: [[SDB:howto]]. Můžete zadat také přímý odkaz na určitou část ve formátu [[SDB:howto#Stil]], což se zobrazí jako SDB:howto#Stil. Nebo můžete zadat [[SDB:howto#Stil|Stil]] a zobrazí se Stil.
U externích odkazů je vhodné použít náhrdaní řetězec, aby se zmenšila zobrazená dálka.
[http://www.suse.cz SUSE] se zobrazí jako SUSE. Odkaz a popisek odkazu se jednoduše oddělí mezerou.
V některých zemích mohou být externí odkazy porušením místního zákona. Například v Německu nesmíte zadávat odkazy na software, jehož používání by bylo nezákonné. Pokud si nejste jistí, zda váš odkaz neporušuje místní zákon, zašlete dotaz do konference opensuse-wiki (viz Komunikace).
Tabulky
Přečtěte si http://en.wikipedia.org/wiki/Wikipedia:How_to_use_tables
Obrázky
V SDB až doposud nebyly obrázky používány. Vkládejte je pouze tehdy, pokud jsou nezbytně nutné. Do článku můžete také vložit pouze náhled obrázku. Více o vkládání obrázků najdete ve Wikipedii: http://en.wikipedia.org/wiki/Wikipedia:Image_markup.
Styl
Oslovení čtenářů
Pokud budete psát české články, používejte vykání s malým písmenem (vy, váš atd.). Velká písmena se píší jen v dopisech ;-). Tykání z nás všech sice dělá přátele na jedné lodi, ale v dokumentaci se obvykle nepoužívá.
V němčině vždy používejte zdvořilé "Sie", jak je doporučeno v německých standardech pro technickou dokumentaci. U dalších jazyků si prostudujte nejdřív překlad této stránky a zjistěte si, jaké mají jednotlivé jazyky požadavky na formu oslovení.
Terminologie
Při překladech z angličtiny se můžete setkat s problémy, jak přeložit určité termíny. V takovém případě neváhejte a požádejte o radu ostatní uživatele. V některých případech může být dobrým řešením jednoduše anglický termín dát za český do závorky.
Prostě jednoduše!
I když se vám určitý problém může jevit jako brnkačka, nezapomínejte na začátečníky a pokuste se najít postup, který jim také umožní problém vyřešit. Nemusí to nutně znamenat omezovat postup na klikací nástroje jako je např. YaST. Stačí, když postup řešení podrobně popíšete.
Dobrý SDB článek by měl popisovat každý jednotlivý krok, takže se pokuste vyvarovat větám:
V /etc/inittab nastavte úroveň na 3.
ale snažte se trošku rozepsat:
Přihlaste se jako uživatel root a v textovém editoru otevřete soubor /etc/inittab (např. ve vi nebo pico). A řádku
id:5:initdefault:
nahraďte řádkou
id:3:initdefault:
Touto změnou dosáhnete toho, že se systém místo do grafického prostředí spustí do textového.
Správa
U řady článků je potřeba věnovat se i jejich správě oproti novým verzím. Pokud jste napsali nový článek, snažte se čas od času se podívat, zda by nepotřeboval drobnou údržbu. Například se může stát, že váš článek bude aktuální i pro novou verzi SUSE Linuxu. V takovém případě by bylo dobré přidat do řádky Version také tuto novou verzi.