unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org
Subject: Re: [Patch v3 2/3] man: partial conversion to pod.
Date: Fri, 17 Jan 2014 16:09:12 -0400	[thread overview]
Message-ID: <87bnzagyl3.fsf@zancas.localnet> (raw)
In-Reply-To: <87lhyer3lf.fsf@nikula.org>

Jani Nikula <jani@nikula.org> writes:

> On Wed, 15 Jan 2014, David Bremner <david@tethera.net> wrote:
>> From: David Bremner <bremner@debian.org>

> In short, I'm really tempted by using markdown as the format, not least
> because it's what we use for the web pages. The big (also literally)
> downside is pandoc (http://johnmacfarlane.net/pandoc/), the tool for
> converting markdown to man. I don't mind its dependencies, others may
> disagree. Are there any sensible alternatives to pandoc?

To complicate things, if we did decide on something heavyweight I think
I'd propose we think about rst instead of markdown. I don't rst as well
as markdown, but markdown does feel a little too adhoc to me from time
to time (e.g. a verbatim block forcing the end of a list and so on).
As far as I can tell, there are many incompatible versions of markdown
as soon as you start to want e.g. tables.

In any case, rst -> man is supported by python-docutils. sphinx supports
both man page generation and texinfo output.  So that would be relatively
lighter weight alternative (??) to pandoc.

A more radical proposal would be to skip generating info and assuming
everybody can browse html in emacs. That assumption is supposed to
become less ludicrous in emacs24.4 with the inclusion of "eww".

d

  reply	other threads:[~2014-01-17 20:09 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-10  2:22 [RFC patch] emacs: skeleton of texinfo manual for emacs interface david
2013-04-25  1:19 ` Second draft of info manual david
2013-04-25  1:19   ` [RFC Patch v2 1/3] info: start info documentation david
2013-04-25  1:19   ` [RFC Patch v2 2/3] man: partial conversion to pod david
2013-04-25  1:19   ` [RFC Patch v2 3/3] debian: install info files david
2014-01-05 11:39   ` third draft of info manual David Bremner
2014-01-05 11:39     ` [PATCH 1/3] info: start info documentation David Bremner
2014-01-05 11:39     ` [PATCH 2/3] man: partial conversion to pod David Bremner
2014-01-13 21:06       ` Tomi Ollila
2014-01-14 12:06         ` David Bremner
2014-01-14 12:27           ` Tomi Ollila
2014-01-15 13:08             ` David Bremner
2014-01-15 13:08               ` [Patch v3 1/3] info: start info documentation David Bremner
2014-01-17 15:59                 ` Jani Nikula
2014-01-17 16:12                 ` Jani Nikula
2014-01-17 19:54                   ` David Bremner
2014-01-18 11:06                     ` Mark Walters
2014-01-18 12:48                       ` Tomi Ollila
2014-01-18 14:52                       ` [PATCH] emacs: help: add link to info node Mark Walters
2014-01-15 13:08               ` [Patch v3 2/3] man: partial conversion to pod David Bremner
2014-01-17 16:10                 ` Jani Nikula
2014-01-17 20:09                   ` David Bremner [this message]
2014-01-17 23:35                     ` Gregor Zattler
2014-01-18 11:11                     ` Mark Walters
2014-01-15 13:08               ` [Patch v3 3/3] debian: install info files David Bremner
2014-01-15 13:16                 ` David Bremner
2014-01-05 11:39     ` [PATCH " David Bremner

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

  List information: https://notmuchmail.org/

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

  git send-email \
    --in-reply-to=87bnzagyl3.fsf@zancas.localnet \
    --to=david@tethera.net \
    --cc=jani@nikula.org \
    --cc=notmuch@notmuchmail.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.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

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 read-only IMAP folder(s) and NNTP newsgroup(s).