Class ::xowiki::Includelet
::xowiki::Includelet![[i]](/resources/acs-subsite/ZoomIn16.gif)
create ... \
[ -__decoration (default "portlet") ] \
[ -id id ] \
[ -name (default "") ] \
[ -parameter_declaration (default "") ] \
[ -title (default "") ]
Class Relations
- class: ::xotcl::Class
- superclass: ::xo::Context
- subclass: ::xowiki::includelet::vspace, ::xowiki::includelet::creation-date, ::xowiki::includelet::yui-carousel, ::xowiki::includelet::categories-recent, ::xowiki::includelet::html-file, ::xowiki::includelet::random-form-page, ::xowiki::includelet::my-references, ::xowiki::includelet::my-refers, ::xowiki::includelet::presence, ::xowiki::includelet::recent, ::xowiki::includelet::my-yahoo-publisher, ::xowiki::includelet::last-visited, ::xowiki::includelet::references-graph, ::xowiki::includelet::unresolved-references, ::xowiki::includelet::timeline, ::xowiki::includelet::kibana, ::xowiki::includelet::exam-top-includelet, ::xowiki::includelet::most-frequent-visitors, ::xowiki::includelet::form-usages, ::xowiki::includelet::form-stats, ::xowiki::includelet::s5, ::xowiki::includelet::chat, ::xowiki::includelet::link-with-local-return-url, ::xowiki::includelet::iframe, ::xowiki::includelet::book, ::xowiki::includelet::personal-notification-messages, ::xowiki::includelet::wf-todo, ::xowiki::includelet::current-irc-log, ::xowiki::includelet::available-includelets, ::xowiki::includelet::digg, ::xowiki::includelet::child-resources, ::xowiki::includelet::community-link, ::xowiki::includelet::flowplayer, ::xowiki::includelet::LTI-LaunchButton, ::xowiki::includelet::available-formfields, ::xowiki::includelet::delicious, ::xowiki::includelet::chat_room, ::xowiki::includelet::folders, ::xowiki::includelet::form-menu, ::xowiki::includelet::toc, ::xowiki::includelet::graph, ::xowiki::includelet::selection, ::xowiki::includelet::unread-items, ::xowiki::includelet::countdown-timer, ::xowiki::includelet::my-tags, ::xowiki::includelet::tags, ::xowiki::includelet::bookmarklet-button, ::xowiki::includelet::gravatar, ::xowiki::includelet::item-button, ::xowiki::includelet::categories, ::xowiki::includelet::get, ::xowiki::includelet::set-parameter, ::xowiki::includelet::rss-button, ::xowiki::includelet::rss-client, ::xowiki::includelet::most-popular, ::xowiki::includelet::my-general-comments, ::xowiki::includelet::my-categories
Methods (to be applied on the object)
Variables
::xowiki::Includelet set __default_metaclass ::xotcl::Class
::xowiki::Includelet set __default_superclass ::xotcl::Object
::xowiki::Includelet array set html {delete-item-button \
{{{<b>delete-item-button</b> -page_id -title <em>#xowiki.delete#</em> -alt <em>delete</em> \
-book_mode <em>false</em>}}
<p>Button to delete the current or a different page} view-item-button \
{{{<b>view-item-button</b> -page_id -title <em>#xowiki.view#</em> -alt <em>view</em> -link \
<em>""</em> -book_mode <em>false</em>}}
<p>Button to view the current or a different page} s5 \
{{{<b>s5</b> -category_id -slideshow:boolean <em>false</em> -pagenr <em>0</em> -style \
<em>standard</em> -menu_buttons <em>view edit copy create delete</em>}}
<p>} exam-top-includelet \
{{{<b>exam-top-includelet</b> -countdown_audio_alarm <em>true</em> -target_time \
<em>""</em> -url_poll <em>""</em> -url_dismiss <em>""</em> \
-poll_interval <em>5000</em>}}
<p>This is the top includelet for the in-class exam, containing a
countdown timer and the personal notifications includelet} edit-item-button \
{{{<b>edit-item-button</b> -page_id -title <em>#xowiki.edit#</em> -alt <em>edit</em> \
-book_mode <em>false</em> -link <em>""</em> -target <em>""</em>}}
<p>Button to edit the current or a different page} book \
{{{<b>book</b> -category_id -menu_buttons <em>edit</em> -folder_mode <em>false</em> -locale \
<em>""</em> -range <em>""</em> -allow_reorder <em>""</em> -orderby \
<em>page_order,asc</em> -with_footer <em>false</em> -publish_status <em>ready</em>}}
<p>Show contents in book mode.} digg {{{<b>digg</b> -description <em>""</em> -url}}
<p>Add a button to submit article to digg.} collab-graph \
{{{<b>collab-graph</b> -max_edges <em>70</em> -cutoff <em>0.1</em> -show_anonymous \
<em>message</em> -user_id}}
<p>Include a collaboration graph} iframe \
{{{<b>iframe</b> -title <em>""</em> -url:required -width <em>100%</em> -height \
<em>500px</em>}}
<p>Include an iframe containing the specified URL} chat_room \
{{{<b>chat_room</b> -chat_id -mode:optional <em>""</em> -path:optional \
<em>""</em> -skin:optional <em>""</em>}}
<p>Include a chat room} gravatar {{{<b>gravatar</b> -email:required -size <em>80</em>}}
<p>Include gravatar picture for the specified email} my-categories \
{{{<b>my-categories</b> -summary <em>1</em>}}
<p>List the categories associated with the
current page.} jquery-carousel {{{<b>jquery-carousel</b>}}
<p>Display a sequence of pages via jquery-carousel, based on book
includelet.} bookmarklet-button \
{{{<b>bookmarklet-button</b> -siteurl <em>""</em> -label <em>""</em>}}
<p>Include bookmarklet button that makes it easy to add the
current page as a bookmark in the browser of the client.} activity-graph \
{{{<b>activity-graph</b> -max_edges <em>70</em> -cutoff <em>0.1</em> -max_activities:integer \
<em>100</em> -show_anonymous <em>message</em>}}
<p>Include an activity graph} presence \
{{{<b>presence</b> -interval <em>10 minutes</em> -max_users:integer <em>40</em> \
-show_anonymous <em>summary</em> -page}}
<p>Show users actively in the wiki.} current-irc-log \
{{{<b>current-irc-log</b> -date <em>""</em>}}
<p>} launch-zoom {{{<b>launch-zoom</b>}}
<p>} jquery-infinite-carousel {{{<b>jquery-infinite-carousel</b>}}
<p>Display a sequence of pages via jquery-infinite-carousel, based on book
includelet.} launch-bigbluebutton {{{<b>launch-bigbluebutton</b>}}
<p>} jquery-cloud-carousel {{{<b>jquery-cloud-carousel</b>}}
<p>Display a sequence of pages via jquery-cloud-carousel, based on book
includelet.} wf-todo \
{{{<b>wf-todo</b> -workflow <em>""</em> -user_id -ical <em>0</em> -max_entries}}
<p>} rss-button {{{<b>rss-button</b> -span <em>10d</em> -name_filter -entries_of -title}}
<p>Include an RSS button referring to pages of the specified time span.} references-graph \
{{{<b>references-graph</b> -folder <em>.</em> -page <em>""</em> -link_type \
<em>link</em> -rankdir <em>LR</em> -fontsize <em>12</em>}}
<p>Include a graph of the (partial) link structure in a wiki,
starting either with a page or a folder. When a page is
provided, the local link structure of this page is
visualized (including incoming and outgoing links of the
page; e.g. -page "." for the current page).
Alternatively, the content of a folder can be shown.} jquery-spacegallery \
{{{<b>jquery-spacegallery</b>}}
<p>Display a sequence of pages via jquery-spacegalleryl, based on book
includelet.} delicious \
{{{<b>delicious</b> -description <em>""</em> -tags <em>""</em> -url}}
<p>Add a button to submit article to delicious.} html-file \
{{{<b>html-file</b> -title <em>""</em> -extra_css <em>""</em> -levels \
<em>0</em> -file:required}}
<p>Include the specified HTML file} categories-recent \
{{{<b>categories-recent</b> -max_entries:integer <em>10</em> -tree_name <em>""</em> \
-locale <em>""</em> -pretty_age <em>off</em>}}
<p>Display recent entries by categories.} slidy {{{<b>slidy</b>}}
<p>Display a sequence of pages via W3C slidy, based on book includelet} tags \
{{{<b>tags</b> -limit:integer <em>20</em> -summary:boolean <em>0</em> -popular:boolean \
<em>0</em> -page}}
<p>Display specified tags.} get {{{<b>get</b> -variable -form_variable -source <em>""</em>}}
<p>Get an instance variable from the current or from a different
page.} form-stats \
{{{<b>form-stats</b> -form -parent_id -property <em>_state</em> -orderby <em>count,desc</em> \
-renderer <em>table</em>}}
<p>Include form statistics for the specofied Form page.} available-formfields \
{{{<b>available-formfields</b> -flat:boolean <em>false</em>}}
<p>List the available form field types of this installation.} my-general-comments \
{{{<b>my-general-comments</b>}}
<p>List the general comments available for the
current page.} link-with-local-return-url \
{{{<b>link-with-local-return-url</b> -text <em>""</em> -url <em>""</em>}}
<p>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)} flowplayer {{{<b>flowplayer</b> -mp4:required,nohtml}}
<p>Include an mp4 image using flowplayer} LTI-LaunchButton \
{{{<b>LTI-LaunchButton</b> -launch_button_label <em>Join Meeting</em> -launch_button_title \
<em>Click to join</em> -title <em>""</em> -presentation <em>window</em>}}
<p>} form-menu \
{{{<b>form-menu</b> -form_item_id:integer -parent_id -form -buttons <em>new answers</em> \
-button_objs -return_url}}
<p>Include a form menu for the specified Form} last-visited \
{{{<b>last-visited</b> -max_entries:integer <em>20</em>}}
<p>Display last visited pages.} form-usages \
{{{<b>form-usages</b> -form_item_id:integer,1..n -form -parent_id -package_ids \
<em>""</em> -orderby <em>_raw_last_modified,desc</em> -view_field <em>_name</em> \
-publish_status <em>all</em> -field_names -hidden_field_names <em>_last_modified</em> \
-extra_form_constraints <em>""</em> -inherit_from_forms <em>""</em> \
-category_id -unless -where -extra_where_clause <em>""</em> -csv <em>true</em> \
-voting_form -voting_form_form <em>""</em> -voting_form_anon_instances <em>t</em> \
-generate -with_form_link <em>true</em> -with_categories -wf -bulk_actions \
<em>""</em> -buttons <em>edit delete</em> -renderer <em>""</em> -return_url \
-date_format -with_checkboxes:boolean <em>false</em>}}
<p>Show usages of the specified form.} my-tags {{{<b>my-tags</b> -summary <em>1</em>}}
<p>List the tags associated with the
current page.} my-refers {{{<b>my-refers</b>}}
<p>List the pages which are referred to the
current page.} available-includelets {{{<b>available-includelets</b>}}
<p>List the available includelets of this installation.} most-popular \
{{{<b>most-popular</b> -max_entries:integer <em>10</em> -interval}}
<p>Display most popular pages of this wiki instance.} user-timeline \
{{{<b>user-timeline</b> -user_id -data <em>timeline-data</em> -interval1 <em>DAY</em> \
-interval2 <em>MONTH</em>}}
<p>Include a timeline of changes of the current or specified user
(based on yahoo timeline API)} my-references {{{<b>my-references</b>}}
<p>List the pages which are referring to the
current page.} countdown-timer \
{{{<b>countdown-timer</b> -target_time <em>""</em> -audio_alarm <em>true</em>}}
<p>Countdown timer} folders \
{{{<b>folders</b> -show_full_tree <em>false</em> -context_tree_view <em>false</em>}}
<p>List the folder tree of the current instance} community-link \
{{{<b>community-link</b> -text <em>""</em> -url <em>""</em>}}
<p>Include a link to the community including the current page.
This includelet is designed to work with dotlrn.} yui-carousel \
{{{<b>yui-carousel</b> -title <em>""</em> -item_size <em>600x400</em> -image_size \
-num_visible <em>1</em> -play_interval <em>0</em> -auto_size <em>0</em> -folder -glob \
<em>""</em> -form <em>""</em>}}
<p>Include YUI carousel showing the pages of the specified or
current folder.} launch-jupyter {{{<b>launch-jupyter</b>}}
<p>} composite-form \
{{{<b>composite-form</b> -edit_links:boolean <em>false</em> -pages <em>""</em> \
-ordered_pages}}
<p>Create a form from the selection} child-resources \
{{{<b>child-resources</b> -skin:optional <em>yui-skin-sam</em> -show_types \
<em>::xowiki::Page,::xowiki::File,::xowiki::Form,::xowiki::FormPage</em> -regexp:optional \
-language_specific:boolean <em>false</em> -with_subtypes:boolean,optional <em>false</em> \
-orderby:token,optional <em>last_modified,desc</em> -publish_status:wordchar <em>ready</em> \
-view_target <em>""</em> -html-content -parent <em>.</em> -columns <em>
objects
edit
publish_status
object_type
name
last_modified
mod_user
duplicate
delete
</em> -hide <em>""</em> -menubar <em>""</em>}}
<p>Include the content of the current folder somewhat similar to explorer.} categories \
{{{<b>categories</b> -tree_name <em>""</em> -tree_style:boolean <em>1</em> \
-no_tree_name:boolean <em>0</em> -count:boolean <em>0</em> -summary:boolean <em>0</em> \
-locale <em>""</em> -open_page <em>""</em> -order_items_by <em>title,asc</em> \
-style <em>mktree</em> -category_ids <em>""</em> -parent <em>/</em> \
-except_category_ids <em>""</em> -allow_edit <em>false</em> -ordered_composite}}
<p>List the specified category tree.} unread-items \
{{{<b>unread-items</b> -max_entries:integer <em>20</em>}}
<p>List unread items.} selection \
{{{<b>selection</b> -edit_links:boolean <em>true</em> -pages <em>""</em> \
-ordered_pages <em>""</em> -source -publish_status <em>ready</em> -menu_buttons \
<em>edit</em> -range <em>""</em>}}
<p>Provide a selection of pages} my-yahoo-publisher \
{{{<b>my-yahoo-publisher</b> -publisher <em>""</em> -rssurl}}
<p>Name of the publisher, when posting URLs to my yahoo (use in
connection with with_yahoo_publisher).} kibana \
{{{<b>kibana</b> -chart <em>openacs-status-codes</em> -from <em>now-24h</em> -to <em>now</em> \
-hash <em>""</em> -width:integer <em>800</em> -height:integer <em>400</em>}}
<p>Include a Kibana chart identified by the provided hash} timeline \
{{{<b>timeline</b> -user_id -data <em>timeline-data</em> -interval1 <em>DAY</em> -interval2 \
<em>MONTH</em>}}
<p>Include a timeline of changes (based on yahoo timeline API)} copy-item-button \
{{{<b>copy-item-button</b> -page_id -alt <em>copy</em> -book_mode <em>false</em>}}
<p>Button to copy a page} creation-date \
{{{<b>creation-date</b> -source <em>""</em> -format <em>%m-%d-%Y</em>}}
<p>Include the creation date of the current
or specified page in the provided format.} chat \
{{{<b>chat</b> -title <em>""</em> -chat_id <em>""</em> -mode \
<em>""</em> -path <em>""</em> -skin -login_messages_p -logout_messages_p \
-avatar_p -timewindow}}
<p>Include a chat in the current page} create-item-button \
{{{<b>create-item-button</b> -page_id -alt <em>new</em> -book_mode <em>false</em>}}
<p>Button to create a new page based on the current one} graph {{{<b>graph</b>}}
<p>} random-form-page \
{{{<b>random-form-page</b> -form:required -publish_status <em>ready</em> -expires \
<em>600</em>}}
<p>Include random form page (instance of the specified form)} item-button {{{<b>item-button</b>}}
<p>} recent \
{{{<b>recent</b> -max_entries:integer <em>10</em> -allow_edit:boolean <em>false</em> \
-allow_delete:boolean <em>false</em> -pretty_age <em>off</em>}}
<p>Display recent modified entries.} set-parameter {{{<b>set-parameter</b>}}
<p>Set a parameter accessible to the current page (for certain
tailorings), accessible in the page via e.g. the query
parameter interface.} vspace \
{{{<b>vspace</b> -height <em>""</em> -width <em>""</em>}}
<p>} most-frequent-visitors {{{<b>most-frequent-visitors</b> -max_entries:integer <em>15</em>}}
<p>List the most frequent visitors.} rss-client \
{{{<b>rss-client</b> -url:required -max_entries:integer <em>15</em>}}
<p>Include RSS content} personal-notification-messages \
{{{<b>personal-notification-messages</b> -url_poll <em>""</em> -url_dismiss \
<em>""</em> -poll_interval <em>5000</em>}}
<p>Personal notification messages
This includelet can be used for personal messaging, where a
sender can send messages to a single user in a single
applications (e.g. in an exam), where the user has to
acknowledge every single message to make it disappear
(current implementation). The messages are not persisted
(current implementation).} toc \
{{{<b>toc</b> -style <em>""</em> -renderer <em>""</em> -open_page \
<em>""</em> -book_mode <em>false</em> -folder_mode <em>false</em> -ajax \
<em>false</em> -expand_all <em>false</em> -remove_levels <em>0</em> -category_id -locale \
<em>""</em> -orderby <em>""</em> -source <em>""</em> -range \
<em>""</em> -allow_reorder <em>""</em> -include_in_foldertree <em>true</em> \
-CSSclass_top_ul <em>""</em> -CSSclass_ul <em>""</em>}}
<p>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.} unresolved-references \
{{{<b>unresolved-references</b>}}
<p>List the pages with unresolved references in the current
xowiki/xowf package. This is intended for use by admins.}}
