1 .TH LDAPTEMPLATES.CONF 5 "22 September 1998" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldaptemplates.conf \- configuration file for LDAP display template routines
8 ETCDIR/ldaptemplates.conf
11 The file ETCDIR/ldaptemplates.conf contains information used by
12 the LDAP display templates routines (see ldap-disptmpl(3)). Blank lines
13 and lines that have a first character of `#' are treated as comments and
14 ignored. Non-comment lines contain one or more tokens. Tokens are
15 separated by white space, and double quotes `"' can be used to include
16 white space inside a token.
18 The first non-commment line specifies the version of the template
19 information and must contain the token
21 followed by an integer version number. E.g.,
27 The current version is
29 so the above example is always the correct opening line.
31 The remainder of the file consists of one or more display templates.
32 The first two lines of the display template should each contain a single
33 token that specifies singular and plural names for the template that are
34 suitable for human consumption. These names are stored in the
48 specifies appropriate names for a template designed to display X.500
51 The next line specifies the name of the icon or similar element that is
52 associated with this template. E.g.,
59 The next line is a blank-separated list of template options. "" can be
60 used if no options are desired. Available options are: "addable" (it
61 is appropriate to allow entries of this type to be added), "modrdn" (it
62 is appropriate to offer the "modify rdn" operation), "altview" (this
63 template is merely an alternate view of another template, typically
64 used for templates pointed to be a linkaction item). E.g.,
71 The next portion of the template is a list of X.500 object classes that
72 is used to determine whether the template should be used to display a
73 given entry. The object class information consists of one or more lines,
74 followed by a terminating line that contains the single token
76 Each line contains one or more object class names, all of which must be
77 present in an X.500 entry for the
78 .I ldap_oc2template(3)
79 routine to return a pointer to this template.
80 The object class information is stored in the
84 structure. Multiple lines can be used to associate more than one set
85 of object classes with a given template. E.g.,
93 means that the template is appropriate for display of umichPerson entries or
96 Next next line after the object class list is the name of the attribute
97 to authenticate as to make changes (use "" if it is appropriate to
98 authenticate as the entry itself). E.g.,
105 The next line is the default attribute to use when naming a new entry.
113 The next line is the default location under which new entries are created.
114 It should be a string-represented Distringuished Name. E.g.,
117 "dc=OpenLDAP, dc=org"
121 The next section is a list of rules used to assign default values to new
122 entries. The list should be terminated with a line that contains the
125 Each line in this section should either begin with the token
127 and be followed by the name of the attribute and a constant value to
128 assign, or the line should begin with
130 followed by the name of an attribute whose value will be the DN of the
131 person who has authenticated to add the entry.
135 constant associatedDomain umich.edu
141 The last portion of the template is a list of items to display. It
142 consists of one or more lines, followed by a terminating line that
143 contains the single token
145 Each line is must begin with the token
150 It is assumed that each item appears on a row by itself unless it was
153 line (in which case it should be displayed on the same line as the
154 previous item, if possible). Lines that begin with
156 should not have any other tokens on them.
158 Lines that begin with
160 must have at least three more tokens on them: an item type, a label,
161 and an attribute name. Any extra tokens are taken as extra arguments
162 and are stored in the
168 The item type token must be one of the following strings:
170 (for case ignore string attributes),
172 (for multiline string attributes),
174 (for RFC-822 conformant mail address attributes),
176 (for distinguished name pointer attributes),
178 (for Boolean attributes),
180 (for JPEG photo attributes),
182 (for a button that will retrieve and show a JPEG photo attribute),
184 (for FAX T.4 format image attributes),
186 (for a button that will retrieve and show a FAX photo attribute),
188 (for audio attributes),
190 (for UTC time attributes),
192 (for UTC time attributes where only the date portion should be shown),
194 (for labeled Uniform Resource Locator attributes),
196 (to define an action that will do a directory search for other entries),
198 (to define an action which is a link to another display template). See
199 the ACTIONS section below for more information on search and link actions.
201 An example of an item line for the drink attribute (displayed with
202 label "Favorite Beverage"):
205 item cis "Favorite Beverage" drink
209 This section has not been written yet. Sorry!
211 The following template configuration file contains two templates, one
212 for display of people entries and one for display of contries.
216 # LDAP display templates
218 # Version must be 1 for now
227 # name of the icon that is associated with this template
230 # blank-separated list of template options ("" for none)
239 # name of attribute to authenticate as ("" means auth as this entry)
243 # default attribute name to use when forming RDN of a new entry
248 # default location when adding new entries (DN; "" means no default)
249 "dc=OpenLDAP, dc=Org"
252 # rules used to define default values for new entries
256 # list of items for display
257 item jpegbtn "View Photo" jpegPhoto "Next Photo"
258 item audiobtn "Play Sound" audio
259 item cis "Also Known As" cn
260 item cis "Title" title
261 item mls "Work Address" postalAddress
262 item cis "Work Phone" telephoneNumber
263 item cis "Fax Number" facsimileTelephoneNumber
264 item mls "Home Address" homePostalAddress
265 item cis "Home Phone" homePhone
266 item cis "User ID" uid
267 item mail "E-Mail Address" mail
268 item cis "Description" description
269 item cis "Favorite Beverage" drink
270 item dn "See Also" seeAlso
275 ETCDIR/ldaptemplates.conf
278 .BR ldap_disptmpl (3)
281 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
283 is derived from University of Michigan LDAP 3.3 Release.