From: "Casper Ti. Vector" <caspervector@gmail.com>
To: supervision@list.skarnet.org
Subject: Re: [request for review] Port of s6 documentation to mdoc(7)
Date: Tue, 1 Sep 2020 14:38:01 +0800 [thread overview]
Message-ID: <20200901063801.GA2158@CasperVector> (raw)
In-Reply-To: <em5319e6fd-1081-4140-9af5-75537ebd0f40@elzian>
On Mon, Aug 31, 2020 at 08:51:34PM +0000, Laurent Bercot wrote:
> - Unless, of course, someone comes up with the perfect solution (adding
> a DocBook dependency is not a perfect solution, and neither is
> generating HTML from mandoc), in which case, obviously, they would have
> the time and willingness to do all the necessary work themself, and in
> doing so, actually meaningfully contribute to the community instead of
> only adding their drop to the useless sea of It's Easy You Just Have To
> Do This, Just Saying In Case You Had Not Considered.
Sorry if this adds to your boredom in this subject, but I wonder whether
you find the following acceptable:
* We negotiate a HTML schema your documentation can be written in, which
is based on current documentation; existing HTML documentation will be
converted to the schema, with minimised changes. (The structuredness
of HTML helps; now you also see why knowing some Lisp is beneficial :)
* I provide a Python script that validates the schema (and also helps
to convert existing documentation) of your HTML documentation, and
transforms it into an IR suitable for downstream conversion. I am
quite comfortable with writing code transformations, but it may take
some time -- about 1 months in this case, since I have my daily job.
* Those who are fluent in roff-related formats (I *do* like manpages,
but I cannot write them, at least for now) write a program that
transforms the IR into one pre-chosen format (we do not like multiple
standards differing from each other subtlely, right?).
This way, the changes to the current documentation will be minimised;
the downside is a soft dependency on Python, which is only necessary
when the amount of modification to the HTML is so big that you cannot
manually compute corresponding modification to the manpages.
--
My current OpenPGP key:
RSA4096/0x227E8CAAB7AA186C (expires: 2022.09.20)
7077 7781 B859 5166 AE07 0286 227E 8CAA B7AA 186C
next prev parent reply other threads:[~2020-09-01 6:38 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-30 8:30 Alexis
2020-08-30 9:10 ` eric vidal
2020-08-31 6:56 ` Alexis
2020-08-30 10:01 ` Laurent Bercot
2020-08-31 7:01 ` Alexis
2020-08-31 11:04 ` Laurent Bercot
2020-08-31 14:29 ` Guillermo
2020-09-01 10:00 ` possible s6-rc redesign (was: [request for review] Port of s6 documentation to mdoc(7)) Laurent Bercot
2020-09-01 19:24 ` possible s6-rc redesign mobinmob
2020-09-01 22:16 ` Dudemanguy
2020-09-01 22:20 ` Laurent Bercot
2020-09-02 9:41 ` mobinmob
2020-09-02 12:14 ` Laurent Bercot
2020-09-01 23:14 ` possible s6-rc redesign (was: [request for review] Port of s6 documentation to mdoc(7)) Steve Litt
2020-08-31 16:08 ` [request for review] Port of s6 documentation to mdoc(7) J. Lewis Muir
2020-08-31 17:45 ` Jason Lenz
2020-08-31 19:14 ` J. Lewis Muir
2020-08-31 20:51 ` Laurent Bercot
2020-09-01 6:38 ` Casper Ti. Vector [this message]
2020-09-01 9:03 ` Alexis
2020-09-01 9:20 ` Casper Ti. Vector
2020-09-01 10:02 ` Alexis
2020-09-01 10:15 ` Casper Ti. Vector
2020-09-01 20:13 ` Steve Litt
2020-09-02 0:50 ` Alexis
[not found] ` <20200901063801.GA2158@caspervector>
2020-09-01 10:11 ` Laurent Bercot
2020-09-01 11:28 ` Casper Ti. Vector
2020-09-01 11:55 ` Alexis
2020-08-31 19:36 ` Laurent Bercot
2020-08-31 19:58 ` J. Lewis Muir
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=20200901063801.GA2158@CasperVector \
--to=caspervector@gmail.com \
--cc=supervision@list.skarnet.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).