[Cuis-dev] Documenting a package in TerseGuide

[Nicola Mingotti]

Hi Nahuel !

The method you proposed work. Thank you !
Tomorrow I start to write the TerseGuide for Regex.

I would add what you said to the TerseGuideTopic class description pane.
I can do it if you wish. I will make some exercise with github 
procedures ;)

I consider the TerseGuide a very handy tool. Especially for people who
come from other languages.

I think TerseGuide really needs at least one improvement though; the 
possibility of
sorting alphabetically the entry titles, on the left morph, or it is
inefficient to find stuff.

This we can both do, for me it will take a while, because still I need
to study the Cuis Morphic and still I have a handful little problems
in Cuis that I should sort out before attacking another problem.

Bye
Nicola







On 8/4/21 8:40 PM, Nahuel Garbezza wrote:
> 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 <mailto: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 <mailto:Cuis-dev at lists.cuis.st>
>     https://lists.cuis.st/mailman/listinfo/cuis-dev
>     <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/02ee926b/attachment-0001.htm>