XML Web generátor – práce pokračuje

24.8.2011 22:32 | Přečteno: 1844× | WWW | poslední úprava: 25.8.2011 13:49

Před několika měsíci jsem vytvořil program XML Web generátor, jak již název napovídá, program slouží ke generování webů. Práce není od té doby moc intenzivní, ale občas na to sáhnu. Nedávno jsem přidal dvě nové funkce: zvýrazňování syntaxe kódu v <pre/> a možnost vkládání grafů/diagramů.

Smysl

Ačkoli je dneska asi většina webů dynamická a používá nějaký skriptovací/programovací jazyk na straně serveru, statické weby úplně nevymřely a čas od času se hodí. Vytvořit takový web je hračka, stačí k tomu textový editor a základní znalost (X)HTML značek. Jenže pak člověk zjistí, že by chtěl mít na všech stránkách nabídku s odkazy na ostatní stránky, nebo když se rozhodně změnit rozvržení stránky, musí to dělat na všech stránkách ručně.

Další věc je třeba RSS/Atom/Sitemap.xml, které se už vůbec člověku nebude chtít psát ručně. Vkládání záhlaví/zápatí je taky celkem nuda.

Jak to funguje

Proto je dobré ručně udržovat jen ty informace, které jsou jedinečné (obsah stránek) a všechno ostatní automaticky dogenerovat. A k tomu slouží tento program.

Ze sady vstupních XML dokumentů vytváří pomocí XSLT transformace webové stránky.

Formát vstupních dokumentů je velmi jednoduchý a vypadá takhle:

<stránka xmlns="https://trac.frantovo.cz/xml-web-generator/wiki/xmlns/strana">
    <nadpis>Nadpis stránky</nadpis>
    <perex>Krátký popis</perex>
    <pořadí>10</pořadí>

    <text xmlns="http://www.w3.org/1999/xhtml">
        <p>Sem už píšeme obsah stránky – normální (X)HTML, jak ho známe</p>
    </text>

</stránka>

Je to vlastně jen hlavička obsahující nadpis a popis stránky, pořadí v nabídce (pokud chybí, stránka v nabídce nebude, ale vygeneruje se) a pak už následuje obsah stránky uvnitř <text/>, kam už píšeme standardní značky.

Kromě nich můžeme do textu vkládat i „makra“ – vlastní značky, ze kterých generátor něco vyrobí.

Do textu např. vložíme:

<m:měřák hodnota="95"/>

a ve vygenerované stránce bude:

Program obsahuje několik vestavěných maker a další si může dopsat uživatel sám (je to celkem triviální, stačí se inspirovat u těch už hotových).

Více se o programu dočtete na jeho oficiální stránkách nebo v článku Generujeme jednoduchý web pomocí XML.

Nové funkce

Funkce, které jsem nedávno přidal:

Zvýrazňování syntaxe kódu

Když člověk vkládá na web nějakou ukázku kódu, je dobré mít tam zvýrazněnou syntaxi, je to přehlednější. Je škoda, že se o to nemůže postarat prohlížeč sám od sebe, ale co se dá dělat. Do generátoru jsem přidal možnost zvýrazňování – do zdrojového souboru jednoduše vložíme:

<m:pre jazyk="bash">#!/bin/bash
# Matrixový spořič :–)

case "$1" in
    start)
        echo -e "\033[22;32m";
        cat /dev/urandom | hexdump;
;;
    stop)
        echo -e "\033[0m";
;;
    *)
        $0 start;
;;
esac</m:pre>

a generátor z toho vyrobí:

živá ukázka

U složitějších zdrojáků oceníte možnosti XML – kód můžete uzavřít do <![CDATA[…]]>, a pak v něm nemusíte řešit escapování (např. generika v Javě). Časem (snad) bude v generátoru možnost vkládat externí soubory přes XInclude.

Bylo by asi zbytečné psát si vlastní zvýrazňovač syntaxe, tak jsem použil už hotový – Pygments – a propojil ho s generátorem.

Vkládání grafů/diagramů

Občas potřebujeme do stránky vložit diagram, třeba UML, nebo nějaký jiný – obrázek řekne víc. Proto jsem přidal toto makro – do zdrojového souboru vložíme:

<m:diagram orientace="vodorovně">
    A -> B;
    B -> C;
</m:diagram>

a generátor z toho vyrobí:

živá ukázka

Atribut orientace je nepovinný (výchozí je svisle). Jako atribut je taky možné uvést název (zobrazuje se pod grafem).

Vygenerovaný obrázek je ve formátu SVG, takže hezky škáluje, když si ho chce uživatel přiblížit. Časem budou i bitmapové obrázky (PNG), pro případ, že by SVG nešlo zobrazit (<img/> vnořený do <object/>).

Syntaxe použitá pro popis diagramů je vám asi povědomá – použil jsem Graphviz. Můžete pomocí něj tvořit mnohem složitější a hezčí grafy, než jsou tyto ukázky.

