Statalist


[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

st: RE: TeX template for PDF help files


From   "Martin Weiss" <martin.weiss1@gmx.de>
To   <statalist@hsphsun2.harvard.edu>
Subject   st: RE: TeX template for PDF help files
Date   Sun, 22 Nov 2009 10:08:40 +0100

<>

" Has anyone prepared a
template for this already? What are the pros and cons of the PDF
documentation (which is a de-facto standard for the rest of the
software) versus SMCL documentation?"



One of the "cons" is that the integration with the official pdf manuals - in
terms of links to things like -varlist- - is not easily established. This is
not a problem with the smcl files. 


HTH
Martin

-----Original Message-----
From: owner-statalist@hsphsun2.harvard.edu
[mailto:owner-statalist@hsphsun2.harvard.edu] On Behalf Of Sergiy Radyakin
Sent: Sonntag, 22. November 2009 03:34
To: statalist@hsphsun2.harvard.edu
Subject: st: TeX template for PDF help files

Dear All,

I wonder what does the community think about having help files for
custom ados being in PDF format (in light of the recent availability
of the Stata manuals in the said format)? Has anyone prepared a
template for this already? What are the pros and cons of the PDF
documentation (which is a de-facto standard for the rest of the
software) versus SMCL documentation?

In my opinion, the unpleasant task of preparing documentation in SMCL
is a major barrier to release user-written ados to the public (and
there was a complaint recently regarding "no fresh original
programs"). In my vision, the simplier this template is, the more
likely the next generation of ado files will be more completely
described. Perhaps the Stata gurus could take the initiative and
collectively make this template for the rest of us? Now could be the
right moment to standardize this (similar to the SJ template), before
custom versions start to appear.

2Kit: since PDF files are not installed with the package by default,
what are the recommendations if I want to deploy my package with a PDF
documentation only?
2Stata developers: Would it be possible to make -help mycommand- also
check for the presense of mycommand.pdf in case mycommand.sthlp and
mycommand.hlp are not found?

Thank you, Sergiy Radyakin
*
*   For searches and help try:
*   http://www.stata.com/help.cgi?search
*   http://www.stata.com/support/statalist/faq
*   http://www.ats.ucla.edu/stat/stata/

*
*   For searches and help try:
*   http://www.stata.com/help.cgi?search
*   http://www.stata.com/support/statalist/faq
*   http://www.ats.ucla.edu/stat/stata/



© Copyright 1996–2014 StataCorp LP   |   Terms of use   |   Privacy   |   Contact us   |   What's new   |   Site index