SlideShare ist ein Scribd-Unternehmen logo
TYPO3 Dokumentation
mitreStructuredText
Einführung und Überblick
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
Übermich 2
Peter Linzenkirchner
Lisardo EDV-Beratung, Augsburg
Freelancer: TYPO3, HTML, CSS
TYPO3 Certified Integrator
Web: www.typo3-lisardo.de
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
DokumentationmitOpenoffice 3
TYPO3CMSDokuaufdocs.typo3.org 4
ExtensionDokumentation 5
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
reStructuredText 6
reStructuredText ist eine Auszeichnungssprache ähnlich markdown oder
textile. Sie wurde entwickelt für die Dokumentation der Programmiersprache
Python, die für den Parser auch benötigt wird.
Vorteile
auch ungeparst einigermaßen gut lesbar ist
textbasiert
kann mit Git oder SVN versioniert werden
speziell für Dokumentation entwickelt
Export in andere Formate: ODT, Manpage, HTML, XML, LaTeX, PDF etc.
http://wiki.typo3.org/ReST
http://de.wikipedia.org/wiki/ReStructuredText
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
Abschnitt-Titel (Section)
=========================
Unterabschnitt
--------------
Normaler Text und so weiter und so fort.
- Erster Punkt
- Zweiter Punkt
- Dritter Punkt
1) Ein Punkt einer nummerierten Liste
2) Zweites...
3) Dritter Punkt der nummerierten Liste
- der Text hier wird kursiv: *text*
- der hier wird fett: **text**
- und das ist Code: ``text``
===== ===== =======
A B A and B
===== ===== =======
False False False
True True True
===== ===== =======
reStructuredText–Syntax 7
Manuals: http://docutils.sourceforge.net/rst.html
http://wiki.typo3.org/ReST_Syntax
Dieser Absatz bekommt eine Fußnote. [1]_
Bilder
------
.. image:: images/myimage.jpg
:height: 299
:width: 348
:scale: 50
:alt: Katze beim Duschen
Hyperlinks
----------
_reStructuredText: http://docutils.sf.net/rst.html
Links auf die Dokumentation von TYPO3:
---------------------------------------
- :ref:`TYPO3 Tutorial for Editors <t3editors:start>`
- :ref:`Getting Started Tutorial <t3start:start>`
Fußnoten
---------
.. [1] Eine Fußnote
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
reStructuredText:HTML 8
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
reStructuredText–Voraussetzungen 9
Die Markup-Sprache muss geparst und in eine
andere Sprache konvertiert werden.
Voraussetzungen:
Python
Sphinx – das Tool, das die Umwandlung in HTML vornimmt
die Templates von TYPO3
Tools zum Erstellen von PDFs (optional)
Zwei mögliche Arbeitsweisen:
global: Installation der Tools auf dem Rechner
innerhalb von TYPO3 mit der Extensions »sphinx«
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
reStructuredText–Testen
Online-Editoren
Mit Online-Editoren kann man reStructuredText ausprobieren, ohne vorher
alle Komponenten installieren zu müssen. Allerdings ist es nicht möglich für
den Export die TYPO3-Templates zu verwenden.
https://notex.ch
Umfangreicher Editor, mit einem kompletten Beispielprojekt und
verschiedenen Exportmöglichkeiten: HTML, PDF, EPUB
http://rst.ninjs.org
Simpler Editor, der mit Hilfe von zwei Themes reStructured Text in HTML
umwandelt.
Offline-Editoren
Um diese benutzen zu können, müssen vorher die Komponenten alle
installiert werden. Eine Liste von Offline-Editoren findet sich hier:
http://wiki.typo3.org/Editors_(reST)
10
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
Installation
Global, ausserhalb von TYPO3
Damit können reST-Dokumentation auch ausserhalb von TYPO3 erstellt
werden, und auch mit anderen Templates als TYPO3. Installation und weitere
Arbeit sind aber etwas umständlicher als innerhalb von TYPO3.
Am besten einfach den Anleitungen im Wiki folgen:
Mac + Linux: http://wiki.typo3.org/Rendering_reST_on_Linux
Windows: http://wiki.typo3.org/Rendering_reST_on_Windows
Die Anleitungen sind durchdacht und haben bei mir problemlos funktioniert.
Ausführliche Dokumentation zu Sphinx:
http://sphinx-doc.org
11
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
12
Das default-Theme ist
das Standardtheme der
Python-Dokumentation.
Weitere Themes, Installations-
anleitungen und Anleitung
zum Erstellen eigener Themes
sind auf der Sphinx-Webseite
zu finden:
http://sphinx-doc.org/theming.html
DefaultTemplate
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
InstallationinTYPO3 13
Extension »sphinx«
http://typo3.org/extensions/repository/view/sphinx
Diese Extension installiert die nötigen Tools (Python, Sphinx und die TYPO3-
Templates) in die TYPO3-Installation.
Installation erfolgt in zwei Schritten: Download und Installation der Extension,
danach im Extensions Manager über die Updatefunktion die Tools
herunterladen. Der Vorgang ist in der Dokumentation gut erklärt.
Ausserdem installiert es zwei Module, die bei der Arbeit mit
Dokumentationen hilfreich sind:
Sphinx Console
Damit können innerhalb von fileadmin reST-Projekte angelegt werden
Sphinx Documentation Library
Damit können die reST-Dokumentationen von Betrachtet und Bearbeitet
werden.
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
SphinxConsole–Projektanlegen 14
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
SphinxConsole–Index.rst 15
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
SphinxConsole–Settings.yml 16
SphinxConsole–HTMLgenerieren 17
SphinxConsole–HTML 18
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
SphinxConsole–Dateistruktur 19
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
SphinxDocumention–Kickstarter 20
In Extensions können hier neue Dokumentationen angelegt und/oder
vorhandene Openoffice-Dokument in reST-Dokumentationen konvertiert
werden.
reST-Dokumentationenanschauen 21
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
Lokalisierung 22
http://wiki.typo3.org/Localization_(reST)
http://docs.typo3.org/typo3cms/extensions/sphinx/latest/UsersManual/
DocsTypo3Org/Index.html
reST-Dokumentationbearbeiten 23
www.typo3-lisardo.deTYPO3 Dokumentation mit reST
reST-DokumentationenfürExtensions 24
Manual / Anleitung
http://wiki.typo3.org/ReST_for_extension_manuals
http://docs.typo3.org/typo3cms/extensions/sphinx/latest/Index.html
Die aktuellen Extensions sollen dann unter dieser URL erscheinen:
http://docs.typo3.org/typo3cms/extensions/myext/latest/Index.html
Aktuelle Einschränkungen
die Dokumentation erscheint noch nicht im TER
die Dokumentation muss manuell von Documentation-Team freigeschaltet
werden. Passiert das nicht, wird unter der URL nur das konvertierte
Openoffice-Dokument gezeigt.
Diese Einschränkungen sollen demnächst wegfallen.

