Support #542: CoCoAManual: improve part on data-types - CoCoA-5 - CoCoA Project

Support #542

CoCoAManual: improve part on data-types

Added by Anna Maria Bigatti almost 10 years ago. Updated almost 10 years ago.

Status:

Closed

Priority:

Normal

Assignee:

Anna Maria Bigatti

Category:

Manual/documentation

Target version:

CoCoA-5.1.0 Easter14

Start date:

23 Apr 2014

Due date:

% Done:

100%

Estimated time:

20.00 h

Spent time:

20.50 h

Description

The old manual had a part about data-types.
Recover it and improve it.

Related issues

History

#1 Updated by Anna Maria Bigatti almost 10 years ago

Now in CoCoAHelp.xml we should tag the types as type or rtn in the syntax like this:

<syntax>
adjoint(M: <type>MAT</type>): <rtn>MAT</rtn>
</syntax>

Listing the type in types becomes then redundant.

#2 Updated by Anna Maria Bigatti almost 10 years ago

% Done changed from 0 to 30

#3 Updated by Anna Maria Bigatti almost 10 years ago

Status changed from New to In Progress
Target version changed from CoCoA-5.1.1 Seoul14 to CoCoA-5.1.0 Easter14
% Done changed from 30 to 40
Estimated time set to 7.00 h

More updates done in "commands" syntax.
Now I think that each chapter should be essentially empty and just give specific info, only if needed, and the commands-and-functions sections (find better name?)

#4 Updated by Anna Maria Bigatti almost 10 years ago

% Done changed from 40 to 60

Now that I started this work I see that it has to be finished urgently.
As it was, the documentation wasn't just obsolete/incomplete, but inconsistent and not working (for its inconsistency the "all commands and functions.." sections in the html and TeX versions were built wrongly)

Tagging the types in the syntax actually helps being consistent and automatically produces the complete tables. Moreover avoids duplication of information (the types in syntax were repeated in types) and make the huge xml easier to read and maintain.

Thanks Emacs for this delicate replace work!!

#5 Updated by Anna Maria Bigatti almost 10 years ago

% Done changed from 60 to 70
Estimated time changed from 7.00 h to 12.00 h

While doing this massive change removing all now useless types I'm also doing some cleaning in the documentation.
FUNCTION is a proper type in cocoa-5 so I made a dedicated chapter in "Data Types".
Meanwhile I'm removing redundant and obsolete parts (when I see them).