4.8.1

haghish · Jun 10, 2019 · 32fe4ae · 32fe4ae
1 parent db45f52
commit 32fe4ae
Show file tree

Hide file tree

Showing 6 changed files with 81 additions and 190 deletions.
diff --git a/make.do b/make.do
@@ -3,24 +3,24 @@
 // DO NOT FORGET to update the version of the package, if changed!
 // for more information visit http://github.com/haghish/github
 
-make markdoc, replace toc pkg  version(4.8.0)                                ///
-     license("MIT")                                                          ///
-     author("E. F. Haghish")                                                 ///
-     affiliation("University of Goettingen")                                 ///
-     email("haghish@med.uni-goettingen.de")                                  ///
-     url("https://github.com/haghish/github")                                ///
-     title("a general-purpose literate programming package")                 ///
-     description("generate dynamic document, slides, stata help files, "     ///
-		             "and package vignette in various formats")                  ///
-     install("markdoc_formal.docx;markdoc_minimal.docx;markdoc_simple.docx;" ///
-		         "markdoc_stata.docx;markdoc_title.dlg;markdoc.ado;markdoc.dlg;" ///
-						 "markdoc.sthlp;markdoccheck.ado;markdocpandoc.ado;"             ///
-						 "markdocstyle.ado;markdocversion.ado;markdocwkhtmltopdf.ado;"   ///
-						 "markup.ado;mdconvert.ado;mdconvert.sthlp;mdminor.ado;"         ///
-						 "mdminor.sthlp;mini.ado;mini.dlg;mini.sthlp;pandoc.ado;"        ///
-						 "pandoc.sthlp;rundoc.ado;sthlp.ado;wkhtmltopdf.ado;"            ///
-						 "wkhtmltopdf.sthlp")                                            ///
-     iancillary("")                                                        
+make markdoc, replace toc pkg  version(5.0.0)                                   ///
+     license("MIT")                                                             ///
+     author("E. F. Haghish")                                                    ///
+     affiliation("University of Goettingen")                                    ///
+     email("haghish@med.uni-goettingen.de")                                     ///
+     url("https://github.com/haghish/github")                                   ///
+     title("a general-purpose literate programming package")                    ///
+     description("generate dynamic document, slides, stata help files, "        ///
+		             "and package vignette in various formats")                     ///
+     install("markdoc_formal.docx;markdoc_minimal.docx;markdoc_simple.docx;"    ///
+		         "markdoc_stata.docx;markdoc_title.dlg;markdoc.ado;markdoc.dlg;"    ///
+						 "markdoc.sthlp;markdoccheck.ado;markdocpandoc.ado;"                ///
+						 "markdocstyle.ado;markdocversion.ado;markdocwkhtmltopdf.ado;"      ///
+						 "markup.ado;mdconvert.ado;mdconvert.sthlp;mdminor.ado;"            ///
+						 "mdminor.sthlp;mini.ado;mini.dlg;mini.sthlp;pandoc.ado;"           ///
+						 "pandoc.sthlp;rundoc.ado;sthlp.ado;sthlp.sthlp;wkhtmltopdf.ado;"   ///
+						 "wkhtmltopdf.sthlp")                                               ///
+     ancillary("")                                                        
 
 
 

