Verzovaná dokumentace - Funkcionalita pro editora

Psaní článků

Autentizovaný uživatel s příslušnou rolí píše články v ObjectGears HTML editoru. Aktuálně zobrazený článek může uživatel s rolí Editor aktualizovat po kliknutí na ikonu tužtičky v pravém horním rohu článku.

Editor má možnost postupně vytvářet nový text daného článku, zatímco je zobrazován původní text. Poté, co je nový text dokončen, zveřejní ho kliknutím na tlačítko Zveřejnit.

Editor články může označit:

Označení	Článek	Text článku	Popis
Zkontrolovat obsah	X		Článek je třeba zkontrolovat z pohledu správnosti (aktuálnosti, přesnosti) jeho obsahu.
Jazykově zkontrolovat		X	Text článku je třeba zkontrolovat z pohledu gramatiky.
Přeložit		X	K danému textu článku je třeba vytvořit/aktualizovat odpovídající jazykové varianty.

U Článku i Textu se nachází pole Komentář. V něm může editor podrobněji popsat, co je třeba v článku opravit či dopracovat nebo, kde se nacházejí zdroje použité v článku (pro potřebu pozdějších úprav).

Editor má k dispozici stránku s přehledem všech článků, které vyžadují pozornost.

Editor, který má na článku pracovat, může být přidělen ve článku nebo v textu článku.

Propojování článků odkazy

Články je možné vzájemně propojovat několika způsoby:

1. Na úrovni článku je možné uvést související články. Tyto se zobrazí na konci stránky v sekci Viz také.
2. Linky v textu článku (vedoucí na jiné články nebo mimo verzovanou dokumentaci - např. i weby mimo organizaci).
3. Linky v textu článku (vedoucí na jiné články) zadávané formou závorkového příkazu. Ty lze zadávat třemi způsoby:
   1. závorkový příkaz v URL odkazu - {{AAN,AN0002332}}
   2. závorkový příkaz v textu článku - odkaz přes číslo článku
      {{LinkAN,AN0002335,1.7.1.0,text k zobrazení}}
   3. závorkový příkaz v textu článku - odkaz přes url článku
      {{LinkURL,session_safety,1.7.1.0,text k zobrazení}}

Ve všech případech se zobrazí článek (nalezený buď přes jeho číslo nebo url textu článku) v uvedené verzi. Text odkazu je dán posledním parametrem závorkového příkazu. Pokud je zadána neexistující verze článku nebo verze není zadána ({{LinkAN,AN0002335,,text pro an}}), zobrazí se článek v aktuální verzi, kterou uživatel používá. První uvedený způsob vždy zobrazí článek ve verzi a jazyku dle aktuálního nastavení uživatele.

První uvedený způsob se liší od dvou dalších tím, že editor při editaci článku vidí přímo zobrazovaný text a závorkový příkaz je v URL - dostupný až po rozkliknutí. Editor napíše text pro zobrazení, text označí, klikne na ikonu pro zadání odkazu a odkaz zadá do okna, které vyskočí. (Ujistěte se, že v comboboxu Protokol je vybráno .)

V druhém a třetím způsobu při editaci píše kompletní závorkový příkaz a ten se mu celý zobrazuje. V případě použití mnoha odkazů na stránce bývá vhodnější použít z důvodu přehlednosti první způsob.

Na články je možné odkázat i z venku pomocí URL opět dvěma způsoby:

1. Your_web/vcd/an/číslo_clanku
2. Your_web/vcd/url_textu_clanku

     V url je možné zadat i parametry jazyka a verze, např:

https://doc.objectgears.cz/vcd/cs-CZ/AN/AN0001833/v/1.8.0.0

Chybné odkazy

Pokud bychom v dokumentaci uvedli chybný odkaz, uživatel bude po kliknutí na něj přesměrován na výchozí článek dokumentace, který ho informuje o možných příčinách nenalezení článku a doporučí mu, jak hledat dále. Zároveň toto hledání bude zalogováno ve třídě Chybná hledání, jejíž data použijeme k odhalení chybných odkazů a jejich opravě.

Text článku - Název a Název v menu

U každého článku zadáváme Název (povinný attribut) a Název v menu (volitelný atribut). Název se zobrazí jako nadpis článku, je součástí tagu Title a nadpisu h1 (viz níže). Název v menu se zobrazí ve stromu v levé části obrazovky. Ve většině případů stačí zadat povinný atribut Název a ten je pak převzat i pro zobrazení v menu. Na níže uvedeném obrázku však v nadpisu chceme uvést dlouhý text a zmínit, že jde o případovou studii, zatímco pro menu potřebujeme kratší text a to, že jde o případovou studii, již vyplývá z pojmenování nadřízeného článku ve stromu. Proto definujeme oba texty různě.

