Univention Bugzilla – Bug 31269
Developer Documentation for UMC
Last modified: 2024-04-17 13:16:10 CEST
Show how to use branches/ucs-3.1/ucs-3.1-2/management/univention-management-console/umc-module-templates/ How to add "flavour" for new UDM modules. - i18n - disable modules Check if branches/ucs-3.1/ucs-3.1-2/packaging/univention-directory-manager-module-example/ is releavtn and/or integrate with UDM/LDAP chapter http://wiki.univention.de/index.php?title=UCS_3.0_UMC_API_for_Modules http://wiki.univention.de/index.php?title=UCS_3.0_UMC_Architecture_and_Protocol see doku-3.1/developer-reference/umc.xml for a start
Also see Bug #26275
*** Bug 23198 has been marked as a duplicate of this bug. ***
*** Bug 26275 has been marked as a duplicate of this bug. ***
I am suggesting the following structure: 1. Architecture (short) * UMC-Server ** UMCP * UMC-Webserver * UMC-Moduleprocesses 2. Creating UMC modules * Generating module skeleton structure * Overview of files ** XML module/flavor definition ** XML category definition * Module icons * 2.1 … * 2.2 … * Translating Modules * Configuring permissions * Debugging, Logging 2.1 Writing the Python-Module * API-doc(s) * useful utilities: ** decorators ** sanitizers ** progress-bars ** logging ** exceptions ** UCR * example 2.2 Writing the Javascript Module (GUI) * API-doc(s) * Dojo * useful utilities: ** UMC store, grid, […] * example 3. Extending existing modules * Disable modules / flavors * UDM… 4. Creating the debian package What do you think about this, Alex? Anything missing? Anything too detailed?
(In reply to Florian Best from comment #4) > ... > What do you think about this, Alex? Anything missing? Anything too detailed? Your structure seems very complete and also quite a bit of work. I am not sure whether this is what we want with this bug. As a first step, I would suggest to merge the Wiki pages + the existing UMC part in the developer documentation. Then, add information about i18n, disabling modules, flavours, how to generate UMC modules from templates. Then let us recap what is missing.
As discussed, we will move it to a later point.
r71700 | Bug #31269 devdoc: Include UMC Wiki documentation r71699 | Bug #31269 devdoc: Move UMC documentation WIP to convert the deleted Wiki pages to DocBook. Some informations (.umc-module) are now duplicated. Feel free to improve.
r71715 | Bug #31269: fix syntax error in XML r71714 | Bug #31269: add a more modern example of python code r71713 | Bug #31269: remove information about wrong categories r71712 | Bug #31269: remove obsolete information about XML syntax validation
The documentation about UMC is already online and part of our official UCS 4.2 documentation. Did anyone check it?
We should remove chapter 7.3 and 7.4.
This bug hasn't seen any update for several years. I close it. If you still see a need for it, you can reopen the bug. Please add an argumentation about why it's important to take care of it.