::xo::PackageMgr ::xowiki::Package

Class Hierarchy of ::xowiki::Package

• ::xotcl::Object

  Meta-class:

  ::xotcl::Class

  Methods for instances:

  __api_make_doc, __api_make_forward_doc, __next^C, __timediff, abstract, ad_doc, ad_forward, ad_proc, append^C, array^C, asHTML, autoname^C, check^C, class^C, cleanup^C, configure^C, contains, copy, db_1row^C, debug, defaultmethod, destroy^C, destroy_on_cleanup, eval^C, exists^C, extractConfigureArg, filter^C, filterguard^C, filtersearch^C, forward^C, hasclass, incr^C, info^C, init, instvar^C, invar^C, isclass^C, ismetaclass^C, ismixin^C, isobject^C, istype^C, lappend^C, log, method, mixin^C, mixinguard^C, move, msg, noinit^C, parametercmd^C, proc^C, procsearch^C, qn, requireNamespace^C, self, serialize, set^C, subst^C, trace^C, unset^C, uplevel^C, upvar^C, volatile^C, vwait^C

  Methods to be applied on the class (in addition to the methods provided by the meta-class):

  __exitHandler, getExitHandler, setExitHandler, unsetExitHandler

• ::xo::db::Object

  Meta-class:

  ::xo::db::Class

  Methods for instances:

  delete, initialize_loaded_object, insert, object_id^C, object_title^C, save, save_new

  Methods to be applied on the class:

  Methods provided by the meta-class

• ::xo::Package

  Meta-class:

  ::xo::PackageMgr

  Parameter for instances:

  context (default "::xo::cc"), force_refresh_login (default "false"), id, package_url, url

  Methods for instances:

  default_locale^C, exists_form_parameter^C, exists_query_parameter^C, form_parameter^C, get_parameter, init, initialize, insert, instance_name^C, package_id^C, package_key^C, query_parameter^C, reply_to_user, return_page, returnredirect^C, save, set_url

  Methods to be applied on the class:

  Methods provided by the meta-class

• ::xowiki::Package

  Meta-class:

  ::xo::PackageMgr

  Parameter for instances:

  folder_id (default "0"), force_refresh_login (default "false")

  Methods for instances:

  call, check_permissions^C, condition=has_class, condition=has_name, create_new_snippet, default_language, default_locale, delete, delete_revision, edit-new, error_msg, external_name, flush_name_cache, flush_page_fragment_cache, flush_references, folder_path, get_lang_and_name, get_parameter, get_parent_and_name, google-sitemap, google-sitemapindex, import, import_prototype_page, init, insert, invoke, make_link, normalize_name, package_id^C, pretty_link, reindex, require_folder_object, resolve_page, resolve_page_name, resolve_page_name_and_init_context, resolve_request, rss, show_page_order

  Methods to be applied on the class (in addition to the methods provided by the meta-class):

  get_url_from_id, google-sitemapindex, instantiate_page_from_id

Class Relations

• superclass: ::xo::Package
• instmixin: ::xowiki::ParameterCache
• subclass: ::blocks::Package, ::learning_content::Package

Methods

• proc get_url_from_id (public)

  ::xowiki::Package get_url_from_id [ -item_id item_id ] \
      [ -revision_id revision_id ]

  Get the full URL from a page in situations, where the context is not set up.

  Switches:

  -item_id (defaults to "0") (optional)

  -revision_id (defaults to "0") (optional)

  
  See Also:

  • instantiate_page_from_id

• proc google-sitemapindex (public)

  ::xowiki::Package google-sitemapindex [ -changefreq changefreq ] \
      [ -priority priority ]

  Provide a sitemap index of all xowiki instances in google site map format https://www.google.com/webmasters/sitemaps/docs/en/protocol.html

  Switches:

  -changefreq (defaults to "daily") (optional)

  changefreq as defined by google

  -priority (defaults to "priority") (optional)

  priority as defined by google

• proc instantiate_page_from_id (public)

  ::xowiki::Package instantiate_page_from_id \
      [ -revision_id revision_id ] [ -item_id item_id ] \
      [ -user_id user_id ] [ -parameter parameter ]

  Instantiate a page in situations, where the context is not set up (e.g. we have no package object or folder obect). This call is convenient when testing e.g. from the developer shell

  Switches:

  -revision_id (defaults to "0") (optional)

  -item_id (defaults to "0") (optional)

  -user_id (defaults to "-1") (optional)

  -parameter (optional)

