taskGNU Astronomy Utilities - Tasks: task #13597, Add figures to the manual

 
 

You are not allowed to post comments on this tracker with your current authentication level.

task #13597: Add figures to the manual

Submitter:  Mohammad Akhlaghi <makhlaghi>
Submitted:  Thu 30 Apr 2015 02:05:41 AM UTC
 
Should Start On:  Wed 29 Apr 2015 03:00:00 PM UTC Should be Finished on:  Wed 29 Apr 2015 03:00:00 PM UTC
Category:  All Gnuastro Priority:  5 - Normal
Item Group:  Documentation Status:  Postponed
Privacy:  Public Percent Complete:  0%
Assigned to:  None Open/Closed:  Open
Effort:  0.00

Thu 30 Apr 2015 02:05:41 AM UTC, original submission:  

The pros and cons of adding figures to the manual are listed:

Pros:
-----

 - Understanding most concepts becomes more easier.

 - Makes the reading easier since there is less text on some pages.

 - When in info mode (the main output format that doesn't support figures) the user is mainly concerned with the options and doesn't want to understand concepts (they have most probably already read the manual in HTML or PDF). So there is no problem.

Cons:
-----
 - The figures have to be stored along with the source code which can potentially significantly increase the file size for download.

 - The `Invoking ProgramName' sections of the manual should not rely on figures. If they do, then the info version will be useless!

So we have to decide if it is worth it to add all the figures to the sourcecode (the distributed .tar.gz)? Maybe if any day the size of the source code becomes over a few tens of megabytes then this would be no problem. Since the figures sizes would become negligible or comparable. But that is possibly in the distant future! Because Gnuastro is written to be low-level.

One solution would be to not distribute the figures in the actual .tar.gz and put them in another tar archive (for example figures-X.X.tar.gz for each version) so only if the user wants to build the manual, they download it and put the directory in the right place before running Texinfo. The figures would ofcourse be included in the git repository, there is no doubt in that.

If we do decide to add figures to the manual, then we should be very careful that the info version does not rely on them.

Mohammad Akhlaghi <makhlaghi>
Project Administrator

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by makhlaghi (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

     

     

    No changes have been made to this item

    Back to the top


    Powered by Savane 3.9