Writing plugins

David.ehnebuske — Thu, 17 May 2012 20:35:59 GMT

Adding a Configuration Page -

←Older revision		Revision as of 20:35, 17 May 2012
(One intermediate revision not shown.)
Line 52:		Line 52:

	Plugins need not be complex. A really simple plugin might consist of just two files and one subfolder: the <nowiki>[plugin_name].yaml</nowiki> file in the root and a hook folder containing one hook file. In fact, a useful plugin need not contain program logic at all. For example, by including a style.css stylesheet in the 'css' folder and graphics in 'gfx' a 'colour theme' plugin can be created that changes the "look" of the whole system.		Plugins need not be complex. A really simple plugin might consist of just two files and one subfolder: the <nowiki>[plugin_name].yaml</nowiki> file in the root and a hook folder containing one hook file. In fact, a useful plugin need not contain program logic at all. For example, by including a style.css stylesheet in the 'css' folder and graphics in 'gfx' a 'colour theme' plugin can be created that changes the "look" of the whole system.
-
-	== Packaging Your Plugin ==
-
-	While it is still possible to manually install a plugin on your server (see [[Writing_plugins#Before_the_Plugin_Manager\|Before the Plugin Manager]], below), the preferred method is to package all of the needed files into a ResourceSpace Plugin (.rsp) file and to use the Plugin Manager.
-
-	To create a ResourceSpace Plugin file simply tar and gzip your plugin (.tar.gz) then rename it to "[plugin name].rsp".
-
-	Once you have done this you can upload, install, and activate it using the [[Managing Plugins\|Team Centre > Manage Plugins]] page.
-
-	The .rsp packaging is also the preferred way to distribute plugins to other ResourceSpace users. You may also wish to consider contributing your plugin to the community at large by placing it in the [http://www.resourcespace.org/plugins/ ResourceSpace Plugin Repository].

	== Hooks and Hook Functions ==		== Hooks and Hook Functions ==
Line 124:		Line 114:

	== Adding a Configuration Page ==		== Adding a Configuration Page ==
-	If a plugin needs ~~top~~ be configured there are two ways to enable it: You can have people edit the contents of the the plugin's config.php file or you can provide a plugin configuration page and have an administrator do it through a UI. Editing the config.php is straightforward and requires no code, but it does require skill and access to the config.php file on the server. Using a configuration page requires access to the Team Centre, but no coding skill or access to the config.php file. It does require the plugin developer to write some code, but usually not much.	+	If a plugin needs to be configured there are two ways to enable it: You can have people edit the contents of the the plugin's config.php file or you can provide a plugin configuration page and have an administrator do it through a UI. Editing the config.php is straightforward and requires no code, but it does require skill and access to the config.php file on the server. Using a configuration page requires access to the Team Centre, but no coding skill or access to the config.php file. It does require the plugin developer to write some code, but usually not much.

	As a plugin writer you can do whatever is needed with the configuration page, but doing configuration management from scratch each time leads to a lot of unnecessary work and, potentially, to gratuitous inconsistencies in how plugin configuration works. To help with this, ResourceSpace provides a set of functions for building plugin configuration pages, an annotated sample plugin you can try out and a plugin page template you can use as a starting point for your own configuration pages.		As a plugin writer you can do whatever is needed with the configuration page, but doing configuration management from scratch each time leads to a lot of unnecessary work and, potentially, to gratuitous inconsistencies in how plugin configuration works. To help with this, ResourceSpace provides a set of functions for building plugin configuration pages, an annotated sample plugin you can try out and a plugin page template you can use as a starting point for your own configuration pages.
Line 178:		Line 168:

	If your system uses multiple languages, you would add similar language files for the the additional languages.		If your system uses multiple languages, you would add similar language files for the the additional languages.
		+
		+	== Packaging Your Plugin ==
		+
		+	While it is still possible to manually install a plugin on your server (see [[Writing_plugins#Before_the_Plugin_Manager\|Before the Plugin Manager]], below), the preferred method is to package all of the needed files into a ResourceSpace Plugin (.rsp) file and to use the Plugin Manager.
		+
		+	To create a ResourceSpace Plugin file simply tar and gzip your plugin (.tar.gz) then rename it to "[plugin name].rsp".
		+
		+	Once you have done this you can upload, install, and activate it using the [[Managing Plugins\|Team Centre > Manage Plugins]] page.
		+
		+	The .rsp packaging is also the preferred way to distribute plugins to other ResourceSpace users. You may also wish to consider contributing your plugin to the community at large by placing it in the [http://www.resourcespace.org/plugins/ ResourceSpace Plugin Repository].

	== Before the Plugin Manager ==		== Before the Plugin Manager ==

Archiving

Paul.a.norman — Sat, 12 May 2012 05:09:14 GMT

details of directly searching the archive

←Older revision		Revision as of 05:09, 12 May 2012
Line 16:		Line 16:

	New resources can be created directly in the archive state using the 'New Archive Resource' link in 'Manage Archive Resources'.		New resources can be created directly in the archive state using the 'New Archive Resource' link in 'Manage Archive Resources'.
		+
		+
		+	== Directly Searching the Archive ==
		+
		+	Logged in as Super Admin, (normal) Administrator, or Archivist, under...
		+
		+	Team Centre/ Manage Archive Resources / Search Archived Resources
		+
		+	And clear all fields to search for all, or use the search form to limit search.
		+
		+	If you clear all fields, click into another field box, then the search button at the bottom will adjust.

Subversion

Theorysavage — Fri, 11 May 2012 19:58:27 GMT

←Older revision		Revision as of 19:58, 11 May 2012
Line 12:		Line 12:
	Visit http://svn.montala.net for an online repository browser (useful for keeping track of changes).		Visit http://svn.montala.net for an online repository browser (useful for keeping track of changes).

-	'''Important installation notes: ''' You will ~~need to copy config.default.php to config.php in the include folder, and create a 'filestore' folder in the ResourceSpace root. You will also~~ need to follow the normal installation instructions, i.e. alter php.ini settings and set up folder permissions.	+	'''Important installation notes: ''' You will need to follow the normal installation instructions, i.e. alter php.ini settings and set up folder permissions.

	Visit check.php to make sure your installation is correctly configured.		Visit check.php to make sure your installation is correctly configured.

ResourceSpace Documentation Wiki - Recent changes [en]

Writing plugins

Archiving

Subversion