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

[Oliver Heimlich]

On 03.05.2015 04:34, Daniel J Sebald wrote:
> On 05/02/2015 08:38 PM, Oliver Heimlich wrote:
> > 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.

I don't want to mess with the macro. Lesson learned: The arrow does not 
respect the @example environment in all output formats and if you want 
things to line up, you have to add a newline after the macro for output 
with two or more lines, e. g.,

foo ()
  @result{}
    12345
    67890

> > 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.

This is my file structure:
        doc/manual.texinfo
        doc/image/foo.png

The texinfo contained
        <img src="../image/foo.png" />

I changed the path to image/foo.png. Then, the images are copied by the 
generate_html package to their correct location.