Project

General

Profile

Design #1164

Manual: loading manual entries written by users

Added by Anna Maria Bigatti about 6 years ago. Updated over 4 years ago.

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

100%

Estimated time:
20.00 h
Spent time:

Description

Design a way to load into the online manual extra entries (say, for new packages by users).
For example append entries written in another xml file, or encoded within a cocoa5 package.


Related issues

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

History

#1 Updated by Anna Maria Bigatti about 6 years ago

[Elisa Palezzato and Michele Torielli are developing new packages (for the school in Japan) and would like to test the manual entries they wrote.]

Probably the easiest is to append extra files. The syntax could be

ReloadMan();  // for the official manual only
ReloadMan(["path1/file1.xml", "path2/file2.xml"]);  // official manual + file1 + file2

Forcing the complete reload of all files of interest in one block, instead of just loading the extra files one at a time, allows detecting a duplicate entry(and throw an error).

#2 Updated by Anna Maria Bigatti about 6 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 50

Implemented (and also done a little cleaning in OnlineHelp.H and C)
Example:

/**/ ReloadMan(["/Users/bigatti/Dropbox/BigPalTor/Arrangements of Hyperplanes/prova-man.xml"]);

#3 Updated by Anna Maria Bigatti about 6 years ago

While doing some cleaning and minor re-designing, I introduced a bunch of silly bugs.
Now all fixed.

cvs-ed and made a new cocoa-5 for Mac downloadable fron web-site.

#4 Updated by Anna Maria Bigatti over 5 years ago

  • Status changed from In Progress to Feedback
  • % Done changed from 50 to 90

#5 Updated by John Abbott over 4 years ago

The manual entry for ReloadMan needs to be updated, assuming that the impl is meant to be public.

#6 Updated by Anna Maria Bigatti over 4 years ago

updated manual

#7 Updated by Anna Maria Bigatti over 4 years ago

  • Status changed from Feedback to Closed
  • % Done changed from 90 to 100

#8 Updated by Anna Maria Bigatti about 2 years ago

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

Also available in: Atom PDF