[texinfo] Bug(?) in detailed node listing

[texinfo] Bug(?) in detailed node listing

[Thomas S. Dye]

Aloha all,

I can't figure out how to get the detailed node listing formatted
correctly, so I want to call this a bug.  An example shows the problem:

* Hacking::                        How to hack your way around
* MobileOrg::                      Viewing and capture on a mobile device
* History and Acknowledgments::    How Org came into being

 --- The Detailed Node Listing ---

Introduction

* Summary::                                              Brief summary of what \
Org-mode does
* Installation::                                         How to install a downl\
oaded version of Org-mode

Help?

All the best,
Tom

-- 
T.S. Dye & Colleagues, Archaeologists
735 Bishop St, Suite 315, Honolulu, HI 96813
Tel: 808-529-0866, Fax: 808-529-0884
http://www.tsdye.com

Re: [texinfo] Bug(?) in detailed node listing

[Jonathan Leech-Pepin]

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

Hello Tom,

On 20 February 2013 19:45, Thomas S. Dye <tsd@tsdye.com> wrote:

> Aloha all,
>
> I can't figure out how to get the detailed node listing formatted
> correctly, so I want to call this a bug.  An example shows the problem:
>
> * Hacking::                        How to hack your way around
> * MobileOrg::                      Viewing and capture on a mobile device
> * History and Acknowledgments::    How Org came into being
>
>  --- The Detailed Node Listing ---
>
> Introduction
>
> * Summary::                                              Brief summary of
> what \
> Org-mode does
> * Installation::                                         How to install a
> downl\
> oaded version of Org-mode
>
>
I'm guessing you mean the extra distance between the title and the
description of the listing?

This is not exactly a bug... In an attempt to get all the descriptions
to line up correctly I aligned them all based on the longest
subheading.  I'm guessing in this case there is an extremely long one
somewhere farther down.

I couldn't find any specification as to how far they should be aligned,
otherwise I would have set them to a specific column instead of
basing them on the longest headline.

I should be able to fix this to be more reasonable, however I would
need an opinion as to what distance would be appropriate/desireable.

Regards,

Jon

> Help?
>
> All the best,
> Tom
>
> --
> T.S. Dye & Colleagues, Archaeologists
> 735 Bishop St, Suite 315, Honolulu, HI 96813
> Tel: 808-529-0866, Fax: 808-529-0884
> http://www.tsdye.com
>
>

