Re: Sample markup documentation file for a Tcl/Tk package

Am 24.01.2025 um 09:24 schrieb TorstenBerg:

Hi,
 what did you use to produce the HTML with? For TIP 700, I propose Pandoc
for now as we do not yet have our own Tcl library that is capable of all
the markdown constructs we would like to have.
 Especially the `[string]{.optarg}` construct you mention is not possible
to render with e.g. the tcllib markdown module as it is a Pandoc
markdown syntax element.
 If you need to render it with Pandoc, you have to specify the
corresponding CSS element (Pandoc translates `.optarg` into a CSS class)
which could look like this (untested):
 optarg {
  font-style: italic;
   &:before {
    content: '?';
  }
   &:after {
    content: '?';
  }
}
  Regards, Torsten

Hi Torsten,
thanks for your contribution.
That is all ok and great.
I was following the steps described by Rolf:
- download pandoc.exe
- take main.css from https://github.com/ShaunKulesa/Docs-Maker/tree/main/docs
- invoke Pandoc as described by Rolf:
pandoc\pandoc.exe --standalone -f markdown -t html zxingcpp.md  --css main.css -o zxingcpp.html
- follow TIP700 syntax ({.optorg} etc.)
It is not a problem, that it does not work now.
When the documentation system is ready, I will enhance this.
Thanks for all the work and thanks for the {.optorg} explanation.
Take care,
Harald