Zsh Mailing List Archive
Messages sorted by: Reverse Date, Date, Thread, Author

Re: Cross-reference format in man pages



Patch is attached as a file (since it's rather long).

> 2025/07/04 13:48, Jun T <takimoto-j@xxxxxxxxxxxxxxxxx <mailto:takimoto-j@xxxxxxxxxxxxxxxxx>> wrote:
> 
>    See the section `Filename Generation'
> but the section is in zshexpn(1).

In addition to fixing the missing man page name, various minor
fixes (and improvements, hopefully) are included
(using more specific referent, etc.).

> Since section names in man pages are in bold ALLCAPS, I
> will (try to) use
> bf(FILENAME GENERATION)
> when referring to the section names. Is this OK?
> (I will define a new macro for this)

Four new yodl macros are defined.

  nmref(node)(manpage) is for referring to texi node or manpage
  (depending on ifnzman or ifzman).

  sectref(sectname)(manpage) is for referring to a section in
  manpage, or a texi node. There should be a texi node (or anchor)
  with the same name as the 'sectname'.
  Use anchor() for creating the anchor.

  subref(subsectname)(manpage) is similar but for a subsection.

I also patched Util/zyodl.vim to recognize the 4 new macros.


Attachment: xref.patch
Description: Binary data



Messages sorted by: Reverse Date, Date, Thread, Author