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

[Fernando Pujaico Rivera]

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

                 Summary: generate_html : Adding  package_doc_options field to
generate texinfo documentation
                 Project: GNU Octave
            Submitted by: trucomanx
            Submitted on: Fri 13 May 2016 03:39:38 PM BRT
                Category: None
                Priority: 5 - Normal
                  Status: None
                 Privacy: Public
             Assigned to: None
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any

    _______________________________________________________

Details:

generate_html : Adding  package_doc_options field to generate texinfo
documentation

This proposed patch 'adding_package_doc_options_to_option_structure.diff'
add the 'package_doc_options' field to option structure returned by
get_html_options 
function. This change is proposed to add more functionalities to texinfo
documentation. By example to use CSS style files or specify additional
commands.

The traditional way of generates a tutorial.html with the generate_html
package , 
it is using internally the command, 'makeinfo --html -o package_doc
tutorial.texi',
executing the next Octave command:

        options = get_html_options ("octave-forge");
        options.package_doc = 'tutorial.texi';
        generate_package_html ("image", "image_html", options);

By other side, I am proposing to use also this structure (if desired):

        options = get_html_options ("octave-forge");
        options.package_doc = 'tutorial.texi';
        options.package_doc_options = '--no-split --css-ref=tutorial.css';
        generate_package_html ("image", "image_html", options);

This example code generates a tutorial.html using internally
the command: 

        makeinfo --html -o package_doc tutorial.texi --no-split
--css-ref=tutorial.css

Adding to end of command the string inside of the package_doc_options field.

Additionally, I modify the generate_package_html function to copy any CSS file

called inside the resulting html file. This code is clone of internal function
that make 
the same work with the images.

PS: Also, I am sending a standalone example documentation package. The code
use in the example was
        options = get_html_options ("octave-forge");
        options.package_doc = 'overview.texi';
        options.package_doc_options = '--no-split  --css-ref=manual.css';
        generate_package_html ("bsltl", "bsltl_html", options);
With the current source code of bsltl package.



    _______________________________________________________

File Attachments:


-------------------------------------------------------
Date: Fri 13 May 2016 03:39:38 PM BRT  Name: bsltl_html.tar.gz  Size: 64kB  
By: trucomanx
Adding package_doc_options field 
<http://savannah.gnu.org/patch/download.php?file_id=37146>
-------------------------------------------------------
Date: Fri 13 May 2016 03:39:38 PM BRT  Name:
adding_package_doc_options_to_option_structure.diff  Size: 7kB   By: trucomanx
Adding package_doc_options field 
<http://savannah.gnu.org/patch/download.php?file_id=37147>

    _______________________________________________________

Reply to this item at:

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

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