Orsoft Doku
Dokumentace a nápověda pro IS Orsoft Open
Historie:
Mapa stránek

Rozdíly

Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.

Odkaz na výstup diff

— orsoftdoku:popisdoku [2017/01/20 11:52] (aktuální)
Řádek 1: Řádek 1:
 +====== Orsoft Doku - používání ======
 +
 +
 +**Orsoft Doku** je systém nápovědy a dokumentace pro IS Orsoft Open.
 +
 +
 +Jednotlivé články (help stránky) jsou textové soubory, formátované pomocí Wiki syntaxe. Popis formátování je v samostatném článku.
 +
 +
 +Články jsou organizovány do tzv. jmenných prostorů (namespaces). Toto jsou vlastně adresáře na webovském serveru Orsoft Doku. Hierarchie těchto adresářů tvoří adresářovou strukturu serveru. V současné době je vývojový server Orsoft Doku umístěn na serveru **ortexts2**,​ v adresáři **OrsoftDoku**.
 +
 +
 +Základním členěním jsou:
 +
 +
 +    * **media** ​  - obrázky pro články
 +    * **pages** ​  - vlastní txt soubory - články
 +Ostatní adresáře jsou pracovní pro vlastní server, tedy v nich neprobíhají **žádné úpravy**.
 +
 +
 +===== Hirarchie článků =====
 +
 +
 +Články jsou organizovány v adresářích dle svého logického umístění:​
 +
 +
 +    * **orsoft** ​  - pro Cobolský Orsoft, nebude již více využíváno
 +    * **orsoftdoku** ​  - popis ovládání a syntaxe Orsoft Doku
 +    * **orsoftopen** ​  - pro popis Orsoft Open
 +    * **orsoftweb** ​  - pro popis Orsoft web
 +    * **orsoftimpl** ​  - popis implementace
 +    * **orsoftmodel** ​  - popis datového modelu (dle Enterprise Architectu)
 +Výchozím adresářem pro Orsoft Open je tedy **orsoftopen**.
 +
 +
 +{{  :​orsoftdoku:​dw_namespaces.png?​500 ​ }}
 +
 +
 +Adresář //​orsoftopen// ​  je dále rozdělen podle podsystémů. Je zachováno členění a pojmenování dle funkčního modelu a dále dle "​balíčků"​ v NetBeans, použitých pro vývoj v Javě.
 +
 +
 +{{  :​orsoftdoku:​dw_edit1.png?​600 ​ }}
 +
 +
 +V adresáři //​podsystému// ​  jsou články k celému podsystému. V dalších podadresářích pak články ke konkrétním //​panelům// ​  ​použitým v Orsoft Open.
 +
 +
 +{{  :​orsoftdoku:​dw_edit2.png?​800 ​ }}
 +
 +
 +Tím je daná i logická vazba mezi vývojem v Javě (balíček) a dokumentací (článek). Jednotlivé články lze použít zaroveň jako nápovědu pro Orsoft Open - toto je zajištěno strukturou balíčku, názvem panelů a názvem článků.
 +
 +
 +Př. //​Zařazení v Javě:// ​  ​**z-gui … z0.fakturace … Lqd1Panel.java** ​  //​odpovídá článek:// ​  ​**orsoftopen/​z0/​fakturace/​lqd1.txt** ​
 +
 +
 +Vlastní propojení a příslušné volání nápovědy je zajištěno jádrem Orsoft Open.
 +
 +
 +===== Logické řazení článků =====
 +
 +
 +Obecná hierarchie a zařazení článků pro jednotlivé podsystémy Orsoft Open by mělo ctít následující strukturu:
 +
 +
 +Úvod  - něco jako „jednolist“,​ který bude obsahovat:
 +
 +
 +    * co podsystém umí
 +    * pro koho je určen
 +    * jaké má místo v systému
 +    * jakou má strukturu
 +
 +
 +Popis funkcí
 +
 +
 +    * logicky uspořádané a popsané funkce podsystému včetně nápověd pro jednotlivé prvky (menu, pořizovací obrazovky)
 +    * případné odkazy na dokumentaci Základní části nebo na jiné kapitoly vlastní dokumentace
 +
 +
 +Parametry
 +
 +
 +    * logický popis možných parametrů včetně nápověd pro jednotlivé prvky
 +
 +
 +Implementace (vytváří a udržují konzultanti)
 +
 +
 +    * Standardní nastavení
 +    * Postup
 +    * Archivace dat
 +
 +
 +**Seznam změn**
 +
 +    * Pro každou roční verzi se udržuje jeden seznam změn, který obsahuje popis kompletní verze (kompletní roční distribuce) a seznamy změn k důležitým aktualizacím. Seznamy změn k aktualizacím se v dokumentu umísťují nahoru (nejnovější nejvýše). Seznam změn pro podsystém se vytváří pouze tehdy, došlo-li v něm k významným změnám (tj. nikoliv každý týden, kdy se automaticky generují a zveřejňují knihovny distribuční verze)
 +    * Aktualizace a seznamy změn se rozlišují datem vydání, struktura názvu seznamu změn je tato:
 +              * //Seznam změn - [podsystém] - verze [verze] - poslední změna [**datum**]//  ​
 +              * např.: Seznam změn - Personalistika - verze 16.1 - poslední změna **9.3.2016**
 +              * pokud je do seznamu zapsána aktualizace s novým datem, je potřeba toto datum promítnout také do názvu seznamu změn. Uživatel se potom může orientovat podle data v názvu, a nemusí seznam změn vůbec otevírat, když v něm dle data není nic nového.
 +    * Formát nadpisů AKTUALIZACE a KOMPLETNÍ VERZE je druhý největší nadpis, např. =====AKTUALIZACE - 9.3.2016=====,​ tím je zajištěna přehlednost obsahu (indexu), který se zobrazuje vpravo nahoře.
 +    * Aktualizovaný seznam změn se dostane na web ORTEXu spolu s celou DokuWiki automaticky každý týden. Je tedy k dispozici zákazníkovi,​ který se dle jeho obsahu může rozhodnout pro stažení nové verze Orsoftu.
 +    * Příklad pojmenování seznamů změn:
 +    {{:​orsoftdoku:​seznamy1.png?​600}} ​
 +    * Příklad obsahu seznamu změn:
 +    {{:​orsoftdoku:​seznamy2.png?​600}}
 +    ​
 +
 +===== Příklad řazení článků pro Základní část =====
 +
 +
 +Úvod
 +
 +
 +    * Něco jako jednolist
 +
 +
 +Základy obsluhy
 +
 +
 +    * popis ovládání (klávesy, obsluha, tisky, nápovědy, exporty…)
 +    * popis společných principů (prvků)
 +
 +
 +Administrace
 +
 +
 +    * Oprávnění
 +    * Operátorské činnosti
 +    * Instalace
 +    * Aktualizace
 +    * …
 +
 +
 +Kmenová data
 +
 +
 +Parametry
 +
 +
 +Implementace
 +
 +
 +{{  :​orsoftdoku:​dw_zc.png?​300 ​ }}
 +
 +Seznam změn
 +
 +
 +
 +===== Oddíl Datový model =====
 +
 +
 +Datový model - je udržován samostatně,​ dle datového modelu v Enterpise Architectu
 +
 +
 +    * Odkaz na datový model
 +    * Případná rozhraní
 +
 +
 +===== Oddíl Implementace =====
 +
 +
 +Implementace každého podsystému je vytvářena a udržována konzultanty.
 +
 +
 +Skládá se z :
 +
 +
 +Implementace
 +
 +
 +    * Standardní nastavení
 +    * Postup
 +    * Archivace dat
 +
 +
 +{{  :​orsoftdoku:​dw_impl.png?​600 ​ }}
 +
 +
 +===== Příklad postupu tvorby článku =====
 +
 +
 +Zde je popsán jeden ze způsobů jak vytvářet nový článek.
 +
 +
 +=== A. založení nového článku ===
 +
 +== A1. založení nového článku z Orsoft Open ==
 +1. V Orsoft Open překontrolujeme,​ zda máme správně nastavený server s OrsoftDoku. Aktuální je "​ortexts2"​
 +
 +{{  :​orsoftdoku:​dw_tutor11.png?​600 ​ }}
 +
 +2. Připravíme příslušné obrázky
 +
 +
 +{{  :​orsoftdoku:​dw_tutor3.png?​600 ​ }}
 +
 +
 +a uložíme do příslušného adresáře //​media/​orsoftopen/​z0/​z0_zis.png// ​
 +
 +
 +3. Použijeme ikonu {{  :​orsoftdoku:​dw_tutor12.png?​50 ​ }} pro zobrazení nápovědy. ​
 +Jestliže stránka nápovědy existuje nabídne se tato k aktualizaci,​ jestliže stránka neexistuje, lze založit novou a tuto editovat.
 +
 +
 +== A2. "​ruční"​ založení nového článku ==
 +1. Založíme soubor txt do adresáře dle zvolené hierarchie
 +
 +
 +{{  :​orsoftdoku:​dw_tutor1.png?​600 ​ }}
 +
 +
 +Zde pro podsystém ZIS, úvodní stránku //​pages/​orsoftopen/​z0/​z0_uvod.txt//​.
 +
 +
 +{{  :​orsoftdoku:​dw_tutor2.png?​600 ​ }}
 +
 +
 +2. Připravíme příslušné obrázky
 +
 +
 +{{  :​orsoftdoku:​dw_tutor3.png?​600 ​ }}
 +
 +
 +a uložíme do příslušného adresáře //​media/​orsoftopen/​z0/​z0_zis.png// ​
 +
 +
 +{{  :​orsoftdoku:​dw_tutor4.png?​600 ​ }}
 +
 +
 +=== B. založení volby v menu ===
 +
 +**POZOR - Bohužel, pro založení volby v  menu, nebo pro editaci menu nelze použít FCK Edit, dochází z celkovému poškození struktury menu.
 +Pro editaci menu je třeba DW Edit**
 +
 +1. Použijeme volbu k editaci menu.
 +
 +
 +{{:​orsoftdoku:​dw_tutor5.png?​600}}
 +
 +
 +2. Do příslušné hierarchie založíme nový článek s odkazem:
 +
 +
 +{{:​orsoftdoku:​dw_tutor7.png?​600}}
 +
 +
 +3. Přejdeme do založené volby
 +
 +
 +a dáme //Upravit stránku// ​
 +
 +
 +{{:​orsoftdoku:​dw_tutor8.png?​500}}
 +
 +
 +provedeme editaci - úpravy textu, vložení obrázků, formátování
 +
 +
 +{{:​orsoftdoku:​dw_tutor9.png?​600}}
 +
 +
 +4. Uložíme
 +
 +
 +volbou (tlačítkem) //​Uložit// ​
 +
 +
 +{{:​orsoftdoku:​dw_tutor10.png?​600}}
 +
 +
 +{{  http://​www.brunovic-pohadky.estranky.cz/​img/​picture/​23/​pat-a-mat.jpg?​direct& ​ }}