git/list[1] front-page[2] threads[3] people[4] search[5] about
 

RFD: tables in documentation

From
Michael J Gruber <git@drmicha.warpmail.net>
Date
May 1, 2010, 18:37 UTC
Message-ID
<4BDC74F3.2020206@drmicha.warpmail.net>

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: Jeff King
Message 1 of 11 in “RFD: tables in documentation”
  1. Michael J GruberMay 1, 2010
  2. Jeff KingMay 2, 2010
  3. Michael J GruberMay 2, 2010
  4. Will PalmerMay 2, 2010
  5. Will PalmerMay 2, 2010
  6. Michael J GruberMay 2, 2010
  7. Michael J GruberMay 2, 2010
  8. Jonathan NiederMay 2, 2010
  9. Michael J GruberMay 2, 2010
  10. Jeff KingMay 25, 2010
  11. Michael J GruberMay 25, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.