Uživatelské nástroje

Nástroje pro tento web


tutorialy:wiki

Rozdíly

Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.

Odkaz na výstup diff

tutorialy:wiki [2007/04/04 17:27]
stod
tutorialy:wiki [2007/04/13 13:51] (aktuální)
stod
Řádek 1: Řádek 1:
 ====== Použití DokuWiki pro psaní dokumentů ====== ====== 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á [[doku>​wiki:​dokuwiki|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:
 +<code java5>
 +public static void main(String[] args) {
 +    javax.swing.SwingUtilities.invokeLater(new Runnable() {
 +        public void run() {
 +            createAndShowGUI();​
 +        }
 +    });
 +}
 +</​code>​
 +
 +===== Základní info  =====
 +
 +Představu o systému Wiki si uděláte v českém [[http://​wiki.kn.vutbr.cz/​index.cgi|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é [[wpcs>​Wiki|Wikipedii]]. ​
 +
 +Stránky wiki jsou psány v jednoduchém značkovacím jazyce ([[wiki:​syntax]]). Číst stránky může každý, upravovat je může jen přihlášený uživatel. Musíte se [[this>​start?​do=register|zaregistrovat]]. Psaní na wiki si můžete libovolně zkoušet na [[playground:​playground|pískovišti]].
 +
 +Manuál DokuWiki najdete [[doku>​wiki:​manual|tady]]. **Přečtěte si interní [[tutorialy:​wiki|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. 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.
Řádek 14: Řádek 38:
 Používáme systém [[http://​wiki.splitbrain.org/​wiki:​dokuwiki|DokuWiki]] s rozšířením [[http://​tatewake.com/​wiki/​projects:​monobook_for_dokuwiki|MonoBook]],​ které nabízí navíc diskuse k článkům, přehlednější navigaci na stránkách a lepší vzhled systému. ​ Používáme systém [[http://​wiki.splitbrain.org/​wiki:​dokuwiki|DokuWiki]] s rozšířením [[http://​tatewake.com/​wiki/​projects:​monobook_for_dokuwiki|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 [[this>​start?​do=register|registraci]]. ​Časem((on demand)) dojde pravděpodobně k vytvoření chráněné sekce, do které budou mít přístup ​pouze členové Kofrlabu.+**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 [[this>​start?​do=register|registraci]]. ​Některé stránky ​(osobní stránky, aktuality)mohou číst ​pouze členové Kofrlabu.
  
 ===== Syntaxe ===== ===== Syntaxe =====
  
-[[wiki:​syntax|Přehled syntaxe]] DokuWiki. Práci s wiki si můžete volně zkoušet na [[wiki:​playground|pískovišti]].+[[wiki:​syntax|Přehled syntaxe]] DokuWiki. Práci s wiki si můžete volně zkoušet na [[playground:​playground|pískovišti]]. 
 + 
 +===== Poznámky a doporučení =====
  
-TODO poznámky: 
   * Použití nadpisů vede k automatickému vytvoření obsahu stránky.   * 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.   * Emailové adresy by měly být teoreticky chráněny před spammerskými pavouky.
-  * Syntax ​highlighting ​csharp, actionscript,​ xml, java, html, sql, ... +  * Klíčová slova pro syntax ​highlighting: ''​csharp''​''​actionscript''​''​xml''​''​java5''​''​html''​''​sql''​, ... 
-  * Náhled stránky před uložením +  * 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+E (editace stránky), ... +  * Klávesové zkratky -- Alt+P (náhled), Alt+S (uložit), Alt+E (editace stránky), ... 
-  * Editace části stránky (sekce) ​-- lepší orientace v dlouhém textu +  * 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) 
-  * Soubory -- v nástrojích ​odkaz Nahrát soubor. ​Obrázky i libovolné ​soubory. +  * 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
-  * Sledování ​změn obsahu stránek mailem +  * 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 -- pomocník při psaní textu +  * Editor ​textu má ikonky pro formátování ​--  není potřeba si všechno pamatovat 
-  * Export do formátů mimo Wiki (XHTML, ...) +  * Export do formátů mimo Wiki -- tohle se dá dohledat, export do (X)HTML umí přímo DokuWikipro další formáty jsem viděl nástroje 
-  * Zálohování obsahu ​-- TODO+  * Zálohování obsahu -- tak tohle musíme vyřešitDokuWiki nepoužívá databázi, všechny texty ukládá jako plaintext na diskuFIXME 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 ===== ===== Stuktura Kofrlab wiki =====
-TODO strom+FIXME strom
  
 ===== Jak založit novou stránku ===== ===== 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 [[:​wiki:​syntax#​internal|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!**). ​ +Wiki neumožňuje založit novou stránku přímo. Místo toho je nutné nejprve na neexistující stránku vytvořit [[:​wiki:​syntax#​internal|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 [[:​start|úvodní stránky]].
- +
-===== Pravidla Kofrlab Wiki ===== +
-TODO používání dlouhých pomlček, používání syntax highlightingu,​ co nejvíce ​odkazů, nebát se upravovat cizí stránky (pozor ​na názorové rozepře), případně používat diskuse, tvorba odstavců, dodržovat strukturu Kofrlab wiki+
tutorialy/wiki.1175700421.txt.gz · Poslední úprava: 2007/04/04 17:27 autor: stod