Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
opoudjis committed Jul 30, 2024
1 parent 5898f5e commit c22093c
Show file tree
Hide file tree
Showing 4 changed files with 108 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
= IHO Metanorma Templates

This GitHub repository contains templates for IHO documents.

This repository is used by the `metanorma new` command to create new documents.

== Document types

These types supported in this template repository:

* `s-100`: The template belongs to the S-100 series and is based on the rules given in IHO S-97: IHO Guidelines for Creating S-100 Product Specifications
* `default`: The template belongs to the default for IHO, extrapolated from C-17

Note that both of these generate `standard` documents for their document type ("doctype") by default, but they are still invoked through
the `-d` option.

[source,console]
----
metanorma new -t iho -d s-100
metanorma new -t iho -d default
----
23 changes: 23 additions & 0 deletions default/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
= IHO Default template in Metanorma

== Installing build tools

See https://www.metanorma.com

== Building the document (HTML + Word)

[source,sh]
----
make clean all
----

Your document will be created in the same directory.

== Iterating the document (HTML)

It's easiest to generate the HTML to iterate on the document.

[source,sh]
----
make html open
----
62 changes: 62 additions & 0 deletions default/document.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
= Title
:comment: ### Title of document
:title: Title
:comment: ### Legal values: B C M S
:series: C
:comment: ### Incremental number of document within the series. For example, C-17 is broken down as series: C, docnumber: 17
:docnumber: 17
:comment: ### Omit if not published. The date on which the document is published. Provide in ISO date format: YYYY-MM or YYYY-MM-DD; Metanorma will convert this to MONTH YYYY
:published-date: 2018-06-01
:comment: ### Used to indicate the date when a document has been updated since publication. In particular, used for dating of errata releases.
:updated-date: 2018-06-01
:comment: ### Omit if published: this is the date on which a draft is circulated.
:circulated-date: 2018-06-01
:comment: ### Date last updated for a revision
:revdate: 2018-06-01
:comment: ### Year that the document has been copyrighted to; by default is the year of the `:published-date:`
:copyright-year: 2018
:comment: ### Omit if not applicable. Edition of the document, as a concatenation of the major, minor, and patch numbers
:edition: 2.0.0
:comment: ### The major, minor, and patch numbers can be supplied instead of `:edition:`, but do not override it
:edition-major: 2
:edition-minor: 0
:edition-patch: 0
:comment: ### Language of document, for internationalisation. Default: en (English)
:language: en
:comment: ### Legal values: draft-proposal draft-development draft-testing draft-implementation in-force retired. Default is in-force
:status: in-force
:comment: ### Document type. Legal values: standard specification resolution regulation.
:doctype: standard
:comment: ### Committee
:committee: ircc
:comment: ### If more than one committee is involved, they are indicated by suffixing _2, _3 etc to the attribute name
:committee_2: hssc
:comment: ### Workgroup
:workgroup: msdiwg
:comment: ### If more than one workgroup is involved, they are indicated by suffixing _2, _3 etc to the attribute name
:workgroup_2: csbwg
#:comment: ### Name of sponsoring organisation. Not yet implemented. Multiple sponsors are indicated by suffxing _2, _3 etc to the attribute name
#:sponsor: Department of Homeland Security + \ Federal Emergency Management Agency + \ United States Fire Administration
#:comment: ### Logo of sponsor. Not yet implemented.
#:sponsor-logo: fema.jpg
:comment: ### draft status, enables display of reviewer notes; remove if final document
:draft:
:toc:
:stem:
:comment: ### name of this AsciiDoc file
:docfile: document.adoc
:mn-document-class: iho
:comment: ### Omit one of the following to exclude that format from being generated
:mn-output-extensions: xml,html,doc,pdf,rxl
:local-cache-only:
:data-uri-image:
////
////
include::sections/00-preface.adoc[]
include::sections/01-introduction.adoc[]
include::sections/02-clause.adoc[]
include::sections/03-annexA.adoc[]
2 changes: 2 additions & 0 deletions doctypes.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
DOCTYPES=default
TYPE=iho

0 comments on commit c22093c

Please sign in to comment.