bugGNU roff - Bugs: bug #61157, [ms]: Add support for user-defined...

 
 

bug #61157: [ms]: Add support for user-defined styling of TOC leaders

Submitter:  Keith Marshall <keithmarshall>
Submitted:  Tue 14 Sep 2021 09:33:25 PM UTC
   
 
Category:  Macro ms Severity:  3 - Normal
Item Group:  Feature change Status:  Fixed
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  1.23.0
* Mandatory Fields

Add a New Comment Rich Markup
   

Jump to the original submission

Wed 01 Jun 2022 12:56:21 AM UTC, comment #8: 

I got the documentation ported over last October but forgot to close this ticket.

A ChangeLog closer is queued for my next push.


commit 430fd13266124fe11debdb4529d05e77bb491213
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Sun Oct 3 23:53:51 2021 +1100

    [docs]: Expand ms.ms TOC material.

    * doc/ms.ms (Creating a table of contents): Sync with recent additions
      to groff_ms(7), expand, and heavily revise.

commit 4d3cde4de0fa1abc07c9a96baeebe56108619a48
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Oct 7 06:57:39 2021 +1100

    doc/groff.texi (ms): Sync with doc/ms.ms.

    Port new table of contents documentation to our Texinfo manual.


G. Branden Robinson <gbranden>
Group administrator
Fri 01 Oct 2021 10:52:57 AM UTC, comment #7: 

Hi Branden,

comment #6:

> comment #5:
> > Would you like me to [also] push my corresponding proposed
> > groff_ms(7) manpage patch, (and also those I've attached to
> > ticket #61022, relating to FS-MARK and FP)?  Or, would you prefer
> > to take ownership of the documentation aspect yourself?
>
> Sure, go ahead!  ...
> I can always do my fastidious doc sync-ups and nit-picks after
> your changes land.

I've now finalized, and pushed all related patches; reassigning to you, for manpage review, and info integration.

Keith Marshall <keithmarshall>
Group Member
Fri 01 Oct 2021 02:40:53 AM UTC, comment #6: 

Hi, Keith!

comment #5:

> Branden,
>
> comment #4:
> > comment #3:
> > > comment #1:
> > > > Will you follow up with a patch to the documentation, or would [you] prefer me to write it?
> > > I'll tackle the manpage update, if you wish, ...
> > Proposed manpage patch attached.
> >
> > (file #51924)
> In my local sandbox, I've adapted pdfmark.ms to use TC-LEADER, and TC-MARGIN, so I would like to push the s.tmac patch, fairly soon, (followed by several pdfmark.ms updates).
>
> Would you like me to also push my corresponding proposed groff_ms(7) manpage patch, (and also those I've attached to ticket #61022, relating to FS-MARK and FP)?  Or, would you prefer to take ownership of the documentation aspect yourself?


Sure, go ahead!  I find myself occupied with bug #60666 at the moment.

I can always do my fastidious doc sync-ups and nit-picks after your changes land.

G. Branden Robinson <gbranden>
Group administrator
Thu 30 Sep 2021 11:25:31 PM UTC, comment #5: 

Branden,

comment #4:

> comment #3:
> > comment #1:
> > > Will you follow up with a patch to the documentation, or would [you] prefer me to write it?
> > I'll tackle the manpage update, if you wish, ...
> Proposed manpage patch attached.
>
> (file #51924)

In my local sandbox, I've adapted pdfmark.ms to use TC-LEADER, and TC-MARGIN, so I would like to push the s.tmac patch, fairly soon, (followed by several pdfmark.ms updates).

Would you like me to also push my corresponding proposed groff_ms(7) manpage patch, (and also those I've attached to ticket #61022, relating to FS-MARK and FP)?  Or, would you prefer to take ownership of the documentation aspect yourself?

Keith Marshall <keithmarshall>
Group Member
Wed 15 Sep 2021 10:40:35 PM UTC, comment #4: 

comment #3:

> comment #1:
> > Will you follow up with a patch to the documentation, or would [you] prefer me to write it?
> I'll tackle the manpage update, if you wish, ...

Proposed manpage patch attached.

(file #51924)

Keith Marshall <keithmarshall>
Group Member
Wed 15 Sep 2021 01:08:04 PM UTC, comment #3: 

comment #1:

> This proposal seems fine to me.

Thanks, Branden.

> Will you follow up with a patch to the documentation, or would prefer me to write it?

I'll tackle the manpage update, if you wish, but I am not at all familiar with texinfo, so perhaps you could attend to that, please?

Keith Marshall <keithmarshall>
Group Member
Wed 15 Sep 2021 12:32:31 PM UTC, comment #2: 

comment #1:

> ... I intended to document FS-MARK but found myself confused with respect to use cases.  I'll follow up with you about that elsewhere since it's off-topic for this ticket.

There is a strong hint to the use-case, on ticket #61022; I suggest that further discussion be directed there.

Keith Marshall <keithmarshall>
Group Member
Tue 14 Sep 2021 09:55:36 PM UTC, comment #1: 

This proposal seems fine to me.  Will you follow up with a patch to the documentation, or would prefer me to write it?

Also, I intended to document FS-MARK but found myself confused with respect to use cases.  I'll follow up with you about that elsewhere since it's off-topic for this ticket.

G. Branden Robinson <gbranden>
Group administrator
Tue 14 Sep 2021 09:33:25 PM UTC, original submission:  

ms defines the leader character, for use within tables of contents generated by XS/XA, as:

.char \[toc*leader-char] .\h'1m'

Personally, (and this is, strictly, just my opinion),  I think that 1em of space between the leader dots is too much.  Unfortunately, that definition of 'toc*leader-char' appears within the body of the PX macro, (which is used to emit the collected table of contents), so even knowing the (undocumented) internal name, I cannot easily override the hard-wired definition.

I would like to apply a patch, such as the attached, so that users will have an opportunity to adjust the leader style, and the width of the width of the following right-hand margin, (in which the page number is placed), by defining TC-LEADER and TC-MARGIN respectively, (both of which we can document), before invoking PX; (in the event of neither being predefined, the behaviour would remain identically as at present).

Keith Marshall <keithmarshall>
Group Member

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

Attached Files
file #51924:  ms-toc-manpage.patch added by keithmarshall (3KiB - text/x-patch - Proposed groff_ms(7) manpage patch)
file #51912:  ms-toc-leader.patch added by keithmarshall (912B - text/x-patch - Patch to support TOC leader styling)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gbranden (Posted a comment)
  • -email is unavailable- added by keithmarshall (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 8 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-06-01 gbranden StatusIn Progress Fixed
        Open/ClosedOpen Closed
    2021-10-01 keithmarshall Assigned tokeithmarshall gbranden
        Planned ReleaseNone 1.23.0
    2021-10-01 gbranden StatusNone In Progress
        Assigned toNone keithmarshall
    2021-09-15 keithmarshall Attached File- Added ms-toc-manpage.patch, #51924
    2021-09-14 keithmarshall Attached File- Added ms-toc-leader.patch, #51912

    Back to the top

    Powered by Savane 3.13-3230.
    Corresponding source code