EPrints Documentation - User contributions [en-gb]

Category:Training Video

2017-06-01T15:38:21Z

Af05v@ecs.soton.ac.uk: /* The EPrints API */

__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
* [[Training_Video:Browsing|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
* [[Training_Video:Staff_Search|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]]
* Using pins within phrases and 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
* [[Trianing_Video:Browse_View_configuration|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
* Adding New Fields
**[[Training_Video:Add_A_Field|Adding a Simple Metadata Field]]
**Add a compound multiple 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 ==

* [[Training Video:Technical Orientation|Technical Orientation]]

=== Systems Administration ===
* [[Training_Video:EPrints_Install|Installing EPrints]]
* [[Training Video:Setting up SSL|Setting up SSL (https)]]
* 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
** Screen Plugins
** [[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]].

In the training course above, any items that are not linked to pages require a resource (e.g. a video) and a training course page to be created.

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).

-

Category:Installation

2017-01-23T11:25:33Z

Af05v@ecs.soton.ac.uk: /* Distribution Notes */

The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.

'''The EPrints team currently recommends installing EPrints in one of the following ways:'''

* '''[[Installing EPrints 3 via apt (Debian/Ubuntu)]]'''
* '''[[Installing_EPrints_3_on_RedHat_Enterprise_5|Installing using yum on RedHat Enterprise 5 or Fedora]]'''
* '''[[Installation|Installing from source]]'''

Here are some other ways:

* [[non-root_proxy|Proxied to a non-root]] user account: Where the server and all associated code is installed without root/admin access to anything
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server

This catagory contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}

If you want to write Installation instructions for a system other than those listed here please do. Remember to tag the page with <nowiki>[[Category:Installation]]</nowiki> so that appears in this list.

'''If you use one of the installation guides below and it doesnt work edit the page to say what went wrong and how you fixed it. This will help others (and probably your future self) tackle these problems in future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.'''

== Distribution Notes ==

Known issues and gotchas on various Linux distributions

{| class="wikitable"
|-
! Distibution
! Support
! Notes
|-
| Centos 7
| Supported
| No known issues. EPrints Services test builds against this release [http://www.eprints.org/tech.php/22149.html].
|-
| Ubuntu 16.10
| Currently Not working
| See Andrew Beeken's tech-list post: notes http://www.eprints.org/tech.php/22140/attachment/message.html
|-
| Ubuntu 14.04
| Supported
| No known issues. EPrints Services test builds against this release [http://www.eprints.org/tech.php/22149.html].
|}

Category:Installation

2017-01-23T11:24:53Z

Af05v@ecs.soton.ac.uk: /* Distribution Notes */

The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.

'''The EPrints team currently recommends installing EPrints in one of the following ways:'''

* '''[[Installing EPrints 3 via apt (Debian/Ubuntu)]]'''
* '''[[Installing_EPrints_3_on_RedHat_Enterprise_5|Installing using yum on RedHat Enterprise 5 or Fedora]]'''
* '''[[Installation|Installing from source]]'''

Here are some other ways:

* [[non-root_proxy|Proxied to a non-root]] user account: Where the server and all associated code is installed without root/admin access to anything
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server

This catagory contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}

If you want to write Installation instructions for a system other than those listed here please do. Remember to tag the page with <nowiki>[[Category:Installation]]</nowiki> so that appears in this list.

'''If you use one of the installation guides below and it doesnt work edit the page to say what went wrong and how you fixed it. This will help others (and probably your future self) tackle these problems in future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.'''

== Distribution Notes ==

Known issues and gotchas on various Linux distributions

{| class="wikitable"
|-
! Distibution
! Support
! Notes
|-
| Centos 7
| Supported
| No known issues. EPrints Services test builds against this release. http://www.eprints.org/tech.php/22149.html
|-
| Ubuntu 16.10
| Currently Not working
| See Andrew Beeken's tech-list post: notes http://www.eprints.org/tech.php/22140/attachment/message.html
|-
| Ubuntu 14.04
| Supported
| No known issues. EPrints Services test builds against this release. http://www.eprints.org/tech.php/22149.html
|}

Category:Installation

2017-01-23T11:24:04Z

Af05v@ecs.soton.ac.uk: /* Distribution Notes */

The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.

'''The EPrints team currently recommends installing EPrints in one of the following ways:'''

* '''[[Installing EPrints 3 via apt (Debian/Ubuntu)]]'''
* '''[[Installing_EPrints_3_on_RedHat_Enterprise_5|Installing using yum on RedHat Enterprise 5 or Fedora]]'''
* '''[[Installation|Installing from source]]'''

Here are some other ways:

* [[non-root_proxy|Proxied to a non-root]] user account: Where the server and all associated code is installed without root/admin access to anything
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server

This catagory contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}

If you want to write Installation instructions for a system other than those listed here please do. Remember to tag the page with <nowiki>[[Category:Installation]]</nowiki> so that appears in this list.

'''If you use one of the installation guides below and it doesnt work edit the page to say what went wrong and how you fixed it. This will help others (and probably your future self) tackle these problems in future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.'''

== Distribution Notes ==

Known issues and gotchas on various Linux distributions

{| class="wikitable"
|-
! Distibution
! Support
! Notes
|-
| Centos 7
| Supported
| No known issues. EPrints Services test builds against this release.
|-
| Ubuntu 16.10
| Currently Not working
| See Andrew Beeken's tech-list post: notes http://www.eprints.org/tech.php/22140/attachment/message.html
|-
| Ubuntu 14.04
| Supported
| No known issues. EPrints Services test builds against this release.
|}

Category:Installation

2017-01-19T15:22:35Z

Af05v@ecs.soton.ac.uk: /* Distribution Notes */

The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.

'''The EPrints team currently recommends installing EPrints in one of the following ways:'''

* '''[[Installing EPrints 3 via apt (Debian/Ubuntu)]]'''
* '''[[Installing_EPrints_3_on_RedHat_Enterprise_5|Installing using yum on RedHat Enterprise 5 or Fedora]]'''
* '''[[Installation|Installing from source]]'''

Here are some other ways:

* [[non-root_proxy|Proxied to a non-root]] user account: Where the server and all associated code is installed without root/admin access to anything
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server

This catagory contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}

If you want to write Installation instructions for a system other than those listed here please do. Remember to tag the page with <nowiki>[[Category:Installation]]</nowiki> so that appears in this list.

'''If you use one of the installation guides below and it doesnt work edit the page to say what went wrong and how you fixed it. This will help others (and probably your future self) tackle these problems in future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.'''

== Distribution Notes ==

Known issues and gotchas on various Linux distributions

{| class="wikitable"
|-
! Distibution
! Support
! Notes
|-
| Ubuntu 16.10
| Currently Not working
| See Andrew Beeken's tech-list post: notes http://www.eprints.org/tech.php/22140/attachment/message.html
|-
| Ubuntu 14.04
| Supported
| No known issues
|}

Category:Installation

2017-01-19T15:22:13Z

Af05v@ecs.soton.ac.uk:

The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.

'''The EPrints team currently recommends installing EPrints in one of the following ways:'''

* '''[[Installing EPrints 3 via apt (Debian/Ubuntu)]]'''
* '''[[Installing_EPrints_3_on_RedHat_Enterprise_5|Installing using yum on RedHat Enterprise 5 or Fedora]]'''
* '''[[Installation|Installing from source]]'''

Here are some other ways:

* [[non-root_proxy|Proxied to a non-root]] user account: Where the server and all associated code is installed without root/admin access to anything
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server

This catagory contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}

If you want to write Installation instructions for a system other than those listed here please do. Remember to tag the page with <nowiki>[[Category:Installation]]</nowiki> so that appears in this list.

'''If you use one of the installation guides below and it doesnt work edit the page to say what went wrong and how you fixed it. This will help others (and probably your future self) tackle these problems in future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.'''

== Distribution Notes ==

{| class="wikitable"
|-
! Distibution
! Support
! Notes
|-
| Ubuntu 16.10
| Currently Not working
| See Andrew Beeken's tech-list post: notes http://www.eprints.org/tech.php/22140/attachment/message.html
|-
| Ubuntu 14.04
| Supported
| No known issues
|}

Category:Installation

2017-01-19T15:21:56Z

Af05v@ecs.soton.ac.uk: /* Distribution Notes */

The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.

'''The EPrints team currently recommends installing EPrints in one of the following ways:'''

* '''[[Installing EPrints 3 via apt (Debian/Ubuntu)]]'''
* '''[[Installing_EPrints_3_on_RedHat_Enterprise_5|Installing using yum on RedHat Enterprise 5 or Fedora]]'''
* '''[[Installation|Installing from source]]'''

== Distribution Notes ==

{| class="wikitable"
|-
! Distibution
! Support
! Notes
|-
| Ubuntu 16.10
| Currently Not working
| See Andrew Beeken's tech-list post: notes http://www.eprints.org/tech.php/22140/attachment/message.html
|-
| Ubuntu 14.04
| Supported
| No known issues
|}

Here are some other ways:

* [[non-root_proxy|Proxied to a non-root]] user account: Where the server and all associated code is installed without root/admin access to anything
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server

This catagory contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}

If you want to write Installation instructions for a system other than those listed here please do. Remember to tag the page with <nowiki>[[Category:Installation]]</nowiki> so that appears in this list.

'''If you use one of the installation guides below and it doesnt work edit the page to say what went wrong and how you fixed it. This will help others (and probably your future self) tackle these problems in future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.'''

Category:Installation

2017-01-19T15:21:37Z

Af05v@ecs.soton.ac.uk: /* Distribution Notes */

The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.

'''The EPrints team currently recommends installing EPrints in one of the following ways:'''

* '''[[Installing EPrints 3 via apt (Debian/Ubuntu)]]'''
* '''[[Installing_EPrints_3_on_RedHat_Enterprise_5|Installing using yum on RedHat Enterprise 5 or Fedora]]'''
* '''[[Installation|Installing from source]]'''

== Distribution Notes ==

{| class="wikitable"
|-
! Distibution
! Support
! Notes
|-
| Ubuntu 16.10
| Currently Not working
| See Andrew Beeken's notes http://www.eprints.org/tech.php/22140/attachment/message.html
|-
| Ubuntu 14.04
| Supported
| No known issues
|}

Here are some other ways:

* [[non-root_proxy|Proxied to a non-root]] user account: Where the server and all associated code is installed without root/admin access to anything
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server

This catagory contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}

If you want to write Installation instructions for a system other than those listed here please do. Remember to tag the page with <nowiki>[[Category:Installation]]</nowiki> so that appears in this list.

'''If you use one of the installation guides below and it doesnt work edit the page to say what went wrong and how you fixed it. This will help others (and probably your future self) tackle these problems in future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.'''

Category:Installation

2017-01-19T15:21:22Z

Af05v@ecs.soton.ac.uk:

The default installation of EPrints is on a stand-alone linux system, but this is not the only way EPrints can (and has) been installed.

'''The EPrints team currently recommends installing EPrints in one of the following ways:'''

* '''[[Installing EPrints 3 via apt (Debian/Ubuntu)]]'''
* '''[[Installing_EPrints_3_on_RedHat_Enterprise_5|Installing using yum on RedHat Enterprise 5 or Fedora]]'''
* '''[[Installation|Installing from source]]'''

== Distribution Notes ==

{| class="wikitable"
|-
! Distibution
! Support
! Notes
|-
| Ubuntu 16.10
| Currently Not working
| See Andrew Beeken's notes [http://www.eprints.org/tech.php/22140/attachment/message.html]
|-
| Ubuntu 14.04
| Supported
| No known issues
|}

Here are some other ways:

* [[non-root_proxy|Proxied to a non-root]] user account: Where the server and all associated code is installed without root/admin access to anything
* [[How to set up EPrints on virtual directories other than root|Hosted on virtual directories other than root]] - sharing with other Web applications on the same server

This catagory contains a range of other sets of instructions for different operating systems and versions of EPrints. Most of them are not supported but may still work. {{EPrintsTech}}

If you want to write Installation instructions for a system other than those listed here please do. Remember to tag the page with <nowiki>[[Category:Installation]]</nowiki> so that appears in this list.

