Path: ...!eternal-september.org!feeder3.eternal-september.org!news.eternal-september.org!eternal-september.org!.POSTED!not-for-mail
From: Harald Oehlmann <wortkarg3@yahoo.com>
Newsgroups: comp.lang.tcl
Subject: Re: Sample markup documentation file for a Tcl/Tk package
Date: Thu, 23 Jan 2025 15:54:41 +0100
Organization: A noiseless patient Spider
Lines: 67
Message-ID: <vmtl7h$1h979$2@dont-email.me>
References: <vmloku$30le9$1@dont-email.me> <87sepaev0t.fsf@pointsman.de>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
Injection-Date: Thu, 23 Jan 2025 15:54:42 +0100 (CET)
Injection-Info: dont-email.me; posting-host="e063327a9a3c19a3d9f9f7e4e2a348de";
	logging-data="1615081"; mail-complaints-to="abuse@eternal-september.org";	posting-account="U2FsdGVkX1+M7xu0HYW4j/v8b+QqW+Js"
User-Agent: Mozilla Thunderbird
Cancel-Lock: sha1:boJi+2/bttCLfYuL08USZNJVFio=
Content-Language: en-GB
In-Reply-To: <87sepaev0t.fsf@pointsman.de>
Bytes: 3161

Hi Rolf,
I also tried it.

All the special syntax like [string]{.optarg} does not render for me.
But anyway, it is done.

For me, it looks better without style sheet, as the style sheet changes 
some fonts, and some not.

I have added horizontal lines to avoid the strange spacing.

Anyway, early beginner...

Here is the result.

https://github.com/oehhar/zxing-cpp-wrapper-tcl/tree/master/wrappers/tcl/doc

To get the stylesheet version, just put "main.css" beside it ;-).

Thanks for all,
Harald

Am 22.01.2025 um 16:19 schrieb Rolf Ade:
> 
> 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 ?
>>