category::list::get_pretty_list (public)
category::list::get_pretty_list \ [ -category_delimiter category_delimiter ] \ [ -category_link category_link ] \ [ -category_link_eval category_link_eval ] \ [ -category_link_html category_link_html ] \ [ -remove_link remove_link ] \ [ -remove_link_eval remove_link_eval ] \ [ -remove_link_text remove_link_text ] \ [ -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 ] [ -uplevel uplevel ] \ category_id_list [ locale ]
Defined in packages/categories/tcl/category-list-procs.tcl
Accepts a list of category_ids and returns a pretty list of tree-names and category-names with optional links for each tree and category.
- Switches:
- -category_delimiter (optional, defaults to
", "
)- 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.
- -remove_link (optional)
- -remove_link_eval (optional)
- -remove_link_text (optional)
- -tree_delimiter (optional, defaults to
"; "
)- string that separates the tree-names in the pretty list
- -tree_colon (optional, defaults to
": "
)- 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 (optional, defaults to
"__category_id"
)- name of the variable that will hold the category_id for category link generation.
- -tree_varname (optional, defaults to
"__tree_id"
)- name of the variable that will hold the tree_id for category and tree link generation.
- -uplevel (optional, defaults to
"1"
)- upvar level to set __tree_id and __category_id for link generation.
- Parameters:
- category_id_list (required)
- tcl-list of categories to display.
- locale (optional)
- locale of the category-names and tree-names.
- Returns:
- pretty list of tree-names and category-names
- Author:
- Timo Hentschel <timo@timohentschel.de>
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.