xotcl.wu-wien.ac.at
Begin main content
Methods: Source: Variables:
[All Methods | Documented Methods | Hide Methods] [Display Source | Hide Source] [Show Variables | Hide Variables]

::xo::PackageMgr[i] ::xowiki::Package

Class Hierarchy of ::xowiki::Package

  • ::xotcl::Object[i]
    Meta-class:
    ::xotcl::Class[i]
    Methods for instances:
    __api_make_doc, __api_make_forward_doc, __timediff, abstract, ad_doc, ad_forward, ad_proc, appendC, arrayC, asHTML, autonameC, check, classC, cleanupC, configureC, containsC, copyC, db_0or1rowC, db_1rowC, debug, defaultmethodC, destroyC, destroy_on_cleanup, ds, evalC, existsC, extractConfigureArg, filterC, filterguardC, filtersearch, forward, hasclass, incrC, infoC, init, instvarC, invarC, isclass, ismetaclass, ismixin, isobject, istype, lappendC, log, method, mixinC, mixinguardC, moveC, msg, noinitC, objectparameter, parametercmdC, proc, procsearch, qn, requireNamespaceC, residualargsC, self, serialize, setC, set_instance_vars_defaults, show-object, substC, traceC, unknown, unsetC, uplevelC, upvarC, volatileC, vwait
    Methods to be applied on the class (in addition to the methods provided by the meta-class):
    getExitHandler, setExitHandler, unsetExitHandler
    • ::xo::db::Object[i]
      Meta-class:
      ::xo::db::Class[i]
      Methods for instances:
      db_1row, delete, initialize_loaded_object, insert, object_idC, object_titleC, save, save_new
      Methods to be applied on the class:
      Methods provided by the meta-class
      • ::xo::Package[i]
        Meta-class:
        ::xo::PackageMgr[i]
        Parameter for instances:
        context (default "::xo::cc"), force_refresh_login (default "false"), id, package_url, url
        Methods for instances:
        default_localeC, exists_form_parameterC, exists_query_parameterC, form_parameterC, get_parameter, init, initialize, insert, instance_nameC, package_idC, package_keyC, query_parameterC, reply_to_user, require_root_folder, return_page, returnredirectC, save, set_url
        Methods to be applied on the class:
        Methods provided by the meta-class
        • ::xowiki::Package[i]
          Meta-class:
          ::xo::PackageMgr[i]
          Parameter for instances:
          folder_id (default "0"), force_refresh_login (default "false")
          Methods for instances:
          call, change-page-order, check_permissionsC, condition=has_class, condition=has_name, create_new_snippet, default_language, default_locale, delete, delete_revision, edit-category-tree, edit-new, error_msg, external_name, flush_name_cache, flush_page_fragment_cache, flush_references, folder_path, get_lang_and_name, get_package_id_from_page_name, get_page_from_item_or_revision_id, get_page_from_item_ref, get_page_from_name, get_page_from_super, get_parameter, get_parent_and_name, google-sitemap, google-sitemapindex, import, import-prototype-page, init, insert, invoke, item_info_from_id, item_info_from_url, item_ref, lookup, make_form_link, make_link, manage-categories, normalize_name, package_idC, package_path, prefixed_lookup, pretty_link, refresh-login, reindex, require_folder_object, require_root_folder, resolve_package_path, resolve_page, resolve_page_name, resolve_page_name_and_init_context, rss, show_page_order, simple_item_ref
          Methods to be applied on the class (in addition to the methods provided by the meta-class):
          get_package_id_from_page_id, get_site_wide_page, get_url_from_id, google-sitemapindex, import_prototype_page, instantiate_page_from_id, lookup_side_wide_page, require_site_wide_pages

Class Relations

  • superclass: ::xo::Package[i]
  • instmixin: ::xowiki::ParameterCache[i]
  • subclass: ::s5::Package[i], ::xowf::Package[i]

