[DEV] Documentation

[Lehrling]

Ich möchte das Handbuch gerne als Erweiterung erstellen.
Der Text als solcher ist ja statisch. Es müssen also keine Daten aus der Datenbank geholt werden, sondern lediglich die Übersetzung der Variablen aus dem jeweiligen Sprachordner.
Wie aber kann ich das jetzt umsetzen? Das Minimum für eine Erweiterung sind ja die Dateien composer.json und license.txt im Hauptverzeichnis der Erweiterung und der Ordner "Style", der dann die Template- und Theme-Dateien enthält.
An welcher Stelle müsste ich denn da eine Datei anlegen für das Handbuch? Muss es eine php-Datei sein oder kann es auch eine HTML-Datei sein? Braucht es in diesem Falle auch die Ordner config, controller und event im Hauptverzeichnis der Erweiterung?
EDIT: Problem gelöst.

[waldkatze]

@Lehrling
Das ist jetzt erst mal blos so eine Idee dazu.
Man könnte das eventuell auf der Basis von FAQ-Manager https://www.phpbb.com/community/viewtopic.php?t=2298861 aufbauen.

Mit ein paar Anpassungen ist das sicher eine sehr brauchbare Vorlage für eine Doku.

[Lehrling]

Danke für den Tipp. Ich werde es mir mal anschauen. Ich habe jetzt als Vorlage die Erweiterung Hangman https://github.com/dmzx/hangman genommen und etwas angepasst. Um aber eine Navigation wie auf der Mutterseite zu erstellen ( https://www.phpbb.com/support/docs/en/3.1/ug/ ), muss ich ja für jedes Kapitel eine eigene HTML-Seite erstellen und wie ich die innerhalb der Erweiterung verlinken kann, bleibt mir nach wie vor schleierhaft.
Ich habe jetzt innerhalb der Erweiterung im Ordner styles/all/template eine HTML-Seite namens documentation.html angelegt. Ich kann andere HTML-Seite inkludieren wie z.B. den Header und die Sidebar. Ich kann aber keine weiteren HTML-Seiten verlinken. Dafür muss ich wohl etwas an der event/listener.php ändern, oder?

[waldkatze]

Der FAQ-Manager bearbeitet die jeweilige Sprachdatei.Der Text kann direkt im ACP geändert werden.
Es wäre damit nicht notwendig für jede Doku-Seite eine extra HTML zu erstellen.
Die gesamte Verlinkungung erfolgt automatisch über die Einstellungsseite wo auch die Texte angepasst werden.

Die Herausforderung würde jetzt darin bestehen:
1.Den Editor des FAQ-Manager für die Eingabe von BBCode zu erweitern,damit auch Bilder etc. eingebaut werden können.
2.Die entsprechende Optik sollte mit einer CSS-Datei machbar sein.

Die zweite und sicher einfachere Möglichkeit wäre dafür einfach die Extension Board Rules https://www.phpbb.com/customise/db/exte ... oardrules/ als Grundlage zu verwenden.

[Kirk]

Bei dem Editor des FAQ-Manager ist html möglich.

[alfi0815]

Hallo Lehrling,
die Doku : https://area51.phpbb.com/docs/dev/31x/index.html ist mit Sphinx erstellt: http://sphinx-doc.org
Eventuell wäre das was für dich?