GNU bug report logs - #25293
More descriptive page titles in documentation?

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 25293 in the body.
You can then email your comments to 25293 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: saffronsnail <at> hushmail.com
To: bug-guile <at> gnu.org
Subject: More descriptive page titles in documentation?
Date: Thu, 29 Dec 2016 10:43:27 -0800

[Message part 1 (text/plain, inline)]

Hello, 
Frequently when I am working on guile code I have a few tabs open with
particular sections of interest open. The titles of the pages all
start with "Guile Reference Manual", which is not useful when
switching between tabs. Would it be possible to retitle the pages so
that the name of the section is first? For example, right now I have
section 6.19.3 open and the title is "Guile Reference Manual: Creating
Guile Modules". I also have section 6.20.6 open and the title is
"Guile Reference Manual: Dynamic FFI". The names displayed in the tabs
are both "Guile Referenc Man...". Rearranging the titles to be
"Creating Guile Modules: Guile Reference Manual" and "Dynamic FFI:
Guile Reference Manual" would make it easier to go directly to the tab
with the information I need, rather than cycling through 4-5 different
tabs to find the one I'm looking for.
Thanks,saffronsnail

[Message part 2 (text/html, inline)]

Message #8 received at 25293 <at> debbugs.gnu.org (full text, mbox):

From: Andy Wingo <wingo <at> pobox.com>
To: saffronsnail <at> hushmail.com
Cc: 25293 <at> debbugs.gnu.org
Subject: Re: bug#25293: More descriptive page titles in documentation?
Date: Mon, 09 Jan 2017 22:56:09 +0100

On Thu 29 Dec 2016 19:43, saffronsnail <at> hushmail.com writes:

> Frequently when I am working on guile code I have a few tabs open with
> particular sections of interest open. The titles of the pages all
> start with "Guile Reference Manual", which is not useful when
> switching between tabs. Would it be possible to retitle the pages so
> that the name of the section is first? For example, right now I have
> section 6.19.3 open and the title is "Guile Reference Manual: Creating
> Guile Modules". I also have section 6.20.6 open and the title is
> "Guile Reference Manual: Dynamic FFI". The names displayed in the tabs
> are both "Guile Referenc Man...". Rearranging the titles to be
> "Creating Guile Modules: Guile Reference Manual" and "Dynamic FFI:
> Guile Reference Manual" would make it easier to go directly to the tab
> with the information I need, rather than cycling through 4-5 different
> tabs to find the one I'm looking for.

Not a bad idea!  Probably we should take this one up with the makeinfo
people.

Andy

Message #11 received at 25293 <at> debbugs.gnu.org (full text, mbox):

From: Andy Wingo <wingo <at> pobox.com>
To: bug-texinfo <at> gnu.org
Cc: saffronsnail <at> hushmail.com, 25293 <at> debbugs.gnu.org
Subject: Re: bug#25293: More descriptive page titles in documentation?
Date: Wed, 01 Mar 2017 15:49:31 +0100

Hello Texinfo peoples,

We have a suggestion that Guile's HTML manual, e.g.

  https://www.gnu.org/software/guile/docs/master/guile.html/Procedures-as-Values.html#Procedures-as-Values

should have the <title> be defined like:

  Procedures as Values: Guile Reference Manual

instead of

  Guile Reference Manual: Procedures as Values

Any thoughts on if this is possible and if so, how to get it working?

Cheers,

Andy

On Mon 09 Jan 2017 22:56, Andy Wingo <wingo <at> pobox.com> writes:

> On Thu 29 Dec 2016 19:43, saffronsnail <at> hushmail.com writes:
>
>> Frequently when I am working on guile code I have a few tabs open with
>> particular sections of interest open. The titles of the pages all
>> start with "Guile Reference Manual", which is not useful when
>> switching between tabs. Would it be possible to retitle the pages so
>> that the name of the section is first? For example, right now I have
>> section 6.19.3 open and the title is "Guile Reference Manual: Creating
>> Guile Modules". I also have section 6.20.6 open and the title is
>> "Guile Reference Manual: Dynamic FFI". The names displayed in the tabs
>> are both "Guile Referenc Man...". Rearranging the titles to be
>> "Creating Guile Modules: Guile Reference Manual" and "Dynamic FFI:
>> Guile Reference Manual" would make it easier to go directly to the tab
>> with the information I need, rather than cycling through 4-5 different
>> tabs to find the one I'm looking for.
>
> Not a bad idea!  Probably we should take this one up with the makeinfo
> people.
>
> Andy

Message #14 received at 25293 <at> debbugs.gnu.org (full text, mbox):

From: Gavin Smith <gavinsmith0123 <at> gmail.com>
To: Andy Wingo <wingo <at> pobox.com>
Cc: Bryan Ferris <saffronsnail <at> hushmail.com>, 25293 <at> debbugs.gnu.org,
 Texinfo <bug-texinfo <at> gnu.org>
Subject: Re: bug#25293: More descriptive page titles in documentation?
Date: Wed, 1 Mar 2017 18:40:25 +0000

On 1 March 2017 at 14:49, Andy Wingo <wingo <at> pobox.com> wrote:
> Hello Texinfo peoples,
>
> We have a suggestion that Guile's HTML manual, e.g.
>
>   https://www.gnu.org/software/guile/docs/master/guile.html/Procedures-as-Values.html#Procedures-as-Values
>
> should have the <title> be defined like:
>
>   Procedures as Values: Guile Reference Manual
>
> instead of
>
>   Guile Reference Manual: Procedures as Values
>
> Any thoughts on if this is possible and if so, how to get it working?

I don't know if you can do it easily with any released version of
Texinfo, but I changed the order on the suggestion of Bryan Ferris on
2017-01-21 in the development code. I believe it is now "Procedures as
Values (Guile Reference Manual)" and will be output this way in the
next release, if nothing changes before then.

Message #19 received at 25293-done <at> debbugs.gnu.org (full text, mbox):

From: Andy Wingo <wingo <at> pobox.com>
To: Gavin Smith <gavinsmith0123 <at> gmail.com>
Cc: Bryan Ferris <saffronsnail <at> hushmail.com>, 25293-done <at> debbugs.gnu.org,
 Texinfo <bug-texinfo <at> gnu.org>
Subject: Re: bug#25293: More descriptive page titles in documentation?
Date: Wed, 01 Mar 2017 21:55:25 +0100

On Wed 01 Mar 2017 19:40, Gavin Smith <gavinsmith0123 <at> gmail.com> writes:

> On 1 March 2017 at 14:49, Andy Wingo <wingo <at> pobox.com> wrote:
>> Hello Texinfo peoples,
>>
>> We have a suggestion that Guile's HTML manual, e.g.
>>
>>   https://www.gnu.org/software/guile/docs/master/guile.html/Procedures-as-Values.html#Procedures-as-Values
>>
>> should have the <title> be defined like:
>>
>>   Procedures as Values: Guile Reference Manual
>>
>> instead of
>>
>>   Guile Reference Manual: Procedures as Values
>>
>> Any thoughts on if this is possible and if so, how to get it working?
>
> I don't know if you can do it easily with any released version of
> Texinfo, but I changed the order on the suggestion of Bryan Ferris on
> 2017-01-21 in the development code. I believe it is now "Procedures as
> Values (Guile Reference Manual)" and will be output this way in the
> next release, if nothing changes before then.

That's great to hear :-)  We'll pick up this change when the next
release comes out.

Happy hacking,

Andy

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.