discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Jan Stary <hans@stare.cz>
To: discuss@mdocml.bsd.lv
Subject: a few -Thtml nits
Date: Thu, 7 Jun 2018 16:59:48 +0200	[thread overview]
Message-ID: <20180607145947.GA28980@www.stare.cz> (raw)

Hi Ingo,

firts of all, many thanks for the continuous improvements of mandoc.

I am in the process of converting the rtptools' html manpages
to be generated from the actual manpages with mandoc -Thtml.

https://github.com/janstary/rtptools/commits/webpage
./configure && make clean html

Mostly, mandoc -Thtml -O style,man works very well.
However, there are a few nits.

1. The w3c validator finds what it considers fatal errors in the output:
https://validator.w3.org/nu/?doc=http%3A%2F%2Fbiblio.stare.cz%2Frtptools%2Frtpdump.1.html
The problem seems to be that the generated html manpage contains,
as a long html comment, the obligate license statement (itself a comment
in the mdoc source) which is long enough to push the <meta charset="utf-8"/>
_after_ the first 1024 bytes, which the validator considers a problem.

2. I can link to http://biblio.stare.cz/rtptools/rtpdump.1.html#F
- would it be an improvement if mandoc -Thtml created such links
in the SYNOPIS, or would it be too much clutter in the one line?

3. The AUTHORS get rendered fine; could the .An John Doe Mt ...
be rendered in the -Thtml output as a "mailto:", or is it
a special case not worth the complication?

	Thanks,

		Jan

--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv

             reply	other threads:[~2018-06-07 14:59 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-06-07 14:59 Jan Stary [this message]
2018-06-07 15:24 ` Jan Stary
2018-06-07 16:15   ` Jan Stary

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180607145947.GA28980@www.stare.cz \
    --to=hans@stare.cz \
    --cc=discuss@mandoc.bsd.lv \
    --cc=discuss@mdocml.bsd.lv \
    --subject='Re: a few -Thtml nits' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

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