Texinfo exporter fails to export M-x helm-documentation

Texinfo exporter fails to export M-x helm-documentation

[Ramesh Nedunchezian]

[-- Attachment #1: Type: text/plain, Size: 869 bytes --]


I was trying to learn [Helm](https://github.com/emacs-helm/helm), is
an Emacs framework for incremental completions and narrowing
selections

The official documentation is generated by M-x helm-documentation, and
it is org format.  I wanted to read the documentation as an info file.
So, when I exporter to texinfo format, I found some issues.

I am attaching a stripped version of the documentation that is posing
problems.  The problem is with level 5 headers.  One such thing is at
https://github.com/emacs-helm/helm/blob/45450d57d5ff97e1a6fbd2a9816ae912ac50edcb/helm-help.el#L651.
I am exporting the file with option set to H:5.

See attachment for the problematic org file, texi output and the error
generated by texinfo exporter.

There are bunch of other issues that the helm documentation poses.  I
will take these up as soon as this bug is addressed.









[-- Attachment #2: *Org INFO Texinfo Output*.txt --]
[-- Type: text/plain, Size: 490 bytes --]

helmdocumentation.org.texi:83: @menu reference to nonexistent node `Recursively rename all files with "JPG" extension to "jpg"'
helmdocumentation.org.texi:84: @menu reference to nonexistent node `Batch-rename files from number 001 to 00x'
helmdocumentation.org.texi:43: @detailmenu reference to nonexistent node `Recursively rename all files with "JPG" extension to "jpg"'
helmdocumentation.org.texi:44: @detailmenu reference to nonexistent node `Batch-rename files from number 001 to 00x'

[-- Attachment #3: helmdocumentation.org.texi --]
[-- Type: text/x-texinfo, Size: 2014 bytes --]

\input texinfo    @c -*- texinfo -*-
@c %**start of header
@setfilename helmdocumentation.org.info
@settitle helmdocumentation.org
@documentencoding UTF-8
@documentlanguage en
@c %**end of header

@finalout
@titlepage
@title helmdocumentation.org
@author Ramesh Nedunchezian
@end titlepage

@contents

@ifnottex
@node Top
@top helmdocumentation.org
@end ifnottex

@menu
* Helm Find Files::

@detailmenu
--- The Detailed Node Listing ---

Helm Find Files

* Tips::

Tips

* Use the wildcard to select multiple files::
* Query replace regexp on filenames::

Query replace regexp on filenames

* Examples::

Examples

* Recursively rename all files with ".JPG" extension to ".jpg": Recursively rename all files with "JPG" extension to "jpg". 
* Batch-rename files from number 001 to 00x::


@end detailmenu
@end menu

@node Helm Find Files
@chapter Helm Find Files

@menu
* Tips::
@end menu

@node Tips
@section Tips

@menu
* Use the wildcard to select multiple files::
* Query replace regexp on filenames::
@end menu

@node Use the wildcard to select multiple files
@subsection Use the wildcard to select multiple files

Use of wildcard is supported to run an action over a set of files.

@node Query replace regexp on filenames
@subsection Query replace regexp on filenames

Replace different parts of a file basename with something else.

@menu
* Examples::
@end menu

@node Examples
@subsubsection Examples

@menu
* Recursively rename all files with ".JPG" extension to ".jpg": Recursively rename all files with "JPG" extension to "jpg". 
* Batch-rename files from number 001 to 00x::
@end menu

@enumerate
@item
Recursively rename all files with ".JPG" extension to ".jpg"


Use the ‘helm-file-globstar’ feature described in recursive globbing
by entering "**.JPG" at the end of the Helm-find-files pattern, then hit
M-@@ and enter "JPG" on first prompt, then "jpg" on second prompt and hit ‘RET’.

@item
Batch-rename files from number 001 to 00x


Use "\#" inside the second prompt.
@end enumerate

@bye

[-- Attachment #4: helmdocumentation.org.org --]
[-- Type: application/vnd.lotus-organizer, Size: 1174 bytes --]

Re: Texinfo exporter fails to export M-x helm-documentation

[Nicolas Goaziou]

Hello,

Ramesh Nedunchezian <rameshnedunchezian@outlook.com> writes:

> I was trying to learn [Helm](https://github.com/emacs-helm/helm), is
> an Emacs framework for incremental completions and narrowing
> selections
>
> The official documentation is generated by M-x helm-documentation, and
> it is org format.  I wanted to read the documentation as an info file.
> So, when I exporter to texinfo format, I found some issues.
>
> I am attaching a stripped version of the documentation that is posing
> problems.  The problem is with level 5 headers.  One such thing is at
> https://github.com/emacs-helm/helm/blob/45450d57d5ff97e1a6fbd2a9816ae912ac50edcb/helm-help.el#L651.
> I am exporting the file with option set to H:5.

The problem is that you are explicitly requesting a level of headlines
without providing a sectioning command for them. By default
`org-texinfo-classes' stops at level 4.

Anyway, this should be fixed. Thank you.

Regards,
-- 
Nicolas Goaziou

Re: Texinfo exporter fails to export M-x helm-documentation

[Jonas Bernoulli]

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

> The problem is that you are explicitly requesting a level of headlines
> without providing a sectioning command for them. By default
> `org-texinfo-classes' stops at level 4.
>
> Anyway, this should be fixed. Thank you.

You did that in f99f26306c57d2342069880eac4dca324d7579ec
but I think you added a off-by-one error in the process.
In

    (>= (org-export-get-relative-level h info)
        (length sections))

the ">=" should be a ">", or it can match with 4 >= 4, which
should result in valid menus, but is currently disallowed by
this check.

     Jonas
     

Re: Texinfo exporter fails to export M-x helm-documentation

[Nicolas Goaziou]

Hello,

Jonas Bernoulli <jonas@bernoul.li> writes:

> You did that in f99f26306c57d2342069880eac4dca324d7579ec
> but I think you added a off-by-one error in the process.
> In
>
>     (>= (org-export-get-relative-level h info)
>         (length sections))
>
> the ">=" should be a ">", or it can match with 4 >= 4, which
> should result in valid menus, but is currently disallowed by
> this check.

Indeed! Fixed. Thank you!

Regards,
-- 
Nicolas Goaziou