Weitere ähnliche Inhalte

Andere mochten auch

Wordpress Bücher
Wordpress BücherWordpress Bücher
Wordpress Bücher
frankstaude
 
US Patent No 9,253,556 B1
US Patent No 9,253,556 B1US Patent No 9,253,556 B1
US Patent No 9,253,556 B1
Will Pounds (Doc)
 
Hall-Wattens Paketangebote & Höhepunkte 2015/16
Hall-Wattens Paketangebote & Höhepunkte 2015/16Hall-Wattens Paketangebote & Höhepunkte 2015/16
Hall-Wattens Paketangebote & Höhepunkte 2015/16
Tourismusverband Region Hall Wattens in Tirol
 
Pkw Maut wird 2016 in Deutschland eingeführt
Pkw Maut wird 2016 in Deutschland eingeführtPkw Maut wird 2016 in Deutschland eingeführt
Pkw Maut wird 2016 in Deutschland eingeführt
ichwillmeinautoloswerden
 
Trabajo de la Materia de Aplicaciones Informaticas- HISTORIA DE LOS DINOSAURIOS
Trabajo de la Materia de Aplicaciones Informaticas- HISTORIA DE LOS DINOSAURIOSTrabajo de la Materia de Aplicaciones Informaticas- HISTORIA DE LOS DINOSAURIOS
Trabajo de la Materia de Aplicaciones Informaticas- HISTORIA DE LOS DINOSAURIOS
Ariadna Chavez
 