Videa a soubory

K článku je možné přiložit a ve stránce s článkem zobrazit také videa a soubory.

Video se vloží závorkovým příkazem {{VideoYT,EKxdrfCqllo}}:

Soubory přiložené k textu článku se buď zobrazí na konci stránky (soubory vložené do sloupce Soubory) nebo je možné je volitelně zobrazit v libovolném místě stránky (soubory uložené ve sloupci Soubory ve stránce) pomocí závorkového příkazu:

Závorkový příkaz	Výsledné zobrazení	Komentář
{{File,Test file.txt}}	Test file.txt	Je zobrazena výchozí ikona pro soubor.
{{FileImg,Test file.txt,,ImagesData/Icons/Files/txt.png}}	Test file.txt	V příkazu definujeme ikonu.
{{FileImg,Test file.txt,Text tooltipu,ImagesData/Icons/Files/txt.png}}	Test file.txt	Kromě ikony definujeme i text tooltipu.

Vložení zvýrazněných bloků textu

Do článků je možné vložit pomocí závorkových příkazů vložit i bloky zvýraňující text s klíčovými informacemi pro upoutání pozornosti uživatele.

Typ	Závorkový příkaz	Zobrazení
Informace	{{info,Zvýrazněný blok textu s informací pro upoutání pozornosti uživatele.}}	Zvýrazněný blok textu s informací pro upoutání pozornosti uživatele.
Varování	{{warning,Zvýrazněný blok textu s varováním pro upoutání pozornosti uživatele.}}	Zvýrazněný blok textu s varováním pro upoutání pozornosti uživatele.
Chyba	{{error,Zvýrazněný blok textu s informací typu chyba pro upoutání pozornosti uživatele.}}	Zvýrazněný blok textu s informací typu chyba pro upoutání pozornosti uživatele.

Vložení znaků <  a  >

Pro vložení těchto dvou znaků (špičatých závorek) je třeba použít speciální závorkový příkaz. To je důležité hlavně při vkládání příkladů v HTML nebo XML. HTML editor pochopí HTML či XML text jako příkazy/tagy v HTML a začne je provádět namísto pouhého zobrazení. Všechny výskyty těchto dvou znaků je proto třeba před vložením do editoru obalit dvojitými složenými závorkami.

Kód, který chceme zobrazit:

<p>Html text</p>

Kód, který vložíme do článku:

Poznámka: Žádané zobrazení uvidí až čtenář při zobrazení článku. V HTML editoru vidíme kód včetně dvojitých závorek.

Strom článků, jazyk a verze článku

Daný článek může být vytvořen v různých jazycích a verzích. Uživateli se pak zobrazuje jazyk a verze dle jeho volby. Uživatel přepíná mezi jazyky v pravém horním rohu a verzi v levé části obrazovky.

V horní části obrazovky se nacházejí hlavní témata. Po zvolení tématu (na obrázku níže jde o záložku Řešení) se objeví v levé části obrazovky strom článků patřící do daného tématu. Uživatel může procházet strom článků a zobrazovat tak články na stejné úrovni, podřízené články atd.

Pořadí článků ve stromu článků v levém části stránky je dáno vlastností článku: Pořadí. Pokud hodnota Pořadí není vyplněna, články se zobrazují v abecedním pořadí. Pořadí je tedy vhodné použít, pokud články nacházející se ve stromu pod nadřízeným článkem mají být čteny v určitém pořadí. Pokud Pořadí není definováno, zobrazí se v každém jazyce v jiném pořadí (dle Názvu v daném jazyce). Pokud určité podčlánky Pořadí mají definováno a další ne, zobrazí se nejdříve články s definovaným pořadím a za nimi články bez definované hodnoty Pořadí v pořadí dle jejich Názvu daného Textu článku.

Zobrazování článku

Zobrazení článku a jeho textů závisí na několika faktorech:

1. Článek se zobrazuje, pouze pokud je označen jako Aktivní.
2. Článek se zobrazuje, pouze pokud má uživatel vybránu k zobrazení Verzi, jejíž pořadí je nižší nebo rovno vlastnosti článku Poslední verze.
3. Článek se zobrazuje, pouze pokud existuje Text článku s vlastností Od verze, která je nižší nebo rovna verzi, kterou má k zobrazování vybránu uživatel.

SEO a optimalizace pro vyhledávače

U textu článku je možné uvést klíčová slova (meta tag keywords) a text zobrazující se jako popis u odkazu ve výsledcích vyhledávání Google (meta tag description). Title článku je přebírán z Názvu textu článku stejně jako element nadpisu h1.