- Publicity: Public Only All
install-procs.tcl
Procs which may be invoked using similarly named elements in an install.xml file.
- Location:
- packages/acs-tcl/tcl/install-procs.tcl
- Created:
- 2004-06-16
- Author:
- Lee Denison <lee@thaum.net>
- CVS Identification:
$Id: install-procs.tcl,v 1.40 2024/12/28 15:39:56 gustafn Exp $
Procedures in this file
- install::xml::action::add-subsite-admin (public)
- install::xml::action::add-subsite-member (public)
- install::xml::action::ats-page (public)
- install::xml::action::call-tcl-proc (private)
- install::xml::action::create-package (public)
- install::xml::action::create-user (public)
- install::xml::action::install (public)
- install::xml::action::instantiate-object (private)
- install::xml::action::location (public)
- install::xml::action::mount (public)
- install::xml::action::mount-existing (public)
- install::xml::action::register-parameter (public)
- install::xml::action::relation-add (public)
- install::xml::action::relation-type (public)
- install::xml::action::rename-instance (public)
- install::xml::action::set-id (public)
- install::xml::action::set-join-policy (public)
- install::xml::action::set-parameter (public)
- install::xml::action::set-parameter-default (public)
- install::xml::action::set-permission (public)
- install::xml::action::set-theme (public)
- install::xml::action::source (private)
- install::xml::action::text (public)
- install::xml::action::unset-permission (public)
- install::xml::action::wizard (public)
- install::xml::object_id::admin-group (public)
- install::xml::object_id::application-group (public)
- install::xml::object_id::group (public)
- install::xml::object_id::member-group (public)
- install::xml::object_id::object (public)
- install::xml::object_id::package (public)
- install::xml::util::get_id (public)
Detailed information
install::xml::action::add-subsite-admin (public)
install::xml::action::add-subsite-admin node
Add a member to a subsite's admins group.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::add-subsite-member (public)
install::xml::action::add-subsite-member node
Add a member to a subsites application group.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::ats-page (public)
install::xml::action::ats-page node
Creates an ATS Page.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::call-tcl-proc (private)
install::xml::action::call-tcl-proc node
Call an arbitrary Tcl library procedure. Parameters which have a name are called using the "-param" syntax. If there's no name given, the value is passed directly as a positional parameter. It is the user's responsibility to list all named parameters before any positional parameter (as is necessary if the proc is declared using ad_proc). If a named parameter has an XML attribute declaring its type to be boolean, and the value is blank, the switch is passed without a value. Otherwise, the boolparam=value syntax is used. You can cheat and use this to execute arbitrary Tcl code if you dare, since Tcl commands are just procs ...
- Parameters:
- node (required)
- Author:
- Don Baccus donb@pacifier.com
- Created:
- 2008-12-04
- Testcases:
- No testcase defined.
install::xml::action::create-package (public)
install::xml::action::create-package node
Create a relation type.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::create-user (public)
install::xml::action::create-user node
Create a new user. local-p should be set to true when this action is used in the bootstrap install.xml - this ensures we call the auth::local api directly while the service contract has not been setup.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::install (public)
install::xml::action::install node
Installs a package including dependencies.
<install package="package-key />
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::instantiate-object (private)
install::xml::action::instantiate-object node
Instantiate an object using package_instantiate_object. This will work for both PostgreSQL and Oracle if the proper object package and new() function have been defined.
- Parameters:
- node (required)
- Author:
- Don Baccus donb@pacifier.com
- Created:
- 2008-12-04
- Testcases:
- No testcase defined.
install::xml::action::location (public)
install::xml::action::location node
Creates a URL location object.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::mount (public)
install::xml::action::mount node
Mounts a package on a specified node.
<mount package="package-key instance-name="name" mount-point="url" />
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::mount-existing (public)
install::xml::action::mount-existing node
Mounts an existing package on a specified node.
<mount-existing package-id="package-id mount-point="url" />
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::register-parameter (public)
install::xml::action::register-parameter node
Registers a package parameter.
<register-parameter name="parameter" description="description" package-key="package-key" scope="instance or global" default-value="default-value" datatype="datatype" [ [ [ section="section" ] min-n-values="min-n-values" ] max-n-values="max-n-values" ] [ callback="callback" ] [ parameter-id="parameter-id" ]
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::relation-add (public)
install::xml::action::relation-add node
Create a relation.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::relation-type (public)
install::xml::action::relation-type node
Create a relation type.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::rename-instance (public)
install::xml::action::rename-instance node
Change the instance name of an existing package (such as the main subsite). Either the url (if it's mounted) or package_id of the package may be given.
<rename-instance package-id="package-id" url="url" instance-name="new instance name" />
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::set-id (public)
install::xml::action::set-id node
set a name/id pair for use in other install xml things
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::set-join-policy (public)
install::xml::action::set-join-policy node
Set the join policy of a group.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::set-parameter (public)
install::xml::action::set-parameter node
Sets a package parameter.
<set-parameter name="parameter" [ package="package-key | url="package-url" ] type="[id|literal]" value="value" />
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::set-parameter-default (public)
install::xml::action::set-parameter-default node
Sets a package parameter default value
<set-parameter-default name="parameter" package-key="package-key" value="val">
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::set-permission (public)
install::xml::action::set-permission node
Sets permissions on an object.
<set-permissions grantee="party" privilege="package-key />
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::set-theme (public)
install::xml::action::set-theme node
Sets a theme for a subsite. If no subsite is specified it defaults to the main subsite "/". Valid themes are e.g. "openacs_bootstrap5", "openacs_bootstrap3", "default_plain", or default "tabbed".
<set-theme theme="theme" [ package="subsite ]
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::source (private)
install::xml::action::source node
Source an install.xml file, SQL file or Tcl script during execution of the current install.xml. If no type attribute is specified then this tag will attempt to guess type of the sourced script from the file extension, otherwise it defaults to install.xml. The type of the sourced script may be explicitly declared as 'tcl', 'sql' or 'install.xml' using the type attribute.
- Parameters:
- node (required)
- Author:
- Lee Denison lee@xarg.co.uk
- Created:
- 2005-02-04
- Testcases:
- No testcase defined.
install::xml::action::text (public)
install::xml::action::text node
A documentation element which ignores its contents and does no processing.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::unset-permission (public)
install::xml::action::unset-permission node
Revokes a permissions on an object - has no effect if the permission is not granted directly (i.e. does not act as negative permissions).
<unset-permissions grantee="party" privilege="package-key />
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::action::wizard (public)
install::xml::action::wizard node
Creates a wizard using the subtags for each step.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::object_id::admin-group (public)
install::xml::object_id::admin-group node
- Parameters:
- node (required)
- Returns:
- an object_id for an admin group of a given package.
- Testcases:
- No testcase defined.
install::xml::object_id::application-group (public)
install::xml::object_id::application-group node
Returns an object_id for an application group or relational segment of a given package. The node name is ignored so any node which provides the correct attributes may be used.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::object_id::group (public)
install::xml::object_id::group node
Returns an object_id for a group or relational segment. The node name is ignored so any node which provides the correct attributes may be used.
<group id="group_id" [ type="group type" relation="relation-type" ] />
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::object_id::member-group (public)
install::xml::object_id::member-group node
- Parameters:
- node (required)
- Returns:
- an object_id for a member group of a given package.
- Testcases:
- No testcase defined.
install::xml::object_id::object (public)
install::xml::object_id::object node
Returns a literal object_id for an object. use <object id="-100"> to return the literal id -100.
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::object_id::package (public)
install::xml::object_id::package node
Returns an object_id for a package specified in node. The node name is ignored so any node which provides the correct attributes may be used.
<package [ id="id" | key="package-key" | url="package-url" ] />
- Parameters:
- node (required)
- Testcases:
- No testcase defined.
install::xml::util::get_id (public)
install::xml::util::get_id id
Returns an id from the global ids variable if it exists and attempts to find an acs_magic_object if not.
- Parameters:
- id (required)
- Testcases:
- No testcase defined.