[-- Attachment #2: Type: text/html, Size: 2526 bytes --]

Re: [texinfo] Bug(?) in detailed node listing

[Thomas S. Dye]

Hi Jon,

Jonathan Leech-Pepin <jonathan.leechpepin@gmail.com> writes:

> Hello Tom,
>
> On 20 February 2013 19:45, Thomas S. Dye <tsd@tsdye.com> wrote:
>
>> Aloha all,
>>
>> I can't figure out how to get the detailed node listing formatted
>> correctly, so I want to call this a bug.  An example shows the problem:
>>
>> * Hacking::                        How to hack your way around
>> * MobileOrg::                      Viewing and capture on a mobile device
>> * History and Acknowledgments::    How Org came into being
>>
>>  --- The Detailed Node Listing ---
>>
>> Introduction
>>
>> * Summary::                                              Brief summary of
>> what \
>> Org-mode does
>> * Installation::                                         How to install a
>> downl\
>> oaded version of Org-mode
>>
>>
> I'm guessing you mean the extra distance between the title and the
> description of the listing?

Yes.

>
> This is not exactly a bug... In an attempt to get all the descriptions
> to line up correctly I aligned them all based on the longest
> subheading.  I'm guessing in this case there is an extremely long one
> somewhere farther down.
>

Yes, that explains it.

> I couldn't find any specification as to how far they should be aligned,
> otherwise I would have set them to a specific column instead of
> basing them on the longest headline.
>
> I should be able to fix this to be more reasonable, however I would
> need an opinion as to what distance would be appropriate/desireable.

* MobileOrg::                   Viewing and capture on a mobile device
* History and Acknowledgments::  How Org came into being
* GNU Free Documentation License::  The license for this documentation.
* Main Index::                  An index of Org's concepts and features

Based on this example from the Org manual, it looks as if the
descriptions should start on column 32 or the third column after the end
of the title, whichever is greater.

Thanks for your help on this.

All the best,
Tom

-- 
Thomas S. Dye
http://www.tsdye.com

Re: [texinfo] Bug(?) in detailed node listing

[Jonathan Leech-Pepin]

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

Hi Tom,

On 21 February 2013 18:44, Thomas S. Dye <tsd@tsdye.com> wrote:

> Hi Jon,
> [...]
>
> Based on this example from the Org manual, it looks as if the
> descriptions should start on column 32 or the third column after the end
> of the title, whichever is greater.
>
>
I've just pushed a fix for this.  It also introduces a new defcustom
to allow for choosing the column you want it to align at
(org-texinfo-node-description-column).

Regards,

--
Jon

> Thanks for your help on this.
>
> All the best,
> Tom
>
> --
> Thomas S. Dye
> http://www.tsdye.com
>

[-- Attachment #2: Type: text/html, Size: 1188 bytes --]

Re: [texinfo] Bug(?) in detailed node listing

[Thomas S. Dye]

Hi Jon,

Jonathan Leech-Pepin <jonathan.leechpepin@gmail.com> writes:

> Hi Tom,
>
> On 21 February 2013 18:44, Thomas S. Dye <tsd@tsdye.com> wrote:
>
>> Hi Jon,
>> [...]
>>
>> Based on this example from the Org manual, it looks as if the
>> descriptions should start on column 32 or the third column after the end
>> of the title, whichever is greater.
>>
>>
> I've just pushed a fix for this.  It also introduces a new defcustom
> to allow for choosing the column you want it to align at
> (org-texinfo-node-description-column).
>

Nice.  Thanks!

One nit: You have one space between the `::' at the end of a long title
and the start of the description, where the Org manual has two spaces.

All the best,
Tom

-- 
Thomas S. Dye
http://www.tsdye.com

Re: [texinfo] Bug(?) in detailed node listing

[Jonathan Leech-Pepin]

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

Hello Tom,

On 25 February 2013 11:57, Thomas S. Dye <tsd@tsdye.com> wrote:

> Hi Jon,
>
> Jonathan Leech-Pepin <jonathan.leechpepin@gmail.com> writes:
>
> > Hi Tom,
> >
> > On 21 February 2013 18:44, Thomas S. Dye <tsd@tsdye.com> wrote:
> >
> >> Hi Jon,
> >> [...]
> >>
> >> Based on this example from the Org manual, it looks as if the
> >> descriptions should start on column 32 or the third column after the end
> >> of the title, whichever is greater.
> >>
> >>
> > I've just pushed a fix for this.  It also introduces a new defcustom
> > to allow for choosing the column you want it to align at
> > (org-texinfo-node-description-column).
> >
>
> Nice.  Thanks!
>
> One nit: You have one space between the `::' at the end of a long title
> and the start of the description, where the Org manual has two spaces.
>
>
This should now be fixed (along with a logic error that was actually
inserting
description at column+5)

Regards,

Jon

> All the best,
> Tom
>
> --
> Thomas S. Dye
> http://www.tsdye.com
>

[-- Attachment #2: Type: text/html, Size: 1871 bytes --]

Re: [texinfo] Bug(?) in detailed node listing

[Thomas S. Dye]

Hi Jon,

Jonathan Leech-Pepin <jonathan.leechpepin@gmail.com> writes:

> Hello Tom,
>
>> One nit: You have one space between the `::' at the end of a long title
>> and the start of the description, where the Org manual has two spaces.
>>
>>
> This should now be fixed (along with a logic error that was actually
> inserting
> description at column+5)
>

I hadn't detected the logic error, but can confirm that the other fix
works.

Thanks!

All the best,
Tom

-- 
Thomas S. Dye
http://www.tsdye.com