Project

General

Profile

Support #169

Font for parameters in manual

Added by John Abbott about 12 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Low
Assignee:
Anna Maria Bigatti
Category:
Manual/documentation
Target version:
CoCoA-5.4.0
Start date:
25 May 2012
Due date:
% Done:

100%

Estimated time:
4.00 h
Spent time:
1.90 h

Description

Often the description in the CoCoA manual refers to the formal parameters by name.
Should these names be put in a special font?
A similar question applies to the names of types (and keywords, and...)

2022 use tt or ttref (see README)

Related issues

Related to CoCoA-5 - Support #406: Manual for CoCoAManual/CoCoAHelp.xmlClosed2013-10-10

Has duplicate CoCoA-5 - Support #324: Correct font for variable references in descriptionClosed2013-02-26

History

#1 Updated by Anna Maria Bigatti about 10 years ago

  • Target version set to CoCoA-5.1.0 Easter14

#2 Updated by John Abbott about 10 years ago

  • Target version changed from CoCoA-5.1.0 Easter14 to CoCoA-5.1.1 Seoul14

#3 Updated by Anna Maria Bigatti almost 10 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 20
  • Estimated time set to 4.00 h

As said in another issue:
- parameters should have the same name as in <syntax>
- <syntax> should be moved before <description>
- parameters should go between <tt>.. </tt>

This is all very tedious.
We've beein doing it a little bit at a time when updating/adding new entries in the manual.

#4 Updated by John Abbott almost 10 years ago

  • Target version changed from CoCoA-5.1.1 Seoul14 to CoCoA-5.?.?

#5 Updated by John Abbott almost 6 years ago

  • Target version changed from CoCoA-5.?.? to CoCoA-5.3.0
  • % Done changed from 20 to 30

I think this already have been done (in most entries).
In the description we have used <tt> rather than code because <tt> is easier to type, and also because there is <ttref>.

#6 Updated by John Abbott almost 6 years ago

  • Related to Support #406: Manual for CoCoAManual/CoCoAHelp.xml added

#7 Updated by John Abbott over 4 years ago

  • Target version changed from CoCoA-5.3.0 to CoCoA-5.4.0

We should try to work through the manual systematically. Perhaps there should be 26 sub-issues, one for each initial letter. That would break the task into manageable chunks.

#8 Updated by John Abbott over 2 years ago

  • Priority changed from Normal to Low
  • Target version changed from CoCoA-5.4.0 to CoCoA-5.4.2

#9 Updated by Anna Maria Bigatti over 2 years ago

  • Description updated (diff)
  • Status changed from In Progress to Resolved
  • Target version changed from CoCoA-5.4.2 to CoCoA-5.4.0
  • % Done changed from 30 to 70

#10 Updated by Anna Maria Bigatti over 2 years ago

  • % Done changed from 70 to 80

Also code snippets should be between tt's.

But not for types, e.g. INT, MODULE and RING, because they are already uppercase, and usually appear in groups,
so typing the tt's would be tedious,
reading the XML code would be difficult,
and having all the quotes in the user manual would be too heavy to read.

(I used to write the tt's for types, but I've just changed my mind while doing the actual work of adding them thorougly in the manual)

#11 Updated by John Abbott about 2 years ago

Can we close this issue now?

#12 Updated by Anna Maria Bigatti about 2 years ago

  • Tracker changed from Bug to Support
  • Status changed from Resolved to Closed
  • Assignee set to Anna Maria Bigatti
  • % Done changed from 80 to 100

Also available in: Atom PDF