Skip to content

Package Structure

E. F. Haghish edited this page Oct 1, 2018 · 4 revisions

For those who wish to contribute to MarkDoc, this document can behave as a quick reference to different source files included in the package.

The main engine of MarkDoc is markdoc.ado. This program calls many other programs as well to keep the syntax coherent. Here, these commands are explained.

Dynamic document and dynamic slides

The programs involved with making dynamic documents and slides are the same. markdoc.ado takes care of translating SMCL log files and generating these documents. However, if a do-file is specified as a source, markdoc will call rundoc program, defined in rundoc.ado. rundoc is called for executing Stata commands in a particular way to allow passive dynamic text.

Dynamic Stata help files (sthlp)

For producing Stata help files and SMCL files, you should read sthlp.ado, markup.ado, and md2smcl.ado. Here is a description of other script files:

Other files

  • markdocversion.ado checks the new updates available for MarkDoc, if there is any
  • markdoccheck.ado checks the required third-party software on the machine and if the install option is specified, it install the required software
  • markdocpandoc.ado installs Pandoc automatically, if the install option is specified and the software is not found
  • markdocwkhtmltopdf.ado installs wkhtmltopdf automatically, if the install option is specified and the software is not found