search

mdedwards / slippery-chicken

slippery chicken: algorithmic composition software in common lisp and clos
http://michael-edwards.org/sc
72 stars 3 forks source link

add tags to robodoc #101

Open mdedwards opened 6 months ago

mdedwards commented 6 months ago

We should add tags to various methods and functions to show in which scenarios particular algorithms are useful. For instance, the tag transitions would be useful for both Fibonacci transitions and the procession algorithm.

Robodoc accepts the TAGS keyword, and will pull it into the HTML and other documentation format (e.g. https://michael-edwards.org/sc/robodoc/l-for-lookup_lsp.html#robo283), but it won't provide a link to those tags at the top right of the generated, HTML page, for instance, where functions, methods et cetera are linked. A single page with all of the tags listed, along with links to the code documentation for the particular functions and methods would be essential if this is to be at all useful.

rubenphilipp commented 6 months ago

I investigated robodoc as well and had a brief look at the source where I wasn't able to locate any function for generating such a "tags-index". What about writing an issue to the robodoc repository (https://github.com/gumpu/ROBODoc)? It seems not to be completely inactive (at least the most recent commit dates to last year).

mdedwards commented 6 months ago

Hello Ruben, it wouldn't hurt to ask I suppose, but I wouldn't hold my breath ;-)