* Re: Dangling reference in zshroadmap(1) (was: Re: test for newline in a variable--unexpected results sometimes) [not found] ` <1537138615.3041549.1510092752.5632AB35@webmail.messagingengine.com> @ 2018-09-16 23:33 ` dana 2018-09-17 0:04 ` Daniel Shahaf 0 siblings, 1 reply; 2+ messages in thread From: dana @ 2018-09-16 23:33 UTC (permalink / raw) To: Daniel Shahaf; +Cc: Zsh hackers list (This belongs in workers now, yeah?) On 16 Sep 2018, at 17:56, Daniel Shahaf <d.s@daniel.shahaf.name> wrote: >I don't understand the last sentence? I haven't bothered to look at the actual source (and don't know it well from memory yet), but just from the end result, it seems that it's set up so that if a chapter has no sub-sections (like 'Command Execution') or if it has some introductory text before the sub-sections (like 'Functions'), the top-level heading is preserved. For chapters like 'Jobs & Signals', where the first bit of content is a sub-heading, that top-level heading goes away, so as not to have two consecutive headings. On 16 Sep 2018, at 17:56, Daniel Shahaf <d.s@daniel.shahaf.name> wrote: >What end result would we like to achieve? Once we nail that down we can >think how to implement it. > >At least, we could grep for any instances of ifnzman(see the section >`foo'...) where `foo' is a texinode() of a chapter(), and fix them. For cases like the 'Shell Grammar' reference you found, it seems like there are basically two kinds of options: Either change the reference to point to a specific section instead of a whole chapter, or change the structure of the pages to include the chapter heading. Assuming that's true, only the latter is appropriate here, right? I'm probably speaking out of turn, though, tbh; i know way less about how this works than you. dana ^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: Dangling reference in zshroadmap(1) (was: Re: test for newline in a variable--unexpected results sometimes) 2018-09-16 23:33 ` Dangling reference in zshroadmap(1) (was: Re: test for newline in a variable--unexpected results sometimes) dana @ 2018-09-17 0:04 ` Daniel Shahaf 0 siblings, 0 replies; 2+ messages in thread From: Daniel Shahaf @ 2018-09-17 0:04 UTC (permalink / raw) To: dana; +Cc: Zsh hackers list dana wrote on Sun, 16 Sep 2018 18:33 -0500: > (This belongs in workers now, yeah?) > Sure. > On 16 Sep 2018, at 17:56, Daniel Shahaf <d.s@daniel.shahaf.name> wrote: > >I don't understand the last sentence? > > I haven't bothered to look at the actual source (and don't know it well from > memory yet), but just from the end result, it seems that it's set up so that if > a chapter has no sub-sections (like 'Command Execution') or if it has some > introductory text before the sub-sections (like 'Functions'), the top-level > heading is preserved. For chapters like 'Jobs & Signals', where the first bit of > content is a sub-heading, that top-level heading goes away, so as not to have > two consecutive headings. > Ah, I see. So you're saying there's some method to the madness by which it's decided which chapter() directives do, or do not, appear in the man page. Furthermore, chapter() headings ("9. Functions") and sect() headings ("9.1 Autoloading Functions") are rendered the same way in the man page. It would be nice to fix this. > On 16 Sep 2018, at 17:56, Daniel Shahaf <d.s@daniel.shahaf.name> wrote: > >What end result would we like to achieve? Once we nail that down we can > >think how to implement it. > > > >At least, we could grep for any instances of ifnzman(see the section > >`foo'...) where `foo' is a texinode() of a chapter(), and fix them. > > For cases like the 'Shell Grammar' reference you found, it seems like there are > basically two kinds of options: Either change the reference to point to a > specific section instead of a whole chapter, or change the structure of the > pages to include the chapter heading. Assuming that's true, only the latter is > appropriate here, right? > Actually, if you look at the source, you'll find that all these references are done separately for the man page output and for the texinfo output. This instance is typical; it looks like this: . General shell syntax is introduced in ifzman(the section `Shell Grammar' in zmanref(zshmisc))\ ifnzman(noderef(Shell Grammar)). . Therefore, we can easily change the text for the man page output only, as a low-hanging fruit / hotfix. > I'm probably speaking out of turn, though, tbh; i know way less about how this > works than you. I don't think you are. What I know about yodl and the manual could fit in a very small number of bytes. Cheers, Daniel ^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-09-17 0:04 UTC | newest] Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- [not found] <20180916172716.GA27892@lilyforest.localdomain> [not found] ` <20180916204433.6k36inmuekgqp3a2@tarpaulin.shahaf.local2> [not found] ` <DC89977C-A130-483E-A631-E7A2CD6AE7A0@dana.is> [not found] ` <1537134280.3026165.1510059848.0DC32D7A@webmail.messagingengine.com> [not found] ` <73DDD712-8DE5-4EA7-8488-5ED0A4EFB2A6@dana.is> [not found] ` <1537138615.3041549.1510092752.5632AB35@webmail.messagingengine.com> 2018-09-16 23:33 ` Dangling reference in zshroadmap(1) (was: Re: test for newline in a variable--unexpected results sometimes) dana 2018-09-17 0:04 ` Daniel Shahaf
Code repositories for project(s) associated with this public inbox https://git.vuxu.org/mirror/zsh/ This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).