Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

man page missing header causing appending to XML discussion #846

Closed
jidanni opened this issue Nov 21, 2019 · 3 comments
Closed

man page missing header causing appending to XML discussion #846

jidanni opened this issue Nov 21, 2019 · 3 comments

Comments

@jidanni
Copy link
Contributor

jidanni commented Nov 21, 2019

On tidy 5.6 man page, before

       Configuration options can be specified...

there is a missing header, causing this to still be part of the XML discussion.

@geoffmcl
Copy link
Contributor

@jidanni thank you for the issue...

Yes, it certainly does appear, the man tidy page, even with the latest 5.7.28, by indentation alone, the the paragraph with options can be specified seems joined with the last subheading, namely XML... ugh!

After a bit a reading about xsltproc stylesheet syntax, (difficult to find)...

... reading the source docs, like how the man page is generated, from CMakeLists.txt...

... particularly the last call-template, in the src tidy1.xsl.in...

... showing how the man page is generated... through xml transformation... blah, blah, blah,,,

This led me to a simple sub-header addition, and a new line... so a suggested patch...

--- tidy1.org.xsl       2019-07-10 19:48:51.000000000 +0200
+++ tidy1.xsl   2019-11-27 16:21:53.000000000 +0100
@@ -98,6 +98,8 @@
 can be combined; for example '\fB-i\fR', '\fB-m\fR' and '\fB-u\fR'
 may be combined as '\fB-imu\fR'.<xsl:text/>
 <xsl:call-template name="show-cmdline-options" />
+.SS Configuration Options General
+.rs
 .LP
 \fIConfiguration\fR options can be specified
 by preceding each option with \fB--\fR at the command line,

But I am entirely new to this syntax, and maybe others, who know, understand more... can make the docs better...

Please step in with comments, patches, PR, etc... thanks...

@geoffmcl geoffmcl added the Docs label Nov 28, 2019
@geoffmcl
Copy link
Contributor

2020/10/11
@jidanni thank you for responding with an emoji... way back then... but...

But I need someone, preferably with xsltproc stylesheet syntax knowledge, to try the patch, maybe modify... correct... build... and report...

As stated, can someone please step up, with comments, tests, patches, PR, etc... so this issue can move forward... thanks...

@geoffmcl
Copy link
Contributor

20210414: review, 6 months later, over a year from opening...

@jidanni, well, no one has stepped forward, given feedback, help, comments... nothing, except an emoji... oh, well...

I have tested again with the simple patch, as below, and it seems to correct the problem of the XML discussion runs into the following config options text...

diff --git a/man/tidy1.xsl.in b/man/tidy1.xsl.in
index a1d9cfd..e4271db 100644
--- a/man/tidy1.xsl.in
+++ b/man/tidy1.xsl.in
@@ -98,6 +98,8 @@ Single-letter \fIcommand-line\fR options without an associated value
 can be combined; for example '\fB-i\fR', '\fB-m\fR' and '\fB-u\fR'
 may be combined as '\fB-imu\fR'.<xsl:text/>
 <xsl:call-template name="show-cmdline-options" />
+.SS Configuration Options General
+.rs
 .LP
 \fIConfiguration\fR options can be specified
 by preceding each option with \fB--\fR at the command line,

Can someone at least apply the tiny 2 line patch, and test, review, it...

I use $ man -l tidy.1, after a fresh build, and it looks fine...

Or suggest alternatives... thanks...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants