On Fri, Feb 22, 2008 at 10:57 AM, Reinier Lamers <<a href="mailto:tux_rocker@reinier.de">tux_rocker@reinier.de</a>> wrote:<br><br>> [...] <br>> Of course, the source code includes comments that specify what<br>
> functions do, and so provide a bit of API documentation. But such<br>> comments should contain as little formatting as possible to keep them<br>> readable in a text editor.<br><br>Hi Reinier,<br><br>Do you know about the [Markdown] format and the [Pandoc] processor? [Markdown] is designed for *readability* in text editors and based on common text conventions.<br>
<br>From the [markdown] home page:<br><br>> The overriding design goal for Markdown's formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions. While Markdown's syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown's syntax is the format of plain text email.<br>
<br>Don't take their word for it or mine. You can copy and paste this message into the [Try Pandoc] page.<br><br>Regards, - Conal<br><br>[Markdown]: <a href="http://daringfireball.net/projects/markdown">http://daringfireball.net/projects/markdown</a> "The markdown project page"<br>
[Pandoc]: <a href="http://johnmacfarlane.net/pandoc/try">http://johnmacfarlane.net/pandoc/try</a> "The Pandoc project page"<br>[Try Pandoc]: <a href="http://johnmacfarlane.net/pandoc/try">http://johnmacfarlane.net/pandoc/try</a> "Try out Pandoc for yourself"<br>
<br>