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

Re: WIP: asciidoc replacement

From
Wincent Colaiuta <win@wincent.com>
Date
Oct 3, 2007, 10:05 UTC
Message-ID
<1D18C52E-BB96-49EC-97A9-F802D56CAFF5@wincent.com>
In-Reply-To
<85abr0y5ua.fsf@lola.goethe.zz>
El 3/10/2007, a las 10:12, David Kastrup escribió:
> What with output in print, HTML, info?
Yes, that's still a problem...
> Personally, I think it might make sense to just step away from the
> AsciiDoc documentation to Docbook: plain text (without cutified
> formatting control like in AsciiDoc) can be generated _from_ Docbook.

Yes, but editing DocBook (XML) is relatively painful compared to editing plain text. You either have to rely on a bloated XML- validating editor or instead ask your doc authors to manually write valid XML (and I totally agree with Terrence Parr that, "XML makes a lousy human interface "; see <http://www.ibm.com/developerworks/xml/library/x-sbxml.html> for his full take).

I know that Linus has argued for AsciiDoc because the source *is* the plain text documentation and is therefore easily readable, but for me the real benefit lies in the fact that *because* the source is plain text it is easily edited (ie. that the source is easily *writeable*), and things like documentation patches are very neat with AsciiDoc.

Cheers, Wincent

Previous: David KastrupNext: David Kastrup
Message 12 of 25 in “WIP: asciidoc replacement”
  1. Johannes SchindelinOct 3, 2007
  2. Sam VilainOct 3, 2007
  3. Johannes SchindelinOct 3, 2007
  4. Jeff KingOct 3, 2007
  5. J. Bruce FieldsOct 3, 2007
  6. Sam VilainOct 4, 2007
  7. Johannes SchindelinOct 4, 2007
  8. Wincent ColaiutaOct 3, 2007
  9. Junio C HamanoOct 3, 2007
  10. Wincent ColaiutaOct 3, 2007
  11. David KastrupOct 3, 2007
  12. Wincent ColaiutaOct 3, 2007
  13. David KastrupOct 3, 2007
  14. Sam RavnborgOct 3, 2007
  15. J. Bruce FieldsOct 3, 2007
  16. David KastrupOct 3, 2007
  17. Junio C HamanoOct 3, 2007
  18. Sam RavnborgOct 3, 2007
  19. Johannes SchindelinOct 3, 2007
  20. Sam RavnborgOct 3, 2007
  21. Martin LanghoffOct 4, 2007
  22. David KastrupOct 4, 2007
  23. Martin LanghoffOct 4, 2007
  24. Johannes SchindelinOct 3, 2007
  25. David KastrupOct 3, 2007

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.