OGC uses Metanorma software for creating Technical Paper documents. Note that OGC Technical Paper documents used to be called White Paper documents. The metanorma commands below therefore use 'white-paper' and in due course will be changed to use 'technical-paper'.
You can compile documents using either a local installation of Metanorma or optionally a docker-containerized instance of Metanorma.
Confirm that you have Metanorma installed locally on your operating system. If you do not have Metanorma installed, follow the steps at the Metanorma website to install it.
Step 1. Obtain the template for a Draft OGC Technical Paper document from the template sub-folder.
Now that you have obtained a copy of the template, you can edit the document. The following steps assume that you have read the authoring guidelines are at https://www.metanorma.org/author/ogc/authoring-guide/
Step 2. Next, edit the asciidoc file document.adoc by filling the document properties: docsubtype, status, abbrev, edition (i.e. version of the document), docnumber (OGC Document Number), keywords, fullname (of the editors).
Step 3. Ensure that the doctype property is set to white-paper.
Refer to the authoring guidelines for the complete list of document properties.
NOTE: If there are multiple editors, the names of the editors are listed in the sequence fullname, fullname_2, fullname_3,...
To convert the draft document from asciidoc format to HTML and PDF formats, we use the metanorma software to compile the document.
Step 4. From the folder containing the document.adoc file, run the following command.
metanorma compile --agree-to-terms -t ogc -x xml,html,doc document.adoc
NOTE: You need to add this option to retrieve licensed fonts --agree-to-terms
Confirm that you have docker installed on your operating system. If you do not have docker installed, follow the steps at the Get Docker page to install it.
The template for Technical Paper documents is organized as a folder of asciidoc files, with nested folders for sections, and other resources.
To create a copy of the template, follow these steps.
Step 1. Pull the latest version of the Metanorma image on to your local docker installation.
docker pull metanorma/metanorma:latest
Step 2. Generate a copy of the template for OGC Technical Paper documents by running the following command from a terminal (i.e. from the command prompt).
docker run --rm -v "$(pwd)":/metanorma metanorma/metanorma metanorma new -d white-paper -t ogc -l https://github.com/metanorma/metanorma-templates-ogc folder_for_white_paper
NOTE: The -d white-paper -t ogc flags instruct metanorma that the template is for OGC Technical Paper documents.
NOTE: The folder_for_technical_paper value can be replaced with whatever you would like to be the name of the folder that contains the copy of the template.
Now that you have generated a copy of the template, you can edit the document. The following steps assume that you have read the authoring guidelines are at https://www.metanorma.org/author/ogc/authoring-guide/
Step 3. Next, edit the asciidoc file document.adoc by filling the document properties: status, abbrev, edition (i.e. version of the document), docnumber (OGC Document Number), keywords, fullname (of the editors).
Step 4. Ensure that the doctype property is set to white-paper.
Refer to the authoring guidelines for the complete list of document properties.
NOTE: If there are multiple editors, the names of the editors are listed in the sequence fullname, fullname_2, fullname_3,...
To convert the draft OGC Technical Paper from asciidoc format to HTML and PDF formats, we use the metanorma software to compile the document.
Step 5. From the folder containing the document.adoc file, run the following command.
docker run -v "$(pwd)":/metanorma -v ${HOME}/.fontist/fonts/:/config/fonts metanorma/metanorma metanorma compile --agree-to-terms -t ogc -x xml,html,doc document.adoc
NOTE: You need to add this option to retrieve licensed fonts --agree-to-terms