AKOMA NTOSO Documentation — Site
Personal tools

Skip to content. | Skip to navigation

 
You are here: Home → AKOMA NTOSO Documentation
Technical Documentation
 

Document Actions


AKOMA NTOSO Documentation


The documentation is structured as follows:
  • technical documentation that provides an explanation of the characteristics and requirements for each element of the AKOMA NTOSO schema
  • in-context documentation that through examples of actual AKOMA NTOSO documents shows the role of AKOMA NTOSO elements and attributes in the context of a document.

 

We are also working to develop a "Quick References" document to provide a short explanation of all AKOMA NTOSO elements to be used as references.

 

Please feel free to provide us with your inputs and suggestions which will be very much appreciated.

 

 

Technical documentation

Technical documentation

The technical documentation is mainly intended for the "tool makers/programmers" who are in charge of development of tools and applications used to process AKOMA NTOSO documents. In the technical documentation you will find mainly the technical requirements of each elments but also a brief description of the role that each of the AKOMA NTOSO element is supposed to serve.

 

In order to better meet the different needs of users we have developed three indexes, that are meant to meet defferent needs. So the very same technical documentation can be accessed by:

  • Schema Categories - In this index, the structures of the schema are grouped by the classes of the XSD schemas (attributes groups, elements, elements groups and types).
  • Pattern Categories - In this index, the structures of the schema are grouped by the XML pattern that each of them belongs to.
  • Alphabetical Listing - In this index the elements of the technical documentation are listed alphabetically

 

 

XML Examples

XML Examples

These examples are mainly intended as an aid to the drafters/clerks who are in charge of marking up parliamentary, legislative and judiciary documents to better appreciate how AKOMA NTOSO markup works in the context of the different documents. The  examples provide an "in-context documentation" and it is possible to appreciate how the structural and semantic parts as well as the metadata of the different documents currently supported by AKOMA NTOSO are marked up and what is the technical meaning of the different elements.

 

The examples of AKOMA NTOSO documents (best viewed with Firefox, Opera or Safari - they can be viewed with IE too but performance will be slow), are presented in a way that allows the user to click on any element and see the part of the text it refers to if any and also the technical documentation of the selected element in separate tab.  You can also select what level of display you want to see the XML code thus allowing quick movement around the schema. It is also possible to click on the text at the right end side of the screen (HTML Representation) and see highlighted in the left part of the screen the corresponding XML code.

 

Please note that a drafter/clerk will never come across the actual XML and the mark-up will be done by using the traditional interface of a text editor with forms etc. So, no need to "panic".

 

A technical user will be able to better understand elements, their requirements etc. in the context of  actual examples while at the same time accessing the technical documentation if needed.