Planos
PlanosPlanos
Planos
Yunae
 
Presentación alberto torres
Presentación alberto torresPresentación alberto torres
Presentación alberto torres
Leudy Padilla
 
Windows
WindowsWindows
Trabajo final
Trabajo finalTrabajo final
Trabajo final
vicko_12
 
Agenturpräsentation dimap communications Checkpoint Karrieretag 2012
Agenturpräsentation dimap communications Checkpoint Karrieretag 2012Agenturpräsentation dimap communications Checkpoint Karrieretag 2012
Agenturpräsentation dimap communications Checkpoint Karrieretag 2012MLuderich
 
Sesión 04 la educación como método de la pastoral juvenil
Sesión 04   la educación como método de la pastoral juvenilSesión 04   la educación como método de la pastoral juvenil
Sesión 04 la educación como método de la pastoral juvenil
Justo Llecllish
 
Utilerias
UtileriasUtilerias
Sitios de internet
Sitios de internetSitios de internet
Sitios de internet
GAbii Castillo
 
Grosssägewerke in der Schweiz - industrieökonomische Auslegeordnung
Grosssägewerke in der Schweiz - industrieökonomische AuslegeordnungGrosssägewerke in der Schweiz - industrieökonomische Auslegeordnung
Grosssägewerke in der Schweiz - industrieökonomische AuslegeordnungMarkus Saurer
 
Maestria exp
Maestria expMaestria exp
Maestria exp
Leudy Padilla
 
Empresa Animales en aluminio.
Empresa Animales en aluminio.Empresa Animales en aluminio.
Empresa Animales en aluminio.
Yeison Cheer
 
Salvemos el mundo
Salvemos el mundoSalvemos el mundo
Salvemos el mundo
Luis Campbell
 
Desert scenes
Desert scenesDesert scenes
Desert scenes
Amadeu Wolff
 

Andere mochten auch (20)

Wordpress Bücher
Wordpress BücherWordpress Bücher
Wordpress Bücher
 
Regionalmarketing
RegionalmarketingRegionalmarketing
Regionalmarketing
 
US Patent No 9,253,556 B1
US Patent No 9,253,556 B1US Patent No 9,253,556 B1
US Patent No 9,253,556 B1
 
Hall-Wattens Paketangebote & Höhepunkte 2015/16
Hall-Wattens Paketangebote & Höhepunkte 2015/16Hall-Wattens Paketangebote & Höhepunkte 2015/16
Hall-Wattens Paketangebote & Höhepunkte 2015/16
 
Pkw Maut wird 2016 in Deutschland eingeführt
Pkw Maut wird 2016 in Deutschland eingeführtPkw Maut wird 2016 in Deutschland eingeführt
Pkw Maut wird 2016 in Deutschland eingeführt
 
Trabajo de la Materia de Aplicaciones Informaticas- HISTORIA DE LOS DINOSAURIOS
Trabajo de la Materia de Aplicaciones Informaticas- HISTORIA DE LOS DINOSAURIOSTrabajo de la Materia de Aplicaciones Informaticas- HISTORIA DE LOS DINOSAURIOS
Trabajo de la Materia de Aplicaciones Informaticas- HISTORIA DE LOS DINOSAURIOS
 
