Uživatelské nástroje

Nástroje pro tento web


tutorialy:wiki

Použití DokuWiki pro psaní dokumentů

Tyto stránky by měly sloužit pro psaní specifikací, manuálů, rad, dokumentace, poznámek a dalších věcí, které je vhodné sdílet mezi členy týmu. Protože libovolnou stránku může každý člen týmu editovat, lze průběžně vylepšovat dokumentaci opravováním chyb nebo nepřesností. Použitá DokuWiki stránky verzuje, je tedy možné snadno dohledat změny provedené na stránce, případně je zahodit a vrátit se ke starší podobě stránky. Vynikající vlastnost je syntax highlighting vloženého kódu. Ukázka:

public static void main(String[] args) {		
    javax.swing.SwingUtilities.invokeLater(new Runnable() {
        public void run() {
            createAndShowGUI();
        }
    });
}

Základní info

Představu o systému Wiki si uděláte v českém WikiHelpu. Pozor, naše wiki se v detailech (např. v syntaxi některých prvků) mírně liší, podstata je ale stejná. Více si přečtete na české Wikipedii.

Stránky wiki jsou psány v jednoduchém značkovacím jazyce (syntax). Číst stránky může každý, upravovat je může jen přihlášený uživatel. Musíte se zaregistrovat. Psaní na wiki si můžete libovolně zkoušet na pískovišti.

Manuál DokuWiki najdete tady. Přečtěte si interní Wiki tutoriál.

Systém wiki bychom měli používat pro psaní specifikací, dokumentací, návodů, tutoriálů a dalších textů, které by měly být přístupné všem členům laborky.

Výhody wiki:

  • jednoduchá – čistě textová podoba, syntaxe jednodušší než HTML
  • webová – práce přes webový prohlížeč, přístup možný odkudkoliv
  • veřejná – informace jsou přístupné komukoliv, kdokoliv je může editovat
  • řízení přístupu – samozřejmě lze nastavit úroveň přístupových práv k jednotlivým sekcím/stránkám
  • verzovaná – systém sleduje změny stránek a umožňuje se snadno vrátit k některé z minulých verzí

Kofrlab Wiki

Používáme systém DokuWiki s rozšířením MonoBook, které nabízí navíc diskuse k článkům, přehlednější navigaci na stránkách a lepší vzhled systému.

Kofrlab Wiki je umístěna na adrese http://patf-biokyb.lf1.cuni.cz/wiki. Kterýkoliv návštěvník může wiki číst, pro zápis je potřeba mít registraci. Některé stránky (osobní stránky, aktuality)mohou číst pouze členové Kofrlabu.

Syntaxe

Přehled syntaxe DokuWiki. Práci s wiki si můžete volně zkoušet na pískovišti.

Poznámky a doporučení

  • Použití nadpisů vede k automatickému vytvoření obsahu stránky.
  • Emailové adresy by měly být teoreticky chráněny před spammerskými pavouky.
  • Klíčová slova pro syntax highlighting: csharp, actionscript, xml, java5, html, sql, …
  • Během editace si můžete prohlížet, jak bude stránka vypadat pomocí tlačítka Nádled
  • Klávesové zkratky – Alt+P (náhled), Alt+S (uložit), Alt+E (editace stránky), …
  • Není třeba vždy editovat celou stránku – použitím nadpisů se text rozdělí do sekcí, které se dají editovat zvlášť (odkaz vpravo dole u každé sekce)
  • Pro vložení obrázku nebo jiného souboru použijte odkaz v nástrojích (vlevo) Nahrát soubor. Je možné linkovat na obrázky nebo soubory umístěné i mimo wiki.
  • Můžete se přihlásit k sledování změn obsahu stránek mailem – odkaz odebírat změny mailem v záhlaví stránky
  • Editor textu má ikonky pro formátování – není potřeba si všechno pamatovat
  • Export do formátů mimo Wiki – tohle se dá dohledat, export do (X)HTML umí přímo DokuWiki, pro další formáty jsem viděl nástroje
  • Zálohování obsahu – tak tohle musíme vyřešit. DokuWiki nepoužívá databázi, všechny texty ukládá jako plaintext na disku. FIXME Domluvit s Marcelem zálohování adresáře s daty.
  • RSS – pokud používáte RSS čtečku, můžete si do ní přidat kanál, který ukazuje poslední změny na celé wiki (adresa feedu je v patičce stránky v ikoně RSS|XML FEED)


:!:

  • Používejte syntax highlighting, kdykoliv to bude možné
  • Používejte odkazy, kdykoliv to bude možné
  • Nebojte se upravovat cizí stránky, ale nevyvolejte tím konflikt (ke každé stránce lze připojit diskusi pomocí odkazu diskuse v záhlaví stránky)
  • Dodržujte strukturu Kofrlab wiki

Stuktura Kofrlab wiki

FIXME strom

Jak založit novou stránku

Wiki neumožňuje založit novou stránku přímo. Místo toho je nutné nejprve na neexistující stránku vytvořit odkaz a potom na něj kliknout a stránku založit. Alternativní postup je vysledovat, jak wiki tvoří URL, a zadat adresu neexistující stránky přímo do prohlížeče (nepoužívat!). Pokud možno uvádějte odkaz na každou vytvořenou stránku už z úvodní stránky.

tutorialy/wiki.txt · Poslední úprava: 2007/04/13 13:51 autor: stod