Perl lib/EPrints/ - Revision history

Drn@ecs.soton.ac.uk: Added link to system settings page

2023-04-10T10:04:35Z

Added link to system settings page

Drn@ecs.soton.ac.uk at 01:54, 11 January 2022

2022-01-11T01:54:19Z

Drn@ecs.soton.ac.uk at 01:53, 11 January 2022

2022-01-11T01:53:32Z

Drn@ecs.soton.ac.uk: Fixed missing links

2022-01-10T18:59:36Z

Fixed missing links

Moj at 12:17, 15 January 2007

2007-01-15T12:17:40Z

WikiSysop: EPrints Directory Structure/eprints3/perl lib/EPrints moved to Perl lib/EPrints/

2007-01-05T14:37:43Z

EPrints Directory Structure/eprints3/perl lib/EPrints moved to Perl lib/EPrints/

WikiSysop at 15:02, 4 January 2007

2007-01-04T15:02:21Z

WikiSysop at 16:57, 3 January 2007

2007-01-03T16:57:25Z

WikiSysop at 16:56, 3 January 2007

2007-01-03T16:56:28Z

WikiSysop at 16:55, 3 January 2007

2007-01-03T16:55:46Z

@@ Line 56: / Line 56: @@
 ** '''Session.pm''' - A link between a web request (or command line script), a language, a database connection and a repository.
 ** '''StyleGuide.pm''' - Notes on how to write EPrints code.
-** '''SystemSettings.pm''' - Created by the installation. Contains information on your apache version, where commands are to be found and where EPrints is installed.
+** '''[[perl_lib/EPrints/SystemSettings.pm|SystemSettings.pm]]''' - Created by the installation. Contains information on your apache version, where commands are to be found and where EPrints is installed.
 ** '''TempDir.pm''' - Creates and removes tmp directories.
 ** '''Time.pm''' - Functions related to time and date processing.

