Uživatelské nástroje

Nástroje pro tento web


wiki:jak_psat

Jak psát na Mageia CZ Wiki

Upozornění: Toto je návod na tvorbu stránek na Mageia Wiki. Věnujte mu pozornost, zejména pokud vkládáte článek poprvé. Níže uvedený vzor si můžete zkopírovat a použít jako šablonu. V takovém případě stiskněte tlačítko Upravit stránku napravo, a text v rámečku označte a zkopírujte do schránky (Ctrl+C) Následně jej vložte na místo, kam chcete psát nový článek. Budete tak mít k dispozici vzor s ukázkou formátování. Vlastní text přepište/vymažte a vepište vlastní. Dejte prosíme pozor, aby jste tento text omylem nesmazali.

Shrnutí (perex)

První odstavec stránky má obsahovat stručný souhrn. Vkládáte-li konkrétní návod - HOWTO, uveďte verzi/verze Mageii, se kterým jste návod testovali, stejně jako verzi nástrojů, balíčků, ovladačů apod. Je možné uvést nutné znalosti pro čtení, stejně jako odkazy na stránky s přímo souvisejícími informacemi.

Ukázka perexu

Vzor A: Návod na přidání internetových zdrojů softwaru. Zkoušen ve verzích X, rozdíly jsou v textu vyznačeny. Podívejte se také na Základní informace o balíčkovacím systému [odkaz].

Vzor B: Jak instalovat Nvidia ovladače v příkazové řádce. Zkoušeno v Mageii verze X a ovladači verze 1.2.3.4. Není závislý na konkrétní verzi Mageii, ale může se lišit v případě použití jiné verze ovladačů. Více o práci v příkazovém řádku viz Informace o práci v příkazové řádce[odkaz].

Píšeme návod

Zde začíná samostatný návod. Buďte struční a názorní, nezabíhejte do nepodstatných detailů a nezapomínejte, že jeden obrázek řekne často víc než stránka textu. Berte ohled na začátečníky a používejte nejjednodušší cestu k vyřešení problému. Vysvětlujte postupně, aby čtenář nemusel při čtení přeskakovat mezi jednotlivými částmi dokumentu. V obrázcích můžete vyznačit vysvětlovanou část.

Návod píšete v integrovaném textovém editoru. Vlastnosti napsaného textu lze měnit pomocí editoru a jeho značek - stačí označit libovolnou část textu a přiřadit jí požadovanou vlastnost (nadpis, zvýraznění, odkaz apod.) Psát značky lze i přímo do textu (může to být rychlejší a jednodušší). Kompletní přehled značek najdete na stránce Syntax a vyzkoušet můžete libovolně na Pískovišti.

Wiki návody versus články

Několik připomínek k tvorbě, úpravám a samotné formě vkládaných návodů:

  • Na wiki je možné záznamy upravovat a doplňovat, navíc to může dělat kdokoliv. Toto je specifikum wiki systémů a proto je nutné vytvářet návody od začátku tak, aby měly trvalou informační hodnotu a tomu odpovídající formu.
  • Nepište v první osobě - už z principu je wiki otevřená komukoliv a na návodech se obvykle podílí více než jeden člověk. Vyjádření „Já doporučuji následující postup…“ nahraďte za „Doporučen je následující postup…“
  • Upravujete-li starší návod pro novější verzi Mageii, nezapomeňte uchovat informace pro uživatele starší verze. Buď je oddělte do samostatné stránky a vložte na ni odkaz, nebo je ponechte v návodu jako připomínky - jde hlavně o kroky, které jsou ve starších verzích jinak, případně tam nejsou atd.
  • Nepište wiki návody jako články na web! Základní výhoda wiki systému je právě v tom, že nejde o klasický redakční systém. V něm není možno napsaný článek doplňovat a ztrácí proto s časem informační hodnotu (tzn. není aktuální). Wiki je oproti tomu dělaná tak, aby byly návody/informace aktuální pořád.

Členění a formátování textu

Článek by měl být členěn pomocí nadpisů do kapitol. Hlavní nadpisy se vkládají pomocí tlačítka H1, podkapitoly pomocí H2 a H3 Nepoužívejte více než tři úrovně kapitol - text je nepřehledný a kapitoly nejsou uvedeny v obsahu (generuje se automaticky pouze z H1-H3).

Základní formátování

  • Nepoužívejte příliš barev, ke zvýraznění slouží kurziva (I), pro silné zvýraznění tučný text (B). V případě použití barev se držte běžných zvyklostí [odkaz].
  • Ke zvýšení přehlednosti používejte odstavce. Jako příklad vám může posloužit tento dokument.
  • Maximálně se vyhýbejte tvrdému formátování - tzn. tvrdé konce řádků, volné řádky, mezery apod. Wiki je inteligentní, stačí psát jako ve Wordu a wiki zařídí zbytek.
  • Bez problémů lze používat odrážky - viz tento text.
  • Jména souborů se zvýrazňují tučným písmem.
  • Základní příkazy a jejich parametry vložte do
tabulky
  • Pro vložení více příkazů, výpisů příkazů, části konfiguračního souboru nebo logu použijte html tag code. Ukázka:
    $cat /etc/urpmi/urpmi.cfg 
    {
      downloader:wget
    }
    ...
  • Velmi důležité informace, které by uživatel neměl přehlédnout, označte logem pozor POZOR.

Rozšířené formátování

Změny na stránkách

Při změnách cizích stránek, prosíme, vyplňujte komentář k provedeným změnám. Poslouží nejen vám, všem ostatním při spolupráci.Pokud je na stránce přítomen tento obrázek, znamená to, že stránku má někdo rozpracovanou. ještě budu pokračovat

Nezasahujte do ní, dokud logo nezmizí. Zárověň nezapomeňte na svou rozpracovanou stránku logo umístit.

Odkazy

Někdy je vhodné zařadit na konec odstavec s odkazy na další, podrobnější či jinak rozšiřující zdroje informací. Větší množství odkazů můžete strukturovat do podkapitol podle tématu.

Obecné odkazy k problematice

  • Odkaz 1
  • Kniha: Název, ISBN, autor, případně odkaz
  • vzorová stránka k překopírování - usnadní tvorbu nové stránky
wiki/jak_psat.txt · Poslední úprava: 2014/10/25 13:04 (upraveno mimo DokuWiki)