- Publicity: Public Only All
includelet-procs.tcl
XoWiki - define various kind of includelets
This file defines the following Objects and Classes: ::xowiki::includelet::available-includelets, ::xowiki::includelet::available-formfields, ::xowiki::includelet::get, ::xowiki::includelet::creation-date, ::xowiki::includelet::rss-button, ::xowiki::includelet::bookmarklet-button, ::xowiki::includelet::set-parameter, ::xowiki::includelet::categories, ::xowiki::includelet::categories-recent, ::xowiki::includelet::recent, ::xowiki::includelet::last-visited, ::xowiki::includelet::most-popular, ::xowiki::includelet::rss-client, ::xowiki::includelet::most-frequent-visitors, ::xowiki::includelet::unread-items, ::xowiki::includelet::tags, ::xowiki::includelet::my-tags, ::xowiki::includelet::my-categories, ::xowiki::includelet::my-general-comments, ::xowiki::includelet::digg, ::xowiki::includelet::delicious, ::xowiki::includelet::my-yahoo-publisher, ::xowiki::includelet::my-references, ::xowiki::includelet::my-refers, ::xowiki::includelet::unresolved-references, ::xowiki::includelet::presence, ::xowiki::includelet::toc, ::xowiki::includelet::selection, ::xowiki::includelet::composite-form, ::xowiki::includelet::book, ::xowiki::includelet::slidy, ::xowiki::includelet::jquery-carousel, ::xowiki::includelet::jquery-infinite-carousel, ::xowiki::includelet::jquery-cloud-carousel, ::xowiki::includelet::jquery-spacegallery, ::xowiki::includelet::edit-item-button, ::xowiki::includelet::delete-item-button, ::xowiki::includelet::view-item-button, ::xowiki::includelet::create-item-button, ::xowiki::includelet::copy-item-button, ::xowiki::includelet::collab-graph, ::xowiki::includelet::activity-graph, ::xowiki::includelet::timeline, ::xowiki::includelet::user-timeline, ::xowiki::includelet::form-menu, ::xowiki::includelet::form-stats, ::xowiki::includelet::form-usages, ::xowiki::includelet::iframe, ::xowiki::includelet::yui-carousel, ::xowiki::includelet::gravatar, ::xowiki::includelet::random-form-page, ::xowiki::includelet::flowplayer, ::xowiki::includelet::html-file, ::xowiki::includelet::chat, ::xowiki::includelet::community-link, ::xowiki::includelet::link-with-local-return-url
- Location:
- packages/xowiki/tcl/includelet-procs.tcl
- Created:
- 2006-10-10
- Author:
- Gustaf Neumann
- CVS Identification:
$Id: includelet-procs.tcl,v 1.239.2.104 2023/05/30 09:46:40 gustafn Exp $
Procedures in this file
- Class ::xowiki::includelet::activity-graph (public)
- Class ::xowiki::includelet::available-formfields (public)
- Class ::xowiki::includelet::available-includelets (public)
- Class ::xowiki::includelet::book (public)
- Class ::xowiki::includelet::bookmarklet-button (public)
- Class ::xowiki::includelet::categories (public)
- Class ::xowiki::includelet::categories-recent (public)
- Class ::xowiki::includelet::chat (public)
- Class ::xowiki::includelet::collab-graph (public)
- Class ::xowiki::includelet::community-link (public)
- Class ::xowiki::includelet::composite-form (public)
- Class ::xowiki::includelet::copy-item-button (public)
- Class ::xowiki::includelet::create-item-button (public)
- Class ::xowiki::includelet::creation-date (public)
- Class ::xowiki::includelet::delete-item-button (public)
- Class ::xowiki::includelet::delicious (public)
- Class ::xowiki::includelet::digg (public)
- Class ::xowiki::includelet::edit-item-button (public)
- Class ::xowiki::includelet::flowplayer (public)
- Class ::xowiki::includelet::form-menu (public)
- Class ::xowiki::includelet::form-stats (public)
- Class ::xowiki::includelet::form-usages (public)
- Class ::xowiki::includelet::get (public)
- Class ::xowiki::includelet::gravatar (public)
- Class ::xowiki::includelet::html-file (public)
- Class ::xowiki::includelet::iframe (public)
- Class ::xowiki::includelet::jquery-carousel (public)
- Class ::xowiki::includelet::jquery-cloud-carousel (public)
- Class ::xowiki::includelet::jquery-infinite-carousel (public)
- Class ::xowiki::includelet::jquery-spacegallery (public)
- Class ::xowiki::includelet::last-visited (public)
- Class ::xowiki::includelet::link-with-local-return-url (public)
- Class ::xowiki::includelet::most-frequent-visitors (public)
- Class ::xowiki::includelet::most-popular (public)
- Class ::xowiki::includelet::my-categories (public)
- Class ::xowiki::includelet::my-general-comments (public)
- Class ::xowiki::includelet::my-references (public)
- Class ::xowiki::includelet::my-refers (public)
- Class ::xowiki::includelet::my-tags (public)
- Class ::xowiki::includelet::my-yahoo-publisher (public)
- Class ::xowiki::includelet::presence (public)
- Class ::xowiki::includelet::random-form-page (public)
- Class ::xowiki::includelet::recent (public)
- Class ::xowiki::includelet::rss-button (public)
- Class ::xowiki::includelet::rss-client (public)
- Class ::xowiki::includelet::selection (public)
- Class ::xowiki::includelet::set-parameter (public)
- Class ::xowiki::includelet::slidy (public)
- Class ::xowiki::includelet::tags (public)
- Class ::xowiki::includelet::timeline (public)
- Class ::xowiki::includelet::toc (public)
- Class ::xowiki::includelet::unread-items (public)
- Class ::xowiki::includelet::unresolved-references (public)
- Class ::xowiki::includelet::user-timeline (public)
- Class ::xowiki::includelet::view-item-button (public)
- Class ::xowiki::includelet::yui-carousel (public)
Detailed information
Class ::xowiki::includelet::activity-graph (public)
::xowiki::IncludeletClass ::xowiki::includelet::activity-graph
Include an activity graph
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::available-formfields (public)
::xowiki::IncludeletClass ::xowiki::includelet::available-formfields \ [ -flat flat ]
List the available form field types of this installation.
- Switches:
- -flat
(optional)- when "true" display a flat list structure instead of a tree (default)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::available-includelets (public)
::xowiki::IncludeletClass ::xowiki::includelet::available-includelets
List the available includelets of this installation.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::book (public)
::xowiki::IncludeletClass ::xowiki::includelet::book \ [ -menu_buttons menu_buttons ] [ -folder_mode folder_mode ] \ [ -locale locale ] [ -range range ] \ [ -allow_reorder allow_reorder ] [ -with_footer with_footer ] \ [ -orderby orderby ]
Show contents in book mode.
- Switches:
- -menu_buttons
(optional)- default: edit
- -folder_mode
(optional)- boolean, default false
- -locale
(optional)- for the content
- -range
(optional)- page range
- -allow_reorder
(optional)- allow optional page_reorder based on drag and drop
- -with_footer
(optional)- boolean, default: false
- -orderby
(optional)- by default, sorting is done via page_order (and requires pages with page_order). Alternatively, one can use e.g. "title,asc"
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::bookmarklet-button (public)
::xowiki::IncludeletClass ::xowiki::includelet::bookmarklet-button
Include bookmarklet button that makes it easy to add the current page as a bookmark in the browser of the client.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::categories (public)
::xowiki::IncludeletClass ::xowiki::includelet::categories \ [ -tree_name tree_name ] [ -no_tree_name no_tree_name ] \ [ -open_page open_page ] [ -tree_style tree_style ] \ [ -parent parent ]
List the specified category tree.
- Switches:
- -tree_name
(optional)- match pattern, if specified displays only the trees with matching names
- -no_tree_name
(optional)- if specified, tree names are not displayed
- -open_page
(optional)- name (e.g. en:iMacs) of the page to be opened initially
- -tree_style
(optional)- boolean, default: true, render category tree in tree style and not in sections style
- -parent
(optional)- page-ref, default: /, select entries from this directory
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::categories-recent (public)
::xowiki::IncludeletClass ::xowiki::includelet::categories-recent \ [ -tree_name tree_name ] [ -max_entries max_entries ] \ [ -locale locale ] [ -pretty_age pretty_age ]
Display recent entries by categories.
- Switches:
- -tree_name
(optional)- match pattern, if specified displays only the trees with matching names
- -max_entries
(optional)- show given number of new entries
- -locale
(optional)- use the specified locale
- -pretty_age
(optional)- boolean, use pretty age or not
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::chat (public)
::xowiki::IncludeletClass ::xowiki::includelet::chat
Include a chat in the current page
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::collab-graph (public)
::xowiki::IncludeletClass ::xowiki::includelet::collab-graph
Include a collaboration graph
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::community-link (public)
::xowiki::IncludeletClass ::xowiki::includelet::community-link \ [ -text text ] [ -url url ]
Include a link to the community including the current page. This includelet is designed to work with dotlrn.
- Switches:
- -text
(optional)- text to be displayed in community link
- -url
(optional)- optional path relative to community
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::composite-form (public)
::xowiki::IncludeletClass ::xowiki::includelet::composite-form \ [ -edit_links edit_links ] [ -pages pages ] \ [ -ordered_pages ordered_pages ]
Create a form from the selection
- Switches:
- -edit_links
(optional)- provide an edit link, boolean.
- -pages
(optional)- pages of the selection
- -ordered_pages
(optional)- set of already ordered pages
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::copy-item-button (public)
::xowiki::IncludeletClass ::xowiki::includelet::copy-item-button \ [ -page_id page_id ]
Button to copy a page
- Switches:
- -page_id
(optional)- optional item_id of the referred page
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::create-item-button (public)
::xowiki::IncludeletClass ::xowiki::includelet::create-item-button \ [ -page_id page_id ]
Button to create a new page based on the current one
- Switches:
- -page_id
(optional)- optional item_id of the referred page
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::creation-date (public)
::xowiki::IncludeletClass ::xowiki::includelet::creation-date
Include the creation date of the current or specified page in the provided format.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::delete-item-button (public)
::xowiki::IncludeletClass ::xowiki::includelet::delete-item-button \ [ -page_id page_id ]
Button to delete the current or a different page
- Switches:
- -page_id
(optional)- optional item_id of the referred page
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::delicious (public)
::xowiki::IncludeletClass ::xowiki::includelet::delicious
Add a button to submit article to delicious.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::digg (public)
::xowiki::IncludeletClass ::xowiki::includelet::digg
Add a button to submit article to digg.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::edit-item-button (public)
::xowiki::IncludeletClass ::xowiki::includelet::edit-item-button \ [ -page_id page_id ]
Button to edit the current or a different page
- Switches:
- -page_id
(optional)- optional item_id of the referred page
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::flowplayer (public)
::xowiki::IncludeletClass ::xowiki::includelet::flowplayer
Include an mp4 image using flowplayer
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::form-menu (public)
::xowiki::IncludeletClass ::xowiki::includelet::form-menu
Include a form menu for the specified Form
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::form-stats (public)
::xowiki::IncludeletClass ::xowiki::includelet::form-stats
Include form statistics for the specofied Form page.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::form-usages (public)
::xowiki::IncludeletClass ::xowiki::includelet::form-usages \ [ -return_url return_url ] [ -date_format date_format ] \ [ -extra_where_clause extra_where_clause ] [ -where where ] \ [ -unless unless ]
Show usages of the specified form.
- Switches:
- -return_url
(optional)- -date_format
(optional)- -extra_where_clause
(optional)- -where
(optional)- -unless
(optional)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::get (public)
::xowiki::IncludeletClass ::xowiki::includelet::get
Get an instance variable from the current or from a different page.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::gravatar (public)
::xowiki::IncludeletClass ::xowiki::includelet::gravatar \ [ -size size ]
Include gravatar picture for the specified email
- Switches:
- -size
(optional)- in pixel, default 80
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::html-file (public)
::xowiki::IncludeletClass ::xowiki::includelet::html-file \ [ -file file ]
Include the specified HTML file
- Switches:
- -file
(optional)- file to be included
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::iframe (public)
::xowiki::IncludeletClass ::xowiki::includelet::iframe
Include an iframe containing the specified URL
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::jquery-carousel (public)
::xowiki::IncludeletClass ::xowiki::includelet::jquery-carousel
Display a sequence of pages via jquery-carousel, based on book includelet.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::jquery-cloud-carousel (public)
::xowiki::IncludeletClass ::xowiki::includelet::jquery-cloud-carousel
Display a sequence of pages via jquery-cloud-carousel, based on book includelet.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::jquery-infinite-carousel (public)
::xowiki::IncludeletClass ::xowiki::includelet::jquery-infinite-carousel
Display a sequence of pages via jquery-infinite-carousel, based on book includelet.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::jquery-spacegallery (public)
::xowiki::IncludeletClass ::xowiki::includelet::jquery-spacegallery
Display a sequence of pages via jquery-spacegalleryl, based on book includelet.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::last-visited (public)
::xowiki::IncludeletClass ::xowiki::includelet::last-visited \ [ -max_entries max_entries ]
Display last visited pages.
- Switches:
- -max_entries
(optional)- show given number of entries
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::link-with-local-return-url (public)
::xowiki::IncludeletClass ::xowiki::includelet::link-with-local-return-url
Insert a link with extra return URL pointing the current object. This is particularly useful in cases, where a return URL must be created for a page that does not yet exist at time of definition (e.g. for link pointing to concrete workflow instances)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::most-frequent-visitors (public)
::xowiki::IncludeletClass ::xowiki::includelet::most-frequent-visitors \ [ -max_entries max_entries ]
List the most frequent visitors.
- Switches:
- -max_entries
(optional)- show given number of entries
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::most-popular (public)
::xowiki::IncludeletClass ::xowiki::includelet::most-popular \ [ -max_entries max_entries ] [ -interval interval ]
Display most popular pages of this wiki instance.
- Switches:
- -max_entries
(optional)- show given number of entries
- -interval
(optional)- specified optionally the time interval since when pages are listed
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::my-categories (public)
::xowiki::IncludeletClass ::xowiki::includelet::my-categories \ [ -summary summary ]
List the categories associated with the current page.
- Switches:
- -summary
(optional)- when specified, the category points to a summarized listing
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::my-general-comments (public)
::xowiki::IncludeletClass ::xowiki::includelet::my-general-comments
List the general comments available for the current page.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::my-references (public)
::xowiki::IncludeletClass ::xowiki::includelet::my-references
List the pages which are referring to the current page.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::my-refers (public)
::xowiki::IncludeletClass ::xowiki::includelet::my-refers
List the pages which are referred to the current page.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::my-tags (public)
::xowiki::IncludeletClass ::xowiki::includelet::my-tags \ [ -summary summary ]
List the tags associated with the current page.
- Switches:
- -summary
(optional)- when specified, tag points to a summarized listing
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::my-yahoo-publisher (public)
::xowiki::IncludeletClass ::xowiki::includelet::my-yahoo-publisher
Name of the publisher, when posting URLs to my yahoo (use in connection with with_yahoo_publisher).
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::presence (public)
::xowiki::IncludeletClass ::xowiki::includelet::presence \ [ -interval interval ] [ -max_users max_users ] \ [ -show_anonymous show_anonymous ] [ -page page ]
Show users actively in the wiki.
- Switches:
- -interval
(optional)- list users when active in the wiki in the specified interval (default: 10 minutes)
- -max_users
(optional)- maximum number of users to list
- -show_anonymous
(optional)- specify, whether users not logged in should get a result from this includelet. Possible values "nothing", "all", "summary"
- -page
(optional)- restrict listing to changes on a certain page.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::random-form-page (public)
::xowiki::IncludeletClass ::xowiki::includelet::random-form-page \ [ -publish_status publish_status ] [ -expires expires ]
Include random form page (instance of the specified form)
- Switches:
- -publish_status
(optional)- (default ready)
- -expires
(optional)- (default 600 secs)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::recent (public)
::xowiki::IncludeletClass ::xowiki::includelet::recent \ [ -max_entries max_entries ] [ -allow_edit allow_edit ] \ [ -allow_delete allow_delete ] [ -pretty_age pretty_age ]
Display recent modified entries.
- Switches:
- -max_entries
(optional)- show given number of new entries
- -allow_edit
(optional)- boolean to optionally offer an edit button
- -allow_delete
(optional)- boolean to optionally offer a delete button
- -pretty_age
(optional)- boolean, use pretty age or not
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::rss-button (public)
::xowiki::IncludeletClass ::xowiki::includelet::rss-button
Include an RSS button referring to pages of the specified time span.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::rss-client (public)
::xowiki::IncludeletClass ::xowiki::includelet::rss-client \ [ -max_entries max_entries ] [ -url url ]
Include RSS content
- Switches:
- -max_entries
(optional)- show given number of entries
- -url
(optional)- source for the RSS feed
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::selection (public)
::xowiki::IncludeletClass ::xowiki::includelet::selection \ [ -edit_link edit_link ] [ -menu_buttons menu_buttons ] \ [ -ordered_pages ordered_pages ] [ -pages pages ] \ [ -publish_status publish_status ] [ -range range ] \ [ -source source ]
Provide a selection of pages
- Switches:
- -edit_link
(optional)- provide an edit link, boolean.
- -menu_buttons
(optional)- list of buttons for the entries
- -ordered_pages
(optional)- set of already ordered pages
- -pages
(optional)- pages of the selection
- -publish_status
(optional)- list pages only with the provided publish status
- -range
(optional)- (sub)range of the pages (based on page_order attribute)
- -source
(optional)- take "pages" or "ordered_pages" from the provided page
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::set-parameter (public)
::xowiki::IncludeletClass ::xowiki::includelet::set-parameter
Set a parameter accessible to the current page (for certain tailorings), accessible in the page via e.g. the query parameter interface.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::slidy (public)
::xowiki::IncludeletClass ::xowiki::includelet::slidy
Display a sequence of pages via W3C slidy, based on book includelet
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::tags (public)
::xowiki::IncludeletClass ::xowiki::includelet::tags [ -limit limit ] \ [ -summary summary ] [ -popular popular ] [ -page page ]
Display specified tags.
- Switches:
- -limit
(optional)- maximum number of new entries
- -summary
(optional)- boolean to optionally provide summary
- -popular
(optional)- boolean to optionally list popular tags
- -page
(optional)- provide alternate weblog listing page
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::timeline (public)
::xowiki::IncludeletClass ::xowiki::includelet::timeline
Include a timeline of changes (based on yahoo timeline API)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::toc (public)
::xowiki::IncludeletClass ::xowiki::includelet::toc \ [ -orderby orderby ] [ -CSSclass_top_ul CSSclass_top_ul ] \ [ -CSSclass_ul CSSclass_ul ]
Show table of contents of the current wiki. The "toc" includelet renders the page titles of the current files based on the value of the "page_order" attributes. Only those pages are rendered that have a nonempty "page_order" field.
- Switches:
- -orderby
(optional)- by default, sorting is done via page_order (and requires pages with page_order). Alternatively, one can use e.g. "title,asc".
- -CSSclass_top_ul
(optional)- CSS class for top-level UL element
- -CSSclass_ul
(optional)- CSS class for all UL elements
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::unread-items (public)
::xowiki::IncludeletClass ::xowiki::includelet::unread-items \ [ -max_entries max_entries ]
List unread items.
- Switches:
- -max_entries
(optional)- show given number of entries
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::unresolved-references (public)
::xowiki::IncludeletClass ::xowiki::includelet::unresolved-references
List the pages with unresolved references in the current xowiki/xowf package. This is intended for use by admins.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::user-timeline (public)
::xowiki::IncludeletClass ::xowiki::includelet::user-timeline
Include a timeline of changes of the current or specified user (based on yahoo timeline API)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::view-item-button (public)
::xowiki::IncludeletClass ::xowiki::includelet::view-item-button \ [ -page_id page_id ]
Button to view the current or a different page
- Switches:
- -page_id
(optional)- optional item_id of the referred page
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::yui-carousel (public)
::xowiki::IncludeletClass ::xowiki::includelet::yui-carousel \ [ -glob glob ]
Include YUI carousel showing the pages of the specified or current folder.
- Switches:
- -glob
(optional)- optional matching pattern for page names
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.