[TYPO3-dev] ReST workshop at T3DD12: What do you expect?

[Martin Bless]

I'm planning to to a ReST workshop at the upcoming developer days.
ReST is the upcoming standard for Documentation in the TYPO3 universe.

Q: I'd like know:

- What are your expectations about such a workshop?
- What would you like to learn?
- What would you like to do?

**ReST: What is it?**

ReST stands for "reStructuredText". Lets agree on the spelling "ReST"
to make up an abbreviation and logo (Wort-Bildmarke) for this format.
Simply because its used very often that way and has turned out to
work.

ReST is an approach to use "normal typewriter text" for many kind of
writings. Special properties of the text are recognized as "markup".
ReST tries to use markup as much as possible that seems very natural
to humans: An empty line finishes a paragraph, an underlined line
creates a heading and so on. Most often the source texts are very well
readable by itselves. And they are non-binary!

OTH the syntax that is used for markup sticks to strict rules. The
ReST reader will give you warnings and error messages. Only valid
documents can be processed. The reader creates an internal DOM for the
document that can afterwards be written by writer modules to xml, pdf,
epub, html and so on.


**Is ReST of interest to you?**

Probably yes :-) It is of interest to anybody who needs to create
documentation or wants to create text documents, articles, books using
a non-binary, well readable text format. It is in no way restricted to
TYPO3 documentation. But its very well suited to create documentation
for customer projects.

This posting uses the ReST format.

Martin

-- 
http://mbless.de