AKOMA NTOSO Technical documentation — Site
Personal tools
You are here:

AKOMA NTOSO Technical documentation

— filed under:

We have added to the AKOMA NTOSO site a new section called "Documentation" where we will progressively add documents produced to facilitate the adoption of AKOMA NTOSO by providing more in depth documentation. The first item added is the "Technical Documentation" schemadocs.akomantoso.org, with information mainly intended for the "tool makers/programmers" who are in charge of development of tools and applications used to process AKOMA NTOSO documents.

In "Technical Documentation" you will find the technical requirements of each element and also a brief description of the role that each of the AKOMA NTOSO element is supposed to serve. More specifically the documentation describes:

  • role: what the structure does in the different document types;
  • purpose: what the structure is used for in the different document types;
  • context: what is the document's context of use in the structure.
  • pattern: whenever appropriate, what is the pattern used in the content model, and why it is appropriate.
  • downstream behaviour: what is the plausible or expected behaviour from downstream application in the presence of such structure.

In order to better meet the different needs of users we have developed three indexes. 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

We are also working on a "primer", a document that will provide general indications of why it is important and useful to adopt AKOMA NTOSO and provide a plain language description of the basic concepts that have structured AKOMA NTOSO development.

Document Actions