Bug 26275 - Dokumentation zur Erstellung eines UMC-Moduls
Dokumentation zur Erstellung eines UMC-Moduls
Status: RESOLVED DUPLICATE of bug 31269
Product: UCS extended documentation
Classification: Unclassified
Component: Developer documentation
unspecified
Other Linux
: P3 enhancement (vote)
: ---
Assigned To: Bugzilla Mailingliste
:
: 26110 26494 28799 (view as bug list)
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2012-02-28 12:16 CET by Moritz Muehlenhoff
Modified: 2014-06-11 07:25 CEST (History)
5 users (show)

See Also:
What kind of report is it?: ---
What type of bug is this?: ---
Who will be affected by this bug?: ---
How will those affected feel about the bug?: ---
User Pain:
Enterprise Customer affected?:
School Customer affected?:
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Max CVSS v3 score:


Attachments
DTD für UMC Module (2.78 KB, text/plain)
2013-01-11 17:28 CET, Philipp Hahn
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Moritz Muehlenhoff univentionstaff 2012-02-28 12:16:49 CET
Für die Entwickler-Doku

+++ This bug was initially created as a clone of Bug #23876 +++

Für die Entwicklung eines UMC-Moduls wäre es sehr hilfreich eine Tool zur
Verfügung zu stellen, das es erlaubt ein neues UMC-Modul anhand eines Templates
zu erstellen. Dazu gibt der Benutzer die grundlegenden Informationen wie
Modul-ID, Beschreibungstext etc. an, durch die dann Platzhalter in den
Template-Dateien ersetzt werden. 

Zur Erstellung könnten dann verschiedenen Templates zur Verfügung stehen, in
denen dann Python- und JavaScript-Methoden bereits als Dummies mit Dummywerten
bereitgestellt werden, bspw.:

* Ein Template-Modul mit einem Grid und bereits implementierten Dummy-Methoden
für query, remove, set etc. 
* Ein Template-Modul mit Tabs und verschiedenen Seiten (also mehrere Klassen)
* Ein einfaches Modul mit nur einer Seite und einem Formular

Das würde sicherlich die Einstiegshürde zur Modulprogrammieren senken und wäre
sehr hilfreich für der Dokumentation im Wiki.
Comment 1 Moritz Muehlenhoff univentionstaff 2012-11-28 11:43:40 CET
*** Bug 26110 has been marked as a duplicate of this bug. ***
Comment 2 Moritz Muehlenhoff univentionstaff 2012-12-03 16:49:37 CET
Es sollte beschrieben werden, wie mit umc-create-module ein Modul erstellt werden kann und wie die UMC-API-Doku installiert werden kann, in der die Architektur und weitere Funktionen beschrieben werden.
Comment 3 Moritz Muehlenhoff univentionstaff 2012-12-03 17:16:41 CET
Das ganze kann auch auf Basis dieses Artikels erstellt werden:

http://wiki.univention.de/index.php?title=UCS_3.0_UMC_API_for_Modules

Der sollte dann anschließend gelöscht werden, bzw. auf die Entwicker-Doku verweisen.
Comment 4 Moritz Muehlenhoff univentionstaff 2012-12-03 17:16:53 CET
*** Bug 28799 has been marked as a duplicate of this bug. ***
Comment 5 Moritz Muehlenhoff univentionstaff 2012-12-04 15:48:07 CET
Die Dokumentation aus Bug 26494 sollte ebenfalls integriert werden.
Comment 6 Moritz Muehlenhoff univentionstaff 2012-12-04 15:48:16 CET
*** Bug 26494 has been marked as a duplicate of this bug. ***
Comment 7 Philipp Hahn univentionstaff 2013-01-11 17:28:15 CET
Created attachment 4980 [details]
DTD für UMC Module

This help to validate the .xml files (and shows, that several new attributes of UCS-3.1 are still unducomented)
Relax-NG or XML-Schema would be better, because they're more powerful to describe allowed attribute values and unordered child elemens (flavor<->categories)

To check all current UMC-xml-files run the following command from "branches/ucs-3.1":
find ucs/management ucs-school -name \*.xml -exec xmllint --dtdvalid ucs/management/univention-management-console/doc/module.dtd --noout {} \;
Comment 8 Stefan Gohmann univentionstaff 2014-06-11 07:25:38 CEST

*** This bug has been marked as a duplicate of bug 31269 ***