Jak psát ANS Wiki - návod

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

WIKI 1.0

Pravidla pro názvy stránek

  • Názvy stránek se zadávají v češtině včetně diakritiky a mezer (např: Daň z přidané hodnoty)
  • Lze se řídit pravidlem, že jakýkoliv "pojem" z programu = samostatná stránka
  • Pojmy v množném čísle vznikají vždy jako první, obsahují obecný popis, u číselníku například kde se nachází a popis jednotlivých údajů (např: Daňové skupiny)
  • Pojmy v jednotném čísle obsahují popis funkce (např: Daňová skupina)
  • Jako alternativu pro popis v jednotném čísle a pro další popisy lze použít suffix oddělený pomlčkou bez mezer (např: Daňové skupiny-vyhodnocení)
  • V případě "zanořených" stránek se použijí pomlčky bez mezer (např: Nastavení-Prostředí-Obecné)

Psaní obsahu stránek

Osoba a čas

Dokumentace se píše v přítomném čase se zvratným "se" (jak to nazval Ben). Například:

  • Vyplňuje se ....
  • Zadává se ...
  • Počítá ...
  • ... (možno doplnit)

Styl

  • Každá stránka musí obsahovat verzi {{VERSIONINFO|Modul|číslo}} (např: {{VERSIONINFO|ANS|2.0.25}} )
  • Každá stránka musí obsahovat na konci sekci Odkazy ve které jsou odkazy (linky) na související stránky setříděné od nejpřesnějšího po nejobecnější obsah (Hlavní strana jako poslední)
  • Pro zobrazení "cesty" v menu se použije {{NAVIGATION|cesta}}. Začíná se například slovem Menu a následují kroky oddělené mezerami a lomítkem. (např: Menu / Nástroje / Nastavení)
  • Každý ovládací prvek by měl mít svůj nadpis. Úroveň tohoto nadpisu odpovídá aktuálnímu kontextu psané stránky.
  • Pokud je dialog členěn do "rámečků" doporučuje se názvy těchto rámečků použít jako nadpis vyšší úrovně něž je použito pro ovládací prvky
  • Možnosti výběru u jednotlivých ovládacích prvků (např. u rozbalovacího seznamu, nebo přepínače) se uvádějí jako odrážky
  • V případě záložek na dialogu, je možné stránku rozdělit na více stránek dle těchto záložek. Není to ale podmínka, vždy záleží na množství a složitosti dokumentace k jednotlivé záložce
  • Kombinace kláves se zapisují ve tvaru názvu a znaménka plus (např.: Ctrl+Alt+Shift+P)

Obecná pravidla psaní

  • Vyjadřujeme se slušně, i v editacích, které nejsou ještě zveřejněny, protože fulltextové vyhledávání prohledává vše, včetně historie
  • Než založím novou stránku, nebo napíši odkaz (link), snažím se dohledat, zda již taková neexistuje a upravím dle toho odkaz

Názvy ovládacích prvků

Ovládací prvek Název ve WIKI
Controls Ovládací prvky
Window Okno
Tree Strom
Menu Menu
ToolBar Panel nástrojů
Scroll Seznam
Dialog Dialog
Button Tlačítko
TextBox Editační nebo textové pole
ComboBox Rozbalovací seznam
CheckBox Zatržítko
RadioButton Přepínač
Properties Kontextové menu
Progress Progres ??
ScrollBar Posuvník
Icon Ikona
StatusBar Stavový řádek
Frame Skupina prvků
Tiskový formulář Tiskový formulář

Použití souborů

Pravidla

  • Lze nahrát soubory s příponou png, jpg, pdf, txt, csv.
  • Maximální velikost souboru je 10 MB.
  • Název lokálního souboru by neměl obsahovat diakritiku a speciální znaky. Může dojít k problémům při uploadu souboru na server.
  • Stejně tak název souboru na serveru, který se volí při načítání souboru, by měl být bez diakritiky a mezer, využijte pomlčky, nebo podtržítka.

Odkaz na soubor

Jsou dvě varianty jak se odkázat na soubor:

Doporučuje se první varianta, protože umožňuje na stránce k souboru napsat, co soubor řeší / popisuje. To pro případ, že se k souboru uživatel dostane jiným způsobem, než ze zamýšlené stránky. Například ze seznamu všech souborů. Záleží však vždy na editorovi.

Odkazy

Šablona pro nové stránky

Nápověda k Wiki syntaxi

Hlavní strana