@@ Line 34: / Line 34: @@
 ** '''List.pm''' - A search result, or other list of [[Data Object]]s within a single [[Category:Data Objects#Dataset|Dataset]]
 ** '''[[EPrints_Directory_Structure/eprints3/perl_lib/EPrints/MetaField|MetaField/]]''' - Contains classes representing each type of metadata field.
-** '''MetaField.pm''' - Base class for field objects. An instance of a metafield represents a single field in a [[Category:Data Object#Dataset|Dataset]], not a field + a value.
+** '''MetaField.pm''' - Base class for field objects. An instance of a metafield represents a single field in a [[Category:Data Objects#Dataset|Dataset]], not a field + a value.
 ** '''OpenArchives.pm''' - Handles OAI stuff.
 ** '''Paginate/'''

@@ Line 32: / Line 32: @@
 ** '''Language.pm''' - Provides access to phrases.
 ** '''Latex.pm''' - Latex rendering tools for functions and equations.
-** '''List.pm''' - A search result, or other list of [[Data Object]]s within a single [[Category:Data Object#Dataset|Dataset]]
+** '''List.pm''' - A search result, or other list of [[Data Object]]s within a single [[Category:Data Objects#Dataset|Dataset]]
 ** '''[[EPrints_Directory_Structure/eprints3/perl_lib/EPrints/MetaField|MetaField/]]''' - Contains classes representing each type of metadata field.
 ** '''MetaField.pm''' - Base class for field objects. An instance of a metafield represents a single field in a [[Category:Data Object#Dataset|Dataset]], not a field + a value.

@@ Line 15: / Line 15: @@
 ** '''BackCompatibility.pm''' - defines EPrints 2.3 function calls which call their 3.0 equivalents.
 ** '''Config.pm''' - Handles the configuration of the EPrints system itself
-** '''DataObj/''' - all classes in this dir are a subclass of EPrints::DataObj
+** '''DataObj/''' - all classes in this dir are a subclass of [[API:EPrints/DataObj|EPrints::DataObj]]
 *** '''Access.pm''' - [[Access Object]]
 *** '''Document.pm''' - [[Document Object]]
@@ Line 26: / Line 26: @@
 ** '''DataObj.pm''' - Base class for [[Data Object]]s
 ** '''DataSet.pm''' - Has one instance per repository for each type of [[Data Object]]
-** '''Database.pm''' - Object connecting the [[Session]] to the database. Provides most database calls.
+** '''Database.pm''' - Object connecting the repository to the database. Provides most database calls.
 ** '''Email.pm''' - Handles sending email messages.
 ** '''Extras.pm''' - Handy functions. Nearly obselete.
@@ Line 32: / Line 32: @@
 ** '''Language.pm''' - Provides access to phrases.
 ** '''Latex.pm''' - Latex rendering tools for functions and equations.
-** '''List.pm''' - A search result, or other list of [[Data Object]]s within a single [[Dataset]]
+** '''List.pm''' - A search result, or other list of [[Data Object]]s within a single [[Category:Data Object#Dataset|Dataset]]
-** '''[[EPrints_Directory_Structure/eprints3/perl_lib/EPrints/MetaField|MetaField/]]''' - Contains classes representing each type of metadatat field.
+** '''[[EPrints_Directory_Structure/eprints3/perl_lib/EPrints/MetaField|MetaField/]]''' - Contains classes representing each type of metadata field.
-** '''MetaField.pm''' - Base class for field objects. An instance of a metafield represents a single field in a [[Dataset]], not a field + a value.
+** '''MetaField.pm''' - Base class for field objects. An instance of a metafield represents a single field in a [[Category:Data Object#Dataset|Dataset]], not a field + a value.
 ** '''OpenArchives.pm''' - Handles OAI stuff.
 ** '''Paginate/'''

← Older revision		Revision as of 12:17, 15 January 2007
Line 1:		Line 1:
		+	{{dirs}}
	{{noeditdir}}		{{noeditdir}}

← Older revision	Revision as of 14:37, 5 January 2007
(No difference)

@@ Line 5: / Line 5: @@
 *'''[[EPrints_Directory_Structure/eprints3|eprints3]]/[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]/EPrints'''
 ** '''Apache/'''
-*** '''AnApache.pm''' -
+*** '''AnApache.pm''' - Abstracts differences between apache and mod_perl versions.
-*** '''Auth.pm''' -
+*** '''Auth.pm''' - Handles authentication
-*** '''LogHandler.pm''' -
+*** '''LogHandler.pm''' - Logs accesses as [[Access Object]]s
-*** '''Login.pm''' -
+*** '''Login.pm''' - Handles the login screen
-*** '''Rewrite.pm''' -
+*** '''Rewrite.pm''' - Redirects and rewrites URLs in requests, as appropriate
-*** '''Template.pm''' -
+*** '''Template.pm''' - Handles applying the template to pages
-*** '''VLit.pm''' -
+*** '''VLit.pm''' - Handles the [[vlit]] feature.
-** '''BackCompatibility.pm''' -
+** '''BackCompatibility.pm''' - defines EPrints 2.3 function calls which call their 3.0 equivalents.
-** '''Config.pm''' -
+** '''Config.pm''' - Handles the configuration of the EPrints system itself
-** '''DataObj/'''
+** '''DataObj/''' - all classes in this dir are a subclass of EPrints::DataObj
-*** '''Access.pm''' -
+*** '''Access.pm''' - [[Access Object]]
-*** '''Document.pm''' -
+*** '''Document.pm''' - [[Document Object]]
-*** '''EPrint.pm''' -
+*** '''EPrint.pm''' - [[EPrint Object]]
-*** '''History.pm''' -
+*** '''History.pm''' - [[History Object]]
-*** '''Request.pm''' -
+*** '''Request.pm''' - [[Request Object]]
-*** '''SavedSearch.pm''' -
+*** '''SavedSearch.pm''' - [[Saved Search Object]]
-*** '''Subject.pm''' -
+*** '''Subject.pm''' - [[Subject Object]]
-*** '''User.pm''' -
+*** '''User.pm''' - [[User Object]]
-** '''DataObj.pm''' -
+** '''DataObj.pm''' - Base class for [[Data Object]]s
-** '''DataSet.pm''' -
+** '''DataSet.pm''' - Has one instance per repository for each type of [[Data Object]]
-** '''Database.pm''' -
+** '''Database.pm''' - Object connecting the [[Session]] to the database. Provides most database calls.
-** '''Email.pm''' -
+** '''Email.pm''' - Handles sending email messages.
-** '''Extras.pm''' -
+** '''Extras.pm''' - Handy functions. Nearly obselete.
-** '''Index.pm''' -
+** '''Index.pm''' - Handles text indexing and the indexer.
-** '''Language.pm''' -
+** '''Language.pm''' - Provides access to phrases.
-** '''Latex.pm''' -
+** '''Latex.pm''' - Latex rendering tools for functions and equations.
-** '''List.pm''' -
+** '''List.pm''' - A search result, or other list of [[Data Object]]s within a single [[Dataset]]
-** '''[[EPrints_Directory_Structure/eprints3/perl_lib/EPrints/MetaField|MetaField/]]''' -
+** '''[[EPrints_Directory_Structure/eprints3/perl_lib/EPrints/MetaField|MetaField/]]''' - Contains classes representing each type of metadatat field.
-** '''MetaField.pm''' -
+** '''MetaField.pm''' - Base class for field objects. An instance of a metafield represents a single field in a [[Dataset]], not a field + a value.
-** '''OpenArchives.pm''' -
+** '''OpenArchives.pm''' - Handles OAI stuff.
 ** '''Paginate/'''
-*** '''Columns.pm''' -
+*** '''Columns.pm''' - Subclass of EPrints::Paginate which renders the results as a spread sheet style list, and allows sorting by clicking titles.
-** '''Paginate.pm''' -
+** '''Paginate.pm''' - Paginate search results (eg. 20 items per page) in HTML
-** '''Paracite.pm''' -
+** '''Paracite.pm''' - Paracite interface
 ** '''Platform/'''
-*** '''Unix.pm''' -
+*** '''Unix.pm''' - UNIX specific functions
-** '''Platform.pm''' -
+** '''Platform.pm''' - Allows abstraction of methods which are operating system specific.
-** '''[[EPrints_Directory_Structure/eprints3/perl_lib/EPrints/Plugin|Plugin/]]''' -
+** '''[[EPrints_Directory_Structure/eprints3/perl_lib/EPrints/Plugin|Plugin/]]''' - The plugins directory.
-** '''Plugin.pm''' -
+** '''Plugin.pm''' - The base class (and loader) for all plugins.
-** '''Probity.pm''' -
+** '''Probity.pm''' - Handles producing checksum files for documents.
-** '''Profiler.pm''' -
+** '''Profiler.pm''' - ?
-** '''Repository.pm''' -
+** '''Repository.pm''' - An instance of this represents a single repository and has access to the configuration of that repository.
-** '''ScreenProcessor.pm''' -
+** '''ScreenProcessor.pm''' - Handles the Screen plugin interface
-** '''Script.pm''' -
+** '''Script.pm''' - Processes expressions in the mini-scripting language used in citation and workflows.
 ** '''Search/'''
-*** '''Condition.pm''' -
+*** '''Condition.pm''' - Represents a single search condition (used internally)
-*** '''Field.pm''' -
+*** '''Field.pm''' - Represents a single search field (a row in the search interface). Has a value and a list of metadata fields to search.
-** '''Search.pm''' -
+** '''Search.pm''' - Represents a single search. Returns a List object when executed.
-** '''Session.pm''' -
+** '''Session.pm''' - A link between a web request (or command line script), a language, a database connection and a repository.
-** '''StyleGuide.pm''' -
+** '''StyleGuide.pm''' - Notes on how to write EPrints code.
-** '''SystemSettings.pm''' -
+** '''SystemSettings.pm''' - Created by the installation. Contains information on your apache version, where commands are to be found and where EPrints is installed.
-** '''TempDir.pm''' -
+** '''TempDir.pm''' - Creates and removes tmp directories.
-** '''Time.pm''' -
+** '''Time.pm''' - Functions related to time and date processing.
-** '''Utils.pm''' -
+** '''Utils.pm''' - Misc. functions.
 ** '''Workflow/'''
 *** '''Processor.pm''' -
@@ Line 64: / Line 64: @@
 ** '''Workflow.pm''' -
 ** '''XML/'''
 *** '''DOM.pm''' -
-*** '''EPC.pm''' -
+*** '''EPC.pm''' - Code to handle processing the epc namespace: eg. &lt;epc:if&gt;
 *** '''GDOME.pm''' -
 *** '''LibXML.pm''' -
-** '''XML.pm''' -
+** '''XML.pm''' - Abstraction to handle diferent XML libraries. (DOM, GDOME, LibXML)