Planos
PlanosPlanos
Planos
 
Presentación alberto torres
Presentación alberto torresPresentación alberto torres
Presentación alberto torres
 
Binder1
Binder1Binder1
Binder1
 
Windows
WindowsWindows
Windows
 
Trabajo final
Trabajo finalTrabajo final
Trabajo final
 
Agenturpräsentation dimap communications Checkpoint Karrieretag 2012
Agenturpräsentation dimap communications Checkpoint Karrieretag 2012Agenturpräsentation dimap communications Checkpoint Karrieretag 2012
Agenturpräsentation dimap communications Checkpoint Karrieretag 2012
 
Sesión 04 la educación como método de la pastoral juvenil
Sesión 04   la educación como método de la pastoral juvenilSesión 04   la educación como método de la pastoral juvenil
Sesión 04 la educación como método de la pastoral juvenil
 
Utilerias
UtileriasUtilerias
Utilerias
 
Sitios de internet
Sitios de internetSitios de internet
Sitios de internet
 
Grosssägewerke in der Schweiz - industrieökonomische Auslegeordnung
Grosssägewerke in der Schweiz - industrieökonomische AuslegeordnungGrosssägewerke in der Schweiz - industrieökonomische Auslegeordnung
Grosssägewerke in der Schweiz - industrieökonomische Auslegeordnung
 
Maestria exp
Maestria expMaestria exp
Maestria exp
 
Empresa Animales en aluminio.
Empresa Animales en aluminio.Empresa Animales en aluminio.
Empresa Animales en aluminio.
 
Salvemos el mundo
Salvemos el mundoSalvemos el mundo
Salvemos el mundo
 
Desert scenes
Desert scenesDesert scenes
Desert scenes
 

Ähnlich wie TYPO3 Dokumentation mit ReStructuredText

Extbase/Fluid: Kennenlernen und ausprobieren
Extbase/Fluid: Kennenlernen und ausprobierenExtbase/Fluid: Kennenlernen und ausprobieren
Extbase/Fluid: Kennenlernen und ausprobieren
SpeedPartner GmbH
 
TYPO3 CMS 7.5 - Die Neuerungen - pluswerk
TYPO3 CMS 7.5 - Die Neuerungen - pluswerkTYPO3 CMS 7.5 - Die Neuerungen - pluswerk
TYPO3 CMS 7.5 - Die Neuerungen - pluswerk
die.agilen GmbH
 
TYPO3 Neos in der Praxis
TYPO3 Neos in der PraxisTYPO3 Neos in der Praxis
TYPO3 Neos in der Praxis
TechDivision GmbH
 
Abläufe mit PHP und Phing automatisieren
Abläufe mit PHP und Phing automatisierenAbläufe mit PHP und Phing automatisieren
Abläufe mit PHP und Phing automatisieren
Christian Münch
 
Composer und TYPO3
Composer und TYPO3Composer und TYPO3
Composer und TYPO3
Peter Kraume
 
Web Entwicklung mit PHP - Teil 3 Beta
Web Entwicklung mit PHP - Teil 3 BetaWeb Entwicklung mit PHP - Teil 3 Beta
Web Entwicklung mit PHP - Teil 3 Beta
Hans-Joachim Piepereit
 
Elemente Websolutions - FLOW3 Überblick
Elemente Websolutions - FLOW3 ÜberblickElemente Websolutions - FLOW3 Überblick
Elemente Websolutions - FLOW3 Überblick
elemente websolutions
 
freiesMagazin 09-2011
freiesMagazin 09-2011freiesMagazin 09-2011
freiesMagazin 09-2011
storminator
 
TYPO3 CMS 7.0 - Die Neuerungen - pluswerk
TYPO3 CMS 7.0 - Die Neuerungen - pluswerkTYPO3 CMS 7.0 - Die Neuerungen - pluswerk
TYPO3 CMS 7.0 - Die Neuerungen - pluswerk
die.agilen GmbH
 
