[XBUP]XBUP - Dokumentace: Zavedené konvence

Úvod

Tento dokument je součástí dokumentace projektu eXtensible Binary Universal Protocol. Obsahuje popis pomocných konvencí vytvořených pro potřeby projektu

O úroveň výše

Obsah

1. Název projektu
2. Přípona souboru
3. Terminologie
4. Struktura dokumentů

1. Název projektu

Správná volba názvu může ovlivnit přijetí protokolu veřejností, může se stát tahounem, stejně jako zkázou. Je vhodné předejít kolizi s různými již existujícími projekty internetu. Vybranému názvu by měla také odpovídat připona souboru. Ačkoliv typ souboru bude spíše určen vnitřním kódem, má přesto přípona vliv pro rychlý přehled a lepší čitelnost pro člověka.

Prozatím byl zvolen pro odlišení dvouznakový prefix připony.

Uvažované názvy projektu (název formátu, potenciální přípony):

2. Přípona souboru

Za dvěma znaky, určenými zvoleným názvem, bude následovat některá z přípon, která pak bude vyjadřovat, jakého typu je obsah dokumentu.

Příklady možných přípon (typ přípona):

V případě, že by se formát XBUP skutečně začal používat, bude nutné zvážit označení i pomocí jiných standardů, například MIME, řekněme například "něco/x-xb-*" a další. Protokol sám o sobě stojí přece jenom dosti mimo zavedené metody a pokud by byl někdy plně nasazen, nahradil by nejspíše většinu stávajích formátů. (Ve skutečnosti považuji rozpoznávání typu dat pomocí přípony za překonanou věc a přípona bude v rámci projektu sloužit víceméně pouze jako pomůcka lidem pro rozlišení obsahu souborů)

3. Terminologie

Na tomto místě by bylo vhodné zmínit, že mnoho použitých odborných termínů může být na mnoha místech této dokumentace použito chybně, či přinejmenším neadekvátně. Jde především o nesprávně použité cizí výrazy nebo také chybně přeložené termíny. Tyto nedostatky budou snad postupně odstraněny. Příklady použitých termínů:

Základní bloky (dříve systémové) - označení pro skupinu bloků, jejichž implementace by měla být zahrnuta v každé aplikaci pracující s protokolem XBUP.

Specifikace dokumentu - souhrn bloků definující povolené hranice bloků dokumentu.

4. Struktura dokumentů

V ukázkových aplikacích je použito více rozličných souborů s nestandardními obsahy. Dosud není stanoven koncept tvorby skupin bloků a jejich rozdělení dle významu.

4.1. Realizace katalogu

Doposud byl specifikován pouze základ katalogu, tudíž realizace všech pomocných struktur, jako jsou popisy v různých jazycích, obrázky, nebo odkazy na další bloky jsou spíše pomocného rázu a často ještě nebyly ani definovány.


Homepage: http://xbup.sf.net
License: GNU Free Documentation License (FDL)
Latest update: 2010-01-06