Tags:
create new tag
, view all tags

TWiki Variables » Search » Category: Searching & Listing

DATATBL{"topic" format="..."} -- look up a table

  • Look up a table in the TWiki table markup on the specified topic. And then compose an ouput in the similar manner as SEARCH{...}.
  • Syntax: %DATATBL{ "topic" format="..." separator="..." }%
  • Parameters:
    Parameter Description Default
    "topics" comma separated topics whose first table is looked up. If multiple topics are specified, tables on the topics are combined and hanled as if there is one big table  
    "escaped_variable" Instead of comma separated topics, you can specify an escaped TWiki variable such as $percntINCLUDE{\"http://foo/bar\"}$percnt. Then the variable is expanded and the result becomes the data soruce. Read Getting table data dynamically for more information  
    assumedcols="COLUMNS" causes COLUMNS to be assumed. Read Referring to non-existent columns for more information  
    evalcell="on" causes variable expansion in table data. Read Expand variables in cells for more information off
    COLUMN_NAME="VALUES" select rows whose COLUMN_NAME column has either of comma separated VALUES. Read Select rows for more information  
    by="COLUMN_NAME" value="VALUES" Same as above. But if COLUMN_NAME starts with a lower case letter, this format needs to be used  
    ignorenull="on" causes null result to resort to ifnomatch value. Read Treat null value as no match for more information off
    ignorecase="on" causes string comparison to case insensitive off
    sort="COLUMN"
    sorta="COLUMN"
    sortn="COLUMN"
    sorts the output chunks based on a source table column. sort is for case-sensitive string sort, sorta is for case-insensitive (alphabetical) string sort, and sortn is for numeric sort. The sorting result is in the ascending order. To get the decending order, specify reverse="on" in addition no sorting
    reverse="on" specifies the order of output chunks to be reversed. If combined with sort="COLUMN", output chunks are sorted in the descending order  
    limit="NUMBER" specifies the maximum number of rows selected no limit
    transposed="on" species that the topics have transposed tables - the first column has field names and the second column has field values. Read Transposed tables for more information off
    split="SPLIT_PATTERN" may be used when transposed="on" (above) is specified. It specifies a pattern to split tables even within a table  
    trfrom="SEARCH_LIST"
    trto="REPLACE_LIST"
    tropt="OPTIONS"
    causes transliteration in the result. Read Transliteration for more information  
    format="..." specifies the format of each output chunk corresponding a selected source table row. Read Format parameter for more information $Name
    separator="..." specifies a separator between output chunks. This is the same as the separator parameter of SEARCH{...} (null string)
    separatorN="..." specifies a separator inserted every N output chunks. Read Different separators at different places for more information  
    ifnomatch="STRING" causes the STRING to be yielded when there is no matching row. Read When there is no match for more information  
  • Category: DevelopmentVariables, DatabaseAndFormsVariables, SearchingAndListingVariables
  • Related: DataTablePlugin, SEARCH, FormattedSearch (this topic)

KINOSEARCH{...} -- search indexed topics and attachments

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
    host="..." host IP or name to connect to  
    port="..." port to of the host  
    version="..." protocol version; possible values: 2,3  
    ssl="..." use ssl to bind to the server; possible values 0,1  
    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)
    clear="..." comma separated list of attributes to be removed from the output if they are not resolved nothing is cleared
  • 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

  • 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: 4 variables

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

Topic revision: r1 - 2012-11-11 - TWikiContributor
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.