-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
232 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
= White Paper template in Metanorma | ||
|
||
== General | ||
|
||
White Papers have no set structure, so organize the content as best fits your purposes | ||
|
||
== Content | ||
|
||
This GitHub repository contains the content for an OGC White Paper. | ||
|
||
* `document.adoc` - the main White Paper document with references to all sections | ||
* remaining ``adoc``s - each section of the White Paper document is in a separate document | ||
** follow directions in each document to populate | ||
* `figures` - figures go here | ||
* `images` - Image files for graphics go here. Image files for figures go in the `figures` directory. Only place in here images not used in figures (e.g., as parts of tables, as logos, etc.) | ||
|
||
== Building | ||
|
||
Run `make`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
= White paper for OGC (add title text) | ||
:comment: ### Document type; mandatory. Visit: https://www.metanorma.org/author/ogc/authoring/ for permitted types | ||
:doctype: white-paper | ||
:comment: ### Language of the document; mandatory. Specified in two-letter code: "en" for English, "fr" for French | ||
:language: en | ||
:comment: ### Document status/stage; mandatory. Visit: https://www.metanorma.org/author/ogc/authoring/ for permitted types | ||
:status: swg-draft | ||
:comment: ### Relevant committee; mandatory. The permitted types are: technical, planning, and strategic-member-advisory | ||
:committee: technical | ||
:comment: ### Draft status, enables display of reviewer notes; remove if final document. Value provided conforms the exact iteration of the document in x.y format | ||
:draft: 3.0 | ||
:comment: ### External link referencing the document; optional. If not provided, a default value is created following this structure: "http://www.opengis.net/doc/{abbrevation of doctype}/{abbrev}/{version}" | ||
:external-id: http://www.opengis.net/doc/WP/bigdata | ||
:comment: ### Internal reference number; mandatory | ||
:docnumber: YY-999 | ||
:comment: ### Date on which the standard was updated; mandatory | ||
:received-date: 2029-03-30 | ||
:comment: ### Date on which the standard was approved by the issuing authority; mandatory | ||
:issued-date: 2029-03-30 | ||
:comment: ### Date on which the standard was published; mandatory | ||
:published-date: 2029-03-30 | ||
:comment: ### Author one | ||
:fullname: Editor One | ||
:comment: ### Author two | ||
:fullname_2: Editor Two | ||
:comment: ### Role of the authors; mandatory | ||
:role: editor | ||
:comment: ### Comma delimited keywords; mandatory | ||
:keywords: ogcdoc, OGC document, API, openapi, html | ||
:comment: ### Semicolon-delimited list of the submitting organizations; mandatory | ||
:submitting-organizations: Organization one; Organization two; Organization three | ||
:comment: ### Metanorma flavor; mandatory | ||
:mn-document-class: ogc | ||
:comment: ### Desired output formats; mandatory | ||
:mn-output-extensions: xml,html,doc,pdf | ||
:comment: ### Enable local relaton cache for quick inclusion of prefetched references; optional. For further information, visit: https://www.metanorma.org/author/ref/document-attributes/#caches, https://www.metanorma.org/author/topics/building/reference-lookup/#lookup-result-caching | ||
:local-cache-only: | ||
:comment: ### URI to which the PDF version of this standard is published; optional | ||
:pdf-uri: ./document.pdf | ||
:comment: ### URI to which the XML version of this standard is published; optional | ||
:xml-uri: ./document.xml | ||
:comment: ### URI to which the DOC version of this standard is published; optional | ||
:doc-uri: ./document.doc | ||
:comment: ### Version number; optional. Dot-delimited, preferably with this structure <version number>.<minor version number> | ||
:edition: 1.0 | ||
|
||
//// | ||
Make sure to complete each included document | ||
//// | ||
include::sections/clause_0_front_material.adoc[] | ||
|
||
include::sections/clause_1.adoc[] | ||
|
||
//use annexes as needed | ||
include::sections/annex-n.adoc[] | ||
|
||
//// | ||
Revision History should be the last annex before the Bibliography | ||
Bibliography should be the last annex | ||
//// | ||
include::sections/annex-history.adoc[] | ||
|
||
include::sections/annex-bibliography.adoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Figures go here. | ||
|
||
Each figure is a separate file with the naming convention: | ||
|
||
"FIGn.xxx" where "n" is a number with leading zeroes appropriate for the total number of figures and "xxx" is the appropriate extension for the file type. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Image files for graphics go here. Image files for figures go in the "figures" directory. Only place in here images not used in figures (e.g., as parts of tables, as logos, etc.) | ||
|
||
Each graphic is a separate file with the naming convention: | ||
|
||
"GRPn.xxx" where "n" is a sequential number with leading zeroes appropriate for the total number of graphics and "xxx" is the appropriate extension for the file type. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
[bibliography] | ||
[[Bibliography]] | ||
== Bibliography | ||
|
||
[NOTE] | ||
.Example Bibliography (Delete this note). | ||
=============================================== | ||
The TC has approved Springer LNCS as the official document citation type. | ||
Springer LNCS is widely used in technical and computer science journals and other publications | ||
* For citations in the text please use square brackets and consecutive numbers: [1], [2], [3] | ||
– Actual References: | ||
[n] Journal: Author Surname, A.: Title. Publication Title. Volume number, Issue number, Pages Used (Year Published) | ||
[n] Web: Author Surname, A.: Title, http://Website-Url | ||
=============================================== | ||
|
||
* [[[OGC2015,OGCTB12]]], _OGC: OGC Testbed 12 Annex B: Architecture_ (2015). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
[appendix] | ||
== Revision History | ||
|
||
[width="90%",options="header"] | ||
|=== | ||
|Date |Release |Editor | Primary clauses modified |Description | ||
|2016-04-28 |0.1 |G. Editor |all |initial version | ||
|=== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
[appendix] | ||
:appendix-caption: Annex | ||
== Title | ||
|
||
[NOTE] | ||
Place other Annex material in sequential annexes beginning with "A" and leave final two annexes for the Revision History and Bibliography |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
|
||
//// | ||
== Keywords | ||
|
||
Keywords inserted here automatically by Metanorma | ||
//// | ||
.Preface | ||
[NOTE] | ||
==== | ||
Insert Preface Text here. Give OGC specific commentary: describe the technical content, reason for document, history of the document and precursors, and plans for future work. | ||
There are two ways to specify the Preface: "simple clause" or "full clasuse" | ||
If the Preface does not contain subclauses, it is considered a simple preface clause. This one is entered as text after the `.Preface` label and must be placed between the AsciiDoc document attributes and the first AsciiDoc section title. It should not be give a section title of its own. | ||
If the Preface contains subclauses, it needs to be encoded as a full preface clause. This one is recognized as a full Metanorma AsciiDoc section with te title "Preface", i.e. `== Preface`. (Simple preface content can also be encoded like full preface.) | ||
==== | ||
//// | ||
*OGC Declaration* | ||
//// | ||
//// | ||
[THIS TEXT IS ALREADY ADDED AUTOMATICALLY IN THE FRONTISPIECE OF ALL OGC DOUCMENTS] | ||
|
||
Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. The Open Geospatial Consortium shall not be held responsible for identifying any or all such patent rights. | ||
|
||
Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the standard set forth in this document, and to provide supporting documentation. | ||
//// | ||
//// | ||
NOTE: Uncomment ISO section if necessary | ||
|
||
*ISO Declaration* | ||
|
||
ISO (the International Organization for Standardization) is a worldwide federation of national standards bodies (ISO member bodies). The work of preparing International Standards is normally carried out through ISO technical committees. Each member body interested in a subject for which a technical committee has been established has the right to be represented on that committee. International organizations, governmental and non-governmental, in liaison with ISO, also take part in the work. ISO collaborates closely with the International Electrotechnical Commission (IEC) on all matters of electrotechnical standardization. | ||
|
||
International Standards are drafted in accordance with the rules given in the ISO/IEC Directives, Part 2. | ||
|
||
The main task of technical committees is to prepare International Standards. Draft International Standards adopted by the technical committees are circulated to the member bodies for voting. Publication as an International Standard requires approval by at least 75 % of the member bodies casting a vote. | ||
|
||
Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. ISO shall not be held responsible for identifying any or all such patent rights. | ||
//// | ||
[abstract] | ||
== Abstract | ||
<Insert Abstract Text here> | ||
[.preface] | ||
== Security Considerations | ||
//If no security considerations have been made for this Standard, use the following text. | ||
No security considerations have been made for this Standard. | ||
//// | ||
If security considerations have been made for this Standard, follow the examples found in IANA or IETF documents. Please see the following example. | ||
|
||
“VRRP is designed for a range of internetworking environments that may employ different security policies. The protocol includes several authentication methods ranging from no authentication, simple clear text passwords, and strong authentication using IP Authentication with MD5 HMAC. The details on each approach including possible attacks and recommended environments follows. | ||
|
||
Independent of any authentication type VRRP includes a mechanism (setting TTL=255, checking on receipt) that protects against VRRP packets being injected from another remote network. This limits most vulnerabilities to local attacks. | ||
NOTE: The security measures discussed in the following sections only provide various kinds of authentication. No confidentiality is provided at all. This should be explicitly described as outside the scope....” | ||
//// | ||
//// | ||
== Submitting organizations | ||
|
||
Submitting organisations added automatically by Metanorma from document attributes | ||
//// | ||
[.preface] | ||
== Submitters | ||
All questions regarding this submission should be directed to the editor or the submitters: | ||
|=== | ||
|Name |Affiliation |OGC member | ||
|Steve Liang | University of Calgary, Canada / SensorUp Inc. | Yes | ||
|=== | ||
[.preface] | ||
== Contributors | ||
//This clause is optional. | ||
Additional contributors to this Standard include the following: | ||
Individual name(s), Organization | ||
[NOTE] | ||
==== | ||
If you need to place any further sections in the preface area | ||
use the `[.preface]` attribute. | ||
==== | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
== Section Header | ||
//write text in as many clauses as necessary. Use one document or many, your choice! |