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.

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

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

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.

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.

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

Ú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

Datový model - je udržován samostatně, dle datového modelu v Enterpise Architectu

• Odkaz na datový model
• Případná rozhraní

Implementace každého podsystému je vytvářena a udržována konzultanty.

Skládá se z :

Implementace

• Standardní nastavení
• Postup
• Archivace dat

Zde je popsán jeden ze způsobů jak vytvářet nový článek.

1. Založíme soubor txt do adresáře dle zvolené hierarchie

Zde pro podsystém ZIS, úvodní stránku pages/orsoftopen/z0/z0_uvod.txt.

2. Připravíme příslušné obrázky

a uložíme do příslušného adresáře media/orsoftopen/z0/z0_zis.png

1. Použijeme volbu k editaci menu.

2. Do příslušné hierarchie založíme nový článek s odkazem:

3. Přejdeme do založené volby

a dáme Upravit stránku

provedeme editaci - úpravy textu, vložení obrázků, formátování

4. Uložíme

volbou (tlačítkem) Uložit