Re: [Gretl-devel] Contributing to the documentation
On Mon, 5 Nov 2012, Henrique Andrade wrote:
The examples I'm willing to introduce in the Help are very simple
ones. Let
me give you an example that I used today: the "colnames" function.
<gretl help>
colnames
Output: scalar
Arguments: M (matrix)
s (named list or string)
Attaches names to the columns of the T×k matrix M.
If s is a named list, the column names are copied
from the names of the variables; the list must have
k members. If s is a string, it should contain k
space-separated sub-strings. The return value is 0
on successful completion, non-zero on error. See
also rownames.
*Example:
open australia.gdt
matrix M = {PAU, PUS, IAU, IUS}
colnames(M, "PAU PUS IAU IUS")*
</gretl help>
So I think is something too small too deserve a wiki :-)
In this case, you're welcome to edit the xml files you find in the source
tree under doc/commands. You can use any editor you want (I use emacs),
and the xml syntax is very intuitive. IIRC, you should already have commit
rights to the sourceforge tree, so you can make the changes yourself.
--------------------------------------------------
Riccardo (Jack) Lucchetti
Dipartimento di Economia
Università Politecnica delle Marche
(formerly known as Università di Ancona)
r.lucchetti(a)univpm.it
http://www2.econ.univpm.it/servizi/hpp/lucchetti
--------------------------------------------------