Backendlayout mit FLUID-Templates
Backendlayout mit FLUID-TemplatesBackendlayout mit FLUID-Templates
Backendlayout mit FLUID-Templates
Marcus Schwemer
 
Back to the future - Plone 5.2 und Python 3 Migration am Beispiel Onkopedia
Back to the future - Plone 5.2 und Python 3 Migration am Beispiel OnkopediaBack to the future - Plone 5.2 und Python 3 Migration am Beispiel Onkopedia
Back to the future - Plone 5.2 und Python 3 Migration am Beispiel Onkopedia
Andreas Jung
 
Apache Solr und TYPO3 @ Frankfurt PHP usergroup 2011-01
Apache Solr und TYPO3 @  Frankfurt PHP usergroup 2011-01Apache Solr und TYPO3 @  Frankfurt PHP usergroup 2011-01
Apache Solr und TYPO3 @ Frankfurt PHP usergroup 2011-01
Ingo Renner
 
Python, Plone und Zope in der Luft- und Raumfahrtforschung
Python, Plone und Zope in der Luft- und RaumfahrtforschungPython, Plone und Zope in der Luft- und Raumfahrtforschung
Python, Plone und Zope in der Luft- und Raumfahrtforschung
Andreas Schreiber
 
Python in der Luft- und Raumfahrt
Python in der Luft- und RaumfahrtPython in der Luft- und Raumfahrt
Python in der Luft- und Raumfahrt
Andreas Schreiber
 
TYPO3 Translations
TYPO3 Translations TYPO3 Translations
TYPO3 Translations
Marcus Schwemer
 
20160229_ModernApplicationDevelopment_Python_KPatenge
20160229_ModernApplicationDevelopment_Python_KPatenge20160229_ModernApplicationDevelopment_Python_KPatenge
20160229_ModernApplicationDevelopment_Python_KPatenge
Karin Patenge
 
TYPO3 CMS 6.2 LTS - Die Neuerungen
TYPO3 CMS 6.2 LTS - Die NeuerungenTYPO3 CMS 6.2 LTS - Die Neuerungen
TYPO3 CMS 6.2 LTS - Die Neuerungen
die.agilen GmbH
 
Nagios Conference 2007 | Pluginprogrammierung in Perl by Wolfgang Barth
Nagios Conference 2007 |  Pluginprogrammierung in Perl by Wolfgang BarthNagios Conference 2007 |  Pluginprogrammierung in Perl by Wolfgang Barth
Nagios Conference 2007 | Pluginprogrammierung in Perl by Wolfgang Barth
NETWAYS
 
SLAC 2008 RPMs selber bauen
SLAC 2008 RPMs selber bauenSLAC 2008 RPMs selber bauen
SLAC 2008 RPMs selber bauen
Schlomo Schapiro
 
Alle Änderungen zu TYPO3 6.0
Alle Änderungen zu TYPO3 6.0Alle Änderungen zu TYPO3 6.0
Alle Änderungen zu TYPO3 6.0Alex Kellner
 

Ähnlich wie TYPO3 Dokumentation mit ReStructuredText (20)

Extbase/Fluid: Kennenlernen und ausprobieren
Extbase/Fluid: Kennenlernen und ausprobierenExtbase/Fluid: Kennenlernen und ausprobieren
Extbase/Fluid: Kennenlernen und ausprobieren
 
TYPO3 CMS 7.5 - Die Neuerungen - pluswerk
TYPO3 CMS 7.5 - Die Neuerungen - pluswerkTYPO3 CMS 7.5 - Die Neuerungen - pluswerk
TYPO3 CMS 7.5 - Die Neuerungen - pluswerk
 
TYPO3 Neos in der Praxis
TYPO3 Neos in der PraxisTYPO3 Neos in der Praxis
TYPO3 Neos in der Praxis
 
