[Typo3-documentation] Proposition for Doc section of typo3.org

Patrick Gaumond patrick.gaumond at fsa.ulaval.ca
Wed Jun 16 21:44:39 CEST 2004


Here's a copy of an email I sent to Kasper at the end of May. His answer
was:

"I agree 95% with your text and will add it soon when I look at the site
next week or so."

That was before the wiki... and YOU.

Patrick

-------------------- Original May proposition -------------------------
Here's my view about the whole Document library:

1-       « Introduction » and « Start here » should be merged. (see below)
2-       Full TOC can go away.
3-       Glossary should be hidden (« available soon » is a wish.) Once a
reality, unhide it.
4-       The « introduction » tab is broken, leads to Installation and
upgrade.
5-       Those are my views. As usual you got the last word! And I'm open to
critics!

TYPO3 Documentation Library

The complete TYPO3 documentation represents more than 2000 pages of
information. Here we've regroup the major documents by profile or task. To
view the entire library use the Matrix (link) tab.

Beginners

Getting started - To get an overview of the whole system. Available in
multiple languages in the Matrix.
Modern Template Building part 1 - to get an overview of the templating
system.
Typoscript by example - A great tutorial to see lots of Typoscript examples.
Typo3 Template Basics, Templates, TypoScript & beyond and Golive Template
integration are other tutorials that can help you working with templates.

References

TSref - This is THE reference. Variables, constants, Setup, everything is
there.
TSconfig - Modifications to the BackEnd  (User and Page).
RTE - Even if this extension is controleb via TSconfig, it has his hown
manual.

End users - Editors

Typo3 Tutorial - By Marlie Cohen
Handbuch für Redakteure (deutsch) - An english version should be available
in the future

Advanced users - Extensions programmers

TypoScript Syntax and In-depth Study - The title says it all.
Inside Typo3 - What's the magic behind TYPO3
Project Coding Guidelines - How to code your extensions.
My Extension - An openoffice.org template to document your extension.
Futuristic Template Building (FTB) - How to build templates using the
TemplaVoilà extension.

Installation

There's a complete section in the Matrix about it. You could also consider
the Server Compatibility Chart document.

Extension Specific

Usually, every extension developer should provide documentation. By looking
at the Matrix, you will see at the bottom all of it.


About documentation format

The official format for TYPO3 documentation is the SXW format provide by
using OpenOffice.org Writer wich is available for multiple OS at
www.openoffice.org. It's nice to know that by using this format, you will be
able to modify, if needed, any document found on typo3.org website.

To download documents from the Matrix page, simply click on the SXW icon.

Alternatively, most documents are also available as PDF in the Matrix page
but be aware that they not necessarily represent the latest SXW version.

TYPO3 project adhere to the Open Content License available from
http://www.opencontent.org/opl.shtml.





More information about the TYPO3-project-documentation mailing list