Skip to content

oasis-tcs/odata-specs

Repository files navigation

PoC for Markdown as Authoritative specification source

Section and example numbers and references to them are expressed in the Markdown source as follows:

# ##sec Section Heading
## ##subsec Subsection Heading
### ##subsubsec Subsubsection Heading
Example ##ex: Example
Example ##ex_aggregation: Referenceable example
See [here](#SubsectionHeading). Reference to a subsection.
See [subsection #SubsectionHeading]. Reference to a subsection showing its number.
See [this example](##aggregation). Reference to an example.
See [example ##aggregation]. Reference to an example showing its number.

Long mathematical formulas, especially multi-row ones such as $$\matrix(...)$$, can be typed on multiple lines, if each line except the last ends with a single space.

This additional syntax is resolved with the Node.js module lib/number.js.

Run npm start to start a Node.js server and access the HTML pages at, for example, http://localhost/odata-data-aggregation-ext.

Run npm run build to build HTML and Markdown files for publication on github.io.

To Do

  • Auto-generate table of content with links to sections
  • Make section headlines self-links as in the Core specifications
  • Use same anchor naming convention sec_CondensedHeadlineText as in Core specifications?
  • Fixed scaling of pictures instead of auto-scaling to page width?
  • Align structure of /docs subfolders with OASIS publication folder structure, see https://docs.oasis-open.org/openc2/oc2ls/v1.0/cs02/
    • OASIS filenames for .md and .html instead of constant README.md and index.html
    • include OASIS CSS file in styles subfolder to have snapshot of styles at point of document production
  • Use OASIS work product abbreviation for folder names: odata-data-aggregation-ext instead of odata-aggr
  • Cross-check compliance with OASIS Editor's Manual
  • Check MD/HTML for broken and inconsistent links (similar to what we currently do with the ExtractHyperlinksToExcel Word macro)
  • Request starter Markdown document and align our MD files with it
  • Check diagram sources (Visio) into repository
  • Describe export process for diagrams to SVG