AJA BINARY MARKUP LANGUAGE (AJA-ML)
Developing Version, November 2006
Copyright (c) 2006 ZDENKO VRABEL (sn3d@users.sourceforge.net)
Tri Horky 5 St, Kosice, 040-11, SLOVAKIA
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
-------------------------------------------------------------------------------
=======
CONTENT
=======
1 Introduction
1.1 Reason
1.2 Goals and sights of AJA-ML
1.3 What is AJA-ML?
1.4 Basic terms
2 Types in AJA-ML
2.1 Item types
2.2 Attribute types
2.3 Element types
3 AJA-ML format
3.1 Big Endian vs. Little Endian
4 Attribute item
5 Element item
5.1 Example of data element
5.2 Example of parent element
7 AJA-ML document header item
7.1 AJA-ML version
7.2 Translation table (AJA_TRANSLATION_TABLE)
7.3 Values (AJA_VALUE)
7.4 Example of AJA-ML document item in XML
A TODO
B GNU Free Documentation License
-------------------------------------------------------------------------------
==============
1 Introduction
==============
==========
1.1 Reason
==========
When i work on my home projects i need in many times stored some
informations.XML was a good way but i need something smaller and
faster.Then i have idea.Specified something like binary XML.I take
basic concept of XML and trying specify binary form.I require
something who i easy convert from/to XML.
==============================
1.2 Goals and sights of AJA-ML
==============================
- Specify and describe AJA Markup language
- Safe basic ideas of XML
- AJA Markup language must be easy converted from/to XML
- Importat sight is small size of AJA-ML document
- AJA-ML must be prepared for streaming
- Data must be easyli and fast parsed and cannot be deformed
- AJA-ML must be designed for future extends
- Structure of document can be possible specify by DTD(Document
Type Definition)
- Minor versions must be compatibile.For example parser fo AJA-ML
ver1.5 can parse AJA-ML documents with version 1.1
- AJA-ML is not XML.It is not easy readable for humans.Binaries are
used for machines AJA-ML must be easy readable for machines
- I choose no-compression(like ZIP) because i need do it AJA-ML
very simple and fast parsed.
- I thinking about resize some parts to smaller(smaller ranges for
IDs etc), or about two categories of items with small ranges and
big ranges.
===================
1.3 What is AJA-ML?
===================
What is AJA Markup Language?AJA-ML is Binary Makup Language based
on XML.AJA-ML is binary form of XML.AJA-ML is not complete XML but
take a basic ideas of XML.AJA-ML is something abstract, it is
concept of formating rules for transfering,parsing and building
structured data.All data are serial-stored and was parsed one by
one.
===============
1.4 Basic terms
===============
Item
Item is basic block of data. In this block can be stored any
data.In AJA-ML exists these types of items:
- Elements
- Attributes
- AJA-ML document header
Element:
Elements are equaled to node elenets in XML.These items can
have other child items, can have attributes.Because i need
small representation of node element i change node name
("<element>") by 32 bit ID number.
Attribute:
Attributes are inner items in elements.Attributes are equaled
to '<element attribute="asd"' in XML.Attributes in XML are
specified by ID too, but attributes have only 8bit
number(0-255).
Translation table:
This is special type of AJA-ML document value item.This is
needed when you convert XML to AJA-ML or AJA-ML to XML.In AJA-
ML are used IDs instead of names you need definition table what
ID have what name.Second thing is attribute name. Attribute ID
in AJA-ML can be from 0 to 255 and in document can exist many
attributes. This transaltion table must specify all possible
attributes for every element. One element can have only 255
attributes(in many cases in XML are used lesser).
Types:
Element, document value or attribute can contained many type of
data.In XML exist only one, string representation but in AJA-ML
can be stored data like 32 bit unsigned integer, strings etc...
Parent element:
In AJA-ML exist special type for element contained inner child
elements called PARENT ELEMENT. Because in AJA-ML are elements
serialized in stream-line and XML is structured, must exist
this type telling to parser that parse inner elements.
-------------------------------------------------------------------------------
=================
2 Types in AJA-ML
=================
In AJA-ML is basic block of data called Item(see 3 AJA-ML format). In
this chapter are specifications of all types used in AJA-ML.AJA-ML items
like Elements, Attributes, Document values holding some informations.These
information can be numbers, strings, dates and times or any other binary
data.From this reason i apply following types:
===============
2.1 Item types:
===============
In AJA-ML is basic element called Item. Items can exist:
Table 2.1 Item types
+-----------------------------------------------------------------+
|value | Descr. |
|=================================================================|
| 0x0h | Undefined item type.Item cannot start with this value, |
| | it is reserved for terminator byte(0x00) |
| 0x1h | Element item |
| 0x2h | Attribute item |
| 0xAh | AJA-ML document header item,first bit must be 1(A=1010) |
| | when data are transferred via internet, exist some |
| | situations who set first bit to 0,this value detect |
| | right transfer(like first byte 89 in PNG files) |
| other | bad AJA-ML document |
+-----------------------------------------------------------------+
====================
2.2 Attribute types:
====================
Attributes can store only elementar data types.Attributes cannot
contain inner child attributes and any structures because attribute
is part of element
Type name : DATA
value : 0x1h
Size : Movable
Description: This type is array of bytes.It is equalled with
char[] array in C.In this type can be stored any
binary information.
Structure :
+--------------------------------------------------+
| size | Descr. |
|==================================================|
| 16 bits | Size of data, 16 bit unisgned number |
| - | Data part long like upper defined size |
+--------------------------------------------------+
Type name : NUMBER
value : 0x2h
Size : 4 bytes
Description: This type store 32 bit unsigned integer
Structure :
+--------------------------------------------------+
| size | Descr. |
|==================================================|
| 32 bits | number from range 0-32bits |
+--------------------------------------------------+
Type name : STRING
value : 0x3h
Size : Movable
Description: This is string type.String coding(UNICODE or other)
is specified in AJA-ML document item.Default is used
ASCII coding.
Structure :
+--------------------------------------------------+
| size | Descr. |
|==================================================|
| 16 bits | String size in bytes like 16bit number |
| - | Data part long like upper defined size |
+--------------------------------------------------+
==================
2.3 Element types:
==================
Type name : DATA
value : 0x1h
Size : Movable
Description: This type is array of bytes.It is equalled with
char[] array in C.In this type can be stored any
binary information.This type is better for strings
Structure :
+--------------------------------------------------+
| size | Descr. |
|==================================================|
| 32 bits | Size of data, 32 bit unisgned number |
| - | Data part long like upper defined size |
+--------------------------------------------------+
Type name : NUMBER
value : 0x2h
Size : 4 bytes
Description: This type store 32 bit unsigned integer
Structure :
+--------------------------------------------------+
| size | Descr. |
|==================================================|
| 32 bits | number from range 0-32bits |
+--------------------------------------------------+
Type name : STRING
value : 0x3h
Size : Movable
Description: This is string type.String coding(UNICODE or other)
is specified in AJA-ML document item. Default is
used ASCII coding.
Structure :
+--------------------------------------------------+
| size | Descr. |
|==================================================|
| 16 bits | String size in bytes like 16bit number |
| - | Data part long like upper defined size |
| 8 bits | terminator character 0x00h |
+--------------------------------------------------+
Type name : PARENT_ELEMENT
value : 0xFh
Size : Movable
Description: This type store other inner child elements.Array of
child elements is terminated when new item block
start with value 0x00h.
Structure :
+------------------------------------------------------+
| size | Descr. |
|======================================================|
| 32 bits | size of data in bytes |
| - | child elements int serial-stream |
| 8 bits | End of this parent element(no more child) |
| | End tag have value 0x00 |
+------------------------------------------------------+
-------------------------------------------------------------------------------
===============
3 AJA-ML format
===============
In AJA-ML are data organized into data blocks called items.Items are
stored in stream-line one by one.I choose following basic concept of data
block. First is header of item then are stored data.Header contain
information about item's type and more..
One important differnet thing.In XML must exist one and only one ROOT
element.AJA-ML document can have one OR more root elements. It is better
for streaming.In AJA-ML, must be first special item called AJA-ML document
item. This item contain global informations for document and contain
informations like AJA-ML version etc.
Example of item blocks:
STREAM LINE ----------------------------------------------------------->
AJA-ML document Item 2 - Element item Item 3
+ ----------------||---------------------------------------||----------->
| AJA-ML DOCUMENT || Header | Data || Header
| || (Contain type of item)| || (Contain type
+-----------------||---------------------------------------||----------->
These items in AJA-ML are elements, comments etc. Type of element specify
first 4 bites in header.When we have item type, then we know header size.
Item types have different headers, only first 4 bites have common
information
================================
3.1 Big Endian vs. Little Endian
================================
AJA-ML can transfer data between mixed platforms.Some platforms
working with bytes by big-endian other works like little-endian.
Because i wrote parser on intel x86 platform, i choose for AJA-ML
big-endian form.Platforms using little-endian need swap bits.
-------------------------------------------------------------------------------
================
4 Attribute item
================
In this section is specified Attribute structure and his header.Attribute
item is small and contain only one data information. Attribute is stored
only in element item at current position. Attribute is equivalent of
element attribute="value"> in XML. Attributes have a type by stored data.
Table 4.1 Attribute item structure
+-------------------------------------------------------------------------+
| size | Descr. |
|=========================================================================|
| 4 bits | Attribute item type, must be 0x2h(see Table 2.1) |
| 4 bits | Type of data, when is number, string or other. |
| |(2.2Attribute types) |
| 8 bits | ID of attribute(range is 0-255) |
|-------------------------------------------------------------------------|
| --- | Data part by type(see structure of types in |
| | 2.1 Attribute types) |
+-------------------------------------------------------------------------+
-------------------------------------------------------------------------------
==============
5 Element item
==============
Element item is most presented item in AJA-ML.It is equaled to node
element in XML(example: "<element>").In AJA-ML exists two basic categories
of elements. ELement containing some information and element containing
other child elements.Like in XML, AJA-ML element can contain attributes
(example:'<element attribute1="val" attribute2="val"').In XML have nodes
name but in AJA-ML are used IDs. For convertion from/to XML is used
Translation table where is specified for ID current name and names for his
attributes. ID with value 0 is incorrenct and IDs from range 1-100 are
reserved(see Table 7.3.1 Reserved element IDs)
Table 5.1 Element item structure
+-------------------------------------------------------------------------+
| size | Descr. |
|=========================================================================|
| 4 bits | Element item type, must be 0x1h(see Table 2.1) |
| 4 bits | Type of data, when is number, string or other. |
| | (see 2.3 Element types) |
| 24 bits | Element ID(range 0-100 is reserved) |
| 8 bits | Attribute count(max allowed attributes is 255) |
|--------------+----------------------------------------------------------|
| - | Attributes |
| - | Data part |
+-------------------------------------------------------------------------+
===========================
5.1 Example of data element
===========================
This is equaled to following situation in XML:
<element attribute="some data">
some data
</element>
|--------------------------------------------------------------->
|Data element item
|--------------------------------------------------------------->
|Element Header: |Attribute 1: |Data:
|--------------------+-------------------------+---------------->
|1 |2 |3 |4 |5 |6 |7 |8 | 9
|----+----------+----+----+----+-------+-------+-------------+-->
| 11 | 00 01 65 | 01 | 21 | 01 | 00 02 | FA 31 | 00 00 00 09 | 52
|--------------------------------------------------------------->
>-------------------------||--------....
>-------------------------||--------....
||Header:
>-------------------------||--------....
||1 |
>-------------------------||----+---....
68 0B 00 98 A3 1C 92 A5 || 12 |
>-------------------------||--------....
Element header part:
1 - this 8 bites contain 2 informations:
fisrt 4 bites: Telling about element item(must be 0x1h)
next 4 bites: Telling about element type.In this
situation is DATA type.
(see 2.3 Element types)
2 - ID of element representing by 24 bit number. In this
situation is ID=101
3 - Count of attributes like 8bit number.In this situation
element contain only 1 attribute
Attributes part:
4 - Attribute start.This 8 bites contain two informations:
fisrt 4 bites: Telling about attribute item(must be 0x2h)
next 4 bites: Telling about attribute type.
(see 2.2 Attribute types)
5 - This is ID of attribute(like 8 bit number)
6 - Size of attributes data, because attribute is data type.(in
this situation 2bytes)
7 - Data of attribute(data size is in p.6).In this situations
are 2 bytes 'FA' and '31'
Data part:
8 - Size of element data(because element have data type) like 32
bit usigned int.
In this situation is size 9 bytes.
9 - 9 bytes representing data of element
=============================
5.2 Example of parent element
=============================
This is equaled to following situation in XML:
<element>
<child_element>some data</child_element>
<child_element2>
<inner_element>some data</inner_element>
<inner_element>some data</inner_element>
</child_element2>
</element>
|---------------------------------------------------------||---->
|Parent element item ||
|---------------------------------------------------------||---->
|Element Header: | Data: ||
|--------------------+------------------------------------||---->
|1 |2 |3 | 4 | Child Element 1 |5 ||
|----+----------+----+-------------+----> ....... >--+----||---->
| 1F | 00 00 66 | 00 | 00 00 00 01 | 11 ....... | 00 ||
|---------------------------------------------------------||---->
Element header part:
1 - this 8 bites contain 2 informations:
fisrt 4 bites: Telling about element item(must be 0x1h)
next 4 bites: Telling about element type.In this
situation is PARENT_ELEMENT type.(see 2.3 Element types)
2 - ID of element representing by 24 bit number. In this
situation is ID=102
3 - Count of attributes.In this situation element haven't
attributes.
Data part:
Child Element 1 - Now start inner child element.His type is DATA.
4 – data size in element in bytes
5 - Termination byte(no next element isn't in parent element)
-------------------------------------------------------------------------------
==============================
7 AJA-ML document header item
==============================
Document item is special type of PARENT_ELEMENT item. This item must be
first and contain some informations for document like place of DTD schema,
translation table.AJA-ML document item must exist in document and must be
first. When are in BML document more AJA-ML document items or AJA-ML
document item is placed after other items, then is AJA-ML document broken.
Table 7.1 AJA-ML Document item structure
+-------------------------------------------------------------------------+
| size | Descr. |
|=========================================================================|
| 4 bits | AJA-ML Document item 0xCh (see Table 2.1) | <- Header of item
| 4 bits | Reserved, must be 0x0h |
| 8 bits | Version of AJA-ML document.(see 7.4 AJA-ML version) |
|--------------|----------------------------------------------------------|
| 8 bits | CL character(0x0d) | <- Special part for detecting transfer deformations
| 8 bits | LF character(0x0a) |
| 8 bits | CTRL+Z character for 'type' MS-DOS (0x1a) |
| 8 bits | LF character,for detect CR+LF or LF+CR replace(0x0a) |
|--------------+----------------------------------------------------------|
| - | Elements of document | <- Data part
| 8 bits | terminator byte(0x00) |
+-------------------------------------------------------------------------+
For elements in AJA-ML are reserved IDs from range 1-100.Because translation
table is defined in this item, element and attribute IDs have static meaning
defined in tables 7.3.1 Reserved element IDs and 7.3.2 Reserved attribute IDs
in elements.
AJA-ML document have a specific static structure defined in following DTD:
----------------------------------------------------------------
<!ELEMENT AJA_DOCUMENT (AJA_TRANSLATION_TABLE?, AJA_VALUE*)>
<!ELEMENT AJA_VALUE (#PCDATA)>>
<!ATTLIST AJA_VALUE name value_name #REQUIRED >
<!ELEMENT AJA_TRANSLATION_TABLE (AJA_ELEMENT*)>
<!ELEMENT AJA_ELEMENT (AJA_ATTRIBUTE*, AJA_ELEMENT_DESCR?)>
<!ATTLIST AJA_ELEMENT name element_id #REQUIRED
name element_name #REQUIRED >
<!ELEMENT AJA_ELEMENT_DESCR (#PCDATA)>
<!ELEMENT AJA_ATTRIBUTE (#PCDATA)>
<!ATTLIST AJA_ATTRIBUTE name attribute_id #REQUIRED
name attribute_name #REQUIRED >
----------------------------------------------------------------
Table 7.3.1 Reserved element IDs
+---------------------------------------------------------------------+
| ID | element name in DTD |
|=====================================================================|
| 1 | AJA_DOCUMENT |
| 2 | AJA_VALUE |
| 3 | AJA_TRANSLATION_TABLE |
| 4 | AJA_ELEMENT |
| 5 | AJA_ATTRIBUTE |
+---------------------------------------------------------------------+
Table 7.3.2 Reserved attribute IDs in elements
+---------------------------------------------------------------------+
| element | ID | attribute name in DTD |
|=====================================================================|
| AJA_VALUE | 1 | value_name |
| AJA_ELEMENT | 1 | element_id |
| AJA_ELEMENT | 2 | element_name |
| AJA_ELEMENT | 3 | element_desc |
| AJA_ATTRIBUTE | 1 | attribute_id |
| AJA_ATTRIBUTE | 2 | attribute_name |
| AJA_ATTRIBUTE | 3 | attribute_desc
+---------------------------------------------------------------------+
==================
7.1 AJA-ML version
==================
AJA-ML version is stored in 8 bites. First 4 bites specify Major
version and second 4 bites specify Minor version.
example of verisons:
version 1.0 is 0001-0000 0x10h
version 2.3 is 0010-0011 0x23h
=============================================
7.2 Translation table (AJA_TRANSLATION_TABLE)
=============================================
Translation table is special part of AJA-ML document item. In
this value are defined names for elements and
attributes.Translation table is needed when you convert XML to AJA-
ML or AJA-ML to XML or when you can use DTD where are used names
too. Because in AJA-ML are used IDs instead of names you need
definition table what ID have what name.Second thing are attribute
names.Attribute ID in AJA-ML can be from 0 to 255 and in document
can exist many attributes. This transaltion table must specify all
possible attributes for every element. Because translation table
serve only for converting to/from XML, translation table is not
REQUIRED but can exist in AJA-ML cocument item structure only one.
Every element can have something like a little help or description.
This information is stored in AJA_ELEMENT_DESCR. Converting
informations are stored in attributes element_id, element_name in
AJA_ELEMENT and attribute_id attribute_name in AJA_ATTRIBUTE.
Example of translation table in XML:
------------------------------------
<AJA_TRANSLATION_TABLE>
<AJA_ELEMENT element_id='101' element_name='BOOK'>
<AJA_ATTRIBUTE attribute_id='1' attribute_name='page_count'/>
<AJA_ATTRIBUTE attribute_id='2' attribute_name='price'/>
<AJA_ELEMENT_DESCR>
some description about element
</AJA_ELEMENT_DESCR>
</AJA_ELEMENT>
<AJA_ELEMENT element_id='102' element_name='AUTHOR'/>
</AJA_TRANSLATION_TABLE>
======================
7.3 Values (AJA_VALUE)
======================
Values in AJA-ML document item store many global informations
like place of DTD file for document, string coding, XML version
etc.All AJA_VALUE elements store data like char[] array and this
element have DATA type.Following table specify all supported
informations but can be expanded in future:
Table 7.3.2 Reserved attribute IDs in elements
+-----------------------------------------------------------------+
| value name | description |
|=================================================================|
| xml_version | when is converted from/to XML then what version |
| | of XML was used |
| | |
| strig_coding | all strings in document are coded by this |
| | method(UNICODE etc) |
| | |
| trans_table | translation table can be placed out of document |
| | in other file.This value store path to XML file.|
+-----------------------------------------------------------------+
Example of value in XML:
------------------------------------
<AJA_VALUE value_name='xml_version' >
1.0
</AJA_VALUE>
<AJA_VALUE value_name='string_coding'>
UNICODE
</AJA_VALUE>
==========================================
7.4 Example of AJA-ML document item in XML
==========================================
<AJA_DOCUMENT>
<AJA_VALUE value_name='xml_version' >
1.0
</AJA_VALUE>
<AJA_VALUE value_name='strig_coding'>
UNICODE
</AJA_VALUE>
<AJA_TRANSLATION_TABLE>
<AJA_ELEMENT element_id='101' element_name='BOOK' element_desc="some description about element">
<AJA_ATTRIBUTE attribute_id='1' attribute_name='page_count' attribute_desc="some descr about attribute"/>
<AJA_ATTRIBUTE attribute_id='2' attribute_name='price'/>
</AJA_ELEMENT>
<AJA_ELEMENT element_id='102' element_name='AUTHOR'/>
</AJA_TRANSLATION_TABLE>
</AJA_DOCUMENT>
-------------------------------------------------------------------------------
================================
A. TODO
================================
- finish specification by goals
- reorganize and rewrite document to better form(correct english)
-------------------------------------------------------------------------------
================================
B. GNU Free Documentation License
================================
GNU Free Documentation License
Version 1.2, November 2002
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other
functional and useful document "free" in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
This License is a kind of "copyleft", which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein. The "Document", below,
refers to any such manual or work. Any member of the public is a
licensee, and is addressed as "you". You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
A "Modified Version" of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of
the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall subject
(or to related matters) and contains nothing that could fall directly
within that overall subject. (Thus, if the Document is in part a
textbook of mathematics, a Secondary Section may not explain any
mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
The "Invariant Sections" are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License. If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant. The Document may contain zero
Invariant Sections. If the Document does not identify any Invariant
Sections then there are none.
The "Cover Texts" are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters. A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text. A copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input format, SGML
or XML using a publicly available DTD, and standard-conforming simple
HTML, PostScript or PDF designed for human modification. Examples of
transparent image formats include PNG, XCF and JPG. Opaque formats
include proprietary formats that can be read and edited only by
proprietary word processors, SGML or XML for which the DTD and/or
processing tools are not generally available, and the
machine-generated HTML, PostScript or PDF produced by some word
processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, "Title Page" means
the text near the most prominent appearance of the work's title,
preceding the beginning of the body of the text.
A section "Entitled XYZ" means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language. (Here XYZ stands for a
specific section name mentioned below, such as "Acknowledgements",
"Dedications", "Endorsements", or "History".) To "Preserve the Title"
of such a section when you modify the Document means that it remains a
section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document's license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
public has access to download using public-standard network protocols
a complete Transparent copy of the Document, free of added material.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.
C. State on the Title page the name of the publisher of the
Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled "History", Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section Entitled "History" in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the "History" section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
K. For any section Entitled "Acknowledgements" or "Dedications",
Preserve the Title of the section, and preserve in the section all
the substance and tone of each of the contributor acknowledgements
and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
M. Delete any section Entitled "Endorsements". Such a section
may not be included in the Modified Version.
N. Do not retitle any existing section to be Entitled "Endorsements"
or to conflict in title with any Invariant Section.
O. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.
You may add a section Entitled "Endorsements", provided it contains
nothing but endorsements of your Modified Version by various
parties--for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History"
in the various original documents, forming one section Entitled
"History"; likewise combine any sections Entitled "Acknowledgements",
and any sections Entitled "Dedications". You must delete all sections
Entitled "Endorsements".
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an "aggregate" if the copyright
resulting from the compilation is not used to limit the legal rights
of the compilation's users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
the entire aggregate, the Document's Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include a
translation of this License, and all the license notices in the
Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions
of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
If a section in the Document is Entitled "Acknowledgements",
"Dedications", or "History", the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual
title.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except
as expressly provided for under this License. Any other attempt to
copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However,
parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such
parties remain in full compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License "or any later version" applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation.
ADDENDUM: How to use this License for your documents
To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the "with...Texts." line with this:
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
-------------------------------------------------------------------------------
Copyright (c) 2006 ZDENKO VRABEL (sn3d@users.sourceforge.net)
Tri Horky 5 St, Kosice, 040-11, SLOVAKIA
