Bug 24236 - Dokumentation zu Erstellung eigener Syntax-Definitionen
Dokumentation zu Erstellung eigener Syntax-Definitionen
Status: CLOSED FIXED
Product: UCS extended documentation
Classification: Unclassified
Component: Developer documentation
unspecified
Other Linux
: P5 normal (vote)
: UCS 4.0-1-errata
Assigned To: Philipp Hahn
Arvid Requate
:
: 12696 (view as bug list)
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2011-10-27 13:41 CEST by Moritz Muehlenhoff
Modified: 2013-08-16 15:00 CEST (History)
4 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
Zu migrierende Dokumentation (6.17 KB, text/x-tex)
2011-10-27 13:42 CEST, Moritz Muehlenhoff
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Moritz Muehlenhoff univentionstaff 2011-10-27 13:41:57 CEST
Die Dokumentation zum Anlegen neuer Syntax-Definitionen ist sehr speziell und wurde zu 3.0 aus dem Handbuch entfernt. Sie sollte in die Entwickler-Doku im Wiki migriert werden.
Comment 1 Moritz Muehlenhoff univentionstaff 2011-10-27 13:42:12 CEST
Created attachment 3701 [details]
Zu migrierende Dokumentation
Comment 2 Moritz Muehlenhoff univentionstaff 2012-11-28 11:51:38 CET
*** Bug 12696 has been marked as a duplicate of this bug. ***
Comment 4 Arvid Requate univentionstaff 2013-05-27 13:45:39 CEST
Suggestions for minor changes:

* "check the valu for correctness"
* "it is recommended to directly look at this file" -> "the file should be consulted directly"
* "allowed characters set" -> "allowed character set"
* "Syntax Overwrite" -> "Syntax Override"
* "Some times" -> "Sometimes"
* "The latest case might require an change" -> "The latter case might require a change"
* "the variable directory/manager/web/modules/module/properties/property/syntax"
-> the variable directory/manager/web/modules/module/properties/property=syntax"?
* "(see ????) " -- reference broken?
* "For each found object all values of an multi-valued" -> "For each object found all values of a multi-valued"
* "variables cam ne used"  (two occurences)
* "property, which stored the values" -> "[...] which stores [...]"
* "value in inserted" -> "value is inserted"
* "dependant property than" -> "dependent property then"
* "selected host.. For the dependant" -> "selected host.. For this" (?)
* Description of "error_message": No commas.
* "This class does an UDM search" -> "[...] performs [...]"
* "A Python format string, which is used to generate a label display" -> "A Python format string generating a display label"
* "property definitions like shares/share: dn"   -> some quotes might clarify things here.
* "descriptive text. Mostly unused." -> "descriptive text."

* Maybe there should be a note explaining the difference between "program API" and "UDM API".
Comment 5 Philipp Hahn univentionstaff 2013-05-27 15:38:33 CEST
(In reply to comment #4)
> Suggestions for minor changes:
svn40902

> * "the variable
> directory/manager/web/modules/module/properties/property/syntax"
> -> the variable
> directory/manager/web/modules/module/properties/property=syntax"?

No, that's the name of the UCRV. Instead of "syntax" all other properties can be overridden as well, e.g. editable, multivalued, ...

> * "(see ????) " -- reference broken?

Yes, broken because the <olink>-database did not exist back than and still does not work as expected. See svn17323 for a start.

> * Maybe there should be a note explaining the difference between "program API"
> and "UDM API".

Added. "program API" renamed to "Python API".
Comment 6 Arvid Requate univentionstaff 2013-05-27 18:25:22 CEST
> No, that's the name of the UCRV. Instead of "syntax" all other properties can
> be overridden as well, e.g. editable, multivalued, ...

Then I would recommend elaborating this a bit, as the given example
  directory/manager/web/modules/users/user/properties/username=uid
would seem to be lacking the "/syntax" part to the uninitiated reader?
Comment 7 Philipp Hahn univentionstaff 2013-05-28 08:44:27 CEST
(In reply to comment #6)
> > No, that's the name of the UCRV. Instead of "syntax" all other properties can
> > be overridden as well, e.g. editable, multivalued, ...
> 
> Then I would recommend elaborating this a bit, as the given example
>   directory/manager/web/modules/users/user/properties/username=uid
> would seem to be lacking the "/syntax" part to the uninitiated reader?

Yes, that example is wrong and is missing the /syntax suffix.
Fixed in svn40933