'''If you use one of the installation guides below and it doesnt work edit the page to say what went wrong and how you fixed it. This will help others (and probably your future self) tackle these problems in future. [[Template:Register|Here you can register for an eprints.org account]] to edit the wiki.'''

How to modify static pages

2016-12-20T14:51:49Z

Af05v@ecs.soton.ac.uk:

[[Category:Static Pages]]
The static web pages are created by combining the .xpage files from [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static | /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/]] with the site template. The template can be found at [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|opt/eprints3/archives/ARCHIVEID/cfg/lang/en/templates]]. This is what generate_static does.

Generate static also copies all files which do not have the suffix .xpage from [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static | /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/]]

Non-language specific files go in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|/opt/eprints3/archives/ARCHIVEID/cfg]] directory and appear on the website no matter what language the site is in. eg. images and the style sheet.

Obviously french source files go in cfg/lang/fr/ etc.

Edit the .xpage file (or other file in /static/)

Run [[Bin/|generate_static]] ARCHIVEID

===Issues===

The XML Editor encodes all extended characters, with the exception of core HTML ones (e.g. <) -- this causes issues with pages that need to include one of these symbols. See https://github.com/eprints/eprints/blob/3.3/perl_lib/EPrints/Plugin/Screen/Admin/Config/Edit/XML.pm#L29

A set of phrases have been created for html entites to be used in static pages and phrases that can be edited through the front-end tools. E.g:

<source lang='html4strict'>
<p>Nuts <epc:phrase ref='entity_amp'/> bolts</p>
</source>

A [http://bazaar.eprints.org/id/eprint/471 bazaar package] has been created for the following phrases:

* entity_amp
* entity_gt
* entity_lt
* entity_quot
* entity_apos

See http://bazaar.eprints.org/471/

How to modify static pages

2016-12-20T14:21:18Z

Af05v@ecs.soton.ac.uk: /* Issues */

[[Category:Static Pages]]
The static web pages are created by combining the .xpage files from [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static | /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/]] with the site template. The template can be found at [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|opt/eprints3/archives/ARCHIVEID/cfg/lang/en/templates]]. This is what generate_static does.

Generate static also copies all files which do not have the suffix .xpage from [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static | /opt/eprints3/archives/ARCHIVEID/cfg/lang/en/static/]]

Non-language specific files go in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|/opt/eprints3/archives/ARCHIVEID/cfg]] directory and appear on the website no matter what language the site is in. eg. images and the style sheet.

Obviously french source files go in cfg/lang/fr/ etc.

Edit the .xpage file (or other file in /static/)

Run [[Bin/|generate_static]] ARCHIVEID

===Issues===

The XML Editor encodes all extended characters, with the exception of core HTML ones (e.g. <) -- this causes issues with pages that need to include one of these symbols. See https://github.com/eprints/eprints/blob/3.3/perl_lib/EPrints/Plugin/Screen/Admin/Config/Edit/XML.pm#L29

A set of phrases have been created for html entites to be used in static pages and phrases that can be edited through the front-end tools. E.g:

<source lang='html4strict'>
<p>Nuts <epc:phrase ref='entity_amp'/> bolts</p>
</source>

A bazaar package has been created for the following phrases:

* entity_amp
* entity_gt
* entity_lt
* entity_quot
* entity_apos

See

How to modify static pages

2016-12-20T14:17:51Z

Af05v@ecs.soton.ac.uk:

How to modify static pages

2016-12-20T14:15:41Z

Af05v@ecs.soton.ac.uk: /* Issues */

Training Video:Staff Search

2016-08-24T09:54:19Z

Af05v@ecs.soton.ac.uk: /* Index */

[[Category:Howto]]
[[Category:Training_Video|Staff Search]]

==Introduction==

An overview of the staff search, which allows an editor or an administrator to search for items by item ID, username of depositor and all advanced search fields, regardless of its location in the repository.

==What You Will Learn==

* How to search for items as a staff member

==What You Should Already Know==

* How to log into EPrints

==Resources==

