API:EPrints/CLIProcessor - Revision history

Pod2wiki at 12:16, 4 March 2022

2022-03-04T12:16:13Z

Pod2wiki at 10:10, 20 December 2021

2021-12-20T10:10:21Z

Pod2wiki at 10:08, 20 December 2021

2021-12-20T10:08:12Z

Kgoetz: adding Category:Rubbish

2018-10-03T00:25:31Z

adding Category:Rubbish

Tdb01r: Removing all content from page

2009-08-12T15:40:14Z

Removing all content from page

@@ Line 6: / Line 6: @@
 <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 ==NAME==
-'''EPrints::CLIProcessor''' - utility module supporting command-line scripts
+'''EPrints::CLIProcessor''' - utility module supporting command-line  scripts.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 17: / Line 17: @@
 <!-- Pod2Wiki=head_description -->
 ==DESCRIPTION==
-Currently this module is just a 'handler' for import scripts. In future it may do more things to support the CLI (Command-Line Interface) to EPrints.
+Currently this module is just a 'handler' for import scripts. In  future it may do more things to support the CLI (Command-Line  Interface) to EPrints.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 39: / Line 39: @@
   EPrints::CLIProcessor::color( $type )
-Returns boolean depending on whether $type is a permitted setting for  the '''EPrints::CLIProcessor'''.
+Returns boolean depending on whether $type is a permitted setting for  the [[API:EPrints/CLIProcessor|EPrints/CLIProcessor]].
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 69: / Line 69: @@
   $processor-&gt;add_message( $type, $msg )
-Add a message for the user. $type is 'error', 'warning' or 'message'. $msg is an XHTML fragment.
+Add a message for the user. <tt>$type</tt> is <tt>error</tt>, <tt>warning</tt> or  <tt>message</tt>. <tt>$msg</tt> is an XHTML fragment.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 82: / Line 82: @@
   $dataobj = $processor-&gt;epdata_to_dataobj( $epdata, %opts )
-Requests the handler create the new object from $epdata.
+Requests the handler create the new object from <tt>$epdata</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 95: / Line 95: @@
   $processor-&gt;parsed( [ $epdata ] )
-Register a parsed event, optionally with $epdata.
+Register a parsed event, optionally with <tt>$epdata</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 108: / Line 108: @@
   $processor-&gt;object( $dataset, $dataobj )
-Register a new object event in $dataset with new object $dataobj.
+Register a new object event in <tt>$dataset</tt> with new object  <tt>$dataobj</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 107: / Line 107: @@
 ===object===
-  $processor-&gt;object( DATASET, DATAOBJ )
+  $processor-&gt;object( $dataset, $dataobj )
-Register a new object event in DATASET with new object DATAOBJ.
+Register a new object event in $dataset with new object $dataobj.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

← Older revision		Revision as of 10:08, 20 December 2021
Line 1:		Line 1:
−	[[Category: ~~Rubbish~~]]	+	<!-- Pod2Wiki=_preamble_
		+	This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
		+	-->{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/CLIProcessor.pm\|package_name=EPrints::CLIProcessor}}[[Category:API\|CLIPROCESSOR]]<div><!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
		+	==NAME==
		+	'''EPrints::CLIProcessor''' - utility module supporting command-line scripts
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=head_description -->
		+	==DESCRIPTION==
		+	Currently this module is just a 'handler' for import scripts. In future it may do more things to support the CLI (Command-Line Interface) to EPrints.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=head_methods -->
		+	==METHODS==
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=item_color -->
		+	===color===
		+
		+	EPrints::CLIProcessor::color( $type )
		+	Returns boolean depending on whether $type is a permitted setting for the '''EPrints::CLIProcessor'''.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=item_new -->
		+	===new===
		+
		+	$processor = EPrints::CLIProcessor->new( session => $session, %opts )
		+	Create a new processor object. Supported options:
		+
		+	scripted - backwards compatibility for import scripted interface
		+	epdata_to_dataobj - replace [[API:EPrints/CLIProcessor#epdata_to_dataobj\|epdata_to_dataobj]]
		+	message - replace [[API:EPrints/CLIProcessor#message\|message]]
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=item_add_message -->
		+	===add_message===
		+
		+	$processor->add_message( $type, $msg )
		+	Add a message for the user. $type is 'error', 'warning' or 'message'. $msg is an XHTML fragment.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=item_epdata_to_dataobj -->
		+	===epdata_to_dataobj===
		+
		+	$dataobj = $processor->epdata_to_dataobj( $epdata, %opts )
		+	Requests the handler create the new object from $epdata.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=item_parsed -->
		+	===parsed===
		+
		+	$processor->parsed( [ $epdata ] )
		+	Register a parsed event, optionally with $epdata.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=item_object -->
		+	===object===
		+
		+	$processor->object( DATASET, DATAOBJ )
		+	Register a new object event in DATASET with new object DATAOBJ.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=head_copyright -->
		+	==COPYRIGHT==
		+	{{API:Copyright}}
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

← Older revision	Revision as of 00:25, 3 October 2018
Line 1:	Line 1:
−	+	[[Category: Rubbish]]

← Older revision		Revision as of 15:40, 12 August 2009
Line 1:		Line 1:
−	~~<!-- Pod2Wiki=_preamble_~~
−	~~This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.~~
−	~~-->{{Pod2Wiki}}{{API:Source\|file=EPrints/CLIProcessor.pm\|package_name=EPrints::CLIProcessor}}[[Category:API\|CLIProcessor]]<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_name -->=NAME=~~
−	~~EPrints::CLIProcessor - utility module supporting command-line scripts~~

−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_description -->=DESCRIPTION=~~
−	~~Currently this module is just a 'handler' for import scripts. In future it may do more things to support the CLI (Command-Line Interface) to EPrints.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_methods -->=METHODS=~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_new -->==new==~~
−
−	~~$processor = EPrints::CLIProcessor->new( session => $session, %opts )~~
−
−	~~Create a new processor object. Supported options:~~
−
−	~~scripted - backwards compatibility for import scripted interface~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_add_message -->==add_message==~~
−
−	~~$processor->add_message( TYPE, MESSAGE )~~
−
−	~~Add a message for the user. TYPE is 'error', 'warning' or 'message'. MESSAGE is an XHTML fragment.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_parsed -->==parsed==~~
−
−	~~$processor->parsed( [ $epdata ] )~~
−
−	~~Register a parsed event, optionally with $epdata.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_object -->==object==~~
−
−	~~$processor->object( DATASET, DATAOBJ )~~
−
−	~~Register a new object event in DATASET with new object DATAOBJ.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=~~
−	~~{{API:Undocumented Methods}}<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_color -->==color==~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_message -->==message==~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->~~

API:EPrints/CLIProcessor - Revision history

Pod2wiki at 12:16, 4 March 2022

Pod2wiki at 10:10, 20 December 2021

Pod2wiki at 10:08, 20 December 2021

Kgoetz: adding Category:Rubbish

Tdb01r: Removing all content from page

Tdb01r: New page: