Support #325
CoCoAManual: display syntax first
Description
Move the syntax summary to the beginning of each manual entry (in CoCoAHelp.xml).
Time for some emacs macro magic :-)
Perhaps the syntax could be printed out at the beginning and again at the end when used in interactive mode?
Related issues
History
#1
Updated by Anna Maria Bigatti almost 11 years ago
Updated by - Category set to Manual/documentation
- Status changed from New to In Progress
- Assignee set to Anna Maria Bigatti
- Target version set to CoCoA-5.1.0 Easter14
- % Done changed from 0 to 10
#2
Updated by John Abbott almost 11 years ago
Updated by - Subject changed from Syntax first to CoCoAManual: display syntax first
#3
Updated by Anna Maria Bigatti almost 11 years ago
- % Done changed from 10 to 60
I changed the code in OnlineHelp.C so that syntax is displayed first (2013-02).
It would be worth having the syntax first in CoCoAHelp.xml as well, and I'm doing it slowly, by hand, when updating entries: it really helps in writing more consistent documentation.
When work is a little less hectic I'll do a major update.
#4
Updated by Anna Maria Bigatti about 10 years ago
- Status changed from In Progress to Feedback
- Target version changed from CoCoA-5.1.0 Easter14 to CoCoA-5.0.9
- % Done changed from 60 to 90
Even though CoCoAHelp.xml isn't all written like that (too dangerous to do by emacs-magic), the end results (online, html, tex) display syntax first.
So we should close this issue.
#5
Updated by Anna Maria Bigatti about 10 years ago
- Status changed from Feedback to Closed
- % Done changed from 90 to 100
- Estimated time set to 4.00 h
#6
Updated by Anna Maria Bigatti over 9 years ago
Even though I had closed this issue saying:
Even though CoCoAHelp.xml isn't all written like that (too dangerous to do by emacs-magic), the end results (online, html, tex) display syntax first.
I did the emacs magic (July 2014): I was fed up doing the fixes by hand.