Difference between revisions of "Main Page"

From EPrints Documentation
Jump to: navigation, search
m (link added)
 
(80 intermediate revisions by 14 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 repository software]].
  
−
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
+
[http://tryme.demo.eprints-hosting.org/ Demoprints] is our live, online server that allows anyone to try EPrints without having to install it first.  There are also [http://demo.eprints-hosting.org examples] of various 'flavours' of EPrints available to view as well as some more information on the [https://eprints.org/ EPrints project] and related activities.
−
==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%; '>
+
==New to EPrints?==
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
Found out more through our:
 +
* [[EPrints Glossary]] - Descriptions of the terminology used within EPrints repository software.
 +
* [[: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:
 +
**  '''[[eprints-tech Mailing List|The EPrints Technical Mailing List]]'''
 +
*** 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!
 +
*** [[eprints-tech Mailing List|Click here]] for information about [[eprints-tech Mailing List#Subscription_Options|subscribing to this list]] or [[eprints-tech Mailing List#List_Archives|reading its archives]].
 +
** '''[https://groups.google.com/forum/#!forum/eprints-uk-user-group The EPrints User Group Google Group]'''
 +
*** This group is for anyone involved in using EPrints.  Ask questions, share ideas, hear about forthcoming meetings.
 +
* How to [[Main_Page#Contributing_to_the_Wiki|contribute to the EPrints wiki]]
 +
* EPrints source code on GitHub:
 +
** Core and major plugins - https://github.com/eprints
 +
** Community code sharing - https://eprintsug.github.io and the repositories at https://github.com/eprintsug
  
−
<!-- Pod2Wiki= -->
+
== Download EPrints ==
−
</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;
+
{{Download}}
−
  ==SYNOPSIS==
 
−
  use EPrints::Test::Pod2Wiki;
 
−
  my $p = EPrints::Test::Pod2Wiki-&amp;gt;new(
 
−
    wiki_index =&amp;gt; "http://wiki.foo.org/index.php",
 
−
    username =&amp;gt; "johnd",
 
−
    password =&amp;gt; "xiPi00",
 
−
  );
 
−
  $p-&amp;gt;update_page( "EPrints::Utils" );
 
−
  &lt;!-- Edit below this comment --&gt;
 
−
  &lt;!-- Pod2Wiki= --&gt;
 
−
 
 
−
When the Wiki page is updated each Pod2Wiki section is replaced with the equivalent section content from the POD.
 
  
−
Comments can be made by adding them to the comment sections:
+
==Installation==
  
−
  ...
+
* [[:Category:Installation|Installing]] EPrints on various platforms
−
  &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.
+
==[[New_Repository | Getting Started]]==
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* [[EPrints Manual|EPrints 3 Documentation]]
−
<span style='display:none'>User Comments</span>
+
* [[Perl 101 for EPrints]]
−
<!-- Edit below this comment -->
+
* [https://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==
  
−
<!-- Pod2Wiki= -->
+
* [https://www.eprints.org/services/ EPrints Services] - premium support, training and hosting from EPrints experts
−
</div>
+
* [[Contact]] - mailing lists, bug reports etc.
−
<!-- Pod2Wiki=head_synopsis -->
+
* [[User group meetings]] - regional meetings for users, which often have notes, presentations and information of general interest
−
==SYNOPSIS==
 
−
  use EPrints::Test::Pod2Wiki;
 
−
 
 
−
  my $p = EPrints::Test::Pod2Wiki-&gt;new(
 
−
    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 -->
 
  
 +
==Add-ons, patches and translations==
  
−
<!-- Pod2Wiki= -->
+
* 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]].
−
</div>
+
* The [https://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).
−
<!-- Pod2Wiki=head_description -->
+
* [[:Category:Plugins|Plugins]]: Some Wiki pages about scripts and patches.
−
==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%; '>
+
{{Register}}
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
==Contributing to EPrints==
  
−
<!-- Pod2Wiki= -->
+
* [[Usability|EPrints usability]]
−
</div>
+
* New features in EPrints - [[:Category:Releases|released]] and [[:Category:Planned Releases|proposed]]
−
<!-- Pod2Wiki=head_methods -->
+
* [[How to contribute|How to contribute to EPrints development]]
−
==METHODS==
+
* [https://github.com/eprints/eprints3.4 EPrints 3.4 on GitHub] - Codebase, releases and issues tracker for EPrints 3.4.
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* [https://github.com/eprints/eprints3 EPrints 3.3 on GitHub] - Codebase, releases and issues tracker for EPrints 3.3 (legacy).
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
== Content management ==
  
−
<!-- Pod2Wiki= -->
+
* [[Digital preservation]]: managing content for longer-term access and use
−
</div>
 
−
<!-- Pod2Wiki=item_new -->
 
−
===EPrints::Test::Pod2Wiki-&gt;new( ... )===
 
−
 
 
−
Create a new Pod2Wiki parser. Required options:
 
−
 
 
−
  wiki_index - URL of the MediaWiki "index.php" page
 
−
  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 -->
 

Latest revision as of 09:58, 19 February 2024

Welcome to the EPrints Wiki

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

Demoprints is our live, online server that allows anyone to try EPrints without having to install it first. There are also examples of various 'flavours' of EPrints available to view as well as some more information on the EPrints project and related activities.

New to EPrints?

Found out more through our:

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=16198’