[Octave-patch-tracker] [patch #9002] generate_html : Adding package_doc_options field to generate texinfo documentation

[Fernando Pujaico Rivera]

Follow-up Comment #19, patch #9002 (project octave):

I think that the name "function reference" is fine (for the moment). Given
that the reference manual should be made automatically as in many others
libraries (working with Doxigen, Javadoc). And the package_doc variable should
be used to a "Tutorial".

Thus, we would have:
Reference manual: (automatically) defining as to use the each one of
functions.
Tutorial: (manually) Defining as use the function in a program and in a
context, linking and showing a bit of theory.
(optional) examples: (manually) some examples explicated in the manual and
others

Maybe, with the time we can work to make something similar to doxygen to
Octave.
And that generate_html calls this program, but I think that the current
library generate_html, its fine for me.

Also think that the reference manual of the libaries  were made in plain text
because the documentation can be implemented with texinfo, or without it to
libraries that work also with matlab.

Maybe as future work we need consider enable two types of documentation, }
texinfo source and
matlab compatible source.

options = get_html_options ("octave-forge","texinfo");
options.package_doc="tutorial.texi"; 
 generate_package_html ("packname_refman", "packname", options); 


options = get_html_options ("octave-forge","compatibility");
options.package_doc="tutorial.texi"; 
generate_package_html ("packname_refman", "packname", options); 

    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/patch/?9002>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/