Re: generate_html : Adding new field to option structure in the generation of documentation from texinfo

[Julien Bect]

Le 14/05/2016 15:14, Julien Bect a écrit :
> Le 14/05/2016 06:40, TrucomanX XnamocurT a écrit :
> > I am writing to call your attention and ask for your comments about a 
> > patch that I am proposing.
> >
> > https://savannah.gnu.org/patch/?9002
> >
> > This proposed patch 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, as:
> >
> > 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);
> >
> > You can see the result of this example in the link:
> >
> > https://savannah.gnu.org/patch/download.php?file_id=37146
> >
> > The patch can be download of :
> > https://savannah.gnu.org/patch/download.php?file_id=37147
> >
> > Fernando
>
> I am currently reviewing patch #9002.

@Fernando: since I am still unable to post on savannah, I will 
temporarily use this thread to communicate.

I have pushed your patch on a feature branch named "patch-9002" and made 
some minor changes.  See if you agree with my changes.


@package maintainers: if would be nice if package maintainers that use 
the "package_doc" feature (Oliver? Olaf?) could test this branch and see 
if it doesn't break anything for them.


As far as I am concerned, I have no objection to this patch.  I have 
tested on the bsltl package and it seems to work.

Unless someone has objections, I will merge to default in one week.


Julien.


PS: here is the code that I used to test on bsltl 1.0.1:

# Install bsltl-1.0.1
fn = 'octave-bsltl-f2280f6705914133bfffccefd6667541ed66de10.zip';
url = 
['https://sourceforge.net/code-snapshots/git/o/oc/octave/bsltl.git/' fn];
assert (system (['wget ' url]) == 0);
assert (system (sprintf ('mv %s %s', fn, 'bsltl-1.0.1.zip')) == 0);
pkg install bsltl-1.0.1.zip

# Generate bsltl documentation
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);