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

[Oliver Heimlich]

On 14.05.2016 20:22, Julien Bect wrote:
> 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.

(cannot post to Savannah)

I am fine with the patch. It doesn't break anything on my end, and has
the following advantages for me:

 - I no longer have to use makeinfo_program (…) to define the
package_doc options.

 - I can finally use --css-ref instead of --css-include since the css
file is copied over automatically.

To be discussed: For get_html_options ('octave-forge') it would be nice
to predefine the following options:

1. Fix the up link:
   --set-customization-variable 'TOP_NODE_UP_URL ../index.html'

2. Use Octave stylesheet:

--css-ref="https://www.gnu.org/software/octave/doc/interpreter/octave.css";

3. Add Sourceforge logo to count page impressions:
   --set-customization-variable 'PRE_BODY_CLOSE <a class="sf-logo"
href="http://sourceforge.net/";><img width="120" height="30"
style="border:0" alt="Sourceforge.net Logo"
src="http://sourceforge.net/sflogo.php?group_id=2888&amp;type=13"; /></a>'


Oliver

P.S. I'd recommend to not use “--no-split” unless your package
documentation is very short.