EPrints Documentation - User contributions [en-gb]

Core API

2016-04-18T13:29:17Z

Pm705: /* Repository */

{{API}}
[[Category:API]]

The core API was introduced in EPrints 3.2.0 and is intended to provide a clean and consistent programming interface to the EPrints system.

Not all essential functionality is yet available in the new API, as we've only included functions which we are confident we can keep stable for a number of versions.

=== Overview ===
use EPrints;
my $ep = EPrints->new();
my $repo = $ep->repository( "myrepo" );
my $an_eprint = $repo->eprint( 23 );

=== EPrints ===
$ep = EPrints->new();
@ids = $ep->repository_ids; # list active repository ids
$repo = $ep->repository( "devel", noise=>1 );
$repo = $ep->current_repository(); # from Apache::Request URI
EPrints->abort( $message );

=== Repository ===
<source lang="perl">
$xml = $repo->xml;
$dataset = $repo->dataset( "user" );
$user = $repo->current_user;
$query = $repo->query;
$current_page_url = $repo->current_url( host => 1, path => 1, query => 1, etc. );
$config_element = $repo->config( $key, [@subkeys] );
$repository->log( $message );
$string = $repo->query->param( "X" );
$repo->redirect( $url );
$eprint = $repo->eprint( 23 );
$user = $repo->user( 23 );
$user = $repo->user_by_username( "cjg" );
$user = $repo->user_by_email( 'cjg@ecs.soton.ac.uk' );
</source>

=== Dataset ===
$dataset = $repo->dataset( "eprint" )
$string = $dataset->base_id; # eprint
$string = $dataset->id; # inbox

$repo = $dataobj->repository;

$dataobj = $dataset->create_dataobj( $data );
$eprint = $dataset->dataobj( 23 );

%options = (filters => [ { meta_fields => [ 'contributors_id' ], value => "13249", match=>"EX" } ]);
$search = $dataset->prepare_search( %options );
$list = $dataset->search( %options ); # prepare_search( %options )->execute
$list = $dataset->search; # match ALL

$metafield = $dataset->field( $fieldname );
$metafield = $dataset->key_field;
@metafields = $dataset->fields;

$dataset->search->map( sub {}, $ctx );
$n = $dataset->search->count;
$ids = $dataset->search->ids;
$list = $dataset->list( \@ids );

=== list ===
$n = $list->count;
$list->map( sub {
my ( $repository, $dataset, $dataobj, $ctx ) = @_;
# do something to the dataobj here
}, $ctx );
$dataobj = $list->item( $offset );
@all_dataobjs = $list->slice
@dataobjs = $list->slice( $offset, $length );
\@ids = $list->ids;

=== XML ===
$doc = $xml->parse_string( $string );
$doc = $xml->parse_file( $filename );
$doc = $xml->parse_url( $url );

$utf8_string = $xml->to_string( $dom_node, %opts );

$dom_node = $xml->clone( $dom_node ); # deep
$dom_node = $xml->clone_node( $dom_node ); # shallow

$dom_node = $xml->contents_of( $dom_node ); # clone and return child nodes
$utf8_string = $xml->text_contents_of( $dom_node ); # Return text child nodes as a string

$dom_node = $xml->create_element( $name, %attr );
$dom_node = $xml->create_text_node( $value );
$dom_node = $xml->create_comment( $value );
$dom_node = $xml->create_document_fragment;

$bool = $xml->is( $dom_node, "Text" );

$xml->dispose( $dom_node );

=== XHTML ===
$xhtml = $repo->xhtml;

$utf8_string = $xhtml->to_xhtml( $dom_node, %opts ); # remove NS prefixes, fix <script> etc.

$xhtml_dom_node = $xhtml->input_field( $name, $value, %opts ); # nb. type & noenter are now options. noenter prevents the enter being pressed in the input field using javascript
$xhtml_dom_node = $xhtml->hidden_field( $name, $value, %opts ); # tdb: this is used *a lot* and is well defined
$xhtml_dom_node = $xhtml->text_area_field( $name, $value, %opts ); # tdb: value becomes a child text node
$xhtml_dom_node = $xhtml->form( $method, $url );

$xhtml_dom_node = $xhtml->data_element( $name, $value, %opts ); # tdb: render_data_element

$page = $xhtml->page( $map, %opts );

=== Page ===
$page->send( %options );
$page->write_to_file( $filename );

=== DataObj ===

$dataobj = $dataset->dataobj( $id );
$dataobj->delete;
$dataobj->commit( $force );

$dataset = $dataobj->dataset;
$repo = $dataobj->repository;

$id = $dataobj->id;
$dataobj->set_value( $fieldname, $value );
$value = $dataobj->value( $fieldname );
\@value = $dataobj->value( $fieldname ); # multiple
$boolean = $dataobj->is_set( $fieldname );

