Software documentation with markdoc 5.0-Reference-Cited by-同舟云学术

Software documentation with markdoc 5.0

Published:2020-06 Issue:2 Volume:20 Page:336-362
ISSN:1536-867X
Container-title:The Stata Journal: Promoting communications on statistics and Stata
language:en
Short-container-title:The Stata Journal

Author:

Haghish E. F.¹

Affiliation:

1. Department of Medical Psychology and Medical Sociology, University of Göttingen, Göttingen, Germany,

Abstract

markdoc is a general-purpose literate programming package for generating dynamic documents, dynamic presentation slides, Stata help files, and package vignettes in various formats. In this article, I introduce markdoc version 5.0, which performs independently of any third-party software, using the mini engine. The mini engine is a lightweight alternative to Pandoc (MacFarlane [2006, https://pandoc.org/ ]), completely written in Stata. I also propose a procedure for remodeling package documentation and data documentation in Stata and present a tutorial for generating help files, package vignettes, and GitHub Wiki documentation using markdoc.

Publisher

SAGE Publications

Subject

Mathematics (miscellaneous)

Link

http://journals.sagepub.com/doi/pdf/10.1177/1536867X20931000

Reference31 articles.

1. Baum C. F. 2011. Submitting and retrieving materials from the SSC Archive. Department of Economics, Boston College. http://repec.org/bocode/s/sscsubmit.html.

2. Briand L. C. 2003. Software documentation: How much is enough? In 2003 IEEE Seventh European Conference on Software Maintenance and Reengineering, 13–15. Benevento, Italy: IEEE. https://doi.org/10.1109/CSMR.2003.1192406.

3. Brown P. J. 1974. Programming and documenting software projects. ACM Computing Surveys 6: 213–220. https://doi.org/10.1145/356635.356637.

4. Cordes D., Brown M. 1991. The literate-programming paradigm. IEEE Computer 24: 52–61. https://doi.org/10.1109/2.86838.

5. Gruber J. 2004. Markdown: Syntax. http://daringfireball.net/projects/markdown/syntax.

Cited by 1 articles. 订阅此论文施引文献订阅此论文施引文献，注册后可以免费订阅5篇论文的施引文献，订阅后可以查看论文全部施引文献

1. Developing, maintaining, and hosting Stata statistical software on GitHub;The Stata Journal: Promoting communications on statistics and Stata;2020-12