logo


COVER

Guidelines - Part 1

1 Introduction

1.1 Rationale

1.2 Background

1.3 HLCM Working Group on Document Standards

1.4 Purpose

1.5 Level of Requirement

1.6 Target Audience

1.7 Official Documentation

1.8 Conventions Used in this Guidelines

1.8.1 Formatting

1.8.2 Value Placeholders

1.8.3 Attribute Choice Values

2 Akoma Ntoso: an overview

2.1 Why Akoma Ntoso

2.2 Akoma Ntoso Document Model

2.2.1 AKN Document Types

2.2.2 AKN Document Collections

How to model collections

Portion

2.2.3 Document Type Attributes

2.2.4 Model Document Schema

2.2.5 Main content: body

<body> for documentType <bill> <act>

<debateBody> for documentType <debate>

<judgmentBody> for documentType <judgment>

<mainBody> for documentType: <statement> <debateReport> and <doc>

<collectionBody> for documentType used in collection structures

<amendmentBody> for documentType <amendment>

<portionBody> for documentType <portion>

2.2.6 Akoma Ntoso Metadata

Metadata Schema

2.2.7 Ontology

Document Classes

Non-document Classes

2.3 Akoma Ntoso Naming Convention

2.3.1 Benefits

2.3.2 Internationalized Resource Identifiers (IRIs)

Absolute and relative IRIs

Global and local IRIs

Document IRIs

Non-Document IRI

2.3.3 IRI Identifiers for Documents

Work IRI

Expression IRI

Manifestation IRI

Structural Components IRI

2.3.4 How to Resolve IRIs

2.3.5 Non-Document IRI

2.3.6 Element Identifiers

3 AKN4UN Document Classes

3.1 Document vs Logical Component

3.2 UN Document Classes

3.3 Mapping of AKN4UN Document Classes to AKN Document Types

4 AKN4UN: Modelling Content

4.1 General Principles

4.1.1 Model the Content as It Appears in Documents

4.1.2 Leverage Existing Standards

4.1.3 Element Text vs. Attributes

4.1.4 Generated Content

4.1.5 XML Elements Must be Placed Strictly Around their Related Information

4.1.6 Modelling Languages

4.1.7 Correlation between XML and Print / Presentation documents

4.2 Element Categories

4.3 Basic Structures

4.4 Hierarchical Elements

4.4.1 AKN Hierarchical Elements

4.4.2 AKN4UN Hierarchical Structures

4.4.3 Hierarchical Content Model

Headings

Basic Units

Numbered and Unnumbered Lists

Lists with content outside the points or indents

Lists inside points or indents

Lists inside paragraphs

Text Content Model

4.5 Container Elements

4.5.1 Container Groups

Preface Containers

Preamble Containers

Speech Containers

4.5.2 Containers Content Model

4.5.3 Container Lists

4.6 Inline elements

4.6.1 General Inline

4.6.2 Title Inline

4.6.3 HTML Inline

4.6.4 Header Inline

4.6.5 Semantic Generic Inline

4.6.6 Amendment Inline

4.7 Generic Content Structures

4.8 Quoted Text & Structures

4.9 Insertions and Deletions

4.10 References

4.10.1 Using IRI References

References to documents

Local References to logical components

Link Reference to a specific structural part of a document

Portion References

URLs to other documents

Other Reference Elements

4.11 Tables

4.12 Element Foreign

4.13 Authorial Notes

4.14 Images

4.15 Omissions

4.16 Presentation Elements

4.16.1 HTML Inline

4.16.2 Presentation Elements

4.16.3 Publication formats

5 AKN4UN Metadata

5.1 <identification>

5.1.1 <FRBRcountry>

5.1.2 <FRBRauthor>

5.1.3 <FRBRdate>

5.1.4 <FRBRnumber>

5.1.5 <FRBRlanguage>

5.1.6 <FRBRuri>

5.1.7 <FRBRthis>

5.1.8 <FRBRsubtype>

5.1.9 <FRBRformat>

5.1.10 <FRBRversionNumber>

5.1.11 <FRBRtranslation>

5.1.12 <FRBRmasterExpression>

5.1.13 <componentInfo>

5.1.14 <preservation>

5.2 <publication>

5.3 <classification>

5.4 <lifecycle>

5.5 <workflow>

5.6 <analysis>

5.6.1 Active Passive Modifications

5.6.2 Restrictions

5.6.3 Judicial

5.6.4 Parliamentary

5.6.5 Mappings

5.6.6 Other References

5.6.7 </otherReferences>Other Analysis

5.7 <temporalData>

5.8 <references>

5.8.1 The structure of references

5.8.2 References to precise concepts

5.9 <notes>

5.10 <proprietary>

5.11 <presentation>

6 AKN4UN Naming convention

6.1 IRI Identifiers for Documents

6.1.1 Work IRI

Numbers and Invalid characters in IRI

Documents without Numbers

6.1.2 Expression IRI

6.1.3 Manifestation IRI

6.1.4 Structural Components IRI

Component Hierarchies

6.2 Non-Document IRI

6.3 Element Identifiers

6.3.1 Forming identifiers

Format of an Identifier

Abbreviations

Numbers

6.3.2 Use of @eId, @wId and @GUID

6.4 Using IRI References

6.4.1 References to documents

6.4.2 Local References to logical components

6.4.3 Link Reference to a specific structural part of a document

6.4.4 Portion References

6.5 URLs to other documents

7 AKN4UN Management of Modifications

7.1 Stating Active Modifications

7.2 Stating Passive Modifications

7.3 Temporal Modelling

7.4 Active and Passive Modifications Metadata

8 Annexes

8.1 Annex I: AKN4UN Document Classes

8.1.1 Normative Documents

Charter

Code of Conduct

Code of Practice

Constitution

Convention

Protocol

Recommendation

Rules

Rules of Procedure

Regulation

Standard

Treaty

8.1.2 Deliberative Documents

Resolution

Decision

8.1.3 Administrative Issuances

Administrative Instruction

Administrative Circular

8.1.4 Meeting Agenda

Agenda Listing

Annotated Agenda

8.1.5 Meeting Records

Verbatim Record

8.1.6 Meeting Reports

Meeting Minute

Meeting Report | Conference Report | Council Report

8.1.7 Court Decisions

Judgment / Order

Advisory Opinion

8.1.8 Papers

Policy

Position Paper

Progress Report

Budgetary Document

8.1.9 Communications

Address

Bulletin

Circular

Memoranda

Note

Official Letter

Official Statement

Press Release

8.1.10 Modificatory Instructions

Amendment

8.1.11 Publications

Publication

Collection

Official Compilation

Amendment List

8.2 Annex II: Attributes Values

8.2.1 Akoma Ntoso attributes values

@status values

@contains values

@pos values

<note> : @placement values

<opinion> : @type values

<efficacyMod> : @type values

<forceMod> : @type values

<legalSystemMod> : @type values

<meaningMod> : @type values

<scopeMod> : @type values

<textualMod> : @type values

<event> : @type values

<remark> : @type values

<recordedTime> : @type values

<restriction> : @type values

<result> : @type values

@xml:lang values

8.2.2 AKN4UN Attributes Values

<formula> : @name values

<inline> : @name values

8.3 Annex III: Proprietary Metadata

8.3.1 <presentation> metadata

First page header and footer:

Odd and even page headers and footers: