Uživatelské nástroje

Nástroje pro tento web


wiki:zasady

Zásady práce s Wiki

Premisa

DokuWiki systém je open source projekt pro tvorbu dokumentace malých a středně velkých projektů. Je velmi flexibilní a umožňuje operativně vytvářet a měnit obsah www stránek přístupných odkudkoliv.

Tato jeho flexibilita je jeho velký klad ale stejně také i zápor. Na rozdíl od jiných redakčních systémů totiž má jen velmi málo omezení a pravidel, jež by bylo potřeba dodržovat. To vede k velké volnosti uživatelů, ale také k zvýšené nutnosti uvědomění a zodpovědnosti každého uživatele.

Pokud totiž není struktura stránek systematicky vytvářena, udržována a revidována, může lehce vzniknout chaos, jehož zorganizování stojí nemalé množství úsilí a času.

Snažme se tedy vytvářet tyto stránky od základů dobře strukturované, přehledné a funkční. Pomoci nám k tomu mohou následující zásady.

Obsah a editace

  • Filozofie Wiki systému je založená na předpokladu vzájemné důvěry a práce se společným cílem, proto je většina stránek editovatelná všemi. Přesto existuje na wiki systém oprávnění, takže některé stránky a sekce jsou přístupné jen některým skupinám uživatelů, vězte, že to má vždy dobrý důvod. Pokud jste přesvědčeni, že byste měli mít přístup do některé ze sekcí ale není tomu tak, napište Adminovi1), ten váš dotaz vyhodnotí a pošle odpověď.
  • Dělejte prosím jen takové úpravy stránek, které jsou konstruktivní, nebo zpřehledňují obsah.
  • Veškeré změny stránek jsou archivovány, takže se nebojte změny dělat.
  • Pokud se vám omylem podaří smazat nebo jinak poškodit kus stránky, nevšimnete si toho, stránku uložíte a přijdete na to později, napište email Adminovi, ten stránku obnoví z archívu.
  • Při editaci stránky a jejím ukládání prosím uvádějte také Komentář k úpravám. Jedná se o minimální „zdržení“ a umožní to posléze mnohem jednodušší orientaci v změnách jednotlivých stránek. Pokud se úprava týkala jen odstranění překlepu, chyby nebo drobnosti, komentář uvádět nemusíte, v tom případě prosím zaškrtněte políčko Drobné změny dole vedle místa pro Komentář k úpravám.
  • Při psaní textu prosím používejte diakritiku, obzvlášť pokud je velká šance, že takový text bude použit v některém z materiálů, který bude použit i mimo tuto wiki. Není nic otravnějšího než doplňování diakritiky a ačkoliv existují poloautomatické metody, je to proces, v konečném důsledku, časově velmi náročný.
  • Pokud po editaci stránky chcete vidět výsledek, ale plánujete v úpravách ještě pokračovat, použijte místo tlačítka Uložit tlačítko Náhled. Pod editačním oknem se objeví náhled stránky, vaše úpravy v tento okamžik ale nejsou ještě uložené, takže je nakonec zapotřebí veškeré změny uložit tlačítkem Uložit.

Přístupové údaje

  • Svoje osobní údaje včetně hesla si můžete změnit přes odkaz Upravit profil vpravo nahoře.
  • Pokud chcete umožnit přístup na Wiki dalším osobám (Řešitelům)
    • napište email Adminovi a uveďte
    • Jméno a Příjmení osoby s tituly, instituci, email
    • nesdělujte své přihlašovací údaje třetím stranám
  • Pokud máte podezření, že došlo k vyzrazení vašeho hesla, změňte si je co nejrychleji.
  • Pokud zapomenete heslo, napište email Adminovi a ten vám pošle nové.

