[TYPO3-german] Extension Dokumentation - Struktur für TER

[Alexander Kuemmel]

Hallo zusammen,

ich habe k?rzlich eine Extension fertiggestellt und m?chte nun
sicherstellen, dass diese auch richtig dokumentiert ist.
Aus dem TYPO3-Git habe ich mir das Repo ExtensionManual geladen und in
abgewandelter Form in meine Erweiterung eingebaut.
Leider wird diese Art der Dokumentation mit ReStructured Text nicht vom
TER gerendert.
Meine aktuelle REST-basierte Dokumentation liegt direkt im Verzeichnis
"Documentation", wie im Beispiel-Manual.

Meine Fragen:
Wird weiterhin eine OpenOffice-Datei als Dokumentation verlangt oder
kann ich REST benutzen?
Wo muss die Dokumentation in beiden F?llen liegen?

Vielen Dank f?r Eure Hilfe
und sch?ne Gr??e,
Alexander Kuemmel.

[Kay Strobach]

Hallo Alexander,

leider wird rest derzeit noch nicht vom TER unterst?tzt.
Es gibt aber renderer, sodass du lokal die n?tigen Dateien erzeugen
kannst (manual.pdf, manual.sxw). Ich kann dir leider aber nicht sagen wo
:( - suche selbst noch - habe nur die hinweise gefunden.

Evt. stellst du deine Frage mal in der englischen Liste.

Rest soll aber demn?chst nativ unterst?tzt werden :D

Gr??e
Kay

Post by Alexander Kuemmel
Hallo zusammen,
ich habe k?rzlich eine Extension fertiggestellt und m?chte nun
sicherstellen, dass diese auch richtig dokumentiert ist.
Aus dem TYPO3-Git habe ich mir das Repo ExtensionManual geladen und in
abgewandelter Form in meine Erweiterung eingebaut.
Leider wird diese Art der Dokumentation mit ReStructured Text nicht vom
TER gerendert.
Meine aktuelle REST-basierte Dokumentation liegt direkt im Verzeichnis
"Documentation", wie im Beispiel-Manual.
Wird weiterhin eine OpenOffice-Datei als Dokumentation verlangt oder
kann ich REST benutzen?
Wo muss die Dokumentation in beiden F?llen liegen?
Vielen Dank f?r Eure Hilfe
und sch?ne Gr??e,
Alexander Kuemmel.

--
http://www.kay-strobach.de - Open Source Rocks

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org

Answer was useful - feel free to donate:
-
https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KPM9NAV73VDF2
- https://flattr.com/profile/kaystrobach

[Alexander Kuemmel]

Hallo Kay,

besten Dank f?r die Infos.
Eine simple manual.sxw mit einem Verweis, wie von Elmar beschrieben,
wird wohl meine L?sung sein.

Viele Gr??e
Alexander.

Post by Kay Strobach
Hallo Alexander,
leider wird rest derzeit noch nicht vom TER unterst?tzt.
Es gibt aber renderer, sodass du lokal die n?tigen Dateien erzeugen
kannst (manual.pdf, manual.sxw). Ich kann dir leider aber nicht sagen wo
:( - suche selbst noch - habe nur die hinweise gefunden.
Evt. stellst du deine Frage mal in der englischen Liste.
Rest soll aber demn?chst nativ unterst?tzt werden :D
Gr??e
Kay

Post by Alexander Kuemmel
Hallo zusammen,
ich habe k?rzlich eine Extension fertiggestellt und m?chte nun
sicherstellen, dass diese auch richtig dokumentiert ist.
Aus dem TYPO3-Git habe ich mir das Repo ExtensionManual geladen und in
abgewandelter Form in meine Erweiterung eingebaut.
Leider wird diese Art der Dokumentation mit ReStructured Text nicht vom
TER gerendert.
Meine aktuelle REST-basierte Dokumentation liegt direkt im Verzeichnis
"Documentation", wie im Beispiel-Manual.
Wird weiterhin eine OpenOffice-Datei als Dokumentation verlangt oder
kann ich REST benutzen?
Wo muss die Dokumentation in beiden F?llen liegen?
Vielen Dank f?r Eure Hilfe
und sch?ne Gr??e,
Alexander Kuemmel.

[Elmar Hinz]

Halllo Alexander,

Du kannst REST soweit rendern, da? es auf docs.typo3.org erscheint.

F?r das TER legst Du ggf. noch ein manual.sxw bei, das vorl?ufig auf docs.typo3.org verweist.

Dies ist die erste Extension-Dokumentation, die direkt aus Sphinx gerendert wurde:

http://docs.typo3.org/typo3cms/extensions/esp/latest/

Wie das genau geht, beschreibt Martin Bless hier:

http://docs.typo3.org/typo3cms/drafts/github/marble/DocumentationStarter/Quickstart/

Viel Erfolg


Elmar

[Elmar Hinz]

Post by Elmar Hinz
http://docs.typo3.org/typo3cms/drafts/github/marble/DocumentationStarter/Quickstart/

Soweit ich es verstehe, hast Du ja schon ein Verzeichnis Documentation. Du mu?t also nicht mehr alle Schritte machen.

1.) Du m??test das nach github.com legen, weil es dort einen Commit-Handler gibt, der bei ?nderungen automatisiert das Rendering anst??t.

Du kannst die ganze Extension nach github.com legen oder nur die Doku.
In meinem Beispiel habe ich dort die ganze Extension: https://github.com/t3elmar/esp

2.) Du benachrichtigst Martin Bless wie beschrieben.

3.) Du aktivierst den Handler wie beschrieben.

Elmar

[Alexander Kuemmel]

Hallo Elmar,

vielen Dank f?r die ausf?hrliche Erkl?rung!
Ich habe die notwendigen Schritte erledigt und warte nun auf R?ckmeldung.

Viele Gr??e
Alexander.

Post by Elmar Hinz

Post by Elmar Hinz
http://docs.typo3.org/typo3cms/drafts/github/marble/DocumentationStarter/Quickstart/

Soweit ich es verstehe, hast Du ja schon ein Verzeichnis Documentation.
Du mu?t also nicht mehr alle Schritte machen.
1.) Du m??test das nach github.com legen, weil es dort einen
Commit-Handler gibt, der bei ?nderungen automatisiert das Rendering
anst??t.
Du kannst die ganze Extension nach github.com legen oder nur die Doku.
https://github.com/t3elmar/esp
2.) Du benachrichtigst Martin Bless wie beschrieben.
3.) Du aktivierst den Handler wie beschrieben.
Elmar
_______________________________________________
TYPO3-german mailing list
TYPO3-german at lists.typo3.org
http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-german