[Cuis-dev] Documenting a package in TerseGuide

[Nahuel Garbezza]

Hi Nicola!

TerseGuideTopic was made for adding topics without touching the TerseGuide
package. You create a subclass of it, in any package, and the TerseGuide
will pick it.

The interface with it might need some tweaking, but you can redefine the
#script message and write your topic as a long string. And #title that is
also required.

I made this initial implementation, I'm happy to discuss how to improve it
:)

Thanks,
Nahuel

El mar, 3 de ago. de 2021 a la(s) 14:19, Nicola Mingotti via Cuis-dev (
cuis-dev at lists.cuis.st) escribió:

> Hi,
>
> I was trying to put the documentation of 'my' Regex package
> into the TerseGuide when I hit a roadblock.
>
> Apparently what I am supposed to do is to subclass TerseGuideTopic
> but that is way too restrictive and forces me to type one liners where
> I would like to write more descriptive text. Regexp are tricky.
>
> Do you know any way I could achieve that without modifying
> the TerseGuide package ?
>
> I would like to write my documentation as a long string, as does for
> example: TerseGuideHelp -> coding.
>
> bye
> Nicola
>
>
>
>
>
> --
> Cuis-dev mailing list
> Cuis-dev at lists.cuis.st
> https://lists.cuis.st/mailman/listinfo/cuis-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.cuis.st/mailman/archives/cuis-dev/attachments/20210804/ea17ad41/attachment.htm>