Tipy a triky

  • Podrobná dokumentace k formátovací syntaxi wiki stránek je k vidění na Formatting Syntax (anglický originál) a Formátovací značky a Syntaxe (český překlad).
  • Wiki stránky mají zcela stejnou logickou strukturu jako klasický souborový systém na disku, skládají se z adresářů (namespaces) a souborů (pages), oddělovač je na rozdíl od lomítka “/“ dvojtečka “:“.
  • Odkaz na jinou wiki stránku vytvoříte dvojicí hranatých závorek mezi nimiž je cesta k požadované stránce
    • [[:adresar:pod_adresar:pod_pod_adresar:stranka]]
    • Druhou možností formátování odkazů je [[:adresar:pod_adresar:pod_pod_adresar:stranka|Zobrazený text odkazu]], kde můžete definovat také text odkazu. Pokud text odkazu explicitně neuvedete, použije se hlavní nadpis stránky, na kterou odkazujete.
  • Vytváření nových stránek
    • Novou stránku je možné vytvořit tak, že na nějaké již existující stránce (staré) vytvoříte odkaz na onu novou stránku. Když poté starou stránku uložíte, uvidíte odkaz na novou stránku červeně. Kliknutím na tento červený odkaz se dostanete na novou zatím neexistující stránku, kterou nyní máte možnost vytvořit normální editací.
  • Vytváření podadresářů
    • Stejným mechanismem jako vznikají nové stránky lze vytvářet i adresáře resp. podadresáře. Jednoduše se vytvoří nová stránka v nově zakládaném adresáři. Pokud například chceme vytvořit v adresáři :wiki nový podadresář, v němž budou diskuse stačí vytvořit stránku :wiki:diskuse:uvod. Tím, že jsme vytvořili novou stránku uvod v neexistujícím adresáři diskuse jsme zároveň vytvořili i tento adresář.
  • Odrážkované seznamy vytvoříte jednoduše odsazením textu o dvě mezery a vložením hvězdičky „*“.
    • Další úroveň vytvoříte odsazením o další dvě mezery.
  • Číslované seznamy se vytváří analogicky, místo hvězdičky „*“ se však píše pomlčka “-“.
  • Soubory většiny formátů lze nahrávat na wiki tímto postupem:
    • otevřete si stránku, na které má být umístěn daný soubor k editaci,
    • pomocí ikonky s obrázkem na horní liště (čtvrtá zprava) otevřete okno pro výběr dokumentu,
    • pokud dokument není k nalezení (dokumenty jsou stejně jako ostatní wiki stránky také v adresářové struktuře, která je znázorněna vlevo), vyberte jej u sebe na pevném disku (tlačítko „Procházet“) a uploadněte (tlačítko „Načíst“),
    • vyberte požadovaný dokument, po kliknutí na jeho jméno se okno výběru dokumentu samo zavře a v zdrojovém textu stránky se objeví odkaz na požadovaný dokument,
    • stránku uložíte.

Doporučení k strukturování obsahu stránek

  • Stránka by měla být na první pohled přehledná
    • Pokud tomu tak není, zamyslete se čím to je, buď je to nedostatkem formátování, nebo jeho nadbytkem
  • Pokud vytvoříte stránku, na níž umístíte jen několik řádků textu nebo pár odkazů a není oprávněné předpokládat, že bude obsahu přibývat, zvažte, zda by nebylo vhodné začlenit tuto stránku do některé již existující
  • Pokud je nějaká stránka větší než 2 obrazovky, zvažte, zda není vhodné ji rozdělit do více stránek a tyto provázat odkazy
    • toto není vhodné, pokud se jedná a o tématicky ucelený celek, nebo souvislý seznam ekvivalentních položek
  • Pokud plánujete vytvořit velké množství podobných stránek, nebo nahrátí velkého množství souborů, zvažte, zda pro ně není vhodné vytvořit nový „podadresář“ stejně jako při organizaci dat na vašem disku. Nový podadresář (namespace) se vytvoří tím, že vytvoříte nový soubor v něm (tzn. vyrobíte odkaz na novou stránku s cestou do nového adresáře a společně se vznikem této stránky vznikne i adresář).
1) v současné době Sven
wiki/zasady.txt · Poslední úprava: 2012/02/14 09:37 (upraveno mimo DokuWiki)

Nástroje pro stránku