category::list::prepare_display (public)

 category::list::prepare_display \
    [ -category_delimiter category_delimiter ] \
    [ -category_link category_link ] \
    [ -category_link_eval category_link_eval ] \
    [ -category_link_html category_link_html ] \
    [ -tree_delimiter tree_delimiter ] [ -tree_colon tree_colon ] \
    [ -tree_link tree_link ] [ -tree_link_eval tree_link_eval ] \
    [ -tree_link_html tree_link_html ] \
    [ -category_varname category_varname ] \
    [ -tree_varname tree_varname ] \
    [ -category_column category_column ] \
    [ -categories_column categories_column ] [ -tree_ids tree_ids ] \
    [ -exclude_tree_ids exclude_tree_ids ] \
    [ -container_object_id container_object_id ] [ -locale locale ] \
    [ -one_category_list ] -name name

Defined in packages/categories/tcl/category-list-procs.tcl

Extends a given multirow with either one extra column holding a pretty list of the tree-names and category-names or one column per tree holding a pretty list of category-names. These extra column can then be used in the listbuilder to display a pretty list of categorized objects.

Switches:

-category_delimiter

(defaults to ", ") (optional)

string that separates the categories in the pretty list

-category_link

(optional)

optional link for every category-name

-category_link_eval

(optional)

optional command that returns the link for every category-name. normally this would be a export_vars command that could contain __category_id and __tree_id which refer to category_id and tree_id of the category-name the link will wrap.

-category_link_html

(optional)

optional list of key value pairs for additional html in a link.

-tree_delimiter

(defaults to "; ") (optional)

string that separates the tree-names in the pretty list

-tree_colon

(defaults to ": ") (optional)

string that separates a tree-name from the category-names in that tree.

-tree_link

(optional)

optional link for every tree-name

-tree_link_eval

(optional)

optional command that returns the link for every tree-name. normally this would be a export_vars command that could contain __tree_id which refer to tree_id of the tree-name the link will wrap.

-tree_link_html

(optional)

optional list of key value pairs for additional html in a link.

-category_varname

(defaults to "__category_id") (optional)

name of the variable that will hold the category_id for category link generation.

-tree_varname

(defaults to "__tree_id") (optional)

name of the variable that will hold the tree_id for category and tree link generation.

-category_column

(defaults to "category_id") (optional)

name of the column in the multirow holding the tcl-list of mapped categories.

-categories_column

(defaults to "categories") (optional)

beginning of the names of the multirow columns holding the category names.

-tree_ids

(optional)

tcl-list of trees that should be displayed.

-exclude_tree_ids

(optional)

tcl-list of trees that should not be displayed.

-container_object_id

(optional)

object the trees are mapped to (instead of providing tree_ids).

-locale

(optional)

locale of the category-names and tree-names.

-one_category_list

(boolean) (optional)

switch to generate only one additional column in the multirow that holds a pretty list of tree-names and category-names.

-name

(required)

name of the multirow to extend.

Author:

Timo Hentschel <timo@timohentschel.de>

See Also:

• category::list::collapse_multirow
• category::list::elements
• category::list::get_pretty_list

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.