Contribute: Plugins/ExportPluginsHTML - Revision history

Pm705 at 13:49, 8 February 2010

2010-02-08T13:49:59Z

← Older revision		Revision as of 13:49, 8 February 2010
Line 1:		Line 1:
			[[Category:Contribute]]
			[[Category:Plugins]]
	= Export Plugin Tutorial 3: HTML =		= Export Plugin Tutorial 3: HTML =

Tom: /* xml_dataobj */

2007-09-28T18:59:03Z

xml_dataobj

← Older revision		Revision as of 18:59, 28 September 2007
Line 152:		Line 152:

	== xml_dataobj ==		== xml_dataobj ==
	This method has a similar signature to the output_dataobj method: it takes an implicit reference to the plugin object and a reference to a DataObj, however instead of returning a string it returns a DOM ~~object~~.		This method has a similar signature to the output_dataobj method: it takes an implicit reference to the plugin object and a reference to a DataObj, however instead of returning a string it returns a [http://en.wikipedia.org/wiki/Document_Object_Model DOM] tree.

	Before we can start creating and manipulating DOM objects we need to get a reference to the Session object from the plugin.		Before we can start creating and manipulating [http://en.wikipedia.org/wiki/Document_Object_Model DOM] objects we need to get a reference to the Session object from the plugin.

	<pre>		<pre>
Line 181:		Line 181:
	</pre>		</pre>

	Finally we return a DOM object representing a 'div' element containing our header and paragraph.		Finally we return a [http://en.wikipedia.org/wiki/Document_Object_Model DOM] object representing a 'div' element containing our header and paragraph.

	<pre>		<pre>

Tom: /* output_dataobj */

2007-09-28T18:57:47Z

output_dataobj

← Older revision		Revision as of 18:57, 28 September 2007
Line 125:		Line 125:

	== output_dataobj ==		== output_dataobj ==
	Here the output_dataobj method does very little. It calls the xml_dataobj method to obtain a DOM ~~object~~ which is converted to plain text before being returned. The xml_dataobj method is described later.		Here the output_dataobj method does very little. It calls the xml_dataobj method to obtain a [http://en.wikipedia.org/wiki/Document_Object_Model DOM] tree which is converted to plain text before being returned. The xml_dataobj method is described later.

	<pre>		<pre>

Tom: /* Constructor */

2007-09-28T18:55:44Z

Constructor

← Older revision		Revision as of 18:55, 28 September 2007
Line 117:		Line 117:
	= In More Detail =		= In More Detail =
	== Constructor ==		== Constructor ==
	Here we change the file extension to '.htm' and change the MIME type to "text/html". For general XML documents you should change the file extension to '.xml' and the MIME type to 'text/xml';		Here we change the file extension to '.htm' and change the [http://en.wikipedia.org/wiki/MIME MIME] type to "text/html". For general XML documents you should change the file extension to '.xml' and the [http://en.wikipedia.org/wiki/MIME MIME] type to 'text/xml';

	<pre>		<pre>

Tom: /* HTML.pm */

2007-09-28T13:46:47Z

HTML.pm

← Older revision		Revision as of 13:46, 28 September 2007
Line 4:		Line 4:

	= HTML.pm =		= HTML.pm =
	The code in the section below should be placed in a file called ~~HelloHTML~~.pm in the directory created previously, and MyPlugins should be changed to the name of that directory.		The code in the section below should be placed in a file called HTML.pm in the directory created previously, and MyPlugins should be changed to the name of that directory.

	<pre>		<pre>
Line 19:		Line 19:
	my $self = $class->SUPER::new(%opts);		my $self = $class->SUPER::new(%opts);

	$self->{name} = 'Hello, HTML!';		$self->{name} = 'Hello, HTML';
	$self->{accept} = [ 'dataobj/eprint', 'list/eprint' ];		$self->{accept} = [ 'dataobj/eprint', 'list/eprint' ];
	$self->{visible} = 'all';		$self->{visible} = 'all';

Tom: /* HelloHTML.pm */

2007-09-28T13:46:06Z

HelloHTML.pm

← Older revision		Revision as of 13:46, 28 September 2007
Line 3:		Line 3:
	In this tutorial we'll look at creating an export plugin with slightly more complex output than unformatted plain text. Although the plugin below produces XHTML the same principles apply to producing any XML document.		In this tutorial we'll look at creating an export plugin with slightly more complex output than unformatted plain text. Although the plugin below produces XHTML the same principles apply to producing any XML document.

	= HelloHTML.pm =		= HTML.pm =
			The code in the section below should be placed in a file called HelloHTML.pm in the directory created previously, and MyPlugins should be changed to the name of that directory.

	<pre>		<pre>
	package EPrints::Plugin::Export::MyPlugins::~~HelloHTML~~;		package EPrints::Plugin::Export::MyPlugins::HTML;

	@ISA = ('EPrints::Plugin::Export');		@ISA = ('EPrints::Plugin::Export');

Tom: /* Testing Your Plugin */

2007-09-28T10:25:21Z

Testing Your Plugin

← Older revision		Revision as of 10:25, 28 September 2007
Line 187:		Line 187:

	= Testing Your Plugin =		= Testing Your Plugin =
	Restart your webserver and test the plugin as in [[~~User~~:~~Tom~~/~~Export_Plugins/Hello_Lists~~\| ~~the previous tutorial~~]].		Restart your webserver and test the plugin as [[Contribute:_Plugins/ExportPluginsHello\| before]].

	== Sample Output ==		== Sample Output ==
	[[Image:Exphtml.png]]		[[Image:Exphtml.png]]

Tom: User:Tom/Export Plugins/HTML moved to Contribute: Plugins/ExportPluginsHTML

2007-09-27T20:55:43Z

User:Tom/Export Plugins/HTML moved to Contribute: Plugins/ExportPluginsHTML

← Older revision	Revision as of 20:55, 27 September 2007
(No difference)

Tom: /* HelloHTML.pm */

2007-09-27T14:46:21Z

HelloHTML.pm

← Older revision		Revision as of 14:46, 27 September 2007
Line 92:		Line 92:

	sub xml_dataobj		sub xml_dataobj
			{
	my ($plugin, $dataobj) = @_;		my ($plugin, $dataobj) = @_;

Tom: /* In More Detail */

2007-09-27T12:10:20Z

In More Detail

← Older revision		Revision as of 12:10, 27 September 2007
Line 115:		Line 115:
	= In More Detail =		= In More Detail =
	== Constructor ==		== Constructor ==
	Here we change the file extension to ".htm" and change the MIME type to "text/html". For general XML documents you should change the file extension to ".xml" and the MIME type to "text/xml";		Here we change the file extension to '.htm' and change the MIME type to "text/html". For general XML documents you should change the file extension to '.xml' and the MIME type to 'text/xml';

	<pre>		<pre>
	$self->{suffix} = ".htm";		$self->{suffix} = '.htm';
	$self->{mimetype} = "text/html; charset=utf-8";		$self->{mimetype} = 'text/html; charset=utf-8';
	</pre>		</pre>

Line 146:		Line 146:
	END		END

	my $footer = "</body></html>";		my $footer = '</body></html>';
	</pre>		</pre>

Line 158:		Line 158:
	</pre>		</pre>

	We then create elements using the make_element method of our session object. The first argument to the make_element method is the tag name of the element we want to create, for example "a" or "div". The second parameter is a hash of attributes and values associated with the element.		We then create elements using the make_element method of our session object. The first argument to the make_element method is the tag name of the element we want to create, for example 'a' or 'div'. The second parameter is a hash of attributes and values associated with the element.
	<pre>		<pre>
	my $div = $session->make_element("div");		my $div = $session->make_element('div');
	</pre>		</pre>

Line 166:		Line 166:

	<pre>		<pre>
	my $title = $session->make_element("h2");		my $title = $session->make_element('h2');
	$title->appendChild($session->make_text($dataobj->get_value("title")));		$title->appendChild($session->make_text($dataobj->get_value('title')));
	$div->appendChild($title);		$div->appendChild($title);
	</pre>		</pre>
Line 174:		Line 174:

	<pre>		<pre>
	my $abstract = $session->make_element("p");		my $abstract = $session->make_element('p');
	$abstract->appendChild($session->make_text($dataobj->get_value("abstract")));		$abstract->appendChild($session->make_text($dataobj->get_value('abstract')));
	$div->appendChild($abstract);		$div->appendChild($abstract);
	</pre>		</pre>

	Finally we return a DOM object representing a "div" element containing our header and paragraph.		Finally we return a DOM object representing a 'div' element containing our header and paragraph.

	<pre>		<pre>