Krátká specifikace

Součásti RP

• ODU - XML formát pro texty
• "Back-end" - aplikace pro provádění korektur textů
• "Front-end" - webová aplikace pro odevzdávání textů

ODU

Součástí RP je vytvoření vlastního XML formátu, nazvaného ODU, který bude definován XSD schématem.

ODU bude formátem pro ukládání textů (už od jejich vytvoření pomocí front-endu), a zároveň se přímo nad ním bude pracovat v back-end aplikaci.

ODU bude moci obsahovat následujích informace:

• Původní text - možnost použití základního formátování (nadpis, odstavec, zalomení řádku, zdůraznění)
• Opravy textu - vyznačení různých druhů oprav (pravopis, chybně zvolené slovo, špatný slovosled, chybějící slovo, slovo navíc, stylistické chyby,...). Každá chyba u sebe povinně obsahuje správnou variantu, nepovinně pak například komentář, další možné varianty. Bude také možné vyznačit různou závažnost chyby (hrubá/závažná chyba, drobná chyba, pouze doporučení na zlepšení apod.). Dále bude možné vložit samostatný komentář, který se může, ale nemusí, vázat ke konkrétní části původního textu.
• Metainformace - název, data, autoři, apod.

Součástí také budou možnosti prezentace opraveného textu - např. pro tisk, pro odeslání emailem, pro zveřejnění na webu... K tomu bude použito XSLT, pro jednodušší transformaci případně i CSS. Bude také umožňovat různé způsoby zobrazení - jen originální text, jen opravený text (tedy tak jak by měl vypadat), text s vhodně vyznačenými opravami (hlavně pro studenta), apod.

Toto je nástin základu formátu, jakési verze 1.0, přičemž se počítá s možností (zpětně kompatibilního) rozšíření.

Formát vznikne nejprve v podobě předběžné verze 0.1, která bude postupně upravena na verzi 1.0; verze 1.0 nemusí být s 0.1 zpětně kompatibilní.

Použité technologie: XML, XSD, XSLT, CSS

Back-end

Bude umožňovat provedení korektury textu nad formátem ODU. Hlavním faktorem bude maximální uživatelská přívětivost - opravy textů je nutné provádět rychle a efektivně.

Back-end bude obousměrně spolupracovat s front-endem, ale bude umožňovat i komunikaci s autory textů pomocí emailu a práci přímo se soubory uloženými na disku. Bude také možné načíst plaintext, který bude zkonvertován do nového ODU souboru bez formátování.

Ve fázi RP back-end nemusí obsahovat jiné funkce než výše popsané.

Back-end bude koncipován jako multijazyková aplikace, ve fázi RP nabízející na výběr češtinu a angličtinu.

Použité technologie: C# (a tedy .NET a Visual Studio 2008)

Platforma: MS Windows, .NET Framework 3.5

Front-end

Bude umožňovat psaní a odesílání textů včetně formátování (viz specifikace ODU); dále bude umožňovat prohlížení opravených textů. Aplikace bude zároveň umožňovat obousměrný přístup k textům pomocí back-endu (na základě vhodného systému přístupových oprávnění).

Použité technologie: PHP, MySQL, JS (a související)

Platforma: obecně platformě nezávislé

NÁVRH ROZVRŽENÍ PRACÍ NA RP ve fázi "specifikace"

Podrobná specifikace

V podrobné specifikaci se dle doporučení pana doktora Zavorala zaměřím podrobněji na ty části RP, které se týkají vzájemné komunikace:

• ODU formát verze 0.1
• podrobný popis komunikace front-endu a back-endu
• principy fungování back-endu - zejména způsob práce s ODU daty
• základní nástin fungování front-endu (konkrétní implementace zde není klíčová, půjde spíše o jednoduchou pomocnou aplikaci)

Pilotní verze

• definitivní XSD schéma ODU verze 1.0 (upřesnění a doplnění verze 0.1)
• použitelný back-end (práce s ODU daty, možnost vyznačení základních oprav v textu)
• základ front-endu (umožňující vytvoření textu v ODU formátu)
• alespoň jedno jednoduché CSS pro zobrazení ODU souboru