D1.3e-Infrastructure-Sentinel-report

Deliverable 1.3 - e-Infrastructure Sentinel Report for the Sci-GaIA project http://www.sci-gaia.eu/deliverables/

This repository contains the source necessary to build the document. The document is built with pandoc - see below.

Note :

• The main file is : D1.3-e-Infra-Sentinel-Report.md. This is used to build the other formats (pdf, odt - see below)
• Looking for PDF / DOC ? If you want a pre-compiled document to read, in a .pdf or .odt file, see the Github Releases. This contains the latest succesful build of a release of the document.
• Comments ? If you would to comment on the document, please open a topic on the forum under the topic
• Errors ? Open an issue
• Contributions ? If you would like to contribute to the document, please fork the repository and send your suggestions in a pull request.
  • I want to send you contributions in some other way - whatever works for you, friend - send it over.

Building the document

Travis builds the .odt and .pdf automatically on tagged commits. See the Travis file to see what is done in detail. The following steps are done :

1. Convert images where necessary
2. Conduct spell check
3. Build the document with pandoc
4. Push release on successful build, if tagged

Pandoc

We use pandoc to create the document :

pandoc -S --filter pandoc-fignos \
--filter pandoc-tablenos \
--variable mainfont="Lato" \
--variable sansfont="Lato" \
--variable monofont="Roboto" \
--variable fontsize=12pt \
--variable version=1.17.2 \
--reference-odt="deliverable-template.ott" \
--filter pandoc-citeproc \
--csl="institute-of-physics-numeric.csl" \
--number-sections \
--toc \
--from markdown+implicit_figures+table_captions+pipe_tables+footnotes+inline_notes+yaml_metadata_block \
D1.3-e-Infra-Sentinel-Report.md  -o D1.3-e-Infra-Sentinel-Report.odt

You will need the filters available in your distribution of pandoc.

Spell checking

We use aspell to check the spelling of the document with a custom dictionary kept in the repo.

cat D13-e-Infra-Sentinel-Report.md | aspell --pipe --encoding utf-8|grep -v \* | uniq

Bibliography

The bibliography used in the document is in bibliograhy.yaml. It uses the citeproc-yaml filter for pandoc.

Releases

Releases follow a numbering convention as follows :

• Major versions e.g. v1.0.0 : Public versions, passed internal review and checking.
• Minor versions e.g. v0.1.0 : Internal releases, awaiting review
• Patch versions e.g. v0.0.1 : Work in progress tags.