[squeak-dev] HelpSystem (was Documentation Team)
hannes.hirzel at gmail.com
Wed Apr 21 10:28:41 UTC 2010
Thank you Tobias for this background information.
I would like to remind us that we have our "own markup language": Text.
It is not possible to write it manually as a plain text but the string
representation is OK.
So we need convenience methods like
Text fromTextile: aString
Text fromReStructuredText: aString
Text fromPier2WikiText: aString
and the inverse
As these languages are not feature complete there could be some loss
of formatting by doing a round-trip. However I would say let's focus
on what works.
- bold / italics
- ... maybe more
Helpful in addition
It contains a syntax comparison table,
A lightweight markup language is a markup language with a simple
syntax, designed to be easy for a human to enter with a simple text
editor, and easy to read in its raw form.
Lightweight markup languages are used in applications where people
might be expected to read the document source as well as the rendered
output. For instance, a person downloading a software library might
prefer to read the documentation in a text editor rather than a
Another application is for entry in web-based publishing, such as
weblogs and wikis, where the input interface is a simple text box. The
server software converts the input to a common document markup
language like HTML or XHTML.
On 4/21/10, Tobias Pape <Das.Linux at gmx.de> wrote:
> Am 2010-04-21 um 09:53 schrieb Hannes Hirzel:
>> Regarding markup
>> I think we should look into the ideas presented by 'markdown'.
>> There are a lot of converters in many languages and into many formats.
> There are Different such languages.
> • Markdown, incarnation in Perl
> – a bunch of extenstions thereof
> like http://fletcherpenney.net/multimarkdown/
> • Textile incarnation in PHP
> Both tend to be heavily used in Rails/Ruby on Rails
> • reStructured Text incarnation in Python docutils
> used for python docstrings and PEPs
> From its history and its application
> (and because i like the syntax)
> I'd vote for the last one
> so Long,
More information about the Squeak-dev