Feature #9879
Technologiewahl fuer neue QFQ Dokumentation
Start date:
13.01.2020
Due date:
% Done:
0%
Estimated time:
Discuss:
Description
QFQ
- DOC
- Tutorial
- for Dummies
Anforderungen an die neue Doku:
- Schnell editierbar - wysiwyg
- Suche
- Screenshots
- Beispielcode (Form, FE, Report) - Copz to Clipboard
- Kapitel
- Stichworte
- Versionierbar (pro QFQ Version)
- Up/Down votes pro Seite ob die Seite hilfreich war - damit koennen schlechte Seiten verbessert werden.
- Doku als QFQ App
- Doku in QFQ
Related issues
Updated by Carsten Rose over 1 year ago
- Artikel zu dem Thema: https://www.heise.de/hintergrund/Documentation-as-Code-mit-Asciidoctor-4642013.html
- Was ist mit LaTeX? 'edit me' Button koennte vielleicht geloest werden ... im Artikel Seite 5 hat Fedora das fuer Antora: " ...Die Open-Source-Projekte Couchbase und Fedora nutzen beide Antora, um Dokumentation ihrer Releases auf einer Website darzustellen. Auf jeder Seite findet sich ein Edit-Button, ..."
Updated by Carsten Rose over 1 year ago
- Mit #10004 koennte die QFQ eigene Doc Funktionalitaet wieder interessant werden.
- Idee:
- Bilder: Via Drag'n'Drop Files im TyniMCE fallen lassen, diese werden in einem Upload Order abgelegt. Im Text wird eine Referenz darauf erzeugt. Angezeigt wird ein Thumbnail, click on enlarge. Optional koennen pro Item weitere Parameter eingestellt werden.
- Bilder die in der Zwischenablage sind koennen via Ctrl-V eingefuegt werden.
- Formulare koennen via JSON Export in die Zwischenablage kopiert werden. Werden wie im TinyMCE eingefuegt, erkennt das der Editor und baut daraus einen speziellen Link 'copy to clipboard'. Damit kann der Leser spaeter das Beispielform in seine Zwischenablage kopieren und in seiner QFQ Instanz einfuegen.
Updated by Marc Egger over 1 year ago
Solange QFQ in Typo3 laufen muss, wuerde ich die QFQ Doku eher nicht in QFQ schreiben. Zu viel overhead.
Updated by Carsten Rose about 1 year ago
- Related to Feature #5480: QFQ: Dokumentation mit Screenshots versehen added
Updated by Carsten Rose about 1 year ago
- Related to Bug #10213: Dokumentation rendert ohne Navigation (Docker) added
Updated by Marc Egger 4 months ago
- Status changed from Priorize to New
- Assignee changed from Marc Egger to Carsten Rose
jetzt wo wir die Doku unabhängig von Typo3 rendern koennen, find ich die doku nicht mehr so schlecht.
Die migration der doku ist jedenfalls nicht dringend, deshalb würde ich wahrscheinlich nie dazu kommen.