Difference between revisions of "Main Page"

From EPrints Documentation
Jump to: navigation, search
m (Re-order mailing lists - quite a few technical questions end up on the UK list where the tech list would probably be a better first port of call.)
(61 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
<!-- Pod2Wiki=_preamble_
+
[[Category:Howto]]__NOTOC__
−
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
+
'''Welcome to the EPrints Wiki'''
−
-->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Test/Pod2Wiki.pm|package_name=EPrints::Test::Pod2Wiki}}[[Category:API|Pod2Wiki]]<div><!-- Edit below this comment -->
 
  
 +
This wiki contains technical and user-contributed documentation for the [[Introduction|EPrints software]].
  
−
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
+
[http://demoprints.eprints.org/ Demoprints] is our live, online server that allows anyone to try EPrints without having to install it first.
−
==NAME==
 
−
EPrints::Test::Pod2Wiki - convert EPrints pod to MediaWiki
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
For more information on the EPrints project and related activities visit http://eprints.org/.
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
==New to EPrints?==
  
−
<!-- Pod2Wiki= -->
+
On this wiki you can find:
−
</div>
 
−
<!-- Pod2Wiki=head_editing_pod2wiki_pages -->
 
−
==Editing Pod2Wiki Pages==
 
−
Pages generated by this module have Pod2Wiki markers inserted. These markers are HTML comments that start and end every {{API:PodLink|file=perlpod|package_name=perlpod|section=|text=Plain Old Documentation}} (POD) section. For example a POD synopsis section will look like this:
 
  
−
  &lt;!-- Pod2Wiki=head_synopsis --&gt;
+
* [[:Category:Training Video|Video Training Course]]
−
  ==SYNOPSIS==
+
* [[EPrints_Manual|Documentation]]
−
  use EPrints::Test::Pod2Wiki;
+
* [[Working Groups]]
−
  my $p = EPrints::Test::Pod2Wiki-&amp;gt;new(
+
* Mailing lists - There are two mail lists that you might like to join and where you can ask for help and share ideas:
−
    wiki_index =&amp;gt; "http://wiki.foo.org/index.php",
+
**  '''The EPrints Technical Mailing List'''
−
    username =&amp;gt; "johnd",
+
*** Joining information for [[Contact| EPrints Tech list]]
−
    password =&amp;gt; "xiPi00",
+
*** If you have technical questions, or a part of your EPrints installation is not working properly, this group has people who might be able to help!
−
  );
+
** '''The EPrints User Group Google Group''' https://groups.google.com/forum/#!forum/eprints-uk-user-group
−
  $p-&amp;gt;update_page( "EPrints::Utils" );
+
*** This group is for anyone involved in using EPrints. Ask questions, share ideas, hear about forthcoming meetings.
−
  &lt;!-- Edit below this comment --&gt;
+
* How to [[Wiki_editing_guidlines|contribute to the EPrints wiki]]
−
  &lt;!-- Pod2Wiki= --&gt;
+
* EPrints source code on GitHub:
−
 
+
** Core and major plugins - https://github.com/eprints
−
When the Wiki page is updated each Pod2Wiki section is replaced with the equivalent section content from the POD.
+
** Community code sharing - http://eprintsug.github.io and the repositories at https://github.com/eprintsug
  
−
Comments can be made by adding them to the comment sections:
+
== Download EPrints ==
  
−
  ...
+
{{Download}}
−
  &lt;!-- Pod2Wiki=head_methods --&gt;
 
−
  ==METHODS==
 
−
  Any changes here will be lost
 
−
  &lt;!-- Edit below this comment --&gt;
 
−
  This Wiki comment will be kept.
 
−
  &lt;!-- Pod2Wiki= --&gt;
 
−
  ...
 
−
 
 
−
Note: if a POD section is removed any Wiki content associated with that section will also be removed.
 
  
−
The rest of this page concerns the <em>EPrints::Test::Pod2Wiki</em> module.
+
==Installation==
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* [[:Category:Installation|Installing]] EPrints on various platforms
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
==Getting Started==
  
−
<!-- Pod2Wiki= -->
+
* [[EPrints Manual|EPrints 3 Documentation]]
−
</div>
+
* [[Perl 101 for EPrints]]
−
<!-- Pod2Wiki=head_synopsis -->
+
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.
−
==SYNOPSIS==
+
* [[Frequently Asked Questions]]
−
  use EPrints::Test::Pod2Wiki;
+
* [[:Category:Howto|How to...]]
−
 
+
* [[:Category:Plugins|Plugins and Bazaar packages for EPrints]]
−
  my $p = EPrints::Test::Pod2Wiki-&gt;new(
+
* [[:Category:Training Video|EPrints Training Course]]
−
    wiki_index =&gt; "http://wiki.foo.org/index.php",
 
−
    username =&gt; "johnd",
 
−
    password =&gt; "xiPi00",
 
−
    );
 
−
 
 
−
  $p-&gt;update_page( "EPrints::Utils" );
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
==Getting Support==
  
−
<!-- Pod2Wiki= -->
+
* [http://www.eprints.org/services/ EPrints Services] - premium support, training and hosting from EPrints experts
−
</div>
+
* [[Contact]] - mailing lists, bug reports etc.
−
<!-- Pod2Wiki=head_description -->
+
* [[User group meetings]] - regional meetings for users, which often have notes, presentations and information of general interest
−
==DESCRIPTION==
 
−
This module enables the integration of EPrints POD (documentation) and MediaWiki pages.
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
==Add-ons, patches and translations==
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
* 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.
  
−
<!-- Pod2Wiki= -->
+
{{Register}}
−
</div>
 
−
<!-- Pod2Wiki=head_methods -->
 
−
==METHODS==
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
==Contributing to EPrints==
  
−
<!-- Pod2Wiki= -->
+
* [[Usability|EPrints usability]]
−
</div>
+
* [[:Category:Releases|New features in EPrints]] - released and proposed
−
<!-- Pod2Wiki=item_new -->
+
* [[How to contribute|How to contribute to EPrints development]]
−
===EPrints::Test::Pod2Wiki-&gt;new( ... )===
+
* [http://trac.eprints.org/ EPrints Trac] - access nightly builds, tickets and changes (requires free registration to view source code)
 +
* [[EPrints4 Roadmap]]
 +
* [[EPrints3 Roadmap]] - 2016 Community Roadmap
  
−
Create a new Pod2Wiki parser. Required options:
+
== Content management ==
  
−
  wiki_index - URL of the MediaWiki "index.php" page
+
* [[Digital preservation]]: managing content for longer-term access and use
−
  username - MediaWiki username
 
−
  password - MediaWiki password
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
 
−
 
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_update_page -->
 
−
===$ok = $pod-&gt;update_page( $package_name )===
 
−
 
 
−
Update the MediaWiki page for $package_name.
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
 
−
 
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_command -->
 
−
===$parser-&gt;command( ... )===
 
−
 
 
−
{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback.
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
 
−
 
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_verbatim -->
 
−
===$parser-&gt;verbatim( ... )===
 
−
 
 
−
{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback.
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
 
−
 
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_textblock -->
 
−
===$parser-&gt;textblock( ... )===
 
−
 
 
−
{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback.
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
 
−
 
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_interpolate -->
 
−
===$parser-&gt;interpolate( ... )===
 
−
 
 
−
{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback. Overloaded to also escape HTML entities.
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
 
−
 
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_interior_sequence -->
 
−
===$parser-&gt;interior_sequence( ... )===
 
−
 
 
−
{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback.
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
 
−
 
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
 

Revision as of 09:49, 20 November 2018

Welcome to the EPrints Wiki

This wiki contains technical and user-contributed documentation for the EPrints software.

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:

Download EPrints

Installation

Getting Started

Getting Support

  • EPrints Services - premium support, training and hosting from EPrints experts
  • Contact - mailing lists, bug reports etc.
  • User group meetings - regional meetings for users, which often have notes, presentations and information of general interest

Add-ons, patches and translations

  • As of version 3.3 EPrints can now install plugins and translations through the EPrints Bazaar the wiki also has information about packaging plugins for the Bazaar.
  • The 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).
  • Plugins: Some Wiki pages about scripts and patches.

Contributing to the Wiki

We welcome contributions to the Wiki but you will need to register for an EPrints account (free but requires email activation).

Please use the Request account link at the top right of the page to submit a request for an account.

Before creating a page take a look at the Wiki editing guidelines. They should help keep the wiki organised and useful.

Contributing to EPrints

Content management

Retrieved from ‘https://wiki.eprints.org/w/index.php?title=Main_Page&oldid=13101’