Methods

  • proc get_package_id_from_page_id (public)

    ::xowiki::Package[i] get_package_id_from_page_id \
        [ -revision_id revision_id ] [ -item_id item_id ]
    Obtain the package_id from either the item_id or the revision_id of a page

    Switches:
    -revision_id (defaults to "0") (optional)
    -item_id (defaults to "0") (optional)
  • proc get_url_from_id (public)

    ::xowiki::Package[i] 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[i] 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[i] 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). 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 change-page-order (public)

    <instance of ::xowiki::Package[i]> change-page-order
    Change Page Order for pages by renumbering and filling gaps.

  • instproc external_name (public)

    <instance of ::xowiki::Package[i]> 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[i]> get_parameter \
        [ -check_query_parameter check_query_parameter ] [ -type type ] \
        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) standard OpenACS package parameter

    Switches:
    -check_query_parameter (defaults to "true") (optional)
    -type (optional)
    Parameters:
    attribute
    default (optional)
  • instproc google-sitemap (public)

    <instance of ::xowiki::Package[i]> 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[i]> import [ -user_id user_id ] \
        [ -parent_id parent_id ] [ -replace replace ] [ -objects objects ] \
        [ -create_user_ids create_user_ids ]
    import the specified pages into the xowiki instance

    Switches:
    -user_id (optional)
    -parent_id (defaults to "0") (optional)
    -replace (defaults to "0") (optional)
    -objects (optional)
    -create_user_ids (defaults to "0") (optional)
  • instproc item_ref (public)

    <instance of ::xowiki::Package[i]> item_ref \
        [ -use_package_path use_package_path ] \
        [ -use_site_wide_pages use_site_wide_pages ] \
        [ -normalize_name normalize_name ] -default_lang default_lang  \
        -parent_id parent_id  link
    An item_ref refers to an item (existing or nonexisting) in the content repository relative to some parent_id. The item might be either a folder or some kind of "page" (e.g. a file). An item_ref might be complex, i.e. consist of a path of simple_item_refs, separated by "/". An item_ref stops at the first unknown part in the path and returns item_id == 0 and the appropriate parent_id (and name etc.) for insertion.

    Switches:
    -use_package_path (defaults to "false") (optional)
    -use_site_wide_pages (defaults to "false") (optional)
    -normalize_name (defaults to "true") (optional)
    -default_lang (required)
    -parent_id (required)
    Parameters:
    link
    Returns:
    item info containing link_type form prefix stripped_name item_id parent_id
  • instproc make_link (public)

    <instance of ::xowiki::Package[i]> 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:
  • instproc pretty_link (public)

    <instance of ::xowiki::Package[i]> pretty_link [ -anchor anchor ] \
        [ -query query ] [ -absolute on|off ] [ -siteurl siteurl ] \
        [ -lang lang ] [ -parent_id parent_id ] [ -download download ] \
        [ -context_url context_url ] [ -folder_ids folder_ids ] 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
    -query (optional)
    -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)
    -context_url (optional)
    -folder_ids (optional)
    Parameters:
    name - name of the wiki page
  • instproc refresh-login (public)

    <instance of ::xowiki::Package[i]> refresh-login
    Force a refresh of a login and do a redict. Intended for use from ajax.

  • instproc reindex (public)

    <instance of ::xowiki::Package[i]> reindex
    reindex all items of this package

  • instproc require_root_folder (public)

    <instance of ::xowiki::Package[i]> require_root_folder \
        [ -parent_id parent_id ] [ -content_types content_types ] \
        -name name 
    Make sure, the root folder for the given package exists. If not, create it and register all allowed content types.

    Switches:
    -parent_id (defaults to "-100") (optional)
    -content_types (optional)
    -name (required)
    Returns:
    folder_id
  • instproc rss (public)

    <instance of ::xowiki::Package[i]> 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

Methods: Source: Variables:
[All Methods | Documented Methods | Hide Methods] [Display Source | Hide Source] [Show Variables | Hide Variables]