Re: Manual for GNU Octave package (Octave-Forge)

[Daniel J Sebald]

On 05/02/2015 08:38 PM, Oliver Heimlich wrote:
> On 26.04.2015 18:57, Julien Bect wrote:
> > Le 26/04/2015 12:32, Oliver Heimlich a écrit :
> > > 1. Should I generate a HTML version of the package manual and include
> > > it in the [package]-html.tar.gz for publication on Octave Forge? I
> > > could use the HTML template from the generate_html package to get a
> > > matching design. I could patch the package's index.html to contain a
> > > link to the manual next to the function reference.
> >
> > There is already a minimal support for the inclusion of a "package
> > manual" in the generate_html package.
>
> Julien,
>
> I have two minor problems. Maybe you know solutions.
>
> 1. The “⇒” arrow from the @result{} macros in the html page breaks the
> fixed width font of the example environment. The arrow is slightly
> larger than it should be. Maybe its just in my browser because of the
> particular font used.
>
> If the manual is generated as PDF, it becomes even worse: The arrow is
> twice as large as it should be (compared with plaintext output from
> Texinfo).

Is that symbol being processed as a mathematics arrow somehow?  The math 
symbol is typically a very wide arrow.  Maybe the character needs to be 
entered using some type of numerical code--either ASCII or some type of 
extended ASCII.


> 2. The images for the HTML manual have a relative location of <img
> src="../foo" />. I did this, because makeinfo --html generates the HTML
> version in a subfolder by default and I need the “../” reference for the
> images. This leads to following warnings during generate_package_html:
>
> warning: not copying image ../foo because path contains '..'
> warning: not copying image ../bar because path contains '..'
>
> Thus, I have to copy the images myself for the package-html folder. Its
> easy to handle in a Makefile, but is there a recommended way for
> including images in the HTML documentation?

My guess would be to try and use one of the defined directories in the 
Makefile as the base and give the full path, e.g.,

$(srcdir)/path_to_html/foo
$(DESTDIR)/path_to_html/bar
$(distdir)/path_to_html/foo2

in the copy command.

Dan