Extension Packages - Revision history

Ajm: Typo correction - reposityory -> repository

2023-11-08T15:27:11Z

Typo correction - reposityory -> repository

← Older revision		Revision as of 15:27, 8 November 2023
Line 27:		Line 27:
	And access it in your code like:		And access it in your code like:

	$option_1 = $plugin->{~~reposityory~~}->conf( "extension", "my_cool_extension", "option_1" )		$option_1 = $plugin->{repository}->conf( "extension", "my_cool_extension", "option_1" )

	etc.		etc.
Line 37:		Line 37:
	and then		and then

	$option_1 = $plugin->{~~reposityory~~}->conf( "PreviewPlus_alignment" );		$option_1 = $plugin->{repository}->conf( "PreviewPlus_alignment" );

Pm705 at 10:20, 11 February 2010

2010-02-11T10:20:17Z

← Older revision		Revision as of 10:20, 11 February 2010
Line 1:		Line 1:
	[[Category:Contribute]]		[[Category:Contribute]]
	[[Category:Plugins]]		[[Category:Plugins]]
	An extension package is a .tgz file containing multiple files which adds a suite of functionality when unpacked in the /opt/eprint3 directory.		An extension package is a .tgz file containing multiple files which adds a suite of functionality when unpacked in the /opt/eprint3/archives/ARCHIVE_ID/ directory.

	An extension can be as simple as a plugin plus a css file or add a whole exciting suite of new features.		An extension can be as simple as a plugin plus a css file or add a whole exciting suite of new features.
Line 7:		Line 7:
	Things you might want to put into an eprints extension package:		Things you might want to put into an eprints extension package:

	* Plugins: ~~perl_lib~~/EPrints/Plugin/...		* Plugins: archives/ARCHIVE_ID/cfg/plugins/EPrints/Plugin/...
	* Themes: lib/themes/...		* Themes: lib/themes/...
	* scripts: bin/...		* scripts: archives/ARCHIVE_ID/bin/...
	* CGI scripts: cgi/...		* CGI scripts: archives/ARCHIVE_ID/cgi/...
	* autocompletion scripts: cgi/users/lookup/...		* autocompletion scripts: archives/ARCHIVE_ID/cgi/users/lookup/...
	* phrase files for use by plugins or scripts: ~~lib~~/lang/.../phrases/...		* phrase files for use by plugins or scripts: archives/ARCHIVE_ID/cfg/lang/.../phrases/...
	* images, icons, javascript and css files to support your plugins or scripts: ~~lib~~/static/...		* images, icons, javascript and css files to support your plugins or scripts: archives/ARCHIVE_ID/cfg/static/...

	Other things you might want to include are...		Other things you might want to include are...
Line 19:		Line 19:
	* repository specific phrase files		* repository specific phrase files
	* autocompletion data files		* autocompletion data files
	~~...but these can't be installed directly as they must go in the repository specific directory: archives/ARCHIVEID/cfg/~~
	~~If you have more than 2 files to go in the archive cfg dir you may consider including a second .tgz file to unpack in archives/ARCHIVEID/cfg/~~

	The handy thing is that plugins are autoloaded, .xml files in the phrases directory are autoloaded and .pl files in the archive cfg.d are autoloaded. So if you want to give your plugin some config options, you could just give a .pl file to copy into the cfg.d/ dir looking something like.		The handy thing is that plugins are autoloaded, .xml files in the phrases directory are autoloaded and .pl files in the archive cfg.d are autoloaded. So if you want to give your plugin some config options, you could just give a .pl file to copy into the cfg.d/ dir looking something like.
