- 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.107 2024/08/27 13:16:39 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
List the available form field types of this installation.
- 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
Show contents in book mode.
- 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
List the specified category tree.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::categories-recent (public)
::xowiki::IncludeletClass ::xowiki::includelet::categories-recent
Display recent entries by categories.
- 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
Include a link to the community including the current page. This includelet is designed to work with dotlrn.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::composite-form (public)
::xowiki::IncludeletClass ::xowiki::includelet::composite-form
Create a form from the selection
- 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
Button to copy a 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
Button to create a new page based on the current one
- 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
Button to delete the current or a different 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
Button to edit the current or a different 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
Show usages of the specified form.
- 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
Include gravatar picture for the specified email
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::html-file (public)
::xowiki::IncludeletClass ::xowiki::includelet::html-file
Include the specified HTML file
- 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
Display last visited pages.
- 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
List the most frequent visitors.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::most-popular (public)
::xowiki::IncludeletClass ::xowiki::includelet::most-popular
Display most popular pages of this wiki instance.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::my-categories (public)
::xowiki::IncludeletClass ::xowiki::includelet::my-categories
List the categories associated with the current page.
- 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
List the tags associated with the current page.
- 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
Show users actively in the wiki.
- 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
Include random form page (instance of the specified form)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::recent (public)
::xowiki::IncludeletClass ::xowiki::includelet::recent
Display recent modified entries.
- 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
Include RSS content
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::selection (public)
::xowiki::IncludeletClass ::xowiki::includelet::selection
Provide a selection of pages
- 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
Display specified tags.
- 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
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.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
Class ::xowiki::includelet::unread-items (public)
::xowiki::IncludeletClass ::xowiki::includelet::unread-items
List unread items.
- 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
Button to view the current or a different 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
Include YUI carousel showing the pages of the specified or current folder.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.