Štábní kultura

Přejít na: navigace, hledání

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.

Terminologie

Česká lokalizace Moodlu používá již poměrně ustálenou terminologii. Ta ovšem v tuto chvíli není ve své úplnosti zachycena jinde než přímo v jazykových souborech. Pokud se tedy budete chtít seznámit s tím, jak se čemu v českém Moodlu zatím říká, můžete použít jeden z následujících postupů:

  • navštívit stránky demo.moodle.cz, které slouží právě k tomu, aby se na nich mohl do Moodlu kdokoliv přihlásit a cokoliv si vyzkoušet (buď v roli správce, učitele nebo studenta); přepínáním mezi jazyky (na hlavní stránce vpravo nahoře) lze snadno ověřit anglický i český termín; obsah stránek demo.moodle.org je každou hodinu uveden do výchozího stavu nemusíte se proto bát, že něco pokazíte – ať uděláte, co uděláte, nejpozději do hodiny to bude pryč;
  • podívat se do úložiště českých jazykových souborů a potřebný výraz si najít tam;
  • stáhnout si balík češtiny na svůj počítač a vyhledávat termíny v něm.

Kromě toho lze jen doporučit návštěvu kursu určeného mj. pro koordinaci českého překladu na stránkách moodle.cz (stačí přihlásit se jako host).

Pojmenovávání stránek

Moodle automaticky generuje v zápatí stránek odkaz na dokumentaci podle jména pluginu a skriptu, 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.
  • Obrázky je potřeba nejdříve uložit do wiki, teprve poté je možné na ně odkazovat nebo je vkládat přímo do stránky s textem. K uložení obrázků do wiki slouží stránka Načíst soubor. Po uložení se obrázek vypíše v seznamu načtených obrázků.
  • Způsob odkazování na obrázky a jejich zařazování do stránek lze odvodit ze zdrojových stránek, příp. nahlédnout do nápovědy pro práci s obrázky v anglické Wikipedii: Images, Image markup.
  • Pokud v článku používáte obrázek v plné velikosti, je obvykle výhodnější použít obrázek ve formátu PNG (často je datově úspornější než obrázek ve formátu JPEG). Pokud ovšem v článku používáte pouze náhled obrázku, doporučujeme použít obrázek ve formátu JPEG, vytváření náhledu má na starosti wiki a zřetelně lepších výsledků dosahuje při vytváření náhledů z obrázků ve formátu JPEG – často jsou dostatečně čitelné, takže není potřeba nechat si při čtení zobrazit plnou velikost obrázku; naopak náhledy z obrázků ve formátu PNG jsou obvykle nečitelné a čtenář si tak musí na náhled kliknout a podívat se na obrázek v plné velikosti, nebo musí autor článku vložit obrázek v plné velikosti přímo do textu, což ne vždy vypadá dobře.

Š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.

Odkazy na originální anglickou verzi

Pokud možno každá stránka v této dokumentaci by měla obsahovat odkaz na odpovídající stránku v anglické wiki dokumentaci (tzv. interwiki link). Pro větší přehlednost uvádějte odkaz pouze na anglickou verzi stránky. Na další jazykové mutace stránky se případný zájemce dostane odkaz z anglické verze.