Automatic Layout and Publishing of Scientific and Software Documentation

  • Dmitry Pavlov Institute of Applied Astronomy RAS, Saint Petersburg, Russia

Abstract

The article presents a new tool for automatic layout and publishing of scientific and software documentation in accordance with the requirements of GOST, the Russian national standards. The tool is called GOSTdown (GOST + Markdown) and is designed for large documents created jointly by several participants. Usually such documents are developed in Microsoft Word. GOSTdown is a set of templates and scripts that allow users to work on the content of a document in Markdown format, resulting in an automatically assembled document in DOCX format that does not require manual modification. GOSTdown is based on a universal document converter Pandoc and the Powershell scripting language.

Author Biography

Dmitry Pavlov, Institute of Applied Astronomy RAS, Saint Petersburg, Russia

Dmitry A. Pavlov, Senior researcher at the Laboratory of Ehemeris Astronomy, Institute of Applied Astronomy RAS; 191187 Russia, Saint Petersburg, Kutuzova Embankment 10, IAA RAS, dpavlov@iaaras.ru

References

1. Thompson K., Ritchie D. M. Unix Programmer’s Manual. Bell Labs, 1971.
2. Knuth D. E. The TEXbook. Reading. Mass.: Addison Wesley, 1984. 483 pp.
3. MacFarlane J. Pandoc User’s Guide (2018). URL: http://pandoc.org/MANUAL.pdf (Retrieved 16.12.2018).
4. ECMA. ECMA-376: Office Open XML File Formats. ECMA (European Association for Standardizing
Information and Communication Systems), Geneva, Switzerland (2006). URL: http://www.
ecma-international.org/publications/standards/Ecma-376.htm (Retrieved 16.12.2018).
5. Rintze M. Zelle, CSL 1.0.1 Specification. URL: http://docs.citationstyles.org/en/1.0.1/specification.html
(Retrieved 16.12.2018).
6. URL: https://github.com/citation-style-language/styles/blob/master/gost-r-7-0-5-2008-numeric.csl
(Retrieved 16.12.2018).
7. Pandoc-crossref. URL: http://lierdakil.github.io/pandoc-crossref/ (Retrieved 16.12.2018).
8. URL: https://gitlab.iaaras.ru/iaaras/gostdown (Retrieved 16.12.2018).
Published
2018-12-28
How to Cite
PAVLOV, Dmitry. Automatic Layout and Publishing of Scientific and Software Documentation. Computer Tools in Education, [S.l.], n. 6, p. 39-46, dec. 2018. ISSN 2071-2359. Available at: <http://cte.eltech.ru/ojs/index.php/kio/article/view/1554>. Date accessed: 22 july 2019. doi: https://doi.org/10.32603/2071-2340-2018-6-39-46.
Section
Computers in the teaching process