Univention Bugzilla – Bug 23197
UMC: JavaScript API-Dokumentation mit Dojo-Framework generieren
Last modified: 2012-07-23 11:27:37 CEST
Die JavaScript-API ist derzeit zu einem Teil im Quellcode dokumentiert. Daraus sollte mit den Dojo-Tools eine Dokumentation automatisch erzeugt und paketiert werden: http://dojotoolkit.org/reference-guide/util/doctools.html
Bitte als Patch vorbereiten, so dass dieser nach der Veröffentlichung von 3.0-1 in das SVN übernommen werden kann.
Created attachment 4152 [details] api.patch Um den Patch bauen zu können muss ein tar.gz Archiv des api-viewer source erstellt werden. Das kann mit der enthaltenen create_api_archive.sh gemacht werden. Die im Patch benutzte Version ist Revision 803 (https://svn.dojotoolkit.org/website/trunk/api)
Created attachment 4153 [details] icon.tar.gz Das Icon für die UCS-overview Seite im svg und png Format.
Beim anwenden des patches sollte Bug #26163 beachtet werden. In dem paket ist eine Abhängigkeit auf php5-curl, dieses ist in unmaintained.
Der Patch wurde mit einer kleinen Änderung am create_api_archive.sh eingechekt. Revision 31884 Paket bauen + Changelog kommt morgen. Es sollte vielleicht überlegt werden, dojox aus der doku rauszunehmen, da das Bauen des Pakets dadurch deutlich länger dauert.
Dojox → sollte zunächst der Vollständigkeit halber drin bleiben. Kann der Bug geschlossen werden?
Es gibt hier noch ein Problem: Das Paket muss als root gebaut werden bzw. es braucht Zugriff auf /usr/share/univention-dojo/util/docscripts/modules/umc.module.properties. In dieser Datei muss der Pfad zu den UMC JavaScripten als !! relativer !! Pfad angegeben werden (also ../../../../../../temporäres_verzeichnis_in_dem_gebaut_wird/umc ). umc-frontend kann ja keine build dependency auf sich selbst haben, man könnte das umc-frontend-doc Paket in eine andere Paketgruppe verschieben. Der /usr/share/univention-dojo/util/docscripts/modules/ Pfad kann in der generate.php nicht angegeben werden sondern ist hartkodiert (lib/parser2/dojo2.inc Zeile 19). Allerdings könnte man das umgehen, wenn man in PHP temporär den include_pfad ändert (generate.php patchen). Ich habe einen upstream-Bug angelegt, dass man absolute Pfade auswählen können sollte. http://bugs.dojotoolkit.org/ticket/15119 WORKAROUND: Das Sinnvollste ist wohl erstmal, die generate.php bzw. lib/parser2/dojo2.inc in univention-dojo-dev zu patchen.
(In reply to comment #7) > WORKAROUND: > Das Sinnvollste ist wohl erstmal, die generate.php bzw. lib/parser2/dojo2.inc > in univention-dojo-dev zu patchen. Problem wurde anders gelöst: bei bauen wird jetzt /usr/share/univention-dojo/util/docscripts/ in /tmp/univention-dojo kopiert. Dadurch kann die benötigte Datei angelegt werden.
Ok, jetzt kann der zu. univention-managament-console-frontend 1.0.287-5 und univention-dojo 5.0.18-4 wurden erfolgreich gebaut. Dies enthält nun zusätzlich die Pakete univention-managament-console-frontend-doc und univention-dojo-api-viewer.
Makefile wurde aktualisiert, der temporäre Ordner für dojo ist jetzt nicht mehr in /tmp. revision 31946 univention-management-console-frontend (1.0.287-6) unstable; urgency=low * adapted Makefile (Bug #23197)
Bei der Installation erhalte ich folgenden Fehler: ==================== (Lese Datenbank ... 117726 Dateien und Verzeichnisse sind derzeit installiert.) Vorbereitung zum Ersetzen von univention-management-console-frontend-doc 1.0.256-2 (durch .../univention-management-console-frontend-doc_1.0.288-1.289.201204101452_all.deb) ... Ersatz für univention-management-console-frontend-doc wird entpackt ... univention-management-console-frontend-doc (1.0.288-1.289.201204101452) wird eingerichtet ... ln: Erzeuge symbolische Verknüpfung „/var/www/umc.xml“: Die Datei existiert bereits ====================
(In reply to comment #11) > Bei der Installation erhalte ich folgenden Fehler: > ... Mein Fehler, war noch von einer alten Installation.
Es wäre super, wenn sich die JS-API ebenfalls unterhalb des Eintrages "Entwickler-Dokumentation" installiert (wie auch univention-management-console-doc). Das Icon mit dem Hammer kann ja für den Eintrag "Entwickler-Dokumentation" übernommen werden.
Created attachment 4469 [details] api.patch Eintragung unter "Univention Entwickler-Dokumentation". Das icon dafür wird auch hinzugefügt.
zum Patch wurd noch ein postrm und eine conf.py hinzugefügt. Changelog gemacht. Paket gebaut. univention-doc (0.0.3-2) unstable; urgency=low * removed hardcoded link to index.html (Bug #23197) * added icon file for univention-doc (Bug #23197) univention-dojo (5.0.20-1) unstable; urgency=low * added dependency to univention-doc in univention-dojo-api-viewer (Bug #23197)
QA: Soweit alles super. Changelog-Eintrag vorhanden.
UCS 3.0-2 has been released: http://forum.univention.de/viewtopic.php?f=54&t=1905 If this error occurs again, please use "Clone This Bug".