Štábní kultura: Porovnání verzí
m (→Kategorie stránek: doplněn odkaz na seznam kategorií) |
|||
| Řádek 5: | Řádek 5: | ||
== Pojmenovávání stránek == | == Pojmenovávání stránek == | ||
Moodle automaticky generuje v zápatí stránek odkaz na dokumentaci podle jména pluginu a skript, např. v modulu diskusního fóra ve skriptu discuss.php bude vygenerován odkaz na wiki stránku [[mod/forum/discuss]]. Z těchto stránek odkazovaných z Moodlu vytváříme přesměrování na smysluplně pojmenovanou stránku, např. <nowiki>#REDIRECT[[Diskusní fórum]]</nowiki>. | |||
Stránky pojmenovávejte pokud možno srozumitelně a výstižně, ne ovšem zbytečně dlouze: | Stránky pojmenovávejte pokud možno srozumitelně a výstižně, ne ovšem zbytečně dlouze: | ||
| Řádek 11: | Řádek 12: | ||
* <s>Pole pro vložení dat v databázi</s> - příliš dlouhé | * <s>Pole pro vložení dat v databázi</s> - příliš dlouhé | ||
* Pole databáze - vhodný název pro dostatečně vymezenou i obsáhlou problematiku | * Pole databáze - vhodný název pro dostatečně vymezenou i obsáhlou problematiku | ||
Při vytváření odkazu na stránku dbejte, aby nově vytvářená stránka mohla být někým zdokumentována, tzn. její téma musí být dostatečně jasně vymezeno, případně bude stránka tvořit rozcestník na podrobnější témata. Na druhou by se samostatná stránka neměla týkat vyložené banality (např. "Kliknutí na tlačítko Přihlásit se"). | Při vytváření odkazu na stránku dbejte, aby nově vytvářená stránka mohla být někým zdokumentována, tzn. její téma musí být dostatečně jasně vymezeno, případně bude stránka tvořit rozcestník na podrobnější témata. Na druhou stranu by se samostatná stránka neměla týkat vyložené banality (např. "Kliknutí na tlačítko Přihlásit se"). | ||
V názvech stránek '''používejte české znaky''': | V názvech stránek '''používejte české znaky''': | ||
| Řádek 17: | Řádek 18: | ||
* Šablona databáze | * Šablona databáze | ||
Všechny stránky se umisťují do hlavního jmenného prostoru, takže v jejich názvech se nesmí vyskytovat dvojtečka. | Všechny stránky se prozatím umisťují do hlavního jmenného prostoru, takže v jejich názvech se nesmí vyskytovat dvojtečka. | ||
== Obrázky == | == Obrázky == | ||
Verze z 27. 9. 2007, 09:41
Tato stránka obsahuje návrh pravidel, doporučení a zvyklostí, jaké bychom rádi udržovali při tvorbě české dokumentace. Neváhejte k obsahu diskutovat, zde uváděná pravidla by měla být výsledkem všeobecného konsensu.
Pravopis
Je podmínkou, aby zde vložený obsah odpovídal pravidlům spisovné češtiny. Pakliže narazíte na překlep či chybu, prosím, opravte ji. Pakliže pravidla spisovné češtiny připouštějí více možných variant (např. diskuse x diskuze), je vhodné držet se varianty, která se používá ve standardním balíku češtiny cs_utf8, případně je volba na autorovi textu.
Pojmenovávání stránek
Moodle automaticky generuje v zápatí stránek odkaz na dokumentaci podle jména pluginu a skript, např. v modulu diskusního fóra ve skriptu discuss.php bude vygenerován odkaz na wiki stránku mod/forum/discuss. Z těchto stránek odkazovaných z Moodlu vytváříme přesměrování na smysluplně pojmenovanou stránku, např. #REDIRECT[[Diskusní fórum]].
Stránky pojmenovávejte pokud možno srozumitelně a výstižně, ne ovšem zbytečně dlouze:
Pole- příliš krátké a nevýstižné; zmatečné; zavádějícíPole pro vložení dat v databázi- příliš dlouhé- Pole databáze - vhodný název pro dostatečně vymezenou i obsáhlou problematiku
Při vytváření odkazu na stránku dbejte, aby nově vytvářená stránka mohla být někým zdokumentována, tzn. její téma musí být dostatečně jasně vymezeno, případně bude stránka tvořit rozcestník na podrobnější témata. Na druhou stranu by se samostatná stránka neměla týkat vyložené banality (např. "Kliknutí na tlačítko Přihlásit se").
V názvech stránek používejte české znaky:
Sablona databaze- Šablona databáze
Všechny stránky se prozatím umisťují do hlavního jmenného prostoru, takže v jejich názvech se nesmí vyskytovat dvojtečka.
Obrázky
Obrázky pojmenovávejte malými písmeny a s příponou. Vkládáte-li do stránky obrázek, který byl pořízen jako snímek obrazovky, použijte na začátku názvu souboru řetězec "screenshot-", např. screenshot-ukol-znamkovani.png
Šablony
Používejte šablony. V českých MoodleDocs používáme řadu šablon. Šablony mohou vkládat do stránky doplňující informace, rozcestníky, zařazovat stránku do vhodných kategorií apod.
Vložení šablony je jednoduché - při editaci stránky vložte název šablony do dvojitých složených závorek, např. {{Neúplná}} nebo {{Moodle 1.8}}. Namísto takto vloženého textu se vloží obsah příslušné šablony (srovnatelné např. s konstrukcemi include, use nebo import v některých programovacích jazycích).
Kategorie stránek
V českých MoodleDocs používáme řadu kategorií. Stránky se zařazují do kategorií výlučně pomocí k tomu vytvořené šablony, pakliže není zvláštní důvod udělat to jinak. Stránka šablony a stránka kategorie jsou mezi sebou provázány odkazy. To zjednodušuje správu stránek, vkládání společných navigačních prvků do všech stránek v rámci stejné kategorie apod.
