Re: Documentation strings, declarations, markup, metadata
Jakub T. Jankiewicz 25 May 2024 12:01 UTC
And of course this is not only for new Scheme implementation, if the tool
support only markdown and someone create a R7RS library and if he prefers to
use LaTeX instead of Markdown be can implement a plugin for doc tool and
generate documentation for his library using LaTeX that was originally not
supported.
On Sat, 25 May 2024 13:51:24 +0200
Jakub T. Jankiewicz - jcubic at onet.pl (via srfi-discuss list)
<xxxxxx@srfi.schemers.org> wrote:
> On Sat, 25 May 2024 13:32:31 +0300
> Lassi Kortela <xxxxxx@lassi.io> wrote:
>
> > #markup("# Title
> >
> > paragraph")
>
> Why not use normal string that will be simple to implement and put special
> syntax inside the string as part of the markup that tools that generate
> documentation will understand like:
>
> "#!markdown
>
> # Title
>
> Paragraph"
>
> With this when new documentation language will be create there will be no
> need to change the Scheme interpreter to support it. Scheme code will be the
> same only the tool will change. When some tool will support LaTeX you only
> need:
>
> "#!latext
>
> \section*{This is the title}
>
> Paragraph"
>
> The tool that generate documentation can even allow to write plugins for
> those markup languages, so the tool also could stay the same and person that
> write documentation for new Scheme that he just created can invent his own
> markup languages and plug into the tool.
>
--
Jakub T. Jankiewicz, Senior Front-End Developer
https://jcubic.pl/me
https://lips.js.org
https://koduj.org