$xhtml = $dataobj->render_value( $fieldname );
$xhtml = $dataobj->render_citation( $style, %opts );

$uri = $dataobj->uri;
$url = $dataobj->url;

$string = $dataobj->export( $plugin_id, %opts );
$dataobj = $dataobj->create_subobject( $fieldname, $epdata );

=== MetaField ===
Now has a handle on both it's repository/session AND dataset.

my $field = $dataset->field( $fieldname );

$dataset = $field->dataset;
$repo = $field->repository;

$field->set_property( $property, $value );
$value = $field->property( $property );

$name = $field->name;
$type = $field->type;

$xhtml = $field->render_name;
$xhtml = $field->render_help;
$xhtml = $field->render_value_label( $value );

$values = $field->all_values( %opts );
$sorted_list = $field->sort_values( $unsorted_list );

Pm705:

Community Contributions Day November 2015

2015-11-18T15:34:08Z

Pm705: /* Group 2: Technical */

This page has been created in the run-up to the EPrints Community Contributions day on November 18th, 2015

== Objectives ==

This event is intended to bring the all parts of the EPrints community together to improve the software and documentation. We hope to achieve:

* code improvements
* wiki curation
* training and demonstration videos
* community members interacting and training each other

== Event Run Up ==

Things for participants to do before the event:

* Register for the Wiki via the EPrints LDAP server at [http://trac.eprints.org/ldap/ http://trac.eprints.org/ldap/]
* If you have an a suggestion for an interest group, add it below
* Please add your name to an interest group that looks interesting (see [[Training_Video:EPrints_Wiki_Basics]] for how to edit the wiki)

== On the Day ==

=== Jumping In ===

So, you have time to contribute and need to know how to get started. Here are your options:

* Pick an interest group below, and join it
* If you don't know how to join, contact one of the event organisers
** Adam Field
*** @gobfrey on twitter
*** af05v@ecs.soton.ac.uk
** Valerie McCutcheon
***valerie.mccutcheon@glasgow.ac.uk
*** 0141-330-2674
** Rachel Proudfoot
*** 0113 343 4554

=== Interest Groups ===

Any contribution that can be made is welcome, whether it's a minor edit to a wiki page or a bugfix. However, it may be profitable to run a number of discussion groups in the morning around areas of interest. These discussion groups can then set up work to be accomplished in the afternoon.

* 10:00 - 11:00 Interest groups meet (skype, google hangout?), make decisions and assign tasks
** What problem are we solving?
** How will we work?
** What communication platform will we use? Skype, Google Hangouts, Google Docs, EMail?
** Who will do what?
* 11:00 - 13:00 Morning Contributions
* 14:00 - 16:00 Afternoon Contributions
* 16:00 - 16:30 Interest groups wrap-up and reporting.

Each interest group should have a leader who is responsible for chairing the initial meeting, making sure the logistics run smoothly and creating some kind of record of the day (blog post, wiki page, etc).

==== Group 1: Community Training Course ====

We're coordinating via a [https://docs.google.com/document/d/1CPegvGl9BO45E4ye5_Bpk7e3kurc_spEL3OcmGcUZyA/edit?usp=sharing Google Doc]

This interest group is concerned with the wiki page at http://wiki.eprints.org/w/EPrints_Training_Course.

Areas of Discussion
* Standard layout and content for training video pages
* Content of the training course
* Production of new content
* Linking to other wiki pages

Members:
* Adam Field (willing to lead the group)
* Alan Stiles (alternatively contributing to Group 2)
* Lizz Jennings (likely to switch between this and Group 2)
* Mick Eadie
* George Mamalakis (may also help in some bug reports in Group 2 and also help in creating some Bazaar packages we've already started)

==== Group 2: Technical ====

This interest group will be looking at Github, folding in pull requests and evaluating bugs.

Get on the google hangout now [https://hangouts.google.com/call/md4isxlevojprl6n3vpp2c3dtua https://hangouts.google.com/call/md4isxlevojprl6n3vpp2c3dtua]

Topics of Discussion
* Vagrant build - see: https://github.com/eprintsug/eprints-vagrant (Good work! EP-Kudos and a cream bun to Robert Doiel!)
* Categorisation of issues: https://github.com/eprints/eprints/issues
* Building a [[How to build a development environment from source control]]
* Having built an EPrints from source the Unit tests do not all pass...

Members
* Jiadi Yao
* Alan Stiles (alternative contributing to Group 1)
* Lizz Jennings (likely to switch between this and Group 1)
* Mick Eadie
* Patrick McSweeney (will lead the session ;o)
* John Salter (will assist with the leading of the session)

==== Group 3: Community Contributions, Best Practices and Processes ====

This group will look at how barriers to community contributions (at all levels) can be lowered and community engagement can be promoted. We'll also look at community best practices and processes in EPrints. '''If you don't make the 10 o'clock meeting, don't worry, just come and join us at the Google Doc below.'''

Members

* Rachel Proudfoot - skype 'rachel_proudfoot'
* Valerie McCutcheon -skype 'mccutchv'
* Les Carr
* Adam Field (in and out, mainly in group 1)

'''Working Document (Google doc)'''
* [https://docs.google.com/document/d/1YYqeB0r5S8A9rYO9UZN-SoQLBLb2B7WQuP_WW3EKXEU/edit?usp=sharing Group 3 Capture document] - if you can't edit it, contact Rachel or Valerie

Possible subtopics - what do users want?

* User friendly topic guide on wiki
* reliable version information (cf. [[Required_software]]) incl. wiki update
* Impact
* Open Access - drafting community requirements for a standard functionality in EPrints.

=== Independent Contribution ===

Participants are encouraged to join an interest group, but have the option of working independently on their own pet project or objective. Please put your name in the members list below, with a brief description of what you will be progressing.

Members:

* Luke Skywalker (I'll be researching the Force)

=== Logistics ===

Each interest group should decide on the appropriate platform to use for communications and coordination.

== Post Event ==

It would be appreciated if each team could produce a write-up of the days activities for the benefit of future events and to show the value of the day. It should be no more than 400 words and a bulleted list of outcomes. Feel free to post these on any blog or platform you wish, but Adam Field would quite like to gather them all together in a blog post about the day.

Manual

2015-11-18T15:06:36Z

Pm705: /* Technical Reference */

[[Category:Rubbish]]
__NOTOC__
See the [[Main Page]] for other areas of this wiki.

* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]]

<table cellpadding="10"><tr><td width="33%" valign="top">

= Installation and First Steps =

* [[Quick Server Install Guide (Debian / Ubuntu Server)]]

== Releases ==

{{releasenotes}}
* (see also the note on [[EPrints Version Numbering]])

== Download ==
{{Download}}

== Installing EPrints From Binary ==
* [[Installing EPrints 3 via Redhat RPM]]
* [[Installing EPrints 3 via Fedora RPM]]
* [[Installing EPrints 3 via apt (Debian/Ubuntu)]]

== Using EPrints in the Cloud ==
* [[EPrints EC2]] - Running both a vanilla and training repository!

== Using the Live CD ==
* [[EPrints Live CD Help]]
* [[Building the Live CD]]

== Installing EPrints From Source (.tar.gz) ==

* [[Recommended Platforms]]
* [[Required software]]
* Install Guides
** [[Installing Eprints 3 on Fedora Core 7]] (also applicable to FC6)
** [[Installing EPrints 3 on RedHat Enterprise 4]]
** [[Installing EPrints 3 on OS X]]
** [[Debian from source | Installing EPrints 3 on Debian/Ubuntu - The Quick Way]]
** [[Installing EPrints 3 on Ubuntu 6.10]]
** [[Installing EPrints 3 on Debian]]
** [[Installing in a chroot Debian/Ubuntu]]
** [[:Category:Installation|Installing]] EPrints on various platforms.
* [[Https3 | Installing EPrints 3 with an https server]]

==Post Installation==
* [[Getting Started with EPrints 3]]
* [[Upgrading EPrints 3 versions | Upgrading from an earlier version of EPrints3]]
* [[Migration|Migrating from EPrints 2.3]]

==Maintenance==
* [[Backups]]
* [[Generate Scripts]]
* [[Alerts]]
* [[Log Files]]
* [[Automating your maintenance]]
* [[Troubleshooting]]

</td><td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;">

=Training Materials=
* [[EPrints Training Course]]
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.

= How-to Guides =

''[http://en.wikipedia.org/wiki/Howto What is a how-to?]

* Orientation <span style="color: #f94; font-size: 130%">(Start here)</span>
** [[Configuration orientation|New to EPrints 3?]] - ''before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape...''
** [[EPrints_3_Configuration_orientation_for_EPrints_2_administrators|Migrated from EPrints 2?]] - ''this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up...''
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding
* [[Branding with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''
** [[Branding, the next level]] - ''how to completely change the interface to your own design''
* [[OAI]]
* [[Adding new views]]
* Workflow
* Deposit Types
** [[Removing types]]
* Metadata
* Subjects (fold in with Organisation Hierarchy under "controled vocabularies")
* [[EPrints_3_Organisation_Hierarchy|Organisation Hierarchy]] - ''how to put your own organisation's Hierarchy into EPrints 3''
* Searches
* [[Autocompletion and Authority Files (Romeo Autocomplete)]] - ''add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...''
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive
* [[Demoprints Repository]] - ''How to set up and configure the demoprints.eprints.org repository.
* [[SWORD]] - ''How to configure the SWORD protocol on EPrints.
* [[:Category:Howto|more ...]]

= How to contribute =

There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...

Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.

* [[:Category:Documentation Needed| Create some of the missing documentation]]
* [[Contribute: Plugins | Plugins]]
* [[Contribute: Scripts | Scripts]]
* [[Contribute: Themes | Themes]]
* [[Contribute: Translations | Translations]]
* [[Contribute: Other | Other neighbourly things to do]]
* [[Extension Packages]]

= Misc =

* [[Preservation Support]] in EPrints 3
* [[:Category:Languages|Language support and translations]]
</td><td valign="top" width="33%">

= Technical Reference =

* [[EPrints Directory Structure]] - will be linked somewhere better, later.

* [[Metadata]] - configuring metadata fields.
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]
* [[XML Configuration]] Files
** [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.
** [[Citation Format]]
** [[Workflow Format]] - the structure of the EP3 workflow files
** [[Phrase Format]]
** [[Template Format]]
** [[XPAGE Format]]
* [[XML Export Format]]
* EPrints data structure
** of the software
** of the database (relating the dataobjects to each other using eprints fields)
* [[Data Object]]s and data sets
** The [[EPrint Object]]
** The [[User Object]]
** The [[Document Object]]
** The [[Subject Object]]
** The [[Saved Search Object]]
** The [[History Object]]
** The [[Access Object]]
** The [[Request Object]]
* [[:Category:Plugins|Plugins]]
** Import
** [[Create Export Plugins|Export Plugins]]
** Components
** [[Screen Plugins]]
** Convert
* [[Autocompletion]]
** [[Understanding IDs in Workflow Forms]]
* [[API]]
* [[Dynamic Template System]]

= The EPrints Bazaar =
* [[:Category:EPrints_Bazaar|The EPrints Bazaar]] (Start Here)
* The [[EPM Specification]]
* [[:Category:Bazaar_Package|Bazaar Packages]]

</td></tr></table>

Category:Documentation Needed

2015-11-18T15:05:30Z

Pm705:

Below are pages in the wiki that need attention. If you find a page that needs attention, add it to the Documentation_Needed category, and it will appear here. If you get a page listed here up to scratch, feel free to remove the category from that page.

If you are looking for a way to contribute to the EPrints community consider creating or updating one of the pages in this category so that it fits into the [[EPrints Training Course]]. Before you begin creating content you should read the [[EPrints_Training_Course#For_Contributors | notes for contributors]].

Category:Documentation Needed

2015-11-18T15:04:58Z

Pm705:

EPrints Training Course

2015-11-18T15:00:33Z

Pm705: /* For Contributors */

__NOTOC__

This page is intended to tie together training videos and other resources into a set of comprehensive training courses for EPrints. It is intended to serve as an introduction to EPrints for users, administrators and systems administrators involved with running an EPrints Repository.

Some demonstration text.

= EPrints Introduction and Overview =

* EPrints Key Features Tour
* Repositories for other purposes
** Collections
** Research Data
** Open Education

= Course Streams =
<table cellpadding="10"><tr>
<td width="33%" valign="top">
== Using EPrints ==

=== ...as a Visitor ===

* Searching for items
* Browsing for items
* Requesting a copy of a restricted fulltext

=== ...as a User ===

* [[Training_Video:Deposit_Workflow|Depositing an EPrint]]
* Importing EPrints
* Saved Searches and Notifications
* Exporting EPrints
* Managing Your User Profile

=== ...as an Editor ===

* The Editorial Buffer
* The Staff Search

=== ...as an Administrator ===

* Managing Users
** Editing User Records
** Understanding User Roles and Permissions
* Basic Troubleshooting
** [[Training_Video:Search_Troubleshooting|Checking and Starting the Indexer]]
* Batch Editing

</td>
<td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;">

== Configuring EPrints ==

=== Basic Configuration ===

Basic configuration can be done at the front-end, and requires no knowledge of perl or the EPrints API.

* Configuration Tools Overview
* Branding
** Adding a logo
* [[Training_Video:Edit_Phrases|Phrases]]
* [[Training_Video:Edit_and_Create_Static_Pages|Static Pages]]
* Item Types and Metadata Configuration
** [[Training_Video:Subject_Trees|Subject Trees]]
** The Workflow
*** [[Training_Video:Workflow_Configuration|Basic Workflow Configuration]]
*** [[Training_Video:Autocompletion|Authority Lists and Autocompletion]]
** [[Training_Video:Citation_Styles|Citation Styles]]
** Item Types
*** Adding a new type
*** Removing a type
* Browse Views
* [[Training_Video:Search_Configuration|Searches]]
* Installing Bazaar Packages

=== Advanced Configuration ===

Advanced configuration assumes some knowledge of the command-line and sometimes a little bit of Perl and the EPrints API.

* Branding
** Creating a new site-wide template.
* Understanding Configuration Structure
* [[Training_Video:Add_A_Field|Adding a Metadata Field]]
* Programmatic Metadata Values
** [[Training_Video:Automatic_Fields|Automatic Values]]
** [[Training_Video:Default_Fields|Default Values]]
** [[Training_Video:Virtual_Fields|Virtual Fields]]
* Custom Rendering of Values

</td>
<td width="33%" valign="top">

== Maintaining and Developing EPrints ==

* Technical Orientation

=== Systems Administration ===
* [[Training_Video:EPrints_Install|Installing EPrints]]
* Troubleshooting
** [[Training_Video:Search_Troubleshooting|Troubleshooting Searching]]

=== The EPrints API ===

* API Basics
** The Repository Object
** Datasets and Dataobjs
** XML and DOM
* Developing Plugins and Bazaar Packages
** [[Training_Video:Export_Plugin_Bazaar_Package|Export Plugin Bazaar Package]]
** [[Training_Video:New_Field_Bazaar_Package|New Field Bazaar Package]]

=== The EPrints Wiki ===

* [[Training_Video:EPrints_Wiki_Basics|EPrints Wiki Basics]]

=== Core Development ===

* Creating a Dev Environment
* Creating Pull Requests

</td>
</tr></table>

= For Contributors =

We have a list of [[:Category:Documentation Needed| documentation which is missing]]

If you are creating or curating a training course page, please copy/paste the current [[Training_course_template|Template]] page.

Creation of videos can be done with screen capture software. The following packages have been used by video producers:

* Screenflick (on a Mac) -- Adam Field

* Screencast-o-matic (on Windows 10) -- Lizz Jennings (note: there's a microphone "enhancement" feature on Windows 10 that will make you sound like Darth Vader. You need to disable this in the Windows 10 sound settings for the screencast to work).

Manual

2015-11-18T14:58:04Z

Pm705: /* How to contribute */

[[Category:Rubbish]]
__NOTOC__
See the [[Main Page]] for other areas of this wiki.

* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]]

<table cellpadding="10"><tr><td width="33%" valign="top">

= Installation and First Steps =

* [[Quick Server Install Guide (Debian / Ubuntu Server)]]

== Releases ==

{{releasenotes}}
* (see also the note on [[EPrints Version Numbering]])

== Download ==
{{Download}}

== Installing EPrints From Binary ==
* [[Installing EPrints 3 via Redhat RPM]]
* [[Installing EPrints 3 via Fedora RPM]]
* [[Installing EPrints 3 via apt (Debian/Ubuntu)]]

== Using EPrints in the Cloud ==
* [[EPrints EC2]] - Running both a vanilla and training repository!

== Using the Live CD ==
* [[EPrints Live CD Help]]
* [[Building the Live CD]]

== Installing EPrints From Source (.tar.gz) ==

* [[Recommended Platforms]]
* [[Required software]]
* Install Guides
** [[Installing Eprints 3 on Fedora Core 7]] (also applicable to FC6)
** [[Installing EPrints 3 on RedHat Enterprise 4]]
** [[Installing EPrints 3 on OS X]]
** [[Debian from source | Installing EPrints 3 on Debian/Ubuntu - The Quick Way]]
** [[Installing EPrints 3 on Ubuntu 6.10]]
** [[Installing EPrints 3 on Debian]]
** [[Installing in a chroot Debian/Ubuntu]]
** [[:Category:Installation|Installing]] EPrints on various platforms.
* [[Https3 | Installing EPrints 3 with an https server]]

==Post Installation==
* [[Getting Started with EPrints 3]]
* [[Upgrading EPrints 3 versions | Upgrading from an earlier version of EPrints3]]
* [[Migration|Migrating from EPrints 2.3]]

==Maintenance==
* [[Backups]]
* [[Generate Scripts]]
* [[Alerts]]
* [[Log Files]]
* [[Automating your maintenance]]
* [[Troubleshooting]]

</td><td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;">

=Training Materials=
* [[EPrints Training Course]]
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.

= How-to Guides =

''[http://en.wikipedia.org/wiki/Howto What is a how-to?]

* Orientation <span style="color: #f94; font-size: 130%">(Start here)</span>
** [[Configuration orientation|New to EPrints 3?]] - ''before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape...''
** [[EPrints_3_Configuration_orientation_for_EPrints_2_administrators|Migrated from EPrints 2?]] - ''this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up...''
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding
* [[Branding with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''
** [[Branding, the next level]] - ''how to completely change the interface to your own design''
* [[OAI]]
* [[Adding new views]]
* Workflow
* Deposit Types
** [[Removing types]]
* Metadata
* Subjects (fold in with Organisation Hierarchy under "controled vocabularies")
* [[EPrints_3_Organisation_Hierarchy|Organisation Hierarchy]] - ''how to put your own organisation's Hierarchy into EPrints 3''
* Searches
* [[Autocompletion and Authority Files (Romeo Autocomplete)]] - ''add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...''
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive
* [[Demoprints Repository]] - ''How to set up and configure the demoprints.eprints.org repository.
* [[SWORD]] - ''How to configure the SWORD protocol on EPrints.
* [[:Category:Howto|more ...]]

= How to contribute =

There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...

Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.

* [[:Category:Documentation Needed| Create some of the missing documentation]]
* [[Contribute: Plugins | Plugins]]
* [[Contribute: Scripts | Scripts]]
* [[Contribute: Themes | Themes]]
* [[Contribute: Translations | Translations]]
* [[Contribute: Other | Other neighbourly things to do]]
* [[Extension Packages]]

= Misc =

* [[Preservation Support]] in EPrints 3
* [[:Category:Languages|Language support and translations]]
</td><td valign="top" width="33%">

= Technical Reference =

* [[EPrints Directory Structure]] - will be linked somewhere better, later.

* [[Metadata]] - configuring metadata fields.
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]
* [[XML Configuration]] Files
** [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.
** [[Citation Format]]
** [[Workflow Format]] - the structure of the EP3 workflow files
** [[Phrase Format]]
** [[Template Format]]
** [[XPAGE Format]]
* [[XML Export Format]]
* EPrints data structure
** of the software
** of the database (relating the dataobjects to each other using eprints fields)
* [[Data Object]]s and data sets
** The [[EPrint Object]]
** The [[User Object]]
** The [[Document Object]]
** The [[Subject Object]]
** The [[Saved Search Object]]
** The [[History Object]]
** The [[Access Object]]
** The [[Request Object]]
* Plugins
** Import
** [[Create Export Plugins|Export Plugins]]
** Components
** [[Screen Plugins]]
** Convert
* [[Autocompletion]]
** [[Understanding IDs in Workflow Forms]]
* [[API]]
* [[Dynamic Template System]]

= The EPrints Bazaar =
* [[:Category:EPrints_Bazaar|The EPrints Bazaar]] (Start Here)
* The [[EPM Specification]]
* [[:Category:Bazaar_Package|Bazaar Packages]]

</td></tr></table>

Manual

2015-11-18T14:57:54Z

Pm705: /* How to contribute */

[[Category:Rubbish]]
__NOTOC__
See the [[Main Page]] for other areas of this wiki.

* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]]

<table cellpadding="10"><tr><td width="33%" valign="top">

= Installation and First Steps =

* [[Quick Server Install Guide (Debian / Ubuntu Server)]]

== Releases ==

{{releasenotes}}
* (see also the note on [[EPrints Version Numbering]])

== Download ==
{{Download}}

== Installing EPrints From Binary ==
* [[Installing EPrints 3 via Redhat RPM]]
* [[Installing EPrints 3 via Fedora RPM]]
* [[Installing EPrints 3 via apt (Debian/Ubuntu)]]

== Using EPrints in the Cloud ==
* [[EPrints EC2]] - Running both a vanilla and training repository!

== Using the Live CD ==
* [[EPrints Live CD Help]]
* [[Building the Live CD]]

== Installing EPrints From Source (.tar.gz) ==

* [[Recommended Platforms]]
* [[Required software]]
* Install Guides
** [[Installing Eprints 3 on Fedora Core 7]] (also applicable to FC6)
** [[Installing EPrints 3 on RedHat Enterprise 4]]
** [[Installing EPrints 3 on OS X]]
** [[Debian from source | Installing EPrints 3 on Debian/Ubuntu - The Quick Way]]
** [[Installing EPrints 3 on Ubuntu 6.10]]
** [[Installing EPrints 3 on Debian]]
** [[Installing in a chroot Debian/Ubuntu]]
** [[:Category:Installation|Installing]] EPrints on various platforms.
* [[Https3 | Installing EPrints 3 with an https server]]

==Post Installation==
* [[Getting Started with EPrints 3]]
* [[Upgrading EPrints 3 versions | Upgrading from an earlier version of EPrints3]]
* [[Migration|Migrating from EPrints 2.3]]

==Maintenance==
* [[Backups]]
* [[Generate Scripts]]
* [[Alerts]]
* [[Log Files]]
* [[Automating your maintenance]]
* [[Troubleshooting]]

</td><td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;">

=Training Materials=
* [[EPrints Training Course]]
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.

= How-to Guides =

''[http://en.wikipedia.org/wiki/Howto What is a how-to?]

* Orientation <span style="color: #f94; font-size: 130%">(Start here)</span>
** [[Configuration orientation|New to EPrints 3?]] - ''before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape...''
** [[EPrints_3_Configuration_orientation_for_EPrints_2_administrators|Migrated from EPrints 2?]] - ''this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up...''
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding
* [[Branding with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''
** [[Branding, the next level]] - ''how to completely change the interface to your own design''
* [[OAI]]
* [[Adding new views]]
* Workflow
* Deposit Types
** [[Removing types]]
* Metadata
* Subjects (fold in with Organisation Hierarchy under "controled vocabularies")
* [[EPrints_3_Organisation_Hierarchy|Organisation Hierarchy]] - ''how to put your own organisation's Hierarchy into EPrints 3''
* Searches
* [[Autocompletion and Authority Files (Romeo Autocomplete)]] - ''add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...''
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive
* [[Demoprints Repository]] - ''How to set up and configure the demoprints.eprints.org repository.
* [[SWORD]] - ''How to configure the SWORD protocol on EPrints.
* [[:Category:Howto|more ...]]

= How to contribute =

There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...

Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.

* [[Category:Documentation Needed| Create some of the missing documentation]]
* [[Contribute: Plugins | Plugins]]
* [[Contribute: Scripts | Scripts]]
* [[Contribute: Themes | Themes]]
* [[Contribute: Translations | Translations]]
* [[Contribute: Other | Other neighbourly things to do]]
* [[Extension Packages]]

= Misc =

* [[Preservation Support]] in EPrints 3
* [[:Category:Languages|Language support and translations]]
</td><td valign="top" width="33%">

= Technical Reference =

* [[EPrints Directory Structure]] - will be linked somewhere better, later.

* [[Metadata]] - configuring metadata fields.
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]
* [[XML Configuration]] Files
** [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.
** [[Citation Format]]
** [[Workflow Format]] - the structure of the EP3 workflow files
** [[Phrase Format]]
** [[Template Format]]
** [[XPAGE Format]]
* [[XML Export Format]]
* EPrints data structure
** of the software
** of the database (relating the dataobjects to each other using eprints fields)
* [[Data Object]]s and data sets
** The [[EPrint Object]]
** The [[User Object]]
** The [[Document Object]]
** The [[Subject Object]]
** The [[Saved Search Object]]
** The [[History Object]]
** The [[Access Object]]
** The [[Request Object]]
* Plugins
** Import
** [[Create Export Plugins|Export Plugins]]
** Components
** [[Screen Plugins]]
** Convert
* [[Autocompletion]]
** [[Understanding IDs in Workflow Forms]]
* [[API]]
* [[Dynamic Template System]]

= The EPrints Bazaar =
* [[:Category:EPrints_Bazaar|The EPrints Bazaar]] (Start Here)
* The [[EPM Specification]]
* [[:Category:Bazaar_Package|Bazaar Packages]]

</td></tr></table>

2015-11-18T14:38:47Z

Pm705: /* Getting Started */

[[Category:Howto]]
__NOTOC__
{{Box|title=EPrints Community Contributions Day|content=November 18th, 2015 is EPrints Community Contributions day. We encourage everyone to participate. See [[Community_Contributions_Day_November_2015|the event wiki page]]}}

'''Welcome to the EPrints Wiki'''

This wiki contains technical and user-contributed documentation for the [[Introduction|EPrints software]].

[http://demoprints3.eprints.org/ Demoprints] is our live, online server that allows anyone to try EPrints without having to install it first.

For more information on the EPrints project and related activities visit http://eprints.org/.

'''New to EPrints?'''

On this wiki you can find:

*Training videos (link to a page of these?)
*Documentation (link to)
*[[Working Groups]]
*Mailing lists

There are two mail lists that you might like to join.

'''The EPrints User Group Google Group''' https://groups.google.com/forum/#!forum/eprints-uk-user-group

This group is for anyone involved in using EPrints. Ask questions, share ideas, hear about forthcoming meetings.

'''The Eprints Technical Mailing List'''

Join the list at: http://wiki.eprints.org/w/Contact

Offer solutions to peers or ask for help.

*How to contribute to the wiki (link to the contributing to the wiki section on main page)
*Code Sharing Repository https://github.com/eprintsug
*Help - The EPrints mailing lists are useful starting points

== Download EPrints ==

{{Download}}

==Installation==

* [[:Category:Installation|Installing]] EPrints on various platforms

==Getting Started==

* [[EPrints Manual|EPrints 3 Documentation]]
* [[Perl 101 for EPrints]]
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.
* [[Frequently Asked Questions]]
* [[:Category:Howto|How to...]]
* [[:Category:Plugins|Plugins and Bazaar packages for EPrints]
* [[EPrints Training Course]]

==Getting Support==

* [http://www.eprints.org/services/ EPrints Services] - premium support, training and hosting from EPrints experts
* [[Contact]] - mailing lists, bug reports etc.

==Add-ons, patches and translations==

* As of version 3.3 EPrints can now install plugins and translations through the [https://bazaar.eprints.org EPrints Bazaar] the wiki also has information about [[:Category:EPrints Bazaar|packaging plugins for the Bazaar]].
* The [http://files.eprints.org/ EPrints Files Repository] contains add-on and 3rd party scripts, patches and translations. This also provides an archive of all previous EPrints releases (3.0 onwards).
* [[:Category:Plugins|Plugins]]: Some Wiki pages about scripts and patches.

{{Register}}

==Contributing to EPrints==

* [[Usability|EPrints usability]]
* [[:Category:Releases|New features in EPrints]] - released and proposed
* [[How to contribute|How to contribute to EPrints development]]
* [http://trac.eprints.org/ EPrints Trac] - access nightly builds, tickets and changes (requires free registration to view source code)

== Content management ==

* [[Digital preservation]]: managing content for longer-term access and use

2015-11-12T18:55:50Z

Pm705:

[[Category:IRStats]]

<div style="border: 2px solid red; background-color: yellow;padding:10px">This is IRStats1 documentation. IRStats1 is now out of support. You may have been looking for IRStats2</div>

IRStats is a flexible statistics package which allows easy processing of accesses to fulltext documents of eprints. It can be downloaded from the [http://files.eprints.org/722/ Eprints File repository]. For more detailed information, please see the [[IRStats Technical Documentation]], though it is now somewhat out of date.

== The front end ==

===The Query Form===

The main interface to IRStats is found at the following URL (given a repository base URL of myrepository.ac.uk):

<pre>
myrepository.ac.uk/cgi/irstats.cgi
</pre>

You will be presented with a form allowing you to select the parameters with which to generate a report.

===Advanced Report Generation (get_view2 params)===

The following will help if you wish to create queries by setting the CGI parameters by hand.

There are three fundamental parameters that IRStats uses. There are:
* A Date Range (actually 6 parameters for day, month and year for both start and end dates)
* A Set of EPrints
* A View

However, in order to add functionality, the get_view2 page will convert a larger number of parameters into these three. The following table shows all parameters and values, with square brackets denoting variables.

{| border="1"
! Parameter
! Possible Values
! Notes
|-
| IRS_datechoice || period, range || Controls whether the 6 date range parameters or the single period parameter is used.
|-
| period || -[X]m, Q[Z][YYYY] || Used when IRS_datechoice=period.<br/>Where m and Q are literal characters, X is a positive integer, Z is an integer in the range 1 to 4 and YYYY is a four digit year.<br/>Examples: <dl><dt>-4m<dd>Go back exactly four months from today's date<dt>Q32004<dd>Quarter 3, 2004</dl>
|-
| start_day, start_month, start_year, end_day, end_month, end_year || integers (1-31, 1-12, four digit respectively) || Used when IRS_datechoice=range.<br/> Note that if a day value is higher than the highest day in the chosen month, it will be treated as the highest day -- e.g. start_day=31&start_month=02 is seen as valid and equivalent to February 28th. Note that start_day=99 is also valid!
|-
| IRS_epchoice || All, EPrint, [set_id] || Controls whether stats will be generated on all eprints, a single eprints, or a set of eprints. The 'All' option is the only one that does not require extra parameters. Note that 'set_id' is the id of a valid set as defined in the IRStats configuration.
|-
| eprint || [eprintid] || Used when IRS_epchoice=EPrint.<br/>Any valid eprint ID (integer).
|-
| [set_id]s || [set_id]_[set_member_code] || Used when IRS_epchoice=[set_id].<br/> Best described through example: <dl><dt>IRS_epchoice=divisions&divisionss=divisions_art<dd>Will generate a report on the art department, given a standard EPrints repository and IRStats config, where the subject id 'art' exists in the divisions tree in EPrints.
|-
| view || [view classname] || The classname of the IRStats::View perl module.
|}

===The Dashboard Form===

A dashboard is a collection of reports on a single item or set of items (e.g. all items by John Smith). To access the form to generate a report, go to the url:

<pre>
myrepository.ac.uk/cgi/irstats.cgi?page=db
</pre>

== The configuration file ==

Documentation to follow.

Community Contributions Day November 2015

2015-11-12T18:50:52Z

Pm705: /* Group 2: Technical */