Stejně jako Pygments je to externí nástroj volaný při transformaci. Pokud v systému chybí příkaz pygmentize a stránka obsahuje kódy, které se mají zvýraznit, jen se vypíše varování a stránka se vygeneruje bez zvýraznění (to není taková tragédie). Ale pokud stránka obsahuje diagramy a příkaz dot chybí, generování spadne – je potřeba Graphviz doinstalovat. Pokud uživatel tyto funkce nechce využívat, samozřejmě tyto programy nainstalované mít nemusí, generátor bude fungovat bez nich.

Závěr

Program je svobodný software vydaný pod licencí GNU GPL, můžete ho tedy volně používat i upravovat. Budu rád za zpětnou vazbu – nápady na nové funkce, vylepšení, připomínky atd. Používám Trac a některé úkoly už jsem si tam zadal. Program není hotový a chci v něm opravit/vylepšit celkem dost věcí (některé jsou jako TODO v kódu), ale řekl jsem si, že tento zápisek zveřejním už teď – protože kdybych měl čekat, až budu s programem úplně spokojený, asi by nevyšel nikdy        

Komentáře

[manasekp]

ja jsem asi podobny problem resil generovanim RSS feedu a importem do wordpresu - vyhoda je ze pro nej je milion sablon, ma peknou strukturu html kodu a ma pluginy snad na vsechno takze ja jenom dodam vstupni data a zbytek neresim.

[belisarivs]

Hele, nic ve zlem, osobne jsem rad, kdyz nekdo dava svoji praci verejne k dispozici, ale XML tagy v cestine a jeste k tomu s diakritikou? WTF?

[Bedňa]

Máš nejaký problém s tým jazykom?

[Salamek]

ja treba ten ze bych si musel zapnout ceskou klavesnici + jsem zvykly na US qwerty

[w4rr10r]

Na US QWERTY jde psát českou diakritiku.

[vlastikroot]

+1 já to tak používám už dlouho

[Salamek]

Nehodlam si tvorit vlastni rozlozeni... ne ze by to bylo spatne, ale v praci bych ten kus srotu k takovejm kouskum nedonutil ani omylem

[xkucf03]

Co máš za HW?

[Salamek]

v praci nebo doma ?

[xkucf03]

Ten kus šrotu, co bys k takovým kouskům nedonutil.

[Salamek]

pentium 4, 768MB ram intel grafika 16MB ?? W XP Pro kdyz pystum vsechny app co potrebuji k praci tak se vlece jak mrtvola

[xkucf03]

Tak přepínání klávesnice to snad zvládne, ne? A pustit XSLT transformaci resp. Javu taky, té RAMky je až až a P4 taky ujde. Akorát bych vyměnil OS

[Salamek]

to by mi tu vymenu museli povolit... v tip je v tom ze vsechny aplikace ktere pouzivam jsou GNU... krome toho OS, a prakticky nechapu proc jej musim pouzivat... mozna torture ?

[w4rr10r]

To rozložení existuje a dodává se například k X serveru.

[Salamek]

taky sem si rikal...

[xkucf03]

Vždyť to funguje Stejně jako třeba pojmenování tříd/metod v Javě.

[mirec]

No možno by bolo fajn nejako pridať podporu iných jazykov. V každom prípade je mi tento projekt sympatický už len minimálne vďaka českým tagom. Je to také .. iné ako všetko ostatné ;)

[Bystroushaak]

Přílohy:

• WebGenerator.tar.gz (23280 bytů)
• WebGenerator2.tar.gz (829182 bytů)
• RSSGenerator.tar.gz (25757 bytů)

Hehe, to mi připomíná můj první větší python projekt. Byl podstatně víc lame (projekt vznikl impulzivně jedno odpoledne kdy mě začalo štvát upravovat statické html stránky) a navíc jsem ho psal v prváku na VŠ, tedy v době kdy jsem měl nulové znalosti ze softwarového inženýrství a teorie programování něčeho většího, takže to byla totální prasečina. Přesto jsem ho nějaký ten rok používal.

Tenkrát jsem fakt hodně dlouho hledal online službu, která by nedělala nic jiného, než umožnila generovat RSS ve formě několika inputů (name, url) a jedné textarey (obsah). Bohužel, nic takového nejspíš neexistuje. Takže jsem si na konci prváku napsal program v javě co to řešil. To jediné by možná mohlo mít nějakou cenu i pro ostatní :)

Druhá verze pracovala s sqlite, takže RSS už zvládala generovat sama (zpětně mě napadá proč to neuměla už první :S).

Později mi došlo že oba dva zmíněné přístupy mají jen samé nevýhody, takže jsem přešel na dokuwiki.

[xkucf03]

Taky jsem před lety něco takového spáchal: Webátor, hrůza