Re: [Gretl-devel] function package help text: pdf question
On Thu, 8 Oct 2015, Allin Cottrell wrote:
On Thu, 8 Oct 2015, Henrique Andrade wrote:
> What do you think about creating a LaTeX (or/and Word/Writer) template to
> distribute to the authors to use when they prefer to write the help in pdf
> format? Of course it would be based upon the official docs. Allin, if you
> wish, I can help with this.
Good idea. I've thought about that myself but haven't yet done anything. We
already have the style file gretl.sty that's used for the gretl TeX
documentation. It's oriented to the book document-class but could be adapted
for the article class quite easily, I think.
The help files for the addons already contain something like that. For
example, if you take the preamble to addons/SVAR/SVAR.tex you get several
definitions you can reuse for your own function package. I guess we could
create a sty file containing (roughly) the first 70 lines of SVAR.tex and
use that as an include file.
Also, if your package needs substantial documentation, consider the
possibility of delegating the help proper to a gretl working paper (like
we do fo the DPB package for dynamic binary panel probit and logit
models), with only a quick pointer in the package.
-------------------------------------------------------
Riccardo (Jack) Lucchetti
Dipartimento di Scienze Economiche e Sociali (DiSES)
Università Politecnica delle Marche
(formerly known as Università di Ancona)
r.lucchetti(a)univpm.it
http://www2.econ.univpm.it/servizi/hpp/lucchetti
-------------------------------------------------------