diff --git a/markdoc.ado b/markdoc.ado
@@ -2,23 +2,31 @@
 // . markdoc markdoc.ado, mini export(sthlp) replace
 
 /***
-_version 4.8.0_
+_version 5.0.0_
 
 markdoc
 =======
 
 __markdoc__ is a general-purpose literate programming package for Stata that
 produces _dynamic analysis documents_, _presentation slides_, as well as Stata
 package help files and package vignettes in various formats such as __pdf__, 
-__docx__, __html__, and __sthlp__. for further information see:
+__docx__, __html__, and __sthlp__. 
+
+for further information see:
 
 - [markdoc homepage](http://haghish.com/markdoc)
-- [journal article](http://haghish.com/resources/pdf/Haghish_markdoc.pdf)
+- [journal article](https://journals.sagepub.com/doi/abs/10.1177/1536867X1601600409)
 - [manual on Github wiki](https://github.com/haghish/markdoc/wiki)
+- [package vignette (pdf)](https://github.com/haghish/markdoc/blob/master/vignette.pdf)
 - [release notes on Github](https://github.com/haghish/markdoc/releases)
 - [examples on GitHub](https://github.com/haghish/markdoc/tree/master/Examples)
 - [please ask your questions on statalist.org](http://www.statalist.org/forums/forum/general-stata-discussion/general)
 
+> from version _5.0_ forth, __markdoc__ is 
+{err}fully functional without any third-party software{txt}, due to its new 
+light-weight [mini engine](https://github.com/haghish/markdoc/wiki/mini). Yet, 
+a full installation of __markdoc__ and its dependencies is recommended.
+
 Syntax
 ------
 
@@ -66,7 +74,6 @@ options related to software documentation:
 | Option                 | Description                                                                                      |
 |-------------------|--------------------------------------------------------------------------------------------------|
 | helplayout             | appends a Markdown help documentation to a stata script file                                     |
-| datalayout             | appends/creates a Markdown help documentation to a stata script file                             |
 
 
 and the following options are for communicating with the third-party software (not required in the __mini__ mode)
@@ -127,7 +134,7 @@ packages hosted on GitHub. you can install __github__ by typing:
 next, install the latest stable __markdoc__ release along with its Stata 
 dependencies by typing:
 
-        . github install haghish/markdoc
+        . github install haghish/markdoc, stable
 
 Description
 -----------
@@ -152,10 +159,6 @@ producing educational materials within Stata Do-file editor. For example:
 Software Installation
 ---------------------
 
-{err}
-REMEMBER, __markdoc__ v. 4.2 forth can run without any software dependencies, 
-using the [__mini__](https://github.com/haghish/markdoc/wiki/mini) engine. {txt}
-
 Without applying the __mini__ option, which uses the light-weight engine, 
 the markdoc package requires additional software which can be installed manually or 
 automatically. The required software are [Pandoc](http://pandoc.org/) and
@@ -501,7 +504,7 @@ program markdoc
     syntax [anything(name=smclfile id="The smcl file name is")]                 /// 
     [,               ///
     replace          /// replaces the exported file
-        mini             /// runs markdoc independent of Pandoc and wkhtmltopdf
+    mini             /// runs markdoc independent of Pandoc and wkhtmltopdf
     MARKup(name)     /// specifies the markup language used in the document
     Export(name)     /// specifies the exported format
     INSTALl          /// Installs the required software automatically

diff --git a/markdoc.pkg b/markdoc.pkg
@@ -1,9 +1,9 @@
 v 5.0.0
 d 'MARKDOC': a general-purpose literate programming package
 d 
-d generate dynamic document, slides, stata help files, and package vignette in various formats
+d generate dynamic document, slides, stata help files,  and package vignette in various formats
 d 
-d Distribution-Date:   20190605
+d Distribution-Date:   20190610
 d License: MIT
 d 
 F markdoc.ado

diff --git a/markdoc.sthlp b/markdoc.sthlp
@@ -1,5 +1,5 @@
 {smcl}
-{it:version 4.8.0}
+{it:version 5.0.0}
 
 
 {title:markdoc}
@@ -8,15 +8,24 @@
 {bf:markdoc} is a general-purpose literate programming package for Stata that
 produces {it:dynamic analysis documents}, {it:presentation slides}, as well as Stata
 package help files and package vignettes in various formats such as {bf:pdf}, 
-{bf:docx}, {bf:html}, and {bf:sthlp}. for further information see:
+{bf:docx}, {bf:html}, and {bf:sthlp}. 
+
+{p 4 4 2}
+for further information see:
 
 {break}    -  {browse "http://haghish.com/markdoc":markdoc homepage}
-{break}    -  {browse "http://haghish.com/resources/pdf/Haghish_markdoc.pdf":journal article}
+{break}    -  {browse "https://journals.sagepub.com/doi/abs/10.1177/1536867X1601600409":journal article}
 {break}    -  {browse "https://github.com/haghish/markdoc/wiki":manual on Github wiki}
+{break}    -  {browse "https://github.com/haghish/markdoc/blob/master/vignette.pdf":package vignette (pdf)}
 {break}    -  {browse "https://github.com/haghish/markdoc/releases":release notes on Github}
 {break}    -  {browse "https://github.com/haghish/markdoc/tree/master/Examples":examples on GitHub}
 {break}    -  {browse "http://www.statalist.org/forums/forum/general-stata-discussion/general":please ask your questions on statalist.org}
 
+{p 8 8 2} from version {it:5.0} forth, {bf:markdoc} is 
+{err}fully functional without any third-party software{txt}, due to its new 
+light-weight  {browse "https://github.com/haghish/markdoc/wiki/mini":mini engine}. Yet, 
+a full installation of {bf:markdoc} and its dependencies is recommended.
+
 
 {title:Syntax}
 
@@ -69,7 +78,6 @@ options related to software documentation:
 {col 5}Option{col 24}Description
 {space 4}{hline}
 {col 5}helplayout{col 24}appends a Markdown help documentation to a stata script file
-{col 5}datalayout{col 24}appends/creates a Markdown help documentation to a stata script file
 {space 4}{hline}
 
 {p 4 4 2}
@@ -135,7 +143,7 @@ packages hosted on GitHub. you can install {bf:github} by typing:
 next, install the latest stable {bf:markdoc} release along with its Stata 
 dependencies by typing:
 
-        . github install haghish/markdoc
+        . github install haghish/markdoc, stable
 
 
 {title:Description}
@@ -161,10 +169,6 @@ producing educational materials within Stata Do-file editor. For example:
 
 {title:Software Installation}
 
-{err}
-REMEMBER, {bf:markdoc} v. 4.2 forth can run without any software dependencies, 
-using the  {browse "https://github.com/haghish/markdoc/wiki/mini":{bf:mini}} engine. {txt}
-
 {p 4 4 2}
 Without applying the {bf:mini} option, which uses the light-weight engine, 
 the markdoc package requires additional software which can be installed manually or 

diff --git a/stata.toc b/stata.toc
@@ -1,9 +1,9 @@
-v 4.8.0
+v 5.0.0
 d Materials by E. F. Haghish
 d University of Goettingen
 d haghish@med.uni-goettingen.de
 d https://github.com/haghish/github
 
-d 'markdoc': generate dynamic document, slides, stata help files, and package vignette in various formats
+d 'markdoc': generate dynamic document, slides, stata help files,  and package vignette in various formats
 
 p markdoc