=== Video===
The Video can be found at [https://youtu.be/F19zzi1Uggs https://youtu.be/F19zzi1Uggs].
====Index====

* [https://youtu.be/F19zzi1Uggs?t=00m00s 00:00 - introduction]
* [https://youtu.be/F19zzi1Uggs?t=00m21s 00:21 - find Admin Search]
* [https://youtu.be/F19zzi1Uggs?t=00m30s 00:30 - extra fields on admin search]
* [https://youtu.be/F19zzi1Uggs?t=00m45s 00:45 - search retired items]
* [https://youtu.be/F19zzi1Uggs?t=01m00s 01:00 - search by Username]
* [https://youtu.be/F19zzi1Uggs?t=01m25s 01:25 - search in user workarea]
* [https://youtu.be/F19zzi1Uggs?t=01m43s 01:43 - who can use it (admin / editor)]

Alternative Index:
* [https://youtu.be/F19zzi1Uggs?t=00m00s 00:00 - Introduction to purpose]
* [https://youtu.be/F19zzi1Uggs?t=00m18s 00:18 - Explanation of search form]
* [https://youtu.be/F19zzi1Uggs?t=00m43s 00:43 - 1st example: search of retired items]
* [https://youtu.be/F19zzi1Uggs?t=01m18s 01:18 - 2nd example: search in helpless user's inbox]

==== The Video====
<youtube>F19zzi1Uggs</youtube>

====Notes, Errata and Additional Information====

See [[Search.pl#Adding_fields_to_the_staff_search]] for info about pushing more fields into the staff search.

* EPrints 3.3.15

==Test Yourself==

* Search for an item in a user work area.
* Search for a retired item.
* Search for an item with a particular eprint ID.
* Search for an item belonging to a particular user.

==More Reading==

Training Video:Staff Search

2016-07-08T15:21:16Z

Af05v@ecs.soton.ac.uk: /* Video */

Training Video:Staff Search

2016-06-15T15:53:13Z

Af05v@ecs.soton.ac.uk:

[[Category:Howto]]
[[Category:Training_Video|Staff Search]]

==Introduction==

An overview of the staff search, which allows an editor or an administrator to search for items by item ID, username of depositor and all advanced search fields, regardless of its location in the repository.

==What You Will Learn==

* How to search for items as a staff member

==What You Should Already Know==

* How to log into EPrints

==Resources==

=== Video===
The Video can be found at [http://youtu.be/nc6sZDkc5jI http://youtu.be/nc6sZDkc5jI].
====Index====
* [http://youtu.be/KzrS_u-4eoM?t=0m0s 0:00 introduction]
* [http://youtu.be/KzrS_u-4eoM?t=0m13s 0:13 log in as admin]
* [http://youtu.be/KzrS_u-4eoM?t=0m200s 0:20 open staff search]
* [http://youtu.be/KzrS_u-4eoM?t=0m50s 0:50 search for articles]
* [http://youtu.be/KzrS_u-4eoM?t=1m15s 1:15 search by item id]
* [http://youtu.be/KzrS_u-4eoM?t=1m25s 1:25 explaining other search options]

==== The Video====
<youtube>nc6sZDkc5jI</youtube>

====Notes, Errata and Additional Information====

See [[Search.pl#Adding_fields_to_the_staff_search]] for info about pushing more fields into the staff search.

* EPrints 3.3.15

==Test Yourself==

* Search for an item in a user work area.
* Search for a retired item.
* Search for an item with a particular eprint ID.
* Search for an item belonging to a particular user.

==More Reading==

Training Video:Staff Search

2016-06-15T15:16:50Z

Af05v@ecs.soton.ac.uk: Created page with "Category:Howto Staff Search ==Introduction== An overview of the staff search, which allows an editor or an administrator to search for items..."

Category:Training Video

2016-06-15T15:10:36Z

Af05v@ecs.soton.ac.uk:

__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
* [[Training_Video:Browsing|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
* [[Training_Video:Staff_Search|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]]
* Using pins within phrases and 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
* [[Trianing_Video:Browse_View_configuration|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
* Adding New Fields
**[[Training_Video:Add_A_Field|Adding a Simple Metadata Field]]
**Add a compound multiple 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 ==

* [[Training Video:Technical Orientation|Technical Orientation]]

=== Systems Administration ===
* [[Training_Video:EPrints_Install|Installing EPrints]]
* [[Training Video:Setting up SSL|Setting up SSL (https)]]
* 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]].

In the training course above, any items that are not linked to pages require a resource (e.g. a video) and a training course page to be created.

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).

-

MultiLang Fields Bazaar Package

2016-06-06T10:53:21Z

Af05v@ecs.soton.ac.uk: /* Introducing ml_title field in EPrints */

[[Category:EPrints 3 Plugins]]

The MultiLang plugins introduces multiple language support in EPrints fields. The specific plugin replaces '''title''' and '''abstract''' fields with their multilanguage version ('''ml_title''' and '''ml_abstract''' respectively), but this wiki-page will explain how one can achieve this functionality in other EPrints fields as well.

== Installation Prerequisites ==
None

== Installation ==

Install through the EPrints Bazaar

== How to use the plugin ==
Once the plugin has been installed, the user needs to edit the workflow to contain the multilingual fields' versions instead of the default ones. This procedure is explained in [[MultiLang Fields Bazaar Package::Edit workflow]] section.

== How the plugin works ==
In order to introduce a new field in EPrints (such as the '''ml_title''' field), a few things need to take place:

* The field's name and functionality needs to be introduced to the EPrints system via a configuration file located in '''~eprints/archives/<reponame>/cfg/cfg.d/'''.
* EPrints' database needs to be updated to include the new field. This is achieved when user eprints executes (from his home directory):
<pre>
$ ./bin/epadmin update reponame
</pre>
* The appropriate phrases need to be added for each field and for each supported language.
* The workflow needs to be edited in order to contain the new fields - and not include the original ones.
* The repository needs to be reloaded, by running:
<pre>
$ ./bin/epadmin reload reponame
</pre>
within eprints' home directory.

The following sections explain each step in detail, where we are using '''ml_title''' as our example field. The code snippets are just for demonstration purposes (and proof of concept). If you want to see the final, working implementation, you should look at the source code of the plugin.

== Introducing ml_title field in EPrints ==
We create the file: '''~eprints/archives/<reponame>/cfg/cfg.d/zz_multilang_field.pl''' with the following content:

<source lang='perl'>
#define local fields
my $local_fields = [
{
name => 'ml_title',
type => 'multilang',
multiple => 1,
fields => [ { sub_name => "text", type => "longtext", input_rows => 3, make_single_value_orderkey => 'EPrints::Extras::english_title_orderkey' } ],
input_add_boxes => 1,
},

{
name => 'title',
type => 'virtualwithvalue',
virtual => 1,

get_value => sub
{
my ($eprint) = @_;
if ($eprint->is_set('ml_title'))
{
my $lang = $eprint->repository->get_langid;
my $lang_set = 0;
my $vals = $eprint->get_value('ml_title');
my $title = '';
if (!$lang)
{
$lang_set = 1;
}
else
{
# set the default lang's text as title
foreach my $v1 (@{$vals})
{
if ($v1->{lang} eq $lang)
{
$title = $v1->{text};
}
}
}
# if the language is not set or I can't find an abstract in the
# user's language, get the first object's text as abstract
if ($lang_set or $title eq '')
{
$title = $vals->[0]->{text};
}
return $title;

}
return undef;
},

set_value => sub
{
my ($eprint, $value) = @_;
my $lang = 'en';
#only use this on imports, NOT if the value is already set
if ($eprint->is_set('ml_title'))
{
return;
}
if ($value)
{
$eprint->set_value('ml_title', [{lang=>$lang, text=>$value}]);
}
}
},
];

#create lookup hash of local field names
my $local_fieldnames = {};

foreach my $f (@{$local_fields})
{
$local_fieldnames->{$f->{name}} = 1;
}

#merge in existing field configurations
foreach my $f (@{$c->{fields}->{eprint}})
{
if (!$local_fieldnames->{$f->{name}})
{
push @{$local_fields}, $f;
}
}

#overwrite original array of configured fields
$c->{fields}->{eprint} = $local_fields;
</source>

Where we can see that our new '''ml_title''' field is of type '''virtualwithvalue''' (which we'll explain later in this section) and implements two functions: '''get_value''' and '''set_value'''. Both these functions are used by EPrints API and their existence, as well as their return values, are critical for EPrints to work properly, and do exactly what their names suggest. In the end of our example code one can see how a custom field can be added in the list of EPrints fields.

== Editing the workflow ==
blahblah

Tweepository

2015-12-18T12:22:48Z

Af05v@ecs.soton.ac.uk: /* Exporting to a Web Observatory */

[[Category:EPrints 3 Plugins]]

The Tweepository plugin enables the repository to harvest a stream of tweets from a twitter search. This document applies to Tweepository 0.3.1.

== Installation Prerequisites ==

The following perl libraries must be installed on the server before the Bazaar package will function.

<pre>
Archive::Zip
Archive::Zip::MemberRead
Data::Dumper
Date::Calc
Date::Parse
Encode
File::Copy
File::Path
HTML::Entities
JSON
LWP::UserAgent
Number::Bytes::Human
Storable
URI
URI::Find
</pre>

== Installation ==

Install through the EPrints Bazaar

== Add Twitter API Keys ==

Create a file in your repository's cfg.d directory for your twitter API keys (e.g. called z_tweepository_oath.pl). The content should look like this:

<pre>
$c->{twitter_oauth}->{consumer_key} = 'xxxxxxxxxxxx';
$c->{twitter_oauth}->{consumer_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token} = 'xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
</pre>

== Setting Up Cron Jobs ==

There are three processes that need to be regularly run. Due to the heavyweight nature of these tasks, they should be put into the crontab rather than being handled by the EPrints Indexer. However, they have been created as event plugins for future inclusion in the indexer. Scripts have been created to wrap the plugins

Running these scripts will result in log files and a cache being created in the repository's 'var' directory. These should be checked if there are any issues with harvesting.

add the following to your eprints crontab (assuming EPrints is installed in '/opt/eprints3'):

<pre>
0,30 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstreams.pl REPOSITORYID
15 0 * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstream_abstracts.pl REPOSITORYID
45 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/export_tweetstream_packages.pl REPOSITORYID
</pre>

== Using ==

To create a new tweetstream, click on 'Manage Records', then on 'Twitter Feed', and then on the 'Create new Item' button. A new tweetstream object will be created, and you will need to enter two parameters:

[[File:tweepository_create.png]]

* Search String: Passed directly to Twitter as the search parameter.
* Expiry Date: The date on which to stop harvesting this stream.

Note that in version 0.3.1, more metadata fields have been added, most notably a 'project' field, which the default tweetstream browse views uses.

Once these fields have been completed, click 'Save and Return'.

== Harvesting ==

Every 20 minutes, the tweepository package will harvest each stream. No harvesting is done on creation, to the tweetstream will initially be empty. Tweets will be processed to:

*extract hashtags
*extract mentioned users

These data will be summarised in the tweetstream objects.

==URLs==

Note that URLs are no longer followed to expand shortened links. This is a target for future development.

== Viewing a Tweetstream ==

To view a tweetstream, click on 'Manage Records', then 'Twitter Feed':

[[File:Tweepository_manage.png]]

The above screen shows a list of all twitter streams that the logged in user has access to. Clicking on the view icon (the magnifying glass) will bring up the view screen, which shows all metadata set on this twitter feed. At the top of the page will be a link to the tweetstream's page. It will be of the form:

http://repository.foo.com/id/tweetstream/5

Below is an example of a tweetstream page:

[[File:Eprintstweetstream.png]]

== Exporting ==

Due to the architecture of the twitter feeds (see below), exporting using the standard eprints exporters (e.g. XML) will only work if both the tweet dataset and the tweetstream dataset are both exported. For this reason, export plugins have been provided for tweetstreams. Currently, a tweetstream can be exported as:

*CSV
*HTML
*JSON

Note that EPrints may struggle to export very large tweetstreams through the web interface. If there are more than several hundred thousand tweets, it may be advisable to export from the command line.

== Architecture ==

Both tweetstreams and tweets are EPrints Data Objects. Each tweet object stores the ID of all tweetstreams to which it belongs. This allows tweets to appear in more than one stream, but only be stored once in the database.

== Permissions ==

The z_tweepository_cfg.pl file contains the following:

<pre>
$c->{roles}->{"tweetstream-admin"} = [
"datasets",
"tweetstream/view",
"tweetstream/details",
"tweetstream/edit",
"tweetstream/create",
"tweetstream/destroy",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-editor"} = [
"datasets",
"tweetstream/view",
"tweetstream/details:owner",
"tweetstream/edit:owner",
"tweetstream/create",
"tweetstream/destroy:owner",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-viewer"} = [
"tweetstream/view",
"tweetstream/export",
];
push @{$c->{user_roles}->{admin}}, 'tweetstream-admin';
push @{$c->{user_roles}->{editor}}, 'tweetstream-editor';
push @{$c->{user_roles}->{user}}, 'tweetstream-viewer';
</pre>

This defines three roles. The admin role:

* Can create tweetstreams
* Can destroy tweetstreams
* Can see tweetstream details
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The editor role:

* Can create tweetstreams
* Can destroy tweetstreams that they created
* Can see details of tweetstreams that they created
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The viewer role:

* Can view tweetstream abstract pages (but need to know the URL)
* Can export tweetstreams

These three roles have been assigned to repository administrators, editors and users respectively. This can be changed by modifying this part of the config.

== Exporting to a Web Observatory ==

Tweet data can be exported nightly to a Web Observatory. This is accomplished by inserting tweet records into an external MongoDB database that has been set up by the administrators of the Web Observatory for this purpose.

=== Configuring a Web Observatory ===

An example web observatory configuration is visible in the z_tweepository_cfg.pl file. This should be copied to a new .pl file and an entry created for each Web Observatory database that is configured:

<source lang="perl">
$c->{web_observatories} =
{
'websobservatory1' =>
{
type => 'mongodb',
server => 'foo.bar.uk',
port => 1234,
db_name => 'foo',
username => 'username',
password => 'password',
authorised_users =>
[
'username1',
'username2'
]
}
};
</source>

To test, use the web_observatory_test.pl script:

perl -I/<eprints_root>/perl_lib /<eprints_root>/archives/<repositoryid>/bin/tweepository/web_observatory_test.pl <repositoryid> <webobservatoryid>

==== authorised_users ====

A tweetstream is allowed to be pushed to a Web Observatory if its the person that created the tweetstream is in the list of authorised users.

=== Configuring a TweetStream ===

When editing or creating a tweetstream, fill in the Web Observatory Export part of the workflow:

* Export To Web Observatory -- set to 'Yes'
* The ID of the web observatory -- In the above example, it would be 'webobservatory1'
* Web Observatory Collection -- the MongoDB collection that this will be inserted into. Note that:
** More that one tweetstream can be inserted into a collection
** The URL of the tweepository will be prepeneded onto the collection ID. If 'foo' is the collection name, then on the Web Observatory, the collection will be (e.g.) 'http://www.mytweepository.com/foo'

=== Nightly Export ===

The web_observatory_push.pl script needs to be added to the crontab to run nightly. It should be run after the update_tweetstream_abstracts.pl script. Note that it is blocked by update_tweetstream_abstracts, so will only start doing actual work when that script has terminated.

== Troubleshooting ==

If this error is observed when harvesting:

<pre>
DBD::mysql::st execute failed: Duplicate entry '30370867-0' for key 'PRIMARY' at /opt/eprints3/perl_lib/EPrints/Database.pm line 1249.
</pre>

...particularly after database corruption has been fixed, you'll need to sort out the database with some direct mysql queries. First make a note of the duplicate entry ID. In the above case, it's 30370867 (don't worry about the '-0' part). The problem is that there are some dirty records which need to be removed. Subtract a hundred or so from the Duplicate entry ID (e.g. down to a nice round 30370750) and we're going to remove any data with a higher ID than this.

First, from the tweet table:
<pre>
mysql> delete from tweet where tweetid >= 30370750;
</pre>

Then from all 'tweet_foo' tables (the multiple values tables, where the problem actually is).

<pre>
mysql> show tables like "%tweet\_%";
</pre>

This will show something like this:
<pre>
+----------------------------------+
| Tables_in_tweets (tweet\_%) |
+----------------------------------+
| tweet__index |
| tweet__index_grep |
| tweet__ordervalues_en |
| tweet__rindex |
| tweet_has_next_in_tweetstreams |
| tweet_hashtags |
| tweet_target_urls |
| tweet_tweetees |
| tweet_tweetstreams |
| tweet_url_redirects_redirects_to |
| tweet_url_redirects_url |
| tweet_urls_from_text |
| tweet_urls_in_text |
+----------------------------------+
13 rows in set (0.00 sec)
</pre>

Ignore the tables that have '__' in them (tweet__index, tweet__index_grep, tweet__ordervalues_en, tweet__rindex), but repeat the delete command for all other tables:

<pre>
mysql> delete from tweet_has_next_in_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_hashtags where tweetid >= 30370750;
mysql> delete from tweet_target_urls where tweetid >= 30370750;
mysql> delete from tweet_tweetees where tweetid >= 30370750;
mysql> delete from tweet_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_redirects_to where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_url where tweetid >= 30370750;
mysql> delete from tweet_urls_from_text where tweetid >= 30370750;
mysql> delete from tweet_urls_in_text where tweetid >= 30370750;
</pre>

Tweepository

2015-12-18T12:19:51Z

Af05v@ecs.soton.ac.uk: /* Configuring a Web Observatory */

[[Category:EPrints 3 Plugins]]

The Tweepository plugin enables the repository to harvest a stream of tweets from a twitter search. This document applies to Tweepository 0.3.1.

== Installation Prerequisites ==

The following perl libraries must be installed on the server before the Bazaar package will function.

<pre>
Archive::Zip
Archive::Zip::MemberRead
Data::Dumper
Date::Calc
Date::Parse
Encode
File::Copy
File::Path
HTML::Entities
JSON
LWP::UserAgent
Number::Bytes::Human
Storable
URI
URI::Find
</pre>

== Installation ==

Install through the EPrints Bazaar

== Add Twitter API Keys ==

Create a file in your repository's cfg.d directory for your twitter API keys (e.g. called z_tweepository_oath.pl). The content should look like this:

<pre>
$c->{twitter_oauth}->{consumer_key} = 'xxxxxxxxxxxx';
$c->{twitter_oauth}->{consumer_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token} = 'xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
</pre>

== Setting Up Cron Jobs ==

There are three processes that need to be regularly run. Due to the heavyweight nature of these tasks, they should be put into the crontab rather than being handled by the EPrints Indexer. However, they have been created as event plugins for future inclusion in the indexer. Scripts have been created to wrap the plugins

Running these scripts will result in log files and a cache being created in the repository's 'var' directory. These should be checked if there are any issues with harvesting.

add the following to your eprints crontab (assuming EPrints is installed in '/opt/eprints3'):

<pre>
0,30 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstreams.pl REPOSITORYID
15 0 * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstream_abstracts.pl REPOSITORYID
45 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/export_tweetstream_packages.pl REPOSITORYID
</pre>

== Using ==

To create a new tweetstream, click on 'Manage Records', then on 'Twitter Feed', and then on the 'Create new Item' button. A new tweetstream object will be created, and you will need to enter two parameters:

[[File:tweepository_create.png]]

* Search String: Passed directly to Twitter as the search parameter.
* Expiry Date: The date on which to stop harvesting this stream.

Note that in version 0.3.1, more metadata fields have been added, most notably a 'project' field, which the default tweetstream browse views uses.

Once these fields have been completed, click 'Save and Return'.

== Harvesting ==

Every 20 minutes, the tweepository package will harvest each stream. No harvesting is done on creation, to the tweetstream will initially be empty. Tweets will be processed to:

*extract hashtags
*extract mentioned users

These data will be summarised in the tweetstream objects.

==URLs==

Note that URLs are no longer followed to expand shortened links. This is a target for future development.

== Viewing a Tweetstream ==

To view a tweetstream, click on 'Manage Records', then 'Twitter Feed':

[[File:Tweepository_manage.png]]

The above screen shows a list of all twitter streams that the logged in user has access to. Clicking on the view icon (the magnifying glass) will bring up the view screen, which shows all metadata set on this twitter feed. At the top of the page will be a link to the tweetstream's page. It will be of the form:

http://repository.foo.com/id/tweetstream/5

Below is an example of a tweetstream page:

[[File:Eprintstweetstream.png]]

== Exporting ==

Due to the architecture of the twitter feeds (see below), exporting using the standard eprints exporters (e.g. XML) will only work if both the tweet dataset and the tweetstream dataset are both exported. For this reason, export plugins have been provided for tweetstreams. Currently, a tweetstream can be exported as:

*CSV
*HTML
*JSON

Note that EPrints may struggle to export very large tweetstreams through the web interface. If there are more than several hundred thousand tweets, it may be advisable to export from the command line.

== Architecture ==

Both tweetstreams and tweets are EPrints Data Objects. Each tweet object stores the ID of all tweetstreams to which it belongs. This allows tweets to appear in more than one stream, but only be stored once in the database.

== Permissions ==

The z_tweepository_cfg.pl file contains the following:

<pre>
$c->{roles}->{"tweetstream-admin"} = [
"datasets",
"tweetstream/view",
"tweetstream/details",
"tweetstream/edit",
"tweetstream/create",
"tweetstream/destroy",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-editor"} = [
"datasets",
"tweetstream/view",
"tweetstream/details:owner",
"tweetstream/edit:owner",
"tweetstream/create",
"tweetstream/destroy:owner",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-viewer"} = [
"tweetstream/view",
"tweetstream/export",
];
push @{$c->{user_roles}->{admin}}, 'tweetstream-admin';
push @{$c->{user_roles}->{editor}}, 'tweetstream-editor';
push @{$c->{user_roles}->{user}}, 'tweetstream-viewer';
</pre>

This defines three roles. The admin role:

* Can create tweetstreams
* Can destroy tweetstreams
* Can see tweetstream details
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The editor role:

* Can create tweetstreams
* Can destroy tweetstreams that they created
* Can see details of tweetstreams that they created
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The viewer role:

* Can view tweetstream abstract pages (but need to know the URL)
* Can export tweetstreams

These three roles have been assigned to repository administrators, editors and users respectively. This can be changed by modifying this part of the config.

== Exporting to a Web Observatory ==

Tweet data can be exported nightly to a Web Observatory. This is accomplished by inserting tweet records into an external MongoDB database that has been set up by the administrators of the Web Observatory for this purpose.

=== Configuring a Web Observatory ===

An example web observatory configuration is visible in the z_tweepository_cfg.pl file. This should be copied to a new .pl file and an entry created for each Web Observatory database that is configured:

<source lang="perl">
$c->{web_observatories} =
{
'websobservatory1' =>
{
type => 'mongodb',
server => 'foo.bar.uk',
port => 1234,
db_name => 'foo',
username => 'username',
password => 'password',
authorised_users =>
[
'username1',
'username2'
]
}
};
</source>

To test, use the web_observatory_test.pl script:

perl -I/<eprints_root>/perl_lib /<eprints_root>/archives/<repositoryid>/bin/tweepository/web_observatory_test.pl <repositoryid> <webobservatoryid>

==== authorised_users ====

A tweetstream is allowed to be pushed to a Web Observatory if its the person that created the tweetstream is in the list of authorised users.

=== Configuring a TweetStream ===

When editing or creating a tweetstream, fill in the Web Observatory Export part of the workflow:

* Export To Web Observatory -- set to 'Yes'
* The ID of the web observatory -- In the above example, it would be 'webobservatory1'
* Web Observatory Collection -- the MongoDB collection that this will be inserted into. Note that:
** More that one tweetstream can be inserted into a collection
** The URL of the tweepository will be prepeneded onto the collection ID. If 'foo' is the collection name, then on the Web Observatory, the collection will be (e.g.) 'http://www.mytweepository.com/foo'

== Troubleshooting ==

If this error is observed when harvesting:

<pre>
DBD::mysql::st execute failed: Duplicate entry '30370867-0' for key 'PRIMARY' at /opt/eprints3/perl_lib/EPrints/Database.pm line 1249.
</pre>

...particularly after database corruption has been fixed, you'll need to sort out the database with some direct mysql queries. First make a note of the duplicate entry ID. In the above case, it's 30370867 (don't worry about the '-0' part). The problem is that there are some dirty records which need to be removed. Subtract a hundred or so from the Duplicate entry ID (e.g. down to a nice round 30370750) and we're going to remove any data with a higher ID than this.

First, from the tweet table:
<pre>
mysql> delete from tweet where tweetid >= 30370750;
</pre>

Then from all 'tweet_foo' tables (the multiple values tables, where the problem actually is).

<pre>
mysql> show tables like "%tweet\_%";
</pre>

This will show something like this:
<pre>
+----------------------------------+
| Tables_in_tweets (tweet\_%) |
+----------------------------------+
| tweet__index |
| tweet__index_grep |
| tweet__ordervalues_en |
| tweet__rindex |
| tweet_has_next_in_tweetstreams |
| tweet_hashtags |
| tweet_target_urls |
| tweet_tweetees |
| tweet_tweetstreams |
| tweet_url_redirects_redirects_to |
| tweet_url_redirects_url |
| tweet_urls_from_text |
| tweet_urls_in_text |
+----------------------------------+
13 rows in set (0.00 sec)
</pre>

Ignore the tables that have '__' in them (tweet__index, tweet__index_grep, tweet__ordervalues_en, tweet__rindex), but repeat the delete command for all other tables:

<pre>
mysql> delete from tweet_has_next_in_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_hashtags where tweetid >= 30370750;
mysql> delete from tweet_target_urls where tweetid >= 30370750;
mysql> delete from tweet_tweetees where tweetid >= 30370750;
mysql> delete from tweet_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_redirects_to where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_url where tweetid >= 30370750;
mysql> delete from tweet_urls_from_text where tweetid >= 30370750;
mysql> delete from tweet_urls_in_text where tweetid >= 30370750;
</pre>

Tweepository

2015-12-18T12:17:44Z

Af05v@ecs.soton.ac.uk: /* Configuring a Web Observatory */

[[Category:EPrints 3 Plugins]]

The Tweepository plugin enables the repository to harvest a stream of tweets from a twitter search. This document applies to Tweepository 0.3.1.

== Installation Prerequisites ==

The following perl libraries must be installed on the server before the Bazaar package will function.

<pre>
Archive::Zip
Archive::Zip::MemberRead
Data::Dumper
Date::Calc
Date::Parse
Encode
File::Copy
File::Path
HTML::Entities
JSON
LWP::UserAgent
Number::Bytes::Human
Storable
URI
URI::Find
</pre>

== Installation ==

Install through the EPrints Bazaar

== Add Twitter API Keys ==

Create a file in your repository's cfg.d directory for your twitter API keys (e.g. called z_tweepository_oath.pl). The content should look like this:

<pre>
$c->{twitter_oauth}->{consumer_key} = 'xxxxxxxxxxxx';
$c->{twitter_oauth}->{consumer_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token} = 'xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
</pre>

== Setting Up Cron Jobs ==

There are three processes that need to be regularly run. Due to the heavyweight nature of these tasks, they should be put into the crontab rather than being handled by the EPrints Indexer. However, they have been created as event plugins for future inclusion in the indexer. Scripts have been created to wrap the plugins

Running these scripts will result in log files and a cache being created in the repository's 'var' directory. These should be checked if there are any issues with harvesting.

add the following to your eprints crontab (assuming EPrints is installed in '/opt/eprints3'):

<pre>
0,30 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstreams.pl REPOSITORYID
15 0 * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstream_abstracts.pl REPOSITORYID
45 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/export_tweetstream_packages.pl REPOSITORYID
</pre>

== Using ==

To create a new tweetstream, click on 'Manage Records', then on 'Twitter Feed', and then on the 'Create new Item' button. A new tweetstream object will be created, and you will need to enter two parameters:

[[File:tweepository_create.png]]

* Search String: Passed directly to Twitter as the search parameter.
* Expiry Date: The date on which to stop harvesting this stream.

Note that in version 0.3.1, more metadata fields have been added, most notably a 'project' field, which the default tweetstream browse views uses.

Once these fields have been completed, click 'Save and Return'.

== Harvesting ==

Every 20 minutes, the tweepository package will harvest each stream. No harvesting is done on creation, to the tweetstream will initially be empty. Tweets will be processed to:

*extract hashtags
*extract mentioned users

These data will be summarised in the tweetstream objects.

==URLs==

Note that URLs are no longer followed to expand shortened links. This is a target for future development.

== Viewing a Tweetstream ==

To view a tweetstream, click on 'Manage Records', then 'Twitter Feed':

[[File:Tweepository_manage.png]]

The above screen shows a list of all twitter streams that the logged in user has access to. Clicking on the view icon (the magnifying glass) will bring up the view screen, which shows all metadata set on this twitter feed. At the top of the page will be a link to the tweetstream's page. It will be of the form:

http://repository.foo.com/id/tweetstream/5

Below is an example of a tweetstream page:

[[File:Eprintstweetstream.png]]

== Exporting ==

Due to the architecture of the twitter feeds (see below), exporting using the standard eprints exporters (e.g. XML) will only work if both the tweet dataset and the tweetstream dataset are both exported. For this reason, export plugins have been provided for tweetstreams. Currently, a tweetstream can be exported as:

*CSV
*HTML
*JSON

Note that EPrints may struggle to export very large tweetstreams through the web interface. If there are more than several hundred thousand tweets, it may be advisable to export from the command line.

== Architecture ==

Both tweetstreams and tweets are EPrints Data Objects. Each tweet object stores the ID of all tweetstreams to which it belongs. This allows tweets to appear in more than one stream, but only be stored once in the database.

== Permissions ==

The z_tweepository_cfg.pl file contains the following:

<pre>
$c->{roles}->{"tweetstream-admin"} = [
"datasets",
"tweetstream/view",
"tweetstream/details",
"tweetstream/edit",
"tweetstream/create",
"tweetstream/destroy",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-editor"} = [
"datasets",
"tweetstream/view",
"tweetstream/details:owner",
"tweetstream/edit:owner",
"tweetstream/create",
"tweetstream/destroy:owner",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-viewer"} = [
"tweetstream/view",
"tweetstream/export",
];
push @{$c->{user_roles}->{admin}}, 'tweetstream-admin';
push @{$c->{user_roles}->{editor}}, 'tweetstream-editor';
push @{$c->{user_roles}->{user}}, 'tweetstream-viewer';
</pre>

This defines three roles. The admin role:

* Can create tweetstreams
* Can destroy tweetstreams
* Can see tweetstream details
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The editor role:

* Can create tweetstreams
* Can destroy tweetstreams that they created
* Can see details of tweetstreams that they created
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The viewer role:

* Can view tweetstream abstract pages (but need to know the URL)
* Can export tweetstreams

These three roles have been assigned to repository administrators, editors and users respectively. This can be changed by modifying this part of the config.

== Exporting to a Web Observatory ==

Tweet data can be exported nightly to a Web Observatory. This is accomplished by inserting tweet records into an external MongoDB database that has been set up by the administrators of the Web Observatory for this purpose.

=== Configuring a Web Observatory ===

An example web observatory configuration is visible in the z_tweepository_cfg.pl file. This should be copied to a new .pl file and an entry created for each Web Observatory database that is configured:

<source lang="perl">
$c->{web_observatories} =
{
'websobservatory1' =>
{
type => 'mongodb',
server => 'foo.bar.uk',
port => 1234,
db_name => 'foo',
username => 'username',
password => 'password',
authorised_users =>
[
'username1',
'username2'
]
}
};
</source>

To test, use the web_observatory_test.pl script:

perl -I/<eprints_root>/perl_lib /<eprints_root>/archives/<repositoryid>/bin/tweepository/web_observatory_test.pl <repositoryid> <webobservatoryid>

=== Configuring a TweetStream ===

When editing or creating a tweetstream, fill in the Web Observatory Export part of the workflow:

* Export To Web Observatory -- set to 'Yes'
* The ID of the web observatory -- In the above example, it would be 'webobservatory1'
* Web Observatory Collection -- the MongoDB collection that this will be inserted into. Note that:
** More that one tweetstream can be inserted into a collection
** The URL of the tweepository will be prepeneded onto the collection ID. If 'foo' is the collection name, then on the Web Observatory, the collection will be (e.g.) 'http://www.mytweepository.com/foo'

== Troubleshooting ==

If this error is observed when harvesting:

<pre>
DBD::mysql::st execute failed: Duplicate entry '30370867-0' for key 'PRIMARY' at /opt/eprints3/perl_lib/EPrints/Database.pm line 1249.
</pre>

...particularly after database corruption has been fixed, you'll need to sort out the database with some direct mysql queries. First make a note of the duplicate entry ID. In the above case, it's 30370867 (don't worry about the '-0' part). The problem is that there are some dirty records which need to be removed. Subtract a hundred or so from the Duplicate entry ID (e.g. down to a nice round 30370750) and we're going to remove any data with a higher ID than this.

First, from the tweet table:
<pre>
mysql> delete from tweet where tweetid >= 30370750;
</pre>

Then from all 'tweet_foo' tables (the multiple values tables, where the problem actually is).

<pre>
mysql> show tables like "%tweet\_%";
</pre>

This will show something like this:
<pre>
+----------------------------------+
| Tables_in_tweets (tweet\_%) |
+----------------------------------+
| tweet__index |
| tweet__index_grep |
| tweet__ordervalues_en |
| tweet__rindex |
| tweet_has_next_in_tweetstreams |
| tweet_hashtags |
| tweet_target_urls |
| tweet_tweetees |
| tweet_tweetstreams |
| tweet_url_redirects_redirects_to |
| tweet_url_redirects_url |
| tweet_urls_from_text |
| tweet_urls_in_text |
+----------------------------------+
13 rows in set (0.00 sec)
</pre>

Ignore the tables that have '__' in them (tweet__index, tweet__index_grep, tweet__ordervalues_en, tweet__rindex), but repeat the delete command for all other tables:

<pre>
mysql> delete from tweet_has_next_in_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_hashtags where tweetid >= 30370750;
mysql> delete from tweet_target_urls where tweetid >= 30370750;
mysql> delete from tweet_tweetees where tweetid >= 30370750;
mysql> delete from tweet_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_redirects_to where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_url where tweetid >= 30370750;
mysql> delete from tweet_urls_from_text where tweetid >= 30370750;
mysql> delete from tweet_urls_in_text where tweetid >= 30370750;
</pre>

Tweepository

2015-12-18T12:17:05Z

Af05v@ecs.soton.ac.uk: /* Configuring a TweetStream */

[[Category:EPrints 3 Plugins]]

The Tweepository plugin enables the repository to harvest a stream of tweets from a twitter search. This document applies to Tweepository 0.3.1.

== Installation Prerequisites ==

The following perl libraries must be installed on the server before the Bazaar package will function.

<pre>
Archive::Zip
Archive::Zip::MemberRead
Data::Dumper
Date::Calc
Date::Parse
Encode
File::Copy
File::Path
HTML::Entities
JSON
LWP::UserAgent
Number::Bytes::Human
Storable
URI
URI::Find
</pre>

== Installation ==

Install through the EPrints Bazaar

== Add Twitter API Keys ==

Create a file in your repository's cfg.d directory for your twitter API keys (e.g. called z_tweepository_oath.pl). The content should look like this:

<pre>
$c->{twitter_oauth}->{consumer_key} = 'xxxxxxxxxxxx';
$c->{twitter_oauth}->{consumer_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token} = 'xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
</pre>

== Setting Up Cron Jobs ==

There are three processes that need to be regularly run. Due to the heavyweight nature of these tasks, they should be put into the crontab rather than being handled by the EPrints Indexer. However, they have been created as event plugins for future inclusion in the indexer. Scripts have been created to wrap the plugins

Running these scripts will result in log files and a cache being created in the repository's 'var' directory. These should be checked if there are any issues with harvesting.

add the following to your eprints crontab (assuming EPrints is installed in '/opt/eprints3'):

<pre>
0,30 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstreams.pl REPOSITORYID
15 0 * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstream_abstracts.pl REPOSITORYID
45 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/export_tweetstream_packages.pl REPOSITORYID
</pre>

== Using ==

To create a new tweetstream, click on 'Manage Records', then on 'Twitter Feed', and then on the 'Create new Item' button. A new tweetstream object will be created, and you will need to enter two parameters:

[[File:tweepository_create.png]]

* Search String: Passed directly to Twitter as the search parameter.
* Expiry Date: The date on which to stop harvesting this stream.

Note that in version 0.3.1, more metadata fields have been added, most notably a 'project' field, which the default tweetstream browse views uses.

Once these fields have been completed, click 'Save and Return'.

== Harvesting ==

Every 20 minutes, the tweepository package will harvest each stream. No harvesting is done on creation, to the tweetstream will initially be empty. Tweets will be processed to:

*extract hashtags
*extract mentioned users

These data will be summarised in the tweetstream objects.

==URLs==

Note that URLs are no longer followed to expand shortened links. This is a target for future development.

== Viewing a Tweetstream ==

To view a tweetstream, click on 'Manage Records', then 'Twitter Feed':

[[File:Tweepository_manage.png]]

The above screen shows a list of all twitter streams that the logged in user has access to. Clicking on the view icon (the magnifying glass) will bring up the view screen, which shows all metadata set on this twitter feed. At the top of the page will be a link to the tweetstream's page. It will be of the form:

http://repository.foo.com/id/tweetstream/5

Below is an example of a tweetstream page:

[[File:Eprintstweetstream.png]]

== Exporting ==

Due to the architecture of the twitter feeds (see below), exporting using the standard eprints exporters (e.g. XML) will only work if both the tweet dataset and the tweetstream dataset are both exported. For this reason, export plugins have been provided for tweetstreams. Currently, a tweetstream can be exported as:

*CSV
*HTML
*JSON

Note that EPrints may struggle to export very large tweetstreams through the web interface. If there are more than several hundred thousand tweets, it may be advisable to export from the command line.

== Architecture ==

Both tweetstreams and tweets are EPrints Data Objects. Each tweet object stores the ID of all tweetstreams to which it belongs. This allows tweets to appear in more than one stream, but only be stored once in the database.

== Permissions ==

The z_tweepository_cfg.pl file contains the following:

<pre>
$c->{roles}->{"tweetstream-admin"} = [
"datasets",
"tweetstream/view",
"tweetstream/details",
"tweetstream/edit",
"tweetstream/create",
"tweetstream/destroy",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-editor"} = [
"datasets",
"tweetstream/view",
"tweetstream/details:owner",
"tweetstream/edit:owner",
"tweetstream/create",
"tweetstream/destroy:owner",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-viewer"} = [
"tweetstream/view",
"tweetstream/export",
];
push @{$c->{user_roles}->{admin}}, 'tweetstream-admin';
push @{$c->{user_roles}->{editor}}, 'tweetstream-editor';
push @{$c->{user_roles}->{user}}, 'tweetstream-viewer';
</pre>

This defines three roles. The admin role:

* Can create tweetstreams
* Can destroy tweetstreams
* Can see tweetstream details
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The editor role:

* Can create tweetstreams
* Can destroy tweetstreams that they created
* Can see details of tweetstreams that they created
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The viewer role:

* Can view tweetstream abstract pages (but need to know the URL)
* Can export tweetstreams

These three roles have been assigned to repository administrators, editors and users respectively. This can be changed by modifying this part of the config.

== Exporting to a Web Observatory ==

Tweet data can be exported nightly to a Web Observatory. This is accomplished by inserting tweet records into an external MongoDB database that has been set up by the administrators of the Web Observatory for this purpose.

=== Configuring a Web Observatory ===

An example web observatory configuration is visible in the z_tweepository_cfg.pl file. This should be copied to a new .pl file and an entry created for each Web Observatory database that is configured:

<source lang="perl'>
$c->{web_observatories} =
{
'websobservatory1' =>
{
type => 'mongodb',
server => 'foo.bar.uk',
port => 1234,
db_name => 'foo',
username => 'username',
password => 'password',
authorised_users =>
[
'username1',
'username2'
]
}
};
</source>

To test, use the web_observatory_test.pl script:

perl -I/<eprints_root>/perl_lib /<eprints_root>/archives/<repositoryid>/bin/tweepository/web_observatory_test.pl <repositoryid> <webobservatoryid>

=== Configuring a TweetStream ===

When editing or creating a tweetstream, fill in the Web Observatory Export part of the workflow:

* Export To Web Observatory -- set to 'Yes'
* The ID of the web observatory -- In the above example, it would be 'webobservatory1'
* Web Observatory Collection -- the MongoDB collection that this will be inserted into. Note that:
** More that one tweetstream can be inserted into a collection
** The URL of the tweepository will be prepeneded onto the collection ID. If 'foo' is the collection name, then on the Web Observatory, the collection will be (e.g.) 'http://www.mytweepository.com/foo'

== Troubleshooting ==

If this error is observed when harvesting:

<pre>
DBD::mysql::st execute failed: Duplicate entry '30370867-0' for key 'PRIMARY' at /opt/eprints3/perl_lib/EPrints/Database.pm line 1249.
</pre>

...particularly after database corruption has been fixed, you'll need to sort out the database with some direct mysql queries. First make a note of the duplicate entry ID. In the above case, it's 30370867 (don't worry about the '-0' part). The problem is that there are some dirty records which need to be removed. Subtract a hundred or so from the Duplicate entry ID (e.g. down to a nice round 30370750) and we're going to remove any data with a higher ID than this.

First, from the tweet table:
<pre>
mysql> delete from tweet where tweetid >= 30370750;
</pre>

Then from all 'tweet_foo' tables (the multiple values tables, where the problem actually is).

<pre>
mysql> show tables like "%tweet\_%";
</pre>

This will show something like this:
<pre>
+----------------------------------+
| Tables_in_tweets (tweet\_%) |
+----------------------------------+
| tweet__index |
| tweet__index_grep |
| tweet__ordervalues_en |
| tweet__rindex |
| tweet_has_next_in_tweetstreams |
| tweet_hashtags |
| tweet_target_urls |
| tweet_tweetees |
| tweet_tweetstreams |
| tweet_url_redirects_redirects_to |
| tweet_url_redirects_url |
| tweet_urls_from_text |
| tweet_urls_in_text |
+----------------------------------+
13 rows in set (0.00 sec)
</pre>

Ignore the tables that have '__' in them (tweet__index, tweet__index_grep, tweet__ordervalues_en, tweet__rindex), but repeat the delete command for all other tables:

<pre>
mysql> delete from tweet_has_next_in_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_hashtags where tweetid >= 30370750;
mysql> delete from tweet_target_urls where tweetid >= 30370750;
mysql> delete from tweet_tweetees where tweetid >= 30370750;
mysql> delete from tweet_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_redirects_to where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_url where tweetid >= 30370750;
mysql> delete from tweet_urls_from_text where tweetid >= 30370750;
mysql> delete from tweet_urls_in_text where tweetid >= 30370750;
</pre>

Tweepository

2015-12-18T12:15:02Z

Af05v@ecs.soton.ac.uk: /* Exporting to a Web Observatory */

[[Category:EPrints 3 Plugins]]

The Tweepository plugin enables the repository to harvest a stream of tweets from a twitter search. This document applies to Tweepository 0.3.1.

== Installation Prerequisites ==

The following perl libraries must be installed on the server before the Bazaar package will function.

<pre>
Archive::Zip
Archive::Zip::MemberRead
Data::Dumper
Date::Calc
Date::Parse
Encode
File::Copy
File::Path
HTML::Entities
JSON
LWP::UserAgent
Number::Bytes::Human
Storable
URI
URI::Find
</pre>

== Installation ==

Install through the EPrints Bazaar

== Add Twitter API Keys ==

Create a file in your repository's cfg.d directory for your twitter API keys (e.g. called z_tweepository_oath.pl). The content should look like this:

<pre>
$c->{twitter_oauth}->{consumer_key} = 'xxxxxxxxxxxx';
$c->{twitter_oauth}->{consumer_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token} = 'xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
</pre>

== Setting Up Cron Jobs ==

There are three processes that need to be regularly run. Due to the heavyweight nature of these tasks, they should be put into the crontab rather than being handled by the EPrints Indexer. However, they have been created as event plugins for future inclusion in the indexer. Scripts have been created to wrap the plugins

Running these scripts will result in log files and a cache being created in the repository's 'var' directory. These should be checked if there are any issues with harvesting.

add the following to your eprints crontab (assuming EPrints is installed in '/opt/eprints3'):

<pre>
0,30 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstreams.pl REPOSITORYID
15 0 * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstream_abstracts.pl REPOSITORYID
45 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/export_tweetstream_packages.pl REPOSITORYID
</pre>

== Using ==

To create a new tweetstream, click on 'Manage Records', then on 'Twitter Feed', and then on the 'Create new Item' button. A new tweetstream object will be created, and you will need to enter two parameters:

[[File:tweepository_create.png]]

* Search String: Passed directly to Twitter as the search parameter.
* Expiry Date: The date on which to stop harvesting this stream.

Note that in version 0.3.1, more metadata fields have been added, most notably a 'project' field, which the default tweetstream browse views uses.

Once these fields have been completed, click 'Save and Return'.

== Harvesting ==

Every 20 minutes, the tweepository package will harvest each stream. No harvesting is done on creation, to the tweetstream will initially be empty. Tweets will be processed to:

*extract hashtags
*extract mentioned users

These data will be summarised in the tweetstream objects.

==URLs==

Note that URLs are no longer followed to expand shortened links. This is a target for future development.

== Viewing a Tweetstream ==

To view a tweetstream, click on 'Manage Records', then 'Twitter Feed':

[[File:Tweepository_manage.png]]

The above screen shows a list of all twitter streams that the logged in user has access to. Clicking on the view icon (the magnifying glass) will bring up the view screen, which shows all metadata set on this twitter feed. At the top of the page will be a link to the tweetstream's page. It will be of the form:

http://repository.foo.com/id/tweetstream/5

Below is an example of a tweetstream page:

[[File:Eprintstweetstream.png]]

== Exporting ==

Due to the architecture of the twitter feeds (see below), exporting using the standard eprints exporters (e.g. XML) will only work if both the tweet dataset and the tweetstream dataset are both exported. For this reason, export plugins have been provided for tweetstreams. Currently, a tweetstream can be exported as:

*CSV
*HTML
*JSON

Note that EPrints may struggle to export very large tweetstreams through the web interface. If there are more than several hundred thousand tweets, it may be advisable to export from the command line.

== Architecture ==

Both tweetstreams and tweets are EPrints Data Objects. Each tweet object stores the ID of all tweetstreams to which it belongs. This allows tweets to appear in more than one stream, but only be stored once in the database.

== Permissions ==

The z_tweepository_cfg.pl file contains the following:

<pre>
$c->{roles}->{"tweetstream-admin"} = [
"datasets",
"tweetstream/view",
"tweetstream/details",
"tweetstream/edit",
"tweetstream/create",
"tweetstream/destroy",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-editor"} = [
"datasets",
"tweetstream/view",
"tweetstream/details:owner",
"tweetstream/edit:owner",
"tweetstream/create",
"tweetstream/destroy:owner",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-viewer"} = [
"tweetstream/view",
"tweetstream/export",
];
push @{$c->{user_roles}->{admin}}, 'tweetstream-admin';
push @{$c->{user_roles}->{editor}}, 'tweetstream-editor';
push @{$c->{user_roles}->{user}}, 'tweetstream-viewer';
</pre>

This defines three roles. The admin role:

* Can create tweetstreams
* Can destroy tweetstreams
* Can see tweetstream details
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The editor role:

* Can create tweetstreams
* Can destroy tweetstreams that they created
* Can see details of tweetstreams that they created
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The viewer role:

* Can view tweetstream abstract pages (but need to know the URL)
* Can export tweetstreams

These three roles have been assigned to repository administrators, editors and users respectively. This can be changed by modifying this part of the config.

== Exporting to a Web Observatory ==

Tweet data can be exported nightly to a Web Observatory. This is accomplished by inserting tweet records into an external MongoDB database that has been set up by the administrators of the Web Observatory for this purpose.

=== Configuring a Web Observatory ===

An example web observatory configuration is visible in the z_tweepository_cfg.pl file. This should be copied to a new .pl file and an entry created for each Web Observatory database that is configured:

<source lang="perl'>
$c->{web_observatories} =
{
'websobservatory1' =>
{
type => 'mongodb',
server => 'foo.bar.uk',
port => 1234,
db_name => 'foo',
username => 'username',
password => 'password',
authorised_users =>
[
'username1',
'username2'
]
}
};
</source>

To test, use the web_observatory_test.pl script:

perl -I/<eprints_root>/perl_lib /<eprints_root>/archives/<repositoryid>/bin/tweepository/web_observatory_test.pl <repositoryid> <webobservatoryid>

=== Configuring a TweetStream ===

When editing or creating a tweetstream, fill in the Web Observatory Export part of the workflow:

* Export To Web Observatory -- set to 'Yes'
* The ID of the web observatory -- In the above example, it would be 'webobservatory1'
* Web Observatory Collection -- the MongoDB collection that this will be inserted into. Note that:

== Troubleshooting ==

If this error is observed when harvesting:

<pre>
DBD::mysql::st execute failed: Duplicate entry '30370867-0' for key 'PRIMARY' at /opt/eprints3/perl_lib/EPrints/Database.pm line 1249.
</pre>

...particularly after database corruption has been fixed, you'll need to sort out the database with some direct mysql queries. First make a note of the duplicate entry ID. In the above case, it's 30370867 (don't worry about the '-0' part). The problem is that there are some dirty records which need to be removed. Subtract a hundred or so from the Duplicate entry ID (e.g. down to a nice round 30370750) and we're going to remove any data with a higher ID than this.

First, from the tweet table:
<pre>
mysql> delete from tweet where tweetid >= 30370750;
</pre>

Then from all 'tweet_foo' tables (the multiple values tables, where the problem actually is).

<pre>
mysql> show tables like "%tweet\_%";
</pre>

This will show something like this:
<pre>
+----------------------------------+
| Tables_in_tweets (tweet\_%) |
+----------------------------------+
| tweet__index |
| tweet__index_grep |
| tweet__ordervalues_en |
| tweet__rindex |
| tweet_has_next_in_tweetstreams |
| tweet_hashtags |
| tweet_target_urls |
| tweet_tweetees |
| tweet_tweetstreams |
| tweet_url_redirects_redirects_to |
| tweet_url_redirects_url |
| tweet_urls_from_text |
| tweet_urls_in_text |
+----------------------------------+
13 rows in set (0.00 sec)
</pre>

Ignore the tables that have '__' in them (tweet__index, tweet__index_grep, tweet__ordervalues_en, tweet__rindex), but repeat the delete command for all other tables:

<pre>
mysql> delete from tweet_has_next_in_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_hashtags where tweetid >= 30370750;
mysql> delete from tweet_target_urls where tweetid >= 30370750;
mysql> delete from tweet_tweetees where tweetid >= 30370750;
mysql> delete from tweet_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_redirects_to where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_url where tweetid >= 30370750;
mysql> delete from tweet_urls_from_text where tweetid >= 30370750;
mysql> delete from tweet_urls_in_text where tweetid >= 30370750;
</pre>

Tweepository

2015-12-18T11:54:31Z

Af05v@ecs.soton.ac.uk:

[[Category:EPrints 3 Plugins]]

The Tweepository plugin enables the repository to harvest a stream of tweets from a twitter search. This document applies to Tweepository 0.3.1.

== Installation Prerequisites ==

The following perl libraries must be installed on the server before the Bazaar package will function.

<pre>
Archive::Zip
Archive::Zip::MemberRead
Data::Dumper
Date::Calc
Date::Parse
Encode
File::Copy
File::Path
HTML::Entities
JSON
LWP::UserAgent
Number::Bytes::Human
Storable
URI
URI::Find
</pre>

== Installation ==

Install through the EPrints Bazaar

== Add Twitter API Keys ==

Create a file in your repository's cfg.d directory for your twitter API keys (e.g. called z_tweepository_oath.pl). The content should look like this:

<pre>
$c->{twitter_oauth}->{consumer_key} = 'xxxxxxxxxxxx';
$c->{twitter_oauth}->{consumer_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token} = 'xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx';
$c->{twitter_oauth}->{access_token_secret} = 'xxxxxxxxxxxxxxxxxxxxxxxx';
</pre>

== Setting Up Cron Jobs ==

There are three processes that need to be regularly run. Due to the heavyweight nature of these tasks, they should be put into the crontab rather than being handled by the EPrints Indexer. However, they have been created as event plugins for future inclusion in the indexer. Scripts have been created to wrap the plugins

Running these scripts will result in log files and a cache being created in the repository's 'var' directory. These should be checked if there are any issues with harvesting.

add the following to your eprints crontab (assuming EPrints is installed in '/opt/eprints3'):

<pre>
0,30 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstreams.pl REPOSITORYID
15 0 * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/update_tweetstream_abstracts.pl REPOSITORYID
45 * * * * perl -I/opt/eprints3/perl_lib /opt/eprints3/archives/REPOSITORYID/bin/export_tweetstream_packages.pl REPOSITORYID
</pre>

== Using ==

To create a new tweetstream, click on 'Manage Records', then on 'Twitter Feed', and then on the 'Create new Item' button. A new tweetstream object will be created, and you will need to enter two parameters:

[[File:tweepository_create.png]]

* Search String: Passed directly to Twitter as the search parameter.
* Expiry Date: The date on which to stop harvesting this stream.

Note that in version 0.3.1, more metadata fields have been added, most notably a 'project' field, which the default tweetstream browse views uses.

Once these fields have been completed, click 'Save and Return'.

== Harvesting ==

Every 20 minutes, the tweepository package will harvest each stream. No harvesting is done on creation, to the tweetstream will initially be empty. Tweets will be processed to:

*extract hashtags
*extract mentioned users

These data will be summarised in the tweetstream objects.

==URLs==

Note that URLs are no longer followed to expand shortened links. This is a target for future development.

== Viewing a Tweetstream ==

To view a tweetstream, click on 'Manage Records', then 'Twitter Feed':

[[File:Tweepository_manage.png]]

The above screen shows a list of all twitter streams that the logged in user has access to. Clicking on the view icon (the magnifying glass) will bring up the view screen, which shows all metadata set on this twitter feed. At the top of the page will be a link to the tweetstream's page. It will be of the form:

http://repository.foo.com/id/tweetstream/5

Below is an example of a tweetstream page:

[[File:Eprintstweetstream.png]]

== Exporting ==

Due to the architecture of the twitter feeds (see below), exporting using the standard eprints exporters (e.g. XML) will only work if both the tweet dataset and the tweetstream dataset are both exported. For this reason, export plugins have been provided for tweetstreams. Currently, a tweetstream can be exported as:

*CSV
*HTML
*JSON

Note that EPrints may struggle to export very large tweetstreams through the web interface. If there are more than several hundred thousand tweets, it may be advisable to export from the command line.

== Architecture ==

Both tweetstreams and tweets are EPrints Data Objects. Each tweet object stores the ID of all tweetstreams to which it belongs. This allows tweets to appear in more than one stream, but only be stored once in the database.

== Permissions ==

The z_tweepository_cfg.pl file contains the following:

<pre>
$c->{roles}->{"tweetstream-admin"} = [
"datasets",
"tweetstream/view",
"tweetstream/details",
"tweetstream/edit",
"tweetstream/create",
"tweetstream/destroy",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-editor"} = [
"datasets",
"tweetstream/view",
"tweetstream/details:owner",
"tweetstream/edit:owner",
"tweetstream/create",
"tweetstream/destroy:owner",
"tweetstream/export",
];
$c->{roles}->{"tweetstream-viewer"} = [
"tweetstream/view",
"tweetstream/export",
];
push @{$c->{user_roles}->{admin}}, 'tweetstream-admin';
push @{$c->{user_roles}->{editor}}, 'tweetstream-editor';
push @{$c->{user_roles}->{user}}, 'tweetstream-viewer';
</pre>

This defines three roles. The admin role:

* Can create tweetstreams
* Can destroy tweetstreams
* Can see tweetstream details
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The editor role:

* Can create tweetstreams
* Can destroy tweetstreams that they created
* Can see details of tweetstreams that they created
* Can see the list of tweetstreams in 'Manage Records'
* Can view tweetstream abstract pages
* Can export tweetstreams

The viewer role:

* Can view tweetstream abstract pages (but need to know the URL)
* Can export tweetstreams

These three roles have been assigned to repository administrators, editors and users respectively. This can be changed by modifying this part of the config.

== Exporting to a Web Observatory ==

== Troubleshooting ==

If this error is observed when harvesting:

<pre>
DBD::mysql::st execute failed: Duplicate entry '30370867-0' for key 'PRIMARY' at /opt/eprints3/perl_lib/EPrints/Database.pm line 1249.
</pre>

...particularly after database corruption has been fixed, you'll need to sort out the database with some direct mysql queries. First make a note of the duplicate entry ID. In the above case, it's 30370867 (don't worry about the '-0' part). The problem is that there are some dirty records which need to be removed. Subtract a hundred or so from the Duplicate entry ID (e.g. down to a nice round 30370750) and we're going to remove any data with a higher ID than this.

First, from the tweet table:
<pre>
mysql> delete from tweet where tweetid >= 30370750;
</pre>

Then from all 'tweet_foo' tables (the multiple values tables, where the problem actually is).

<pre>
mysql> show tables like "%tweet\_%";
</pre>

This will show something like this:
<pre>
+----------------------------------+
| Tables_in_tweets (tweet\_%) |
+----------------------------------+
| tweet__index |
| tweet__index_grep |
| tweet__ordervalues_en |
| tweet__rindex |
| tweet_has_next_in_tweetstreams |
| tweet_hashtags |
| tweet_target_urls |
| tweet_tweetees |
| tweet_tweetstreams |
| tweet_url_redirects_redirects_to |
| tweet_url_redirects_url |
| tweet_urls_from_text |
| tweet_urls_in_text |
+----------------------------------+
13 rows in set (0.00 sec)
</pre>

Ignore the tables that have '__' in them (tweet__index, tweet__index_grep, tweet__ordervalues_en, tweet__rindex), but repeat the delete command for all other tables:

<pre>
mysql> delete from tweet_has_next_in_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_hashtags where tweetid >= 30370750;
mysql> delete from tweet_target_urls where tweetid >= 30370750;
mysql> delete from tweet_tweetees where tweetid >= 30370750;
mysql> delete from tweet_tweetstreams where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_redirects_to where tweetid >= 30370750;
mysql> delete from tweet_url_redirects_url where tweetid >= 30370750;
mysql> delete from tweet_urls_from_text where tweetid >= 30370750;
mysql> delete from tweet_urls_in_text where tweetid >= 30370750;
</pre>

Training Video:Technical Orientation

2015-12-09T12:51:01Z

Af05v@ecs.soton.ac.uk: Created page with "Category:Howto Technical Orientation ==Introduction== Prose: Why should you watch this video, what is the purpose in EPrints of the thing tha..."

[[Category:Howto]]
[[Category:Training_Video|Technical Orientation]]

==Introduction==

Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?

==What You Will Learn==

* Learning Objective 1
* Learning Objective 2
* Learning Objective 3

==What You Should Already Know==

* Prerequisite 1 with links if appropriate
* Prerequisite 2 with links if appropriate
* Prerequisite 3 with links if appropriate

==Resources==

=== Video===
The Video can be found at [http://youtu.be/-D4hEsRB0g4 http://youtu.be/-D4hEsRB0g4].
====Index====

==== The Video====
<youtube>-D4hEsRB0g4</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

Exercises as appropriate to allow the learner to practice the subject of the page.

==More Reading==

* Wiki page 1
* Wiki page 2
* Wiki page 3

Category:Training Video

2015-12-09T12:49:46Z

Af05v@ecs.soton.ac.uk: /* Maintaining and Developing EPrints */

__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
* [[Training_Video:Browsing|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]]
* Using pins within phrases and 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
* [[Trianing_Video:Browse_View_configuration|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
* Adding New Fields
**[[Training_Video:Add_A_Field|Adding a Simple Metadata Field]]
**Add a compound multiple 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 ==

* [[Training Video:Technical Orientation|Technical Orientation]]

=== Systems Administration ===
* [[Training_Video:EPrints_Install|Installing EPrints]]
* [[Training Video:Setting up SSL|Setting up SSL (https)]]
* 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]].

In the training course above, any items that are not linked to pages require a resource (e.g. a video) and a training course page to be created.

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).

-

Training Video:Setting up SSL

2015-12-09T12:49:03Z

Af05v@ecs.soton.ac.uk: /* Resources */

[[Category:Howto]]
[[Category:Training_Video|Template]]

==Introduction==

Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?

==What You Will Learn==

* Learning Objective 1
* Learning Objective 2
* Learning Objective 3

==What You Should Already Know==

* Prerequisite 1 with links if appropriate
* Prerequisite 2 with links if appropriate
* Prerequisite 3 with links if appropriate

==Resources==

Each resource on this page (video, document, block of wiki text) should have a similar format to the Video section below.

=== Video===
The Video can be found at [http://youtu.be/SzLVBZ-wecA http://youtu.be/SzLVBZ-wecA].
====Index====

==== The Video====
<youtube>SzLVBZ-wecA</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14
* Ubuntu 15.04

==Test Yourself==

Exercises as appropriate to allow the learner to practice the subject of the page.

==More Reading==

* Wiki page 1
* Wiki page 2
* Wiki page 3

Category:Training Video

2015-12-09T12:47:36Z

Af05v@ecs.soton.ac.uk: /* Systems Administration */

__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
* [[Training_Video:Browsing|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]]
* Using pins within phrases and 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
* [[Trianing_Video:Browse_View_configuration|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
* Adding New Fields
**[[Training_Video:Add_A_Field|Adding a Simple Metadata Field]]
**Add a compound multiple 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]]
* [[Training Video:Setting up SSL|Setting up SSL (https)]]
* 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]].

In the training course above, any items that are not linked to pages require a resource (e.g. a video) and a training course page to be created.

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).

-

Training Video:EPrints Wiki Basics

2015-12-09T12:46:42Z

Af05v@ecs.soton.ac.uk: /* Notes and Additional Information */

[[Category:Howto]]
[[Category:Training_Video|EPrints Wiki Basics]]

[[Category:Howto]]
[[Category:Training_Video|Template]]

==Introduction==

Know nothing about wikis? That's OK. Wikis are simple and there are people to help you.

==What You Will Learn==

* How to create an account on this wiki
* How to edit an existing wiki page
* How to create a new wiki page
* How to create headings and links

==What You Should Already Know==

* No prior knowledge required

==Resources==

=== Video===
The Video can be found at [http://www.youtube.com/watch?v=lGez1YNcIPc http://www.youtube.com/watch?v=lGez1YNcIPc].

====Index====
* [http://youtu.be/lGez1YNcIPc?t=00m00s 00:00 - Introduction]
* [http://youtu.be/lGez1YNcIPc?t=00m18s 00:18 - Creating an Account]
* [http://youtu.be/lGez1YNcIPc?t=00m48s 00:48 - Verifying email address]
* [http://youtu.be/lGez1YNcIPc?t=01m11s 01:11 - Loggin in]
* [http://youtu.be/lGez1YNcIPc?t=01m56s 01:56 - Editing a page]
* [http://youtu.be/lGez1YNcIPc?t=02m31s 02:31 - Creating a new page]
* [http://youtu.be/lGez1YNcIPc?t=02m55s 02:55 - Basic wiki formatting (Headings, paragraphs, bulleted lists, links)]
* [http://youtu.be/lGez1YNcIPc?t=06m18s 06:18 - Categories]

====The Video====
<youtube>lGez1YNcIPc</youtube>

====Notes and Additional Information====

The wiki was upgraded in early December, 2015. It is no longer tied to EPrints LDAP. Due to a spam problem, account creation has been disabled. Please post a message to eprints-tech if you would like a wiki account.

==Test Yourself==

* Create an account on the EPrints wiki
* Add your name to the list below
** Rachel Proudfoot
** Adam Field
* Edit the [[Demonstration Page]] that was created in the video.

==More Reading==

* [[Wiki_editing_guidlines|Wiki Editing Guidelines]]
* http://www.mediawiki.org/wiki/Help:Formatting

Training Video:Browse View configuration

2015-11-26T17:27:34Z

Af05v@ecs.soton.ac.uk: /* Index */

[[Category:Howto]]
[[Category:Training_Video|Browse View Configuration]]
[[Category:Documentation_Needed]]

==Introduction==

Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?

==What You Will Learn==

* Learning Objective 1
* Learning Objective 2
* Learning Objective 3

==What You Should Already Know==

* Prerequisite 1 with links if appropriate
* Prerequisite 2 with links if appropriate
* Prerequisite 3 with links if appropriate

==Resources==

Each resource on this page (video, document, block of wiki text) should have a similar format to the Video section below.

=== Video===
The Video can be found at [http://youtu.be/Ap_u7_MCnhI http://youtu.be/Ap_u7_MCnhI].
====Index====
* [http://youtu.be/Ap_u7_MCnhI?t=0m00s 0:00 - What is a browse view]
* [http://youtu.be/Ap_u7_MCnhI?t=0m50s 0:50 - .include files (unbranded lists)]
* [http://youtu.be/Ap_u7_MCnhI?t=1m20s 1:20 - columns and pages on browse menus]
* [http://youtu.be/Ap_u7_MCnhI?t=1m50s 1:50 - configuration file overview (from front end)]
* [http://youtu.be/Ap_u7_MCnhI?t=2m50s 2:50 - multiple-menu views]
* [http://youtu.be/Ap_u7_MCnhI?t=3m30s 3:30 - value ranges on menus]
* [http://youtu.be/Ap_u7_MCnhI?t=4m24s 4:24 - variations on lists]
* [http://youtu.be/Ap_u7_MCnhI?t=4m47s 4:47 - hideempty]
* [http://youtu.be/Ap_u7_MCnhI?t=5m43s 5:43 - regenerating browse views]
* [http://youtu.be/Ap_u7_MCnhI?t=8m08s 8:08 - reloading the configuration]
* [http://youtu.be/Ap_u7_MCnhI?t=9m11s 9:11 - create new browse view (on the command line)]
* [http://youtu.be/Ap_u7_MCnhI?t=13m27s 13:27 - controlling columns on menus]
* [http://youtu.be/Ap_u7_MCnhI?t=13m48s 13:48 - reloading the configuration and refreshing the views (on the command line)]
* [http://youtu.be/Ap_u7_MCnhI?t=15m59s 15:59 - change rendering of browse list]
* [http://youtu.be/Ap_u7_MCnhI?t=16m20s 16:20 - creating render function]
* [http://youtu.be/Ap_u7_MCnhI?t=18m30s 18:30 - creating a DOM object]
* [http://youtu.be/Ap_u7_MCnhI?t=19m42s 19:42 - rendering an eprint with a custom citation style]
* [http://youtu.be/Ap_u7_MCnhI?t=20m30s 20:30 - generating just one view]
* [http://youtu.be/Ap_u7_MCnhI?t=21m35s 21:35 - running epadmin test]
* [http://youtu.be/Ap_u7_MCnhI?t=22m55s 22:55 - example of custom rendered browse view]
* [http://youtu.be/Ap_u7_MCnhI?t=24m13s 24:13 - set citation style on a view list]
* [http://youtu.be/Ap_u7_MCnhI?t=24m44s 24:44 - creating a citation style]
* [http://youtu.be/Ap_u7_MCnhI?t=26m50s 26:50 - optimising browse view generation]
* [http://youtu.be/Ap_u7_MCnhI?t=27m37s 27:37 - increasing the browse view timeout]
* [http://youtu.be/Ap_u7_MCnhI?t=28m08s 28:08 - max items parameter]
* [http://youtu.be/Ap_u7_MCnhI?t=28m40s 28:40 - finding documentation on the EPrints wiki]
* [http://youtu.be/Ap_u7_MCnhI?t=30m05s 30:05 - setting max_list_age and max_menu_age (witout modifying default configuration files)]
* [http://youtu.be/Ap_u7_MCnhI?t=32m10s 32:10 - modifying existing configuration with a loop]
* [http://youtu.be/Ap_u7_MCnhI?t=35m38s 35:38 - confirming properties are set]
* [http://youtu.be/Ap_u7_MCnhI?t=37m35s 37:35 - nightly generation of single browse views]

==== The Video====
<youtube>Ap_u7_MCnhI</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14

==Test Yourself==

Exercises as appropriate to allow the learner to practice the subject of the page.

==More Reading==

* Wiki page 1
* Wiki page 2
* Wiki page 3

Training Video:Browse View configuration

2015-11-26T14:32:39Z

Af05v@ecs.soton.ac.uk:

Training Video:Browse View configuration

2015-11-26T14:32:07Z

Af05v@ecs.soton.ac.uk: Created page with 'Category:Howto Template Category:Documentation_Needed ==Introduction== Prose: Why should you watch this video, what is the purpose in EPrint…'

[[Category:Howto]]
[[Category:Training_Video|Template]]
[[Category:Documentation_Needed]]

==Introduction==

Prose: Why should you watch this video, what is the purpose in EPrints of the thing that you’re learning?

==What You Will Learn==

* Learning Objective 1
* Learning Objective 2
* Learning Objective 3

==What You Should Already Know==

* Prerequisite 1 with links if appropriate
* Prerequisite 2 with links if appropriate
* Prerequisite 3 with links if appropriate

==Resources==

Each resource on this page (video, document, block of wiki text) should have a similar format to the Video section below.

=== Video===
The Video can be found at [http://youtu.be/Ap_u7_MCnhI http://youtu.be/Ap_u7_MCnhI].
====Index====

==== The Video====
<youtube>Ap_u7_MCnhI</youtube>

====Notes, Errata and Additional Information====

Any notes, version information, errata, etc concerned with this video

* EPrints 3.3.14

==Test Yourself==

Exercises as appropriate to allow the learner to practice the subject of the page.

==More Reading==

* Wiki page 1
* Wiki page 2
* Wiki page 3

Category:Training Video

2015-11-26T14:30:17Z

Af05v@ecs.soton.ac.uk: /* Basic Configuration */

__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
* [[Training_Video:Browsing|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]]
* Using pins within phrases and 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
* [[Trianing_Video:Browse_View_configuration|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
* Adding New Fields
**[[Training_Video:Add_A_Field|Adding a Simple Metadata Field]]
**Add a compound multiple 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]]
* Setting up SSL (https)
* 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]].

In the training course above, any items that are not linked to pages require a resource (e.g. a video) and a training course page to be created.

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).

-

Category:Training Video

2015-11-24T11:10:36Z

Af05v@ecs.soton.ac.uk: /* Systems Administration */

__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
* [[Training_Video:Browsing|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]]
* Using pins within phrases and 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
* Adding New Fields
**[[Training_Video:Add_A_Field|Adding a Simple Metadata Field]]
**Add a compound multiple 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]]
* Setting up SSL (https)
* 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]].

In the training course above, any items that are not linked to pages require a resource (e.g. a video) and a training course page to be created.

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).

-

Contact

2015-11-19T15:18:17Z

Af05v@ecs.soton.ac.uk: /* eprints-tech Mailing Lists */

Contact

2015-11-19T15:16:50Z

Af05v@ecs.soton.ac.uk: /* Twitter */

Contact

2015-11-19T15:16:30Z

Af05v@ecs.soton.ac.uk:

Contact

2015-11-19T15:12:00Z

Af05v@ecs.soton.ac.uk: /* Mailing Lists */

Contact

2015-11-19T15:08:09Z

Af05v@ecs.soton.ac.uk: /* Bug Report Policy */

{{manual}}

==Bug Report Policy==

We use a [https://github.com/eprints/eprints/ Github] to record bugs and issues for EPrints. You can search there or the eprints-tech mailing list for existing bugs and possible solutions.

If you identify a new bug or "issue" (issues are not bugs, but are things which could be clearer or better) please post a message to the eprints-tech mailing list - include all the information you can: what version of eprints, operating system etc.

If you think the bug has security implications (i.e. it shouldn't be made public) please email support@eprints.org.

== Mailing Lists ==

===eprints-announce===

eprints-announce is a low-traffic mailing list that just contains announcements for new versions of EPrints or other very important news.

To subscribe send an email with the following line in the message body to [mailto:majordomo@ecs.soton.ac.uk majordomo@ecs.soton.ac.uk]

subscribe eprints-announce

===eprints-tech===

eprints-tech is the mailing list for technical queries or feedback. It can also have general queries, but most traffic is of a technical nature.

To subscribe send an email with a blank message body to [mailto:eprints-tech-join@ecs.soton.ac.uk eprints-tech-join@ecs.soton.ac.uk]

You can access an online archive for eprints-tech at http://www.eprints.org/tech.php/.

===eprints-devel===

We run two mailing lists for committers: eprints-devel and eprints-changes. To receive changes to our tickets and repository, subscribe to eprints-changes (read only). eprint-devel is a lower-traffic discussion of commits (questions will probably be ignored - use ep-tech instead).

To subscribe send an email with one of the following lines in the message body to [mailto:majordomo@ecs.soton.ac.uk majordomo@ecs.soton.ac.uk]

subscribe eprints-devel
subscribe eprints-changes

WARNING: eprints-changes is HIGH traffic (every ticket and commit gets posted).

The list of tickets and commits is also accessible via the Web on our [http://trac.eprints.org/ EPrints Trac].

===eprints-underground===

eprints-underground is the non-technical mailing list for the discussion of metadata, politics (how to get content) and what people plan to use the eprints for.

To subscribe send an email with the following line in the message body to [mailto:majordomo@ecs.soton.ac.uk majordomo@ecs.soton.ac.uk]

subscribe eprints-underground

===Non-EPrints Specific===

The Open Archives Protocol has some mailing lists of its own, see the http://www.openarchives.org/ site for information on these.

== IRC ==

The ep-tech mailing list is the primary location for EPrints technical discussion/help. However, you may find some EPrints people on Freenode IRC:

irc.freenode.net:6667 #eprints

== EPrints UK User Group ==

For general EPrints discussion.

Access the group online at https://groups.google.com/forum/#!forum/eprints-uk-user-group

Contact

2015-11-19T15:07:13Z

Af05v@ecs.soton.ac.uk:

{{manual}}

==Bug Report Policy==

We use a [http://trac.eprints.org/ Trac] to record bugs and issues for EPrints. You can search there or the eprints-tech mailing list for existing bugs and possible solutions.

If you identify a new bug or "issue" (issues are not bugs, but are things which could be clearer or better) please post a message to the eprints-tech mailing list - include all the information you can: what version of eprints, operating system etc.

If you think the bug has security implications (i.e. it shouldn't be made public) please email support@eprints.org.

== Mailing Lists ==

===eprints-announce===

eprints-announce is a low-traffic mailing list that just contains announcements for new versions of EPrints or other very important news.

To subscribe send an email with the following line in the message body to [mailto:majordomo@ecs.soton.ac.uk majordomo@ecs.soton.ac.uk]

subscribe eprints-announce

===eprints-tech===

eprints-tech is the mailing list for technical queries or feedback. It can also have general queries, but most traffic is of a technical nature.

To subscribe send an email with a blank message body to [mailto:eprints-tech-join@ecs.soton.ac.uk eprints-tech-join@ecs.soton.ac.uk]

You can access an online archive for eprints-tech at http://www.eprints.org/tech.php/.

===eprints-devel===

We run two mailing lists for committers: eprints-devel and eprints-changes. To receive changes to our tickets and repository, subscribe to eprints-changes (read only). eprint-devel is a lower-traffic discussion of commits (questions will probably be ignored - use ep-tech instead).

To subscribe send an email with one of the following lines in the message body to [mailto:majordomo@ecs.soton.ac.uk majordomo@ecs.soton.ac.uk]

subscribe eprints-devel
subscribe eprints-changes

WARNING: eprints-changes is HIGH traffic (every ticket and commit gets posted).

The list of tickets and commits is also accessible via the Web on our [http://trac.eprints.org/ EPrints Trac].

===eprints-underground===

eprints-underground is the non-technical mailing list for the discussion of metadata, politics (how to get content) and what people plan to use the eprints for.

To subscribe send an email with the following line in the message body to [mailto:majordomo@ecs.soton.ac.uk majordomo@ecs.soton.ac.uk]

subscribe eprints-underground

===Non-EPrints Specific===

The Open Archives Protocol has some mailing lists of its own, see the http://www.openarchives.org/ site for information on these.

== IRC ==

The ep-tech mailing list is the primary location for EPrints technical discussion/help. However, you may find some EPrints people on Freenode IRC:

irc.freenode.net:6667 #eprints

== EPrints UK User Group ==

For general EPrints discussion.

Access the group online at https://groups.google.com/forum/#!forum/eprints-uk-user-group

Training Video:EPrints Wiki Basics

2015-11-19T11:46:53Z

Af05v@ecs.soton.ac.uk: /* More Reading */

Training Video:EPrints Wiki Basics

2015-11-19T11:46:09Z

Af05v@ecs.soton.ac.uk: /* Test Yourself */

Training Video:EPrints Wiki Basics

2015-11-19T11:45:57Z

Af05v@ecs.soton.ac.uk: /* Test Yourself */

Main Page

2015-11-18T17:15:32Z

Af05v@ecs.soton.ac.uk:

[[Category:Howto]]
__NOTOC__
'''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:

*[[:Category:Training Video|Video Training Course]]
*[[EPrints_Manual|Documentation]]
*[[Working Groups]]
*Mailing lists

There are two mail lists that you might like to join and where you can ask for help and share ideas:

'''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

== 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]]
* [[:Category:Training Video|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

Main Page

2015-11-18T17:15:21Z

Af05v@ecs.soton.ac.uk:

[[Category:Howto]]
__NOTOC__

'''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:

*[[:Category:Training Video|Video Training Course]]
*[[EPrints_Manual|Documentation]]
*[[Working Groups]]
*Mailing lists

There are two mail lists that you might like to join and where you can ask for help and share ideas:

'''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

== 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]]
* [[:Category:Training Video|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

Training Video:EPrints Wiki Basics

2015-11-18T17:06:35Z

Af05v@ecs.soton.ac.uk: /* Test Yourself */

Training Video:EPrints Wiki Basics

2015-11-18T17:00:01Z

Af05v@ecs.soton.ac.uk: /* Test Yourself */

Category:Training Video

2015-11-18T16:58:41Z

Af05v@ecs.soton.ac.uk: /* 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
* [[Training_Video:Browsing|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]]
* Using pins within phrases and 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
* Adding New Fields
**[[Training_Video:Add_A_Field|Adding a Simple Metadata Field]]
**Add a compound multiple 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]].

In the training course above, any items that are not linked to pages require a resource (e.g. a video) and a training course page to be created.

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).

-

Demonstration Page

2015-11-18T16:55:58Z

Af05v@ecs.soton.ac.uk: /* Heading 3 */

= Heading 1 =

The above is a level 1 heading.

== Heading 2 ==

=== Heading 3 ===

Bullet points below:

* point 1
* point 2
** point 2.1
** point 2.2
* point 3

[http://google.com Google's Amazing Search Engine] is the link here.

[[:Category:Training Video | The Training Course]]

== Another Heading 2 ==

==Third Heading 2 ==