Support #406
Manual for CoCoAManual/CoCoAHelp.xml
Description
write a README with instructions about how to write an entry in CoCoAManual/CoCoAHelp.xml
Related issues
History
#1 Updated by Anna Maria Bigatti over 10 years ago
- Estimated time set to 4.00 h
#2 Updated by Anna Maria Bigatti over 10 years ago
- % Done changed from 0 to 20
#3 Updated by John Abbott about 10 years ago
I want some guidance about which fonts to use in the description of a CoCoA function when refering to the arguments. We need to choose "fonts" which render well in all forms of the documentation. Here is a pseudo-example:
This function finds the index of the N-th occurrence of X in the list L.
I think that
N
, X
and L
should be in a different font from the main text.
PS I've added a link to the related issue #324
#4 Updated by Anna Maria Bigatti about 10 years ago
John Abbott wrote:
I think that
N
,X
andL
should be in a different font from the main text.
we should use tt
<tt>N</tt>
there is a similar tag code, but I'd follow the KISS approach and remove that tag: tt is faster to type than code, so we are more likely to do it ;-)
#5 Updated by John Abbott about 10 years ago
- Target version changed from CoCoA-5.1.0 Easter14 to CoCoA-5.?.?
#6 Updated by John Abbott over 5 years ago
- Status changed from New to In Progress
- Target version changed from CoCoA-5.?.? to CoCoA-5.3.0
- % Done changed from 20 to 50
I think that has been partly done. There is certainly a preliminary README
file.
We should check that it is reasonably self explanatory (or make it so).
Then we can close this issue.
#7 Updated by John Abbott over 5 years ago
- Related to Support #169: Font for parameters in manual added
#8 Updated by John Abbott over 4 years ago
Should we postpone this issue to the release after 5.3.0?
#9 Updated by Anna Maria Bigatti over 4 years ago
John Abbott wrote:
Should we postpone this issue to the release after 5.3.0?
I think we should aim at 5.3.0.
If we can't make it, we postpone it in January.
#10 Updated by John Abbott about 4 years ago
- Target version changed from CoCoA-5.3.0 to CoCoA-5.4.0
#11 Updated by John Abbott about 2 years ago
- % Done changed from 50 to 60
I'm postponing this again.
Writing documentation is somehow always "low priority", but writing documentation about writing documentation... oh goodness!!!
#12 Updated by John Abbott about 2 years ago
- Target version changed from CoCoA-5.4.0 to CoCoA-5.4.2
#13 Updated by Anna Maria Bigatti about 2 years ago
- Status changed from In Progress to Feedback
- % Done changed from 60 to 90
Major discussion and work with John Abbott lead to some useful decisions and the consequent major update of the guidelines in REAME.
At this point this is a "forever-issue" as the system develops, but the important guidelines have been fixed.
#14 Updated by Anna Maria Bigatti about 2 years ago
- Target version changed from CoCoA-5.4.2 to CoCoA-5.4.0
#15 Updated by Anna Maria Bigatti about 2 years ago
- Related to Support #1268: Documentation for how to write a CoCoA package added
#16 Updated by Anna Maria Bigatti about 2 years ago
- Related to Design #1164: Manual: loading manual entries written by users added
#17 Updated by Redmine Admin almost 2 years ago
- Status changed from Feedback to Closed
- % Done changed from 90 to 100