Difference between revisions of "API"
| Line 1: | Line 1: | ||
| + | {{api}} | ||
| + | |||
| + | EPrints is written in Perl. Sometimes you may need to write your own perl code using the EPrints API. | ||
| + | |||
| + | Reasons to write some EPrints perl code: | ||
| + | * customising the way the eprints summary pages are rendered | ||
| + | * writing your own script to control EPrints in some way | ||
| + | * writing a new CGI script (dynamic web page) | ||
| + | * writing a plugin | ||
| + | |||
| + | We've broken the API down by subject, rather than by library or object. We hope this will make the reference more useful. | ||
| + | |||
* getting started | * getting started | ||
* DataObjects + metafields | * DataObjects + metafields | ||
| Line 5: | Line 17: | ||
* XML DOM, XHTML | * XML DOM, XHTML | ||
* misc(database, time, utils, platform) | * misc(database, time, utils, platform) | ||
| + | * metadata fields | ||
* Plugins | * Plugins | ||
** Screen (screen processor) | ** Screen (screen processor) | ||
| + | |||
| + | == More Information == | ||
| + | |||
| + | To get more detailed documentation on an eprints module, you can try using perldoc. Many (but not all) of the subroutines are documented inside the code. | ||
| + | |||
| + | eg. | ||
| + | perldoc /opt/eprints3/perl_lib/EPrints/MetaField.pm | ||
Revision as of 17:23, 11 January 2007
EPrints is written in Perl. Sometimes you may need to write your own perl code using the EPrints API.
Reasons to write some EPrints perl code:
- customising the way the eprints summary pages are rendered
- writing your own script to control EPrints in some way
- writing a new CGI script (dynamic web page)
- writing a plugin
We've broken the API down by subject, rather than by library or object. We hope this will make the reference more useful.
- getting started
- DataObjects + metafields
- session+repository+config(?)
- Search + List
- XML DOM, XHTML
- misc(database, time, utils, platform)
- metadata fields
- Plugins
- Screen (screen processor)
More Information
To get more detailed documentation on an eprints module, you can try using perldoc. Many (but not all) of the subroutines are documented inside the code.
eg.
perldoc /opt/eprints3/perl_lib/EPrints/MetaField.pm
