Re: [Gretl-devel] Standards for function package help
Am 21.08.2018 um 17:29 schrieb Henrique Andrade:
m 21 de agosto de 2018, Sven escreveu:
(...)
> 2: Another already mentioned gap are the zip packages without pdf file.
Just one "newbie" thought: I can't remember why we have zip as a
function format in addition to the gfn.
gfn is a single-file text format (being
XML). If a package author wants
to add other arbitrary files (including, but not only, PDF files) that
are needed or useful for the package, it has to be the zipped format.
Inside the zip thing there will still be a gfn file.
> 3: Then the "markdown" business for plain --or not so
plain-- text help
> docs.
I really think markdown offers the best solution when we think about
the trade-off between "easy of use" and "flexibility". But we
can't
forget we need to choose the markdown implementation we will follow
(CommonMark, GitHub Flavored Markdown, etc.)
Exactly -- what's your
recommendation or opinion?
I think we can use something we are already familiar with (but
I'm not sure about possible indentation issues):
<hansl>
markdown
# your code
end markdown
</hansl>
Well, we're talking about the help text in general, not hansl
code. I
see no real reason to use a hansl-style markdown - end markdown block here.
A more simple and direct alternative is just write a
"help.md" file
inside the function folder.
For a plain-text help everything has to be inside the
single gfn file,
additional files are not possible.
cheers,
sven
Attachments:
- attachment.html (text/html — 2.5 KB)