Line 29:		Line 27:
	And access it in your code like:		And access it in your code like:

	$option_1 = $plugin->{~~session~~}->~~get_repository->get_conf~~( "extension", "my_cool_extension", "option_1" )		$option_1 = $plugin->{reposityory}->conf( "extension", "my_cool_extension", "option_1" )

	etc.		etc.

	You could use a shorter path in the $c datastructure, but try and make sure it's distinct to your extension so clashes don't happen.		You could use a shorter path in the $c datastructure, but try and make sure it's distinct to your extension so clashes don't happen.

			$c->{PreviewPlus_alignment} = "vertical";

			and then

			$option_1 = $plugin->{reposityory}->conf( "PreviewPlus_alignment" );

Pm705 at 14:22, 8 February 2010

2010-02-08T14:22:25Z

New page

[[Category:Contribute]]
[[Category:Plugins]]
An extension package is a .tgz file containing multiple files which adds a suite of functionality when unpacked in the /opt/eprint3 directory.

An extension can be as simple as a plugin plus a css file or add a whole exciting suite of new features.

Things you might want to put into an eprints extension package:

* Plugins: perl_lib/EPrints/Plugin/...
* Themes: lib/themes/...
* scripts: bin/...
* CGI scripts: cgi/...
* autocompletion scripts: cgi/users/lookup/...
* phrase files for use by plugins or scripts: lib/lang/.../phrases/...
* images, icons, javascript and css files to support your plugins or scripts: lib/static/...

Other things you might want to include are...
* configuration files
* repository specific phrase files
* autocompletion data files
...but these can't be installed directly as they must go in the repository specific directory: archives/ARCHIVEID/cfg/
If you have more than 2 files to go in the archive cfg dir you may consider including a second .tgz file to unpack in archives/ARCHIVEID/cfg/

The handy thing is that plugins are autoloaded, .xml files in the phrases directory are autoloaded and .pl files in the archive cfg.d are autoloaded. So if you want to give your plugin some config options, you could just give a .pl file to copy into the cfg.d/ dir looking something like.

$c->{extension}->{my_cool_extension}->{option_1} = 1;
$c->{extension}->{my_cool_extension}->{keep_alive} = "always";

And access it in your code like:

$option_1 = $plugin->{session}->get_repository->get_conf( "extension", "my_cool_extension", "option_1" )

etc.

You could use a shorter path in the $c datastructure, but try and make sure it's distinct to your extension so clashes don't happen.

WikiSysop: Reverted edit of WidQlg, changed back to last version by Tom

2007-08-22T09:05:41Z

Reverted edit of WidQlg, changed back to last version by Tom

New page

An extension package is a .tgz file containing multiple files which adds a suite of functionality when unpacked in the /opt/eprint3 directory.

An extension can be as simple as a plugin plus a css file or add a whole exciting suite of new features.

Things you might want to put into an eprints extension package:

* Plugins: perl_lib/EPrints/Plugin/...
* Themes: lib/themes/...
* scripts: bin/...
* CGI scripts: cgi/...
* autocompletion scripts: cgi/users/lookup/...
* phrase files for use by plugins or scripts: lib/lang/.../phrases/...
* images, icons, javascript and css files to support your plugins or scripts: lib/static/...

Other things you might want to include are...
* configuration files
* repository specific phrase files
* autocompletion data files
...but these can't be installed directly as they must go in the repository specific directory: archives/ARCHIVEID/cfg/
If you have more than 2 files to go in the archive cfg dir you may consider including a second .tgz file to unpack in archives/ARCHIVEID/cfg/

The handy thing is that plugins are autoloaded, .xml files in the phrases directory are autoloaded and .pl files in the archive cfg.d are autoloaded. So if you want to give your plugin some config options, you could just give a .pl file to copy into the cfg.d/ dir looking something like.

$c->{extension}->{my_cool_extension}->{option_1} = 1;
$c->{extension}->{my_cool_extension}->{keep_alive} = "always";

etc.

You could use a shorter path in the $c datastructure, but try and make sure it's distinct to your extension so clashes don't happen.

Tom: Removing spam.

2007-08-20T08:38:42Z

Removing spam.

New page

WikiSysop at 15:16, 8 February 2007

2007-02-08T15:16:37Z

New page