Project

General

Profile

Support #456

CoCoAManual: New structure for manual?

Added by Anna Maria Bigatti about 10 years ago. Updated over 9 years ago.

Status:
Closed
Priority:
Normal
Category:
Manual/documentation
Target version:
Start date:
05 Mar 2014
Due date:
% Done:

100%

Estimated time:
3.00 h
Spent time:

Description

CoCoA-4 manual had a part with the list of commands and a part with "topics" (the latter has been obsolete for ages!).
Currently, with nice cross links, the "topics" part is no longer necesary.
I suggest we have just one part with the alphabetical list of commands and topics, remove the redundant and/or obsolete sections and move conveniently the remaining useful sections.

Eventually think of a short tutorial and cheat-sheet.


Related issues

Related to CoCoA-5 - Feature #188: CoCoAManual: entries for operatorsClosed2012-06-14

Related to CoCoA-5 - Feature #466: CoCoAManual: add entry summarising syntax of all CoCoA-5 commandsClosed2014-03-11

Related to CoCoA-5 - Support #177: CoCoAManual: General part of the documentation is obsolete: update? discard?In Progress2012-06-01

History

#1 Updated by Anna Maria Bigatti about 10 years ago

  • Category set to Manual/documentation
  • Status changed from New to In Progress

It seems that pages like Introduction to ... could indeed be nice.
The current one are usually far too long: simplify and update!

#2 Updated by John Abbott about 10 years ago

The "Intro to XYZ" idea is good, but I do not much like the title.

Maybe "XYZ in CoCoA", or "Using XYZ", or "Creating and Using XYZ in CoCoA"...

Another possibility: "Hints and Tips for XYZ"

Is the idea that these pages would contain some of the "philosophy" of CoCoA?

#3 Updated by John Abbott about 10 years ago

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

#4 Updated by Anna Maria Bigatti almost 10 years ago

  • Subject changed from New structure for manual? to CoCoAManual: New structure for manual?
  • Assignee set to Anna Maria Bigatti
  • % Done changed from 0 to 100
  • Estimated time set to 3.00 h

Strictly related with #177

#5 Updated by Anna Maria Bigatti over 9 years ago

  • Status changed from In Progress to Closed

Also available in: Atom PDF