public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed

From: Michael J Gruber <git@drmicha•warpmail.net>
To: Git Mailing List <git@vger•kernel.org>
Subject: RFD: tables in documentation
Date: Sat, 01 May 2010 20:37:39 +0200	[thread overview]
Message-ID: <4BDC74F3.2020206@drmicha.warpmail.net> (raw)

Currently, all tables are formatted using indentation by spaces. This
breaks whenever AsciiDoc's parsing changes.

Instead, I suggest to use AsciiDoc's table syntax which also produces
proper tables in the HTML and man output. I formatted the first part of
the first table in git-read-tree(1) like that so that you can compare
easily.

I put it up at http://repo.or.cz/w/git/mjg.git/commit/table-example for
your viewing pleasure. I'd say it looks great even in links (but not in
lynx). It also shows a problem of xmlto with multiple rowspans (the xml
is correct, .1 apparently not), which could be circumvented easily by
repeating those cells.

HTML:
http://repo.or.cz/w/git/mjg.git/blob_plain/table-example:/Documentation/git-read-tree.html

MAN:
http://repo.or.cz/w/git/mjg.git/blob_plain/table-example:/Documentation/git-read-tree.1

MAN converted to txt by man:
http://repo.or.cz/w/git/mjg.git/blob_plain/table-example:/Documentation/git-read-tree.1.txt

MAN converted to HTML by man2html:
http://repo.or.cz/w/git/mjg.git/blob_plain/table-example:/Documentation/git-read-tree.1.html

Cheers,
Michael

next             reply	other threads:[~2010-05-01 18:37 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-05-01 18:37 Michael J Gruber [this message]
2010-05-02  5:06 ` RFD: tables in documentation Jeff King
2010-05-02 13:31   ` Michael J Gruber
2010-05-02 14:43     ` Will Palmer
2010-05-02 14:51       ` Will Palmer
2010-05-02 15:08         ` Michael J Gruber
2010-05-02 15:27           ` Michael J Gruber
2010-05-02 17:53             ` Jonathan Nieder
2010-05-02 19:23               ` Michael J Gruber
2010-05-25  9:46     ` Jeff King
2010-05-25 11:59       ` Michael J Gruber

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=4BDC74F3.2020206@drmicha.warpmail.net \
    --to=git@drmicha$(echo .)warpmail.net \
    --cc=git@vger$(echo .)kernel.org \
    /path/to/YOUR_REPLY

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox