metanorma / metanorma-csa Goto Github PK

View Code? Open in Web Editor NEW

1.0 11.0 1.0 2.8 MB

Metanorma processor to generate CSA Standard Documents

License: BSD 2-Clause "Simplified" License

Ruby 6.49% Shell 0.02% HTML 7.76% XSLT 76.69% SCSS 9.05%

metanorma-csa's Introduction

Metanorma processor for CSA documents

Functionality

This gem processes Metanorma documents following a template for generating CSA documents.

The gem currently inherits from the https://github.com/metanorma/metanorma-standoc gem, and aligns closely to it. Refer to the ISO gem documentation for guidance, including https://github.com/metanorma/metanorma-iso/wiki/Guidance-for-authoring

The following outputs are generated.

Metanorma XML
HTML output (from Metanorma XML)
PDF output (from Metanorma XML)

Usage

The preferred way to invoke this gem is via the metanorma command:

$ metanorma --type csa a.adoc                   # output just HTML
$ metanorma --type csa a.adoc --extensions html # output just HTML
$ metanorma --type csa a.adoc --extensions xml  # output CSAND XML

The gem translates the document into CSAND XML format, and then validates its output against the CSAND XML document model; errors are reported to console against the XML, and are intended for users to check that they have provided all necessary components of the document.

The gem then converts the XML to HTML, and outputs that files with the appropriate .html suffix.

Installation

If you are using a Mac, the https://github.com/metanorma/metanorma-macos-setup repository has instructions on setting up your machine to run Metanorma scripts such as this one. You need only run the following in a Terminal console:

$ bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup)
$ gem install metanorma-csa

Documentation

See Author Cloud Security Alliance documents with Metanorma-CSAND.

Examples

See https://github.com/metanorma/mn-samples-csa for sample documents.

Notes

Metanorma-CSA was formerly published as asciidoctor-csand.

metanorma-csa's People

Contributors

Stargazers

Watchers

Forkers

webdev778

metanorma-csa's Issues

Refactor HTML CSS

metanorma/isodoc#112

Add

Boilerplate and copyright text should be in MN XML

Move to Nokogiri::XSLT and remove ruby-xslt dependency

We can simplify our dependency list and skip some problem with ruby-xslt on windows plurimath/omml2mathml#5

cc @ronaldtse

Add authorship modeling of CSA documents

Add authorship modeling of CSA documents.

They currently have:

Lead Authors
Contributors
Staff ("CSA Global Staff")
Reviewers

Originally posted by @opoudjis in metanorma/mn-samples-csa#1 (comment)

Enabling CSA designed documents

Sample:
CSA DSO Information Security Management through Reflexive Security.pdf

This content is available on mn-samples-csa.

Requirement subparts CSS formatting

The attached is a sample of HTML with recommendations in it, in the CSAND Metanorma flavour. Recommendations are not heavily styled to date, although in OGC recommendations have been styled as having a pale green background.

The requirement from @ronaldtse is to introduce some CSS styling to these recommendations. I do not know whether this will be permanently incorporated into CSAND or other Metanorma flavours, and I also do not have particular opinions about how this would work.

As you will see from the attached:

Recommendations are signalled by class .recommend; there is also class .permission and .requirement.

Recommendations can be nested.

Recommendations have components, which are presented in HTML as divs, with the classes .requirement-inherit (the recommendation that this recommendation inherits from), .requirement-description, .requirement-specification, .requirement-measurement-target, .requirement-verification, .requirement-import.

These components can mix normal prose and source code (in <pre>).

@ronaldtse will have more opinions than me as to how this should be rendered.

a.html.zip

Render personal authors if present

Follows from #31; personal authors to be rendered with the same XML as in metanorma-cc, except:

The type of contributor is //bibdata/contributor/role/@type if it is not "author"
The type of contributor is //bibdata/contributor/role/description if //bibdata/contributor/role/@type is "author"
The author type needs to be capitalised
The sequence of author types is: full-author (omitted), Contributor, Staff, Reviewer

CSANormalDocument has CSA BibItem
CSA BibItem has CSA Committee
Update CSA DocumentType and CSA CommitteeType