taskManeage - Tasks: task #15825, Documentation in Texinfo

 
 

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

task #15825: Documentation in Texinfo

Submitter:  Mohammad Akhlaghi <makhlaghi>
Submitted:  Sat 28 Nov 2020 11:44:40 PM UTC
 
Should Start On:  Sat 28 Nov 2020 12:00:00 AM UTC Should be Finished on:  Sat 28 Nov 2020 12:00:00 AM UTC
Category:  Documentation Priority:  5 - Normal
Status:  None Privacy:  Public
Percent Complete:  10% Assigned to:  None
Open/Closed:  Open Effort:  0.00

Mon 05 Sep 2022 05:10:10 PM UTC, comment #1: 

Work on a full Texinfo documentation has started in the 'texibook' branch of the Maneage development repo.

In particular, Commit 4fed6094 adds the skeleton Texinfo source (in 'reproduce/softare/doc/maneage.texi') and also adds its build rules in 'high-level.mk'. The build rules currently build the Info, PDF and HTML versions of the manual, making it easily accessible by running '.local/bin/info maneage' on the host operating system.

The basic infrastructure is therefore in place and we can now start adding content. Once the first draft is complete, we can put the HTML and PDF versions on the Maneage webpage :-).

Mohammad Akhlaghi <makhlaghi>
Project Administrator
Sat 28 Nov 2020 11:44:40 PM UTC, original submission:  

As discussed in task #15823, it seems reasonable to have a complete documentation of Maneage in Texinfo:

With Texinfo we'll be able to automatically generate webpages, an elegant PDF, and info pages that Maneage users can directly access on the command-line within their own projects (for example with '.local/bin/info maneage'). The raw source of the Texinfo can be in the core Maneage branch, and its PDF and info formats can built during './project configure'. For us developers, we can use it to extract HTMLs and put them in the webpage. 

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 pedram
  • -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.

     

     

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-09-05 makhlaghi Percent Complete0% 10%
    2020-11-29 pedram Carbon-Copy- Added pedram

    Back to the top


    Powered by Savane 3.9