Abläufe mit PHP und Phing automatisieren
Abläufe mit PHP und Phing automatisierenAbläufe mit PHP und Phing automatisieren
Abläufe mit PHP und Phing automatisieren
 
Composer und TYPO3
Composer und TYPO3Composer und TYPO3
Composer und TYPO3
 
Web Entwicklung mit PHP - Teil 3 Beta
Web Entwicklung mit PHP - Teil 3 BetaWeb Entwicklung mit PHP - Teil 3 Beta
Web Entwicklung mit PHP - Teil 3 Beta
 
Elemente Websolutions - FLOW3 Überblick
Elemente Websolutions - FLOW3 ÜberblickElemente Websolutions - FLOW3 Überblick
Elemente Websolutions - FLOW3 Überblick
 
freiesMagazin 09-2011
freiesMagazin 09-2011freiesMagazin 09-2011
freiesMagazin 09-2011
 
TYPO3 CMS 7.0 - Die Neuerungen - pluswerk
TYPO3 CMS 7.0 - Die Neuerungen - pluswerkTYPO3 CMS 7.0 - Die Neuerungen - pluswerk
TYPO3 CMS 7.0 - Die Neuerungen - pluswerk
 
Backendlayout mit FLUID-Templates
Backendlayout mit FLUID-TemplatesBackendlayout mit FLUID-Templates
Backendlayout mit FLUID-Templates
 
Back to the future - Plone 5.2 und Python 3 Migration am Beispiel Onkopedia
Back to the future - Plone 5.2 und Python 3 Migration am Beispiel OnkopediaBack to the future - Plone 5.2 und Python 3 Migration am Beispiel Onkopedia
Back to the future - Plone 5.2 und Python 3 Migration am Beispiel Onkopedia
 
Apache Solr und TYPO3 @ Frankfurt PHP usergroup 2011-01
Apache Solr und TYPO3 @  Frankfurt PHP usergroup 2011-01Apache Solr und TYPO3 @  Frankfurt PHP usergroup 2011-01
Apache Solr und TYPO3 @ Frankfurt PHP usergroup 2011-01
 
Python, Plone und Zope in der Luft- und Raumfahrtforschung
Python, Plone und Zope in der Luft- und RaumfahrtforschungPython, Plone und Zope in der Luft- und Raumfahrtforschung
Python, Plone und Zope in der Luft- und Raumfahrtforschung
 
Python in der Luft- und Raumfahrt
Python in der Luft- und RaumfahrtPython in der Luft- und Raumfahrt
Python in der Luft- und Raumfahrt
 
TYPO3 Translations
TYPO3 Translations TYPO3 Translations
TYPO3 Translations
 
20160229_ModernApplicationDevelopment_Python_KPatenge
20160229_ModernApplicationDevelopment_Python_KPatenge20160229_ModernApplicationDevelopment_Python_KPatenge
20160229_ModernApplicationDevelopment_Python_KPatenge
 
TYPO3 CMS 6.2 LTS - Die Neuerungen
TYPO3 CMS 6.2 LTS - Die NeuerungenTYPO3 CMS 6.2 LTS - Die Neuerungen
TYPO3 CMS 6.2 LTS - Die Neuerungen
 
Nagios Conference 2007 | Pluginprogrammierung in Perl by Wolfgang Barth
Nagios Conference 2007 |  Pluginprogrammierung in Perl by Wolfgang BarthNagios Conference 2007 |  Pluginprogrammierung in Perl by Wolfgang Barth
Nagios Conference 2007 | Pluginprogrammierung in Perl by Wolfgang Barth
 
SLAC 2008 RPMs selber bauen
SLAC 2008 RPMs selber bauenSLAC 2008 RPMs selber bauen
SLAC 2008 RPMs selber bauen
 
