codelists.md: update codelist section organization

open-contracting · Dec 12, 2024 · 3e4aa28 · 3e4aa28
1 parent 9e1ef69
commit 3e4aa28
Show file tree

Hide file tree

Showing 29 changed files with 94 additions and 82 deletions.
diff --git a/docs/schema/codelists.md b/docs/schema/codelists.md
@@ -4,7 +4,7 @@ Some schema fields refer to codelists, to limit and standardize the possible val
 
 Codelists can either be open or closed;
 
-* **Closed codelists** are intended to be comprehensive; for example, the [currency](#currency) codelist covers all currencies in the world.
+* **Closed codelists** are intended to be comprehensive; for example, the [currency](codelists/currency.md) codelist covers all currencies in the world.
 * **Open codelists** are intended to be representative, but not comprehensive.
 
 Publishers must use the codes in the codelists, unless no code is appropriate. If no code is appropriate and the codelist is **open**, then a publisher may use a new code outside those in the codelist. If no code is appropriate and the codelist is **closed**, then a publisher is encouraged to create an issue in the [OCDS GitHub repository](https://github.com/open-contracting/standard/issues) about adding a new code.
@@ -19,89 +19,101 @@ The release schema, in [JSON Schema](../../build/current_lang/release-schema.jso
 
 Codes are case-sensitive, and are generally provided as English language camelCase. Codes must not be translated, though the OCDS team will work with publishers to translate code titles and definitions.
 
-[Contract Status](codelists/contractStatus.md)
+```{toctree}
+:hidden:
 
-[Award Criteria](codelists/awardCriteria.md)
+codelists/awardCriteria
+codelists/awardFinalStatus
+codelists/awardStatus
+codelists/classificationScheme
+codelists/contractFinalStatus
+codelists/contractStatus
+codelists/country
+codelists/currency
+codelists/documentType
+codelists/extendedProcurementCategory
+codelists/initiationType
+codelists/language
+codelists/linkRelationType
+codelists/mediaType
+codelists/method
+codelists/milestoneStatus
+codelists/milestoneType
+codelists/organizationIdentifierScheme
+codelists/partyRole
+codelists/partyScale
+codelists/procurementCategory
+codelists/relatedProcess
+codelists/relatedProcessScheme
+codelists/releaseTag
+codelists/submissionMethod
+codelists/tenderFinalStatus
+codelists/tenderStatus
+codelists/unitClassificationScheme
+```
 
-[Award Final Status](codelists/awardFinalStatus.md)
+## Uncategorized
 
-[Award Status](codelists/awardStatus.md)
+[Release Tag](codelists/releaseTag.md)
 
 [Classification Scheme](codelists/classificationScheme.md)
 
-[Contract Final Status](codelists/contractFinalStatus.md)
-
-[Country](codelists/country.md)
-
-[Currency](codelists/currency.md)
-
 [Document Type](codelists/documentType.md)
 
-[Extended Procurement Category](codelists/extendedProcurementCategory.md)
+[Milestone Type](codelists/milestoneType.md)
 
-[Initiation Type](codelists/initiationType.md)
+[Initiation Type](codelists/initiationType.md) {bdg-danger}`deprecated`
 
-[Language](codelists/language.md)
+## Status
 
-[Link Relation Type](codelists/linkRelationType.md)
+[Tender Final Status](codelists/tenderFinalStatus.md)
 
-[Media Type](codelists/mediaType.md)
+[Award Final Status](codelists/awardFinalStatus.md)
 
-[Method](codelists/method.md)
+[Contract Final Status](codelists/contractFinalStatus.md)
 
 [Milestone Status](codelists/milestoneStatus.md)
 
-[Milestone Type](codelists/milestoneType.md)
+[Tender Status](codelists/tenderStatus.md) {bdg-danger}`deprecated`
 
-[Organization Identifier Scheme](codelists/organizationIdentifierScheme.md)
+[Award Status](codelists/awardStatus.md) {bdg-danger}`deprecated`
+
+[Contract Status](codelists/contractStatus.md) {bdg-danger}`deprecated`
+
+## Organization
 
 [Organization Role](codelists/partyRole.md)
 
+[Organization Identifier Scheme](codelists/organizationIdentifierScheme.md)
+
 [Party Scale](codelists/partyScale.md)
 
+## Tender
+
+[Method](codelists/method.md)
+
 [Procurement Category](codelists/procurementCategory.md)
 
-[Release Tag](codelists/releaseTag.md)
+[Extended Procurement Category](codelists/extendedProcurementCategory.md)
+
+[Award Criteria](codelists/awardCriteria.md)
+
+[Submission Method](codelists/submissionMethod.md) {bdg-danger}`deprecated`
+
+## Related process
 
 [Related Process](codelists/relatedProcess.md)
 
 [Related Process](codelists/relatedProcessScheme.md)
 
-[Submission Method](codelists/submissionMethod.md)
+## External
 
-[Tender Final Status](codelists/tenderFinalStatus.md)
+[Country](codelists/country.md) ([ISO 3166-1 alpha-2](https://www.iso.org/iso-3166-country-codes.html))
 
-[Tender Status](codelists/tenderStatus.md)
+[Currency](codelists/currency.md) ([ISO4217](https://www.iso.org/iso-4217-currency-codes.html))
 
-```{toctree}
-:hidden:
+[Language](codelists/language.md) ([ISO639-1](https://id.loc.gov/vocabulary/iso639-1.html))
 
-codelists/awardCriteria
-codelists/awardFinalStatus
-codelists/awardStatus
-codelists/classificationScheme
-codelists/contractFinalStatus
-codelists/contractStatus
-codelists/country
-codelists/currency
-codelists/documentType
-codelists/extendedProcurementCategory
-codelists/initiationType
-codelists/language
-codelists/linkRelationType
-codelists/mediaType
-codelists/method
-codelists/milestoneStatus
-codelists/milestoneType
-codelists/organizationIdentifierScheme
-codelists/partyRole
-codelists/partyScale
-codelists/procurementCategory
-codelists/relatedProcess
-codelists/relatedProcessScheme
-codelists/releaseTag
-codelists/submissionMethod
-codelists/tenderFinalStatus
-codelists/tenderStatus
-codelists/unitClassificationScheme
-```
+[Link Relation Type](codelists/linkRelationType.md) ([IANA Link Relation Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml))
+
+[Media Type](codelists/mediaType.md) ([IANA Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml))
diff --git a/docs/schema/codelists/awardCriteria.md b/docs/schema/codelists/awardCriteria.md
@@ -1,6 +1,6 @@
 # Award Criteria
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 The award criteria codelist describes the basis on which contract awards will be made.
 

diff --git a/docs/schema/codelists/awardFinalStatus.md b/docs/schema/codelists/awardFinalStatus.md
@@ -1,6 +1,6 @@
 # Award Final Status
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{versionadded} 1.2
 ```

diff --git a/docs/schema/codelists/awardStatus.md b/docs/schema/codelists/awardStatus.md
@@ -1,6 +1,6 @@
 # Award Status
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{deprecated} 1.2
 ```

diff --git a/docs/schema/codelists/classificationScheme.md b/docs/schema/codelists/classificationScheme.md
@@ -1,6 +1,6 @@
 # Classification Scheme
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 The `classificationScheme` codelist is referenced by the `scheme` field of the `Classification` object, which can be used in multiple contexts. You can find the codes relevant to a given context by filtering the codelist by its `Category` column.
 

diff --git a/docs/schema/codelists/contractFinalStatus.md b/docs/schema/codelists/contractFinalStatus.md
@@ -1,6 +1,6 @@
 # Contract Final Status
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{versionadded} 1.2
 ```

diff --git a/docs/schema/codelists/contractStatus.md b/docs/schema/codelists/contractStatus.md
@@ -1,6 +1,6 @@
 # Contract Status
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{deprecated} 1.2
 ```

diff --git a/docs/schema/codelists/country.md b/docs/schema/codelists/country.md
@@ -1,6 +1,6 @@
 # Country
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{versionadded} 1.2
 ```

diff --git a/docs/schema/codelists/currency.md b/docs/schema/codelists/currency.md
@@ -1,6 +1,6 @@
 # Currency
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{versionadded} 1.1
 ```

diff --git a/docs/schema/codelists/documentType.md b/docs/schema/codelists/documentType.md
@@ -1,6 +1,6 @@
 # Document Type
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 The following list describes documents and documentation recommended for publication as part of an open contracting implementation. The codelist indicates the section of an OCDS release they are most likely to be applicable within.
 

diff --git a/docs/schema/codelists/extendedProcurementCategory.md b/docs/schema/codelists/extendedProcurementCategory.md
@@ -1,6 +1,6 @@
 # Extended Procurement Category
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ```{versionadded} 1.1
 ```

diff --git a/docs/schema/codelists/initiationType.md b/docs/schema/codelists/initiationType.md
@@ -1,6 +1,6 @@
 # Initiation Type
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{deprecated} 1.2
 ```

diff --git a/docs/schema/codelists/language.md b/docs/schema/codelists/language.md
@@ -1,6 +1,6 @@
 # Language
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ```{versionadded} 1.2
 ```

diff --git a/docs/schema/codelists/linkRelationType.md b/docs/schema/codelists/linkRelationType.md
@@ -1,6 +1,6 @@
 # Link Relation Type
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ```{versionadded} 1.2
 ```

diff --git a/docs/schema/codelists/mediaType.md b/docs/schema/codelists/mediaType.md
@@ -1,6 +1,6 @@
 # Media Type
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ```{versionadded} 1.2
 ```

diff --git a/docs/schema/codelists/method.md b/docs/schema/codelists/method.md
@@ -1,6 +1,6 @@
 # Method
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 The procurement method describes which organizations can submit a bid. The method codelist draws upon [the definitions of open, selective and limited provided by the WTO Government Procurement Agreement](https://www.wto.org/english/docs_e/legal_e/rev-gpr-94_01_e.htm), and adds an additional 'direct' code for awards without competition.
 

diff --git a/docs/schema/codelists/milestoneStatus.md b/docs/schema/codelists/milestoneStatus.md
@@ -1,6 +1,6 @@
 # Milestone Status
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{versionchanged} 1.1
 Added the 'scheduled' code.

diff --git a/docs/schema/codelists/milestoneType.md b/docs/schema/codelists/milestoneType.md
@@ -1,6 +1,6 @@
 # Milestone Type
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ```{versionadded} 1.1
 ```

diff --git a/docs/schema/codelists/organizationIdentifierScheme.md b/docs/schema/codelists/organizationIdentifierScheme.md
@@ -1,6 +1,6 @@
 # Organization Identifier Scheme
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ![org-id.guide](../../_static/png/org-id_logo.png)
 

diff --git a/docs/schema/codelists/partyRole.md b/docs/schema/codelists/partyRole.md
@@ -1,6 +1,6 @@
 # Organization Role
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ```{versionadded} 1.1
 ```

diff --git a/docs/schema/codelists/partyScale.md b/docs/schema/codelists/partyScale.md
@@ -1,6 +1,6 @@
 # Party Scale
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{versionadded} 1.2
 ```

diff --git a/docs/schema/codelists/procurementCategory.md b/docs/schema/codelists/procurementCategory.md
@@ -1,6 +1,6 @@
 # Procurement Category
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{versionadded} 1.1
 ```

diff --git a/docs/schema/codelists/relatedProcess.md b/docs/schema/codelists/relatedProcess.md
@@ -1,6 +1,6 @@
 # Related Process
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ```{versionadded} 1.1
 ```

diff --git a/docs/schema/codelists/relatedProcessScheme.md b/docs/schema/codelists/relatedProcessScheme.md
@@ -1,6 +1,6 @@
 # Related Process Scheme
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ```{versionadded} 1.1
 ```

diff --git a/docs/schema/codelists/releaseTag.md b/docs/schema/codelists/releaseTag.md
@@ -1,6 +1,6 @@
 # Release Tag
 
-{bdg-link-secondary}`Open<../../codelists/#open-codelists>`
+{bdg-link-secondary}`open<../../codelists/#open-codelists>`
 
 A contracting (or planning) process can result in a number of releases of information over time. A release must be tagged to indicate whether it is about a planning process or a contracting process and, if it is about the latter, to indicate the stage of the contracting process to which it relates.
 

diff --git a/docs/schema/codelists/submissionMethod.md b/docs/schema/codelists/submissionMethod.md
@@ -1,6 +1,6 @@
 # Submission Method
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ```{deprecated} 1.2
 ```

diff --git a/docs/schema/codelists/tenderFinalStatus.md b/docs/schema/codelists/tenderFinalStatus.md
@@ -1,6 +1,6 @@
 # Tender Final Status
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{versionadded} 1.2
 ```

diff --git a/docs/schema/codelists/tenderStatus.md b/docs/schema/codelists/tenderStatus.md
@@ -1,6 +1,6 @@
 # Tender Status
 
-{bdg-link-primary}`Closed<../../codelists/#codelists>`
+{bdg-link-primary}`closed<../../codelists/#codelists>`
 
 ```{deprecated} 1.2
 ```

diff --git a/docs/schema/codelists/unitClassificationScheme.md b/docs/schema/codelists/unitClassificationScheme.md
@@ -1,6 +1,6 @@
 # Unit Classification Scheme
 
-{bdg-link-secondary}`Open<../../codelists/#codelists>`
+{bdg-link-secondary}`open<../../codelists/#codelists>`
 
 ```{versionadded} 1.1
 ```