Konvence pro vytváření stránek na Evergreen DokuWiki

Názvy stránek se zobrazují jako webová adresa.

• Názvy by měly vždy vystihovat, o čem daná stránka pojednává
• Názvy by měly být co nejkratší,
• Stránky musí být umístěny ve správném jmenném prostoru (viz níže).

==== Jmenné prostory (sekce Dokuwiki) ====´=

Na DokuWiki lze vytvářet tzv. jmenné prostory, tj. sekce webu. Pro tyto sekce lze nejen nastavit přístupová práva pro skupiny uživatelů nebo jednotlivé uživatele, ale také vytvořit speciální navigaci.

V současné době na portále Evergreen DokuWiki existují tyto tematické jmenné prostory:

• úvod do práce ve služebním klientu
• vypujcky (výpůjční protokol)
• rezervace
• katalogizace
• autority (probelmatika správy autorit)
• správa seriálů (periodik)
• akvizice
• opac (manuály k online katalogu)
• zpravy (zprávy a statistiky)
• administrace (natavení a administrace systému)
• prispívání do Souborného katalogu ČR
• doplňky (např. katalogizační šablony, tiskové šablony, obalkyknih.cz)

Dále existují institucionální jmenné prostory pro interní dokumentaci:

• kds (Katolický domov studujících)
• knihovna_jabok (Knihovna Jabok)
• dobry_pastyr (Hospic Dobrého Pastýře v Čerčanech)
• jachymka (Sdružení Jáchymka)
• cvt (Člověk v tísni)
• spok (SPOK -Společný katalog Evergreen)
• osok (Osobní knihovna)

Postup je stejný jako při vytvoření jakékoliv nové stránky¹⁾, jen je nutné před název stránky přidat název jmenného prostoru a za dvojtečkou bez mezer uvést název stránky ve tvaru:

jmenny_prostor:nazev_stranky

Příklady:

Pro vytvoření nové stránky s názvem „Z39.50 ve jmenném prostoru katalogizace zadejte do vyhledávací pole dotaz katalogizace:Z39.50.

Pro vytvoření stránky o prodloužení výpůjček ve jmenném prostoru pro interní dokumentace knihovny KDS zadejejte do vyhledávacího pole dotaz kds:prodloužení výpůjček.

Výše uvedeným způsobem lze nejen vytvářet stránky v již existujícím jmenném prostoru, ale také vytvořit nový jmenný prostor.

Název vstupní stránky jmenného prostoru má být vždy stejný, jako název jmenného prostoru

Příklad

Úvodní stránka jmenného prostoru „katalogizace“ se bude jmenovat také „katalogizace“, tj. v praxi je při jejím vytváření použít název stránky: „katalogizace:katalogizace“

Názvy kláves, tlačítek, položek menu, akcí nebo dalších voleb se píší v uvozovkách a je pro ně použita tučná kurzíva.

Příklad správného označení tlačítka nebo akce:

Klikněte na tlačítko „Potvrdit“

Klikněte na tlačítko //**"Potvrdit"**//

• Popis jednotlivých kroků nebo pracovních postupů pište formou číslovaného seznamu.
• Pro návody postupu používejte tvar 2. osoby množného čísla rozkazovacího způsobu.
• Každý úkon, který má uživatel provést, je samostatným bodem v číslovaném seznamu.
• Popis akce, která se po daném kroku automaticky provede nebo popis zobrazeného rozhraní patří logicky ještě do téže odrážky.
  Příklad: Klikněte na odkaz „Administrace“. Zobrazí se seznam jednotlivých nastavení
• Nespoléhejte se při popisu pouze na obrázky a nepožívejte nepřesná vyjádření jako „Zobrazí se takovýto seznam“. Stručně popište jednotlivé kroky slovně i v případě, že součástí nápovědy je snímek obrazovky nebo jiný obrázek. Uživatel totiž může mít vypnuté obrázky nebo si prohlížet stránku na mobilu (kde je obrázek malý, takže nevidí detaily), nevidomý může používat hlasový výstup, apod. Vždy napište, co konkrétně se uživateli zobrazí např. Zobrazí se seznam uspořádaný podle jednotlivých titulů apod.

Příklad popisu kroků:

1. Přihlaste se do svého čtenářského konta.
2. Klikněte na odkaz „Administrace“. Zobrazí se seznam jednotlivých nastavení.
3. V seznamu nastavení kliněte na odkaz s názvem požadované akce. Otevře se formulář pro nastavení zvlolené položky. Povinná pole jsou zvýrazněna žlutě.
4. Proveďte potřebná nastavení.
5. Poté kliněte na tlačítko „Potvrdit“.

  - [[opac:prihlaseni|Přihlaste se]] do svého čtenářského konta.
  - Klikněte na odkaz //**"Administrace"**//. Zobrazí se seznam jednotlivých nastavení.
  - V seznamu nastavení kliněte na odkaz s názvem požadované akce. Otevře se formulář pro nastavení zvlolené položky. Povinná pole jsou zvýrazněna žlutě. 
  - Proveďte potřebná nastavení. 
  - Poté kliněte na tlačítko //**"Potvrdit"**//.
  - 

Ilustrační obrázky, které se vztahují k textu (např snímky obrazovky, které ilustrují postup popisovaný na stránce) vkládejte do textu tak, aby

• byly na samostatném řádku (s výjimkou smajlíků nebo obrázků, které jsou součástí textu),
• nahoře a dole byly obrázky vizuálně dostatečně oddělené od textu.
  Je to důležité zejména ú snímků obrazovky, které obsahují části textu, takže při malém odsazení obrázku od textu nemusí být zřejmé, kde končí obrázek a začíná text. V některých případech je nutné použít pro dostatečné odsazení použít dvojitý znak nak pro zalomení textu před i za obrázkem: tj.

   \\ \\ 

Příklad:

Text prvního odstavce odstavce

Text druhého odstavce

Text prvního odstavce odstavce

{{::obrazek.jpg|Obrázek}}

Text druhého odstavce

V běžném textu se doporučuje použít dvojitý znak pro odřákování:

Příklad:

První část odstavce.



Druhá část odstavce.

V běžném textu se doporučuje použít dvojitý znak pro odřákování: 

První část odstavce. \\ \\ {{::obrazek.jpg|Obrázek}} \\ \\ Druhá část odstavce.

Aby bylo zachováno číslování položek seznamu a přitom obrázek netvořil samostatnou položku seznamu, je nutné v textu položky seznamu, ke které obrázek patří, použít použít dvojitý znak pro odřákování:

Příklad:

Obrázek je vložen do textu, který obsahuje nečíslovaný seznam:

1. První položka seznamu
2. Druhá položka seznamu
   
   
   
   
3. třetí položka seznamu

Obrázek je vložen do textu, který obsahuje nečíslovaný seznam:
  - První položka seznamu
  - Druhá položka seznamu \\ \\ {{::obrazek.jpg|Obrázek}} \\ \\
  - třetí položka  seznamu

Pokud na dokumentační portál nahráváte jakýkoliv typ souborů, je nutné dát pozor, aby soubory neobsahovaly osobní údaje, které podléhají ochraně.

Snímky obrazovky by neměly obsahovat žádné osobní údaje čtenářů, tj. čárové kódy, jména ve spojení se seznamem výpůjček nebo s osobními údaji jako je adresa, datum narození apod. Někdy je však z výukových důvodů nutné, aby tyto údaje byly na snímku obrazovky zobrazeny. V takovém případě je možné buď

• použít testovací účty s fiktivními údaji
• údaje v obrázku anonymizovat rozostřením nebo zakrytím

Příklad použití testovacího účtu



Příklad anonymizace údajů rozostřením/zakrytím některých údajů