TWiki Variables » Search » Category: Searching & Listing

CHILDREN -- find children of a topic

• Find direct children of a topic, as defined by the parent-child relationship between topics.
• To find children recursively (topic tree) use the TreePlugin.
• Syntax: %CHILDREN{...}%
• Supported parameters:

  Parameter:	Description:	Default:
  web="%WEB%"	Wiki web.	Current web
  topic="%TOPIC%"	The topic to find the children.	Current topic
  format="..."	Custom format for each topic found. Supports same format strings as SEARCH. See FormattedSearch for usage, variables & examples	"$topic"
  separator="..."	Separator between topics.	", "
  default="none"	Default text shown if no children found.	"" (empty)

• Example: %CHILDREN{ topic="%TOPIC%" }%
• Category: SearchingAndListingVariables, SystemInformationVariables
• Related: META, PARENTTOPIC, METASEARCH, SEARCH (this topic)

LDAP{"filter" format="format"} -- LDAP directory query

• An interface to query an LDAP directory and display the results in a TWiki topic
• Syntax: %LDAP{"filter" format="format" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "uid=joeshmoe"	the LDAP query string	required
  filter="uid=joeshmoe"	(Alternative to above)	N/A
  base="..."	base dn of the (sub)tree to search in; if base is written in brackets (e.g. 'base="(ou=people)"') then it is prepended to the default base	the default base of the LdapContrib
  scope="one"	scope of search; possible values: sub, base, one	sub
  format="..."	format string used to display a database record	$dn
  header="..."	header to prepend the output	no header
  footer="..."	footer to appended to the output	no footer
  sep="..." or separator="..."	separator between database records	$n (new line)
  sort="..."	name of attributes to sort the output	DN
  reverse="on"	reverse the result set; possible values: on, off	off
  limit="100"	maximum number of records to return	no limit
  skip="10"	number of records in the hit set to skip before displaying them	0 (nothing is skipped)
  required="..."	a comma separated list of LDAP record attributes. If specified, the LDAP query results not having all of the specified attributes are eliminated	nothing is required
  hidenull="on"	wether to hide any output on an empty hit set; possible values: on, off	off
  default="..."	when the LDAP query yields no results, the value of this parameter is returned as the search result instead of null. Naturally, if hidenull is on, default doesn't have any effect	"" (null string)

• The header, format and footer format strings may contain the following variables and the standard special tokens:

  Variable:	Description:
  $count	the number of hits
  $index	the record number
  $<attr-name>	the value of the record attribute <attr-name>

• Example: %LDAP{"objectClass=posixAccount" format="| $index | $cn | $mail |"}%
• Category: DevelopmentVariables, DatabaseAndFormsVariables, SearchingAndListingVariables
• Related: LDAPUSERS, LdapNgPlugin, LdapContrib (this topic)

LDAPUSERS{...} -- LDAP user information

• This variable is disabled on this TWiki
• List all LDAP user information. Information is drawn from cache and not from the LDAP server. Use ?refreshldap=on to update.
• Supported parameters:

  Parameter:	Description:	Default:
  format="..."	format string used to display a user record	ordered list of $displayName
  header="..."	header to prepend the output	no header
  footer="..."	footer to appended to the output	no footer
  sep="..."	separator between database records	$n (new line)
  limit="100"	maximum number of records to return	no limit
  skip="10"	number of records in the hit set to skip before displaying them	0 (nothing is skipped)
  include="..."	regular expression a user's WikiName must match to be included in the output
  exclude="..."	regular expression a user's WikiName must not match
  hideunknown="off"	on/off, enable/disable filtering out users that did not log in yet and thus have no home topic (e.g. created by TWiki:Plugins/NewUsersPlugin)	on

• The header, format and footer format strings may contain the following variables and the standard special tokens:

  Variable:	Description:
  $index	the record number
  $wikiName	the user's WikiName
  $loginName	the user's login name
  $displayName	a link pointing to the users home topic in the Main web, if it exists, and '<nop>$wikiName' otherwise
  $emails	the list of all known email addresses

• Example: %LDAPUSERS{limit="10"}%
• Category: DevelopmentVariables, DatabaseAndFormsVariables, SearchingAndListingVariables
• Related: LDAPUSERS, LdapNgPlugin, LdapContrib (this topic)

Total: 3 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart