Skript pro konverzi z HTML a speciálních tagů použivaných v systému Confluence na uuTagy používané v interní aplikaci uuBookKit.
Motivací byl převod dokumentace z Confluence do uuBook. Šlo o poměrně bolestivý a zdlouhavý proces, proto jsem se ho rozhodl alespoň částečně automatizovat.
Otevřete soubor index.html. Do pole Vstup vložte HTML kód zkopírovaný z
Confluence (zde doporučuji editovat stránku, zobrazit její kód a následně
zkopírovat veškerý obsah).
Po kliknutí na tlačítko Převést se v poli Výstup zobrazi uuKód vhodný pro vložení do uuBook. Kód je automaticky označen a zkopírován do schránky.
Pokud při konverzi vznikne nějaká chyba, uživatel je upozorněn světle červeným pruhem v horní části stránky. Obsahuje textové odůvodnění chyby. Zároveň by měla být v poli Vstup zvýrazněna ta část, která chybu způsobila.
Pro sestavení byly použity následující npm balíčky:
- htmljs-parser - Pro parsování HTML vstupu do DOM reprezentace.
- js-beautify - Formátování výstupu.
Aktuálně je využíván pouze první jmenovaný balíček. Zjistil jsem totiž, že formátování výstupu může občas způsobit při přenosu do uuBook chybu.
Po provedení změn v javascriptových souborech je nutné sestavit znovu soubor main.js
pomocí příkazu:
npm run build
- Pomocí htmljs-parser je vložený HTML kód převeden do vlastní implementace DOM. Ta zajišťuje potřebné metody pro následný export.
- Po vytvoření DOM jsou spuštěny "automatizační" procesy. Jejich úkolem je provést dodatečné "vyčistění" obsahu.
- Projde se DOM a sestaví se sekvence uuTagů podporovaných v aplikaci uuBookKit.
Pro c2book není jiná dokumentace, než komentáře ve zdrojovém kódu.
Pro uuTagy je možné čerpat z následujících zdrojů (je nutné být přihlášen):
Konverze byla provedena. Exporter má stále určité chyby. Nicméně protože nemám pro skript aktuálně využití, nebude v budoucnu rozšiřován či upravován. Zde je k dispozici pouze pro konzervaci kódu.