Sujet : Re: Sample markup documentation file for a Tcl/Tk package
De : rolf (at) *nospam* pointsman.de (Rolf Ade)
Groupes : comp.lang.tclDate : 22. Jan 2025, 16:19:14
Autres entêtes
Organisation : Me
Message-ID : <87sepaev0t.fsf@pointsman.de>
References : 1
User-Agent : Gnus/5.13 (Gnus v5.13)
Harald Oehlmann writes:
Dear Tcl/Tk group,
I would love to author the documentation of my latest package in
markup (following TIP700 ;-) ).
To get a feeling what TIP 700 [1] mean in praxis some weeks ago I
started to transfer the ooxml documentation into the markdown variant
proposed by the TIP (note to myself: I should pick this up again and
finish it).
What I have done so far is [2].
As you I looked for examples and found [3], which has versions of
automatically from troff to md converted man pages of all Tcl (and Tk)
commands and C API functions.
Having the documentation as md source is only the start. To get the
man and HTML documentation from your new documentation sources you may
peek how I did [4] (which is far away from being canonical, just a fast
scribbled way for my simple case).
For the HTML you need some css. To have one I just picked up [5]
although I think someone™ should give some love to that.
rolf
[1]
https://core.tcl-lang.org/tips/doc/trunk/tip/700.md[2]
https://fossil.sowaswie.de/ooxml/file?name=doc/ooxml.md&ci=tip&txt=1[3]
https://github.com/ShaunKulesa/Docs-Maker/tree/main/docs[4]
https://fossil.sowaswie.de/ooxml/file?udc=1&ln=65-72&ci=tip&name=Makefile.in[5]
https://github.com/ShaunKulesa/Docs-Maker/tree/main/css>
Here is the package
https://github.com/oehhar/zxing-cpp-wrapper-tcl
>
Is there any example how to author the documentation in markup ?
>