• instproc external_name (public)

  <instance of ::xowiki::Package> external_name \
      [ -parent_id parent_id ] name

  Generate a name with a potentially inserted parent name

  Switches:

  -parent_id (optional)

  parent_id (for now just for download)

  Parameters:

  name - name of the wiki page
  

• instproc get_parameter (public)

  <instance of ::xowiki::Package> get_parameter \
      [ -check_query_parameter check_query_parameter ] attribute \
      [ default ]

  resolves configurable parameters according to the following precedence: (1) values specifically set per page {{set-parameter ...}} (2) query parameter (3) form fields from the parameter_page FormPage (4) per instance parameters from the folder object (computable) (5) standard OpenACS package parameter

  Switches:

  -check_query_parameter (defaults to "true") (optional)

  Parameters:

  attribute
  default (optional)
  

• instproc google-sitemap (public)

  <instance of ::xowiki::Package> google-sitemap \
      [ -max_entries max_entries ] [ -changefreq changefreq ] \
      [ -priority priority ]

  Report content of xowiki folder in google site map format https://www.google.com/webmasters/sitemaps/docs/en/protocol.html

  Switches:

  -max_entries (optional)

  -changefreq (defaults to "daily") (optional)

  changefreq as defined by google

  -priority (defaults to "0.5") (optional)

  priority as defined by google

• instproc import (public)

  <instance of ::xowiki::Package> import [ -user_id user_id ] \
      [ -folder_id folder_id ] [ -replace replace ] [ -objects objects ] \
      [ -create_user_ids create_user_ids ] \
      [ -community_id community_id ] [ -old_url old_url ]

  import the specified pages into the xowiki instance

  Switches:

  -user_id (optional)

  -folder_id (optional)

  -replace (defaults to "0") (optional)

  -objects (optional)

  -create_user_ids (defaults to "0") (optional)

  -community_id (defaults to "0") (optional)

  -old_url (optional)

• instproc make_link (public)

  <instance of ::xowiki::Package> make_link \
      [ -with_entities with_entities ] [ -privilege privilege ] \
      [ -link link ] object method args

  Creates conditionally a link for use in xowiki. When the generated link will be activated, the specified method of the object will be invoked. make_link checks in advance, wether the actual user has enough rights to invoke the method. If not, this method returns empty.

  Switches:

  -with_entities (defaults to "0") (optional)

  -privilege (optional)

  -link (optional)

  Parameters:

  object
  method - Which method to use. This will be appended as "m=method" to the url. Examples for methods:

  • view: To view and existing page
  • edit: To edit an existing page
  • revisions: To view the revisions of an existing page

  
  args - List of attributes to be append to the link. Every element can be an attribute name, or a "name value" pair. Behaves like export_vars.
  

  Returns:

  The link or empty

  
  See Also:

  • export_vars

• instproc pretty_link (public)

  <instance of ::xowiki::Package> pretty_link [ -anchor anchor ] \
      [ -absolute on|off ] [ -siteurl siteurl ] [ -lang lang ] \
      [ -parent_id parent_id ] [ -download download ] name

  Generate a (minimal) link to a wiki page with the specified name. Pratically all links in the xowiki systems are generated through this function.

  Switches:

  -anchor (optional)

  anchor to be added to the link

  -absolute (boolean) (defaults to "false") (optional)

  make an absolute link (including protocol and host)

  -siteurl (optional)

  -lang (optional)

  use the specified 2 character language code (rather than computing the value)

  -parent_id (optional)

  parent_id (for now just for download)

  -download (defaults to "false") (optional)

  create download link (without m=download)

  Parameters:

  name - name of the wiki page
  

• instproc reindex (public)

  <instance of ::xowiki::Package> reindex

  reindex all items of this package

• instproc rss (public)

  <instance of ::xowiki::Package> rss [ -maxentries maxentries ] \
      [ -name_filter name_filter ] [ -entries_of entries_of ] \
      [ -title title ] [ -days days ]

  Report content of xowiki folder in rss 2.0 format. The reporting order is descending by date. The title of the feed is taken from the title, the description is taken from the description field of the folder object.

  Switches:

  -maxentries (optional)

  maximum number of entries retrieved

  -name_filter (optional)

  -entries_of (optional)

  -title (optional)

  -days (optional)

  report entries changed in speficied last days