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

[G. Branden Robinson]

Update of bug #61157 (project groff):

  Status: In Progress => Fixed  
 Open/Closed:Open => Closed 

___

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



___

Reply to this item at:

  

___
Message sent via Savannah
https://savannah.gnu.org/

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

[Keith Marshall]

Update of bug #61157 (project groff):

 Assigned to:   keithmarshall => gbranden   
 Planned Release:None => 1.23.0 

___

Follow-up Comment #7:

Hi Branden,

[comment #6 comment #6:]
> [comment #5 comment #5:]
> > Would you like me to [also] push my corresponding proposed
> > groff_ms(7) manpage patch, (and also those I've attached to
> > [bug #61022 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.

___

Reply to this item at:

  

___
  Message sent via Savannah
  https://savannah.gnu.org/

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

[G. Branden Robinson]

Update of bug #61157 (project groff):

  Status:None => In Progress
 Assigned to:None => keithmarshall  

___

Follow-up Comment #6:

Hi, Keith!

[comment #5 comment #5:]
> Branden,
> 
> [comment #4 comment #4:]
> > [comment #3 comment #3:]
> > > [comment #1 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 [bug #61022 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.

___

Reply to this item at:

  

___
  Message sent via Savannah
  https://savannah.gnu.org/

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

[Keith Marshall]

Follow-up Comment #5, bug #61157 (project groff):

Branden,

[comment #4 comment #4:]
> [comment #3 comment #3:]
> > [comment #1 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 [bug #61022 ticket #61022], relating
to FS-MARK and FP)?  Or, would you prefer to take ownership of the
documentation aspect yourself?

___

Reply to this item at:

  

___
  Message sent via Savannah
  https://savannah.gnu.org/

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

[Keith Marshall]

Follow-up Comment #4, bug #61157 (project groff):

[comment #3 comment #3:]
> [comment #1 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)
___

Additional Item Attachment:

File name: ms-toc-manpage.patch   Size:2 KB




___

Reply to this item at:

  

___
  Message sent via Savannah
  https://savannah.gnu.org/

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

[Keith Marshall]

Follow-up Comment #3, bug #61157 (project groff):

[comment #1 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?

___

Reply to this item at:

  

___
  Message sent via Savannah
  https://savannah.gnu.org/

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

[Keith Marshall]

Follow-up Comment #2, bug #61157 (project groff):

[comment #1 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.

___

Reply to this item at:

  

___
  Message sent via Savannah
  https://savannah.gnu.org/

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

[G. Branden Robinson]

Follow-up Comment #1, bug #61157 (project groff):

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.

___

Reply to this item at:

  

___
  Message sent via Savannah
  https://savannah.gnu.org/

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

[Keith Marshall]

URL:
  

 Summary: [ms]: Add support for user-defined styling of TOC
leaders
 Project: GNU troff
Submitted by: keithmarshall
Submitted on: Tue 14 Sep 2021 09:33:25 PM UTC
Category: Macro - ms
Severity: 3 - Normal
  Item Group: New feature
  Status: None
 Privacy: Public
 Assigned to: None
 Open/Closed: Open
 Discussion Lock: Any
 Planned Release: None

___

Details:

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



___

File Attachments:


---
Date: Tue 14 Sep 2021 09:33:25 PM UTC  Name: ms-toc-leader.patch  Size: 912B  
By: keithmarshall
Patch to support TOC leader styling


___

Reply to this item at:

  

___
  Message sent via Savannah
  https://savannah.gnu.org/