Alle Änderungen zu TYPO3 6.0
Alle Änderungen zu TYPO3 6.0Alle Änderungen zu TYPO3 6.0
Alle Änderungen zu TYPO3 6.0
 

TYPO3 Dokumentation mit ReStructuredText

  • 2. www.typo3-lisardo.deTYPO3 Dokumentation mit reST Übermich 2 Peter Linzenkirchner Lisardo EDV-Beratung, Augsburg Freelancer: TYPO3, HTML, CSS TYPO3 Certified Integrator Web: www.typo3-lisardo.de
  • 3. www.typo3-lisardo.deTYPO3 Dokumentation mit reST DokumentationmitOpenoffice 3
  • 6. www.typo3-lisardo.deTYPO3 Dokumentation mit reST reStructuredText 6 reStructuredText ist eine Auszeichnungssprache ähnlich markdown oder textile. Sie wurde entwickelt für die Dokumentation der Programmiersprache Python, die für den Parser auch benötigt wird. Vorteile auch ungeparst einigermaßen gut lesbar ist textbasiert kann mit Git oder SVN versioniert werden speziell für Dokumentation entwickelt Export in andere Formate: ODT, Manpage, HTML, XML, LaTeX, PDF etc. http://wiki.typo3.org/ReST http://de.wikipedia.org/wiki/ReStructuredText
  • 7. www.typo3-lisardo.deTYPO3 Dokumentation mit reST Abschnitt-Titel (Section) ========================= Unterabschnitt -------------- Normaler Text und so weiter und so fort. - Erster Punkt - Zweiter Punkt - Dritter Punkt 1) Ein Punkt einer nummerierten Liste 2) Zweites... 3) Dritter Punkt der nummerierten Liste - der Text hier wird kursiv: *text* - der hier wird fett: **text** - und das ist Code: ``text`` ===== ===== ======= A B A and B ===== ===== ======= False False False True True True ===== ===== ======= reStructuredText–Syntax 7 Manuals: http://docutils.sourceforge.net/rst.html http://wiki.typo3.org/ReST_Syntax Dieser Absatz bekommt eine Fußnote. [1]_ Bilder ------ .. image:: images/myimage.jpg :height: 299 :width: 348 :scale: 50 :alt: Katze beim Duschen Hyperlinks ---------- _reStructuredText: http://docutils.sf.net/rst.html Links auf die Dokumentation von TYPO3: --------------------------------------- - :ref:`TYPO3 Tutorial for Editors <t3editors:start>` - :ref:`Getting Started Tutorial <t3start:start>` Fußnoten --------- .. [1] Eine Fußnote
  • 8. www.typo3-lisardo.deTYPO3 Dokumentation mit reST reStructuredText:HTML 8
  • 9. www.typo3-lisardo.deTYPO3 Dokumentation mit reST reStructuredText–Voraussetzungen 9 Die Markup-Sprache muss geparst und in eine andere Sprache konvertiert werden. Voraussetzungen: Python Sphinx – das Tool, das die Umwandlung in HTML vornimmt die Templates von TYPO3 Tools zum Erstellen von PDFs (optional) Zwei mögliche Arbeitsweisen: global: Installation der Tools auf dem Rechner innerhalb von TYPO3 mit der Extensions »sphinx«
  • 10. www.typo3-lisardo.deTYPO3 Dokumentation mit reST reStructuredText–Testen Online-Editoren Mit Online-Editoren kann man reStructuredText ausprobieren, ohne vorher alle Komponenten installieren zu müssen. Allerdings ist es nicht möglich für den Export die TYPO3-Templates zu verwenden. https://notex.ch Umfangreicher Editor, mit einem kompletten Beispielprojekt und verschiedenen Exportmöglichkeiten: HTML, PDF, EPUB http://rst.ninjs.org Simpler Editor, der mit Hilfe von zwei Themes reStructured Text in HTML umwandelt. Offline-Editoren Um diese benutzen zu können, müssen vorher die Komponenten alle installiert werden. Eine Liste von Offline-Editoren findet sich hier: http://wiki.typo3.org/Editors_(reST) 10
  • 11. www.typo3-lisardo.deTYPO3 Dokumentation mit reST Installation Global, ausserhalb von TYPO3 Damit können reST-Dokumentation auch ausserhalb von TYPO3 erstellt werden, und auch mit anderen Templates als TYPO3. Installation und weitere Arbeit sind aber etwas umständlicher als innerhalb von TYPO3. Am besten einfach den Anleitungen im Wiki folgen: Mac + Linux: http://wiki.typo3.org/Rendering_reST_on_Linux Windows: http://wiki.typo3.org/Rendering_reST_on_Windows Die Anleitungen sind durchdacht und haben bei mir problemlos funktioniert. Ausführliche Dokumentation zu Sphinx: http://sphinx-doc.org 11
  • 12. www.typo3-lisardo.deTYPO3 Dokumentation mit reST 12 Das default-Theme ist das Standardtheme der Python-Dokumentation. Weitere Themes, Installations- anleitungen und Anleitung zum Erstellen eigener Themes sind auf der Sphinx-Webseite zu finden: http://sphinx-doc.org/theming.html DefaultTemplate
  • 13. www.typo3-lisardo.deTYPO3 Dokumentation mit reST InstallationinTYPO3 13 Extension »sphinx« http://typo3.org/extensions/repository/view/sphinx Diese Extension installiert die nötigen Tools (Python, Sphinx und die TYPO3- Templates) in die TYPO3-Installation. Installation erfolgt in zwei Schritten: Download und Installation der Extension, danach im Extensions Manager über die Updatefunktion die Tools herunterladen. Der Vorgang ist in der Dokumentation gut erklärt. Ausserdem installiert es zwei Module, die bei der Arbeit mit Dokumentationen hilfreich sind: Sphinx Console Damit können innerhalb von fileadmin reST-Projekte angelegt werden Sphinx Documentation Library Damit können die reST-Dokumentationen von Betrachtet und Bearbeitet werden.
  • 14. www.typo3-lisardo.deTYPO3 Dokumentation mit reST SphinxConsole–Projektanlegen 14
  • 15. www.typo3-lisardo.deTYPO3 Dokumentation mit reST SphinxConsole–Index.rst 15
  • 16. www.typo3-lisardo.deTYPO3 Dokumentation mit reST SphinxConsole–Settings.yml 16
  • 19. www.typo3-lisardo.deTYPO3 Dokumentation mit reST SphinxConsole–Dateistruktur 19
  • 20. www.typo3-lisardo.deTYPO3 Dokumentation mit reST SphinxDocumention–Kickstarter 20 In Extensions können hier neue Dokumentationen angelegt und/oder vorhandene Openoffice-Dokument in reST-Dokumentationen konvertiert werden.
  • 22. www.typo3-lisardo.deTYPO3 Dokumentation mit reST Lokalisierung 22 http://wiki.typo3.org/Localization_(reST) http://docs.typo3.org/typo3cms/extensions/sphinx/latest/UsersManual/ DocsTypo3Org/Index.html
  • 24. www.typo3-lisardo.deTYPO3 Dokumentation mit reST reST-DokumentationenfürExtensions 24 Manual / Anleitung http://wiki.typo3.org/ReST_for_extension_manuals http://docs.typo3.org/typo3cms/extensions/sphinx/latest/Index.html Die aktuellen Extensions sollen dann unter dieser URL erscheinen: http://docs.typo3.org/typo3cms/extensions/myext/latest/Index.html Aktuelle Einschränkungen die Dokumentation erscheint noch nicht im TER die Dokumentation muss manuell von Documentation-Team freigeschaltet werden. Passiert das nicht, wird unter der URL nur das konvertierte Openoffice-Dokument gezeigt. Diese Einschränkungen sollen demnächst wegfallen.