Class ::xowiki::Package

::xowiki::Package[i] create ... \
           [ -folder_id (default "0") ] \
           [ -force_refresh_login (default "false") ]

Class Relations

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

Methods (to be applied on the object)

  • get_package_id_from_page_id (scripted, 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)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowiki::Package proc get_package_id_from_page_id xowiki::Package proc get_package_id_from_page_id test_create_workflow_with_instance->xowiki::Package proc get_package_id_from_page_id

    Testcases:
    create_workflow_with_instance
  • get_url_from_id (scripted, 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

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.
  • google_sitemapindex (scripted, public)

     xowiki::Package[i] google_sitemapindex [ -changefreq changefreq ] \
        [ -priority priority ] [ -package package ]

    This method provides 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
    -package
    (optional)
    to determine the delivery instance

    Partial Call Graph (max 5 caller/called nodes):
    %3 ad_script_abort ad_script_abort (public) ad_url ad_url (public) parameter::get parameter::get (public) site_node::get_from_object_id site_node::get_from_object_id (public) xo::db::tcl_date xo::db::tcl_date (public) xowiki::Package proc google_sitemapindex xowiki::Package proc google_sitemapindex xowiki::Package proc google_sitemapindex->ad_script_abort xowiki::Package proc google_sitemapindex->ad_url xowiki::Package proc google_sitemapindex->parameter::get xowiki::Package proc google_sitemapindex->site_node::get_from_object_id xowiki::Package proc google_sitemapindex->xo::db::tcl_date

    Testcases:
    No testcase defined.
  • instantiate_page_from_id (scripted, 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 connection 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)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowiki::Package proc instantiate_page_from_id xowiki::Package proc instantiate_page_from_id test_create_workflow_with_instance->xowiki::Package proc instantiate_page_from_id

    Testcases:
    create_workflow_with_instance
  • is_xowiki_p (scripted, public)

     xowiki::Package[i] is_xowiki_p package_id

    A small stunt to detect if a package is a descendant of xowiki.

    Parameters:
    package_id
    Returns:
    boolean

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_parameter__check_procs parameter__check_procs (test acs-tcl) xowiki::Package proc is_xowiki_p xowiki::Package proc is_xowiki_p test_parameter__check_procs->xowiki::Package proc is_xowiki_p apm_package_key_from_id apm_package_key_from_id (public) xowiki::Package proc is_xowiki_p->apm_package_key_from_id

    Testcases:
    parameter__check_procs

Methods (to be applied on instances)

  • external_name (scripted, 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

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_xowiki_test_cases xowiki_test_cases (test xowiki) xowiki::Package instproc external_name xowiki::Package instproc external_name test_xowiki_test_cases->xowiki::Package instproc external_name

    Testcases:
    xowiki_test_cases
  • folder_path (scripted, public)

     <instance of xowiki::Package[i]> folder_path \
        [ -parent_id parent_id ] [ -context_url context_url ] \
        [ -folder_ids folder_ids ] [ -path_encode on|off ]

    Construct a folder path from a hierarchy of xowiki objects. It is designed to work with linked objects, respecting logical and physical parent IDs. The result is URL encoded, unless path_encode is set to false.

    Switches:
    -parent_id
    (optional)
    -context_url
    (optional)
    -folder_ids
    (optional)
    -path_encode
    (boolean) (defaults to "true") (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_link_tests link_tests (test xowiki) xowiki::Package instproc folder_path xowiki::Package instproc folder_path test_link_tests->xowiki::Package instproc folder_path ad_urlencode_path ad_urlencode_path (public) xowiki::Package instproc folder_path->ad_urlencode_path

    Testcases:
    link_tests
  • get_ids_for_bulk_actions (scripted, public)

     <instance of xowiki::Package[i]> get_ids_for_bulk_actions \
        [ -parent_id parent_id ] page_references

    The page_reference is either an item_id, a fully qualified URL path or the name exactly as stored in the content repository ("name" attribute in the database, requires parent_id to be provided as well)

    Switches:
    -parent_id
    (optional)
    optional, only needed in legacy cases, when page_reference is provided as page name
    Parameters:
    page_references - item_ids, paths or names to be resolved as item_ids
    Returns:
    list of valid item_ids

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.
  • get_parameter (scripted, public)

     <instance of xowiki::Package[i]> get_parameter \
        [ -check_query_parameter check_query_parameter ] [ -nocache ] \
        [ -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 The specified attribute can be of the form "name:value_constraint"

    Switches:
    -check_query_parameter
    (defaults to "true") (optional)
    -nocache
    (optional)
    -type
    (optional)
    Parameters:
    attribute
    default (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_form_with_form_instance create_form_with_form_instance (test xowiki) xowiki::Package instproc get_parameter xowiki::Package instproc get_parameter test_create_form_with_form_instance->xowiki::Package instproc get_parameter ad_return_complaint ad_return_complaint (public) xowiki::Package instproc get_parameter->ad_return_complaint xo::validate_parameter_constraints xo::validate_parameter_constraints (public) xowiki::Package instproc get_parameter->xo::validate_parameter_constraints

    Testcases:
    create_form_with_form_instance
  • get_parameter_from_parameter_page (scripted, public)

     <instance of xowiki::Package[i]> get_parameter_from_parameter_page \
        [ -parameter_page_name parameter_page_name ] parameter [ default ]

    Try to get the parameter from the named parameter_page.

    Switches:
    -parameter_page_name
    (optional)
    Parameters:
    parameter
    default (optional)
    Returns:
    parameter value or empty

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_xowiki_test_cases xowiki_test_cases (test xowiki) xowiki::Package instproc get_parameter_from_parameter_page xowiki::Package instproc get_parameter_from_parameter_page test_xowiki_test_cases->xowiki::Package instproc get_parameter_from_parameter_page ad_log ad_log (public) xowiki::Package instproc get_parameter_from_parameter_page->ad_log nsf::is nsf::is xowiki::Package instproc get_parameter_from_parameter_page->nsf::is

    Testcases:
    xowiki_test_cases
  • import (scripted, 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)

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.
  • invoke (scripted)

     <instance of xowiki::Package[i]> invoke

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_folder_with_page create_folder_with_page (test ) xowiki::Package instproc invoke xowiki::Package instproc invoke test_create_folder_with_page->xowiki::Package instproc invoke test_create_form_with_form_instance create_form_with_form_instance (test xowiki) test_create_form_with_form_instance->xowiki::Package instproc invoke test_create_workflow_with_instance create_workflow_with_instance (test xowf) test_create_workflow_with_instance->xowiki::Package instproc invoke test_xowf xowf (test ) test_xowf->xowiki::Package instproc invoke ad_log ad_log (public) xowiki::Package instproc invoke->ad_log ad_return_complaint ad_return_complaint (public) xowiki::Package instproc invoke->ad_return_complaint ad_script_abort ad_script_abort (public) xowiki::Package instproc invoke->ad_script_abort ad_try ad_try (public) xowiki::Package instproc invoke->ad_try

    Testcases:
    create_folder_with_page, xowf, create_workflow_with_instance, create_form_with_form_instance
  • item_info_from_url (scripted)

     <instance of xowiki::Package[i]> item_info_from_url

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_path_resolve path_resolve (test ) xowiki::Package instproc item_info_from_url xowiki::Package instproc item_info_from_url test_path_resolve->xowiki::Package instproc item_info_from_url test_xowiki xowiki (test ) test_xowiki->xowiki::Package instproc item_info_from_url

    Testcases:
    path_resolve, xowiki
  • item_ref (scripted, 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 non-existing) 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

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_path_resolve path_resolve (test xowiki) xowiki::Package instproc item_ref xowiki::Package instproc item_ref test_path_resolve->xowiki::Package instproc item_ref test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->xowiki::Package instproc item_ref

    Testcases:
    xowiki_test_cases, path_resolve
  • lookup (scripted, public)

     <instance of xowiki::Package[i]> lookup \
        [ -use_package_path use_package_path ] \
        [ -use_site_wide_pages use_site_wide_pages ] \
        [ -default_lang default_lang ] -name name  \
        [ -parent_id parent_id ]

    Lookup name (with maybe cross-package references) from a given parent_id or from the list of configured instances (obtained via package_path).

    Switches:
    -use_package_path
    (defaults to "true") (optional)
    -use_site_wide_pages
    (defaults to "false") (optional)
    -default_lang
    (optional)
    -name
    (required)
    -parent_id
    (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_path_resolve path_resolve (test xowiki) xowiki::Package instproc lookup xowiki::Package instproc lookup test_path_resolve->xowiki::Package instproc lookup

    Testcases:
    path_resolve
  • make_link (scripted, public)

     <instance of xowiki::Package[i]> make_link \
        [ -with_entities with_entities ] [ -privilege privilege ] \
        [ -link link ] object [ method ] args [ 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, whether 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)
    When provided, the privilege can be "public" (do not check rights) or a privilege to be checked on the package_id and the current user. When this parameter is not specified, the policy is used to determine the rights to be checked.
    -link
    (optional)
    When this parameter is specified, is used used as base link for export_vars when applied on pages (or for packages as next segment under the package url). When not specified, the base url for pages is the current url, and for packages it is the package url.
    Parameters:
    object - The object to which the link refers to. If it is a package_id it will base to the root_url of the package_id. If it is a page, it will base to the page_url
    method (optional) - 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:

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_xowiki_test_cases xowiki_test_cases (test xowiki) xowiki::Package instproc make_link xowiki::Package instproc make_link test_xowiki_test_cases->xowiki::Package instproc make_link ad_try ad_try (public) xowiki::Package instproc make_link->ad_try

    Testcases:
    xowiki_test_cases
  • normalize_path (scripted)

     <instance of xowiki::Package[i]> normalize_path

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_package_normalize_path package_normalize_path (test ) xowiki::Package instproc normalize_path xowiki::Package instproc normalize_path test_package_normalize_path->xowiki::Package instproc normalize_path test_xowiki xowiki (test ) test_xowiki->xowiki::Package instproc normalize_path

    Testcases:
    package_normalize_path, xowiki
  • pretty_link (scripted, public)

     <instance of xowiki::Package[i]> pretty_link [ -anchor anchor ] \
        [ -query query ] [ -absolute on|off ] [ -siteurl siteurl ] \
        [ -lang lang ] [ -parent_id parent_id ] [ -download on|off ] \
        [ -context_url context_url ] [ -folder_ids folder_ids ] \
        [ -path_encode on|off ] [ -page page ] name

    Generate a (minimal) link to a wiki page with the specified name. Practically all links in the xowiki systems are generated through this method. The method returns the URL path urlencoded, unless "-path_encode" is set to false.

    Switches:
    -anchor
    (optional)
    anchor to be added to the link
    -query
    (optional)
    query parameters to be added literally to the resulting URL
    -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
    -download
    (boolean) (defaults to "false") (optional)
    create download link (without m=download)
    -context_url
    (optional)
    -folder_ids
    (optional)
    -path_encode
    (boolean) (defaults to "true") (optional)
    control URL encoding of the path segmemts
    -page
    (optional)
    Parameters:
    name - name of the wiki page

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_link_tests link_tests (test xowiki) xowiki::Package instproc pretty_link xowiki::Package instproc pretty_link test_link_tests->xowiki::Package instproc pretty_link ad_log ad_log (public) xowiki::Package instproc pretty_link->ad_log ad_url ad_url (public) xowiki::Package instproc pretty_link->ad_url ad_urlencode_path ad_urlencode_path (public) xowiki::Package instproc pretty_link->ad_urlencode_path

    Testcases:
    link_tests
  • reparent (scripted, public)

     <instance of xowiki::Package[i]> reparent [ -item_id item_id ] \
        [ -new_parent_id new_parent_id ] \
        [ -allowed_parent_types allowed_parent_types ]

    Reparent a wiki page from one parent page to another one. The function changes the parent_id in cr_items, updates the cr-child-rels, and clears the caches. The function does not require the item to be instantiated. Limitations: The method does not perform permission checks (whether the actual user has rights to move the page to another parent folder), which should be implemented by the calling methods. Currently, the method does not perform cycle checks. It might be recommended to make sure the target parent is in the same package instance.

    Switches:
    -item_id
    (optional)
    item_id of the item to be moved
    -new_parent_id
    (optional)
    item_id of the target parent
    -allowed_parent_types
    (defaults to "::xowiki::FormPage ::xowiki::Page") (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 xowiki::update_item_index xowiki::update_item_index (public) xowiki::Package instproc reparent xowiki::Package instproc reparent xowiki::Package instproc reparent->xowiki::update_item_index

    Testcases:
    No testcase defined.
  • require_root_folder (scripted, 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

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_form_with_form_instance create_form_with_form_instance (test xowiki) xowiki::Package instproc require_root_folder xowiki::Package instproc require_root_folder test_create_form_with_form_instance->xowiki::Package instproc require_root_folder ad_log ad_log (public) xowiki::Package instproc require_root_folder->ad_log xowiki::transform_root_folder xowiki::transform_root_folder xowiki::Package instproc require_root_folder->xowiki::transform_root_folder

    Testcases:
    create_form_with_form_instance
  • resolve_page (scripted, public)

     <instance of xowiki::Package[i]> resolve_page \
        [ -use_package_path use_package_path ] [ -simple on|off ] \
        [ -lang lang ] object method_var

    Try to resolve from object (path) and query parameter the called object (might be a package or page) and the method to be called.

    Switches:
    -use_package_path
    (defaults to "true") (optional)
    -simple
    (boolean) (defaults to "false") (optional)
    when set, do not try to resolve using item refs, prototype pages or package_path
    -lang
    (optional)
    language used for resolving
    Parameters:
    object - element name to be resolved (not an XOTcl object)
    method_var - output variable for method to be called on the object
    Returns:
    instantiated object (Page or Package) or empty

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_path_resolve path_resolve (test xowiki) xowiki::Package instproc resolve_page xowiki::Package instproc resolve_page test_path_resolve->xowiki::Package instproc resolve_page test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->xowiki::Package instproc resolve_page ad_log ad_log (public) xowiki::Package instproc resolve_page->ad_log

    Testcases:
    xowiki_test_cases, path_resolve
  • www-change-page-order (scripted, public)

     <instance of xowiki::Package[i]> www-change-page-order

    This web-callable method changes the page order for pages by renumbering and filling gaps. The parameter "clean" is just used for page inserts. This method is typically called via AJAX.

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.
  • www-delete (scripted, public)

     <instance of xowiki::Package[i]> www-delete [ -item_id item_id ] \
        [ -name name ] [ -parent_id parent_id ] [ -return_url return_url ]

    This web-callable "delete" method does not require an instantiated object, while the class-specific delete methods in xowiki-procs need these. If a (broken) object can't be instantiated, it cannot be deleted. Therefore, we need this package level delete method. While the class specific methods are used from the application pages, the package_level method is used from the admin pages. If no "item_id", "name" or "return_url" are given, take it from the query parameters.

    Switches:
    -item_id
    (optional)
    -name
    (optional)
    -parent_id
    (optional)
    -return_url
    (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_xowiki_test_cases xowiki_test_cases (test xowiki) xowiki::Package instproc www-delete xowiki::Package instproc www-delete test_xowiki_test_cases->xowiki::Package instproc www-delete _ _ (public) xowiki::Package instproc www-delete->_ ad_urlencode_folder_path ad_urlencode_folder_path (public) xowiki::Package instproc www-delete->ad_urlencode_folder_path

    Testcases:
    xowiki_test_cases
  • www-edit-category-tree (scripted, public)

     <instance of xowiki::Package[i]> www-edit-category-tree

    This web-callable method redirects the caller to the category admin page for a certain category tree. The "object_id" and "tree_id" have to be provided as a query parameter.

    Partial Call Graph (max 5 caller/called nodes):
    %3 export_vars export_vars (public) site_node::get_package_url site_node::get_package_url (public) xowiki::Package instproc www-edit-category-tree xowiki::Package instproc www-edit-category-tree xowiki::Package instproc www-edit-category-tree->export_vars xowiki::Package instproc www-edit-category-tree->site_node::get_package_url

    Testcases:
    No testcase defined.
  • www-edit-new (scripted, public)

     <instance of xowiki::Package[i]> www-edit-new

    This web-callable method can be used to create new pages in the current package. The behavior can be influenced by the query parameters "object_type", "autoname", "parent_id" and "source_item_id". Finally, it calls "www-edit" for the freshly created page.

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_form_with_form_instance create_form_with_form_instance (test xowiki) xowiki::Package instproc www-edit-new xowiki::Package instproc www-edit-new test_create_form_with_form_instance->xowiki::Package instproc www-edit-new ad_return_complaint ad_return_complaint (public) xowiki::Package instproc www-edit-new->ad_return_complaint ad_script_abort ad_script_abort (public) xowiki::Package instproc www-edit-new->ad_script_abort

    Testcases:
    create_form_with_form_instance
  • www-google-sitemap (scripted, public)

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

    This web-callable method reports the content of xowiki folder in google site map format https://www.google.com/webmasters/sitemaps/docs/en/protocol.html

    Switches:
    -max_entries
    (optional)
    maximum number of entries retrieved
    -changefreq
    (defaults to "daily") (optional)
    changefreq as defined by google
    -priority
    (defaults to "0.5") (optional)
    priority as defined by google

    Partial Call Graph (max 5 caller/called nodes):
    %3 xo::db::tcl_date xo::db::tcl_date (public) xowiki::url xowiki::url (private) xowiki::Package instproc www-google-sitemap xowiki::Package instproc www-google-sitemap xowiki::Package instproc www-google-sitemap->xo::db::tcl_date xowiki::Package instproc www-google-sitemap->xowiki::url

    Testcases:
    No testcase defined.
  • www-google-sitemapindex (scripted, public)

     <instance of xowiki::Package[i]> www-google-sitemapindex

    This web-callable method calls "google_sitemapindex" for producing a sitemap index.

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.
  • www-import-prototype-page (scripted, public)

     <instance of xowiki::Package[i]> www-import-prototype-page \
        [ -add_revision on|off ] [ -lang lang ] [ -parent_id parent_id ] \
        [ prototype_name ]

    This web-callable method is designed for admin to ease the import of prototpye pages. When called via web, the query parameter "import-prototype-page" determines the page for the import.

    Switches:
    -add_revision
    (boolean) (defaults to "true") (optional)
    -lang
    (defaults to "en") (optional)
    -parent_id
    (optional)
    Parameters:
    prototype_name (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_form_with_form_instance create_form_with_form_instance (test xowiki) xowiki::Package instproc www-import-prototype-page xowiki::Package instproc www-import-prototype-page test_create_form_with_form_instance->xowiki::Package instproc www-import-prototype-page ad_urlencode_folder_path ad_urlencode_folder_path (public) xowiki::Package instproc www-import-prototype-page->ad_urlencode_folder_path

    Testcases:
    create_form_with_form_instance
  • www-manage-categories (scripted, public)

     <instance of xowiki::Package[i]> www-manage-categories

    This web-callable method redirects the caller to the category admin page configured for the current package. The "object_id" has to be provided as a query parameter.

    Partial Call Graph (max 5 caller/called nodes):
    %3 export_vars export_vars (public) site_node::get_package_url site_node::get_package_url (public) xowiki::Package instproc www-manage-categories xowiki::Package instproc www-manage-categories xowiki::Package instproc www-manage-categories->export_vars xowiki::Package instproc www-manage-categories->site_node::get_package_url

    Testcases:
    No testcase defined.
  • www-refresh-login (scripted, public)

     <instance of xowiki::Package[i]> www-refresh-login

    This web-callable method forces a refresh of a login and do a redirect. Intended for use from ajax.

    Partial Call Graph (max 5 caller/called nodes):
    %3 export_vars export_vars (public) subsite::get_url subsite::get_url (public) xowiki::Package instproc www-refresh-login xowiki::Package instproc www-refresh-login xowiki::Package instproc www-refresh-login->export_vars xowiki::Package instproc www-refresh-login->subsite::get_url

    Testcases:
    No testcase defined.
  • www-reindex (scripted, public)

     <instance of xowiki::Package[i]> www-reindex

    This web-callable method can be used to reindex all items of this package by adding all pages of this package to the search queue.

    Partial Call Graph (max 5 caller/called nodes):
    %3 search::queue search::queue (public) xowiki::Package instproc www-reindex xowiki::Package instproc www-reindex xowiki::Package instproc www-reindex->search::queue

    Testcases:
    No testcase defined.
  • www-rss (scripted, public)

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

    This web-callable method reports the 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 specified last days

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.
  • www-update-references (scripted, public)

     <instance of xowiki::Package[i]> www-update-references

    This web-callable method can be used to update the page references between all items of this package instance. Call with e.g. xowiki/?update-references

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.