Difference between revisions of "Main Page"

From EPrints Documentation
Jump to: navigation, search
m (Reverted edits by Tdb01r (Talk) to last revision by Pm705)
Line 1: Line 1:
−
<!-- Pod2Wiki=_preamble_
+
[[Category:Rubbish]]
−
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.
+
__NOTOC__
−
-->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Test/Pod2Wiki.pm|package_name=EPrints::Test::Pod2Wiki}}[[Category:API|Pod2Wiki]]<div><!-- Edit below this comment -->
 
  
 +
'''Welcome to the EPrints Wiki'''
  
−
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
+
This wiki contains technical and user-contributed documentation for the [[Introduction|EPrints software]].
−
==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%; '>
+
[http://demoprints3.eprints.org/ Demoprints] is our live, online server that allows anyone to try EPrints without having to install it first.
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
For more information on the EPrints project and related activities visit http://eprints.org/.
  
−
<!-- 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.
+
==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>
+
* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.
−
<!-- Edit below this comment -->
+
* [[Frequently Asked Questions]]
 +
* [[:Category:Howto|How to...]]
  
 +
==Getting Support==
  
−
<!-- Pod2Wiki= -->
+
* [http://www.eprints.org/services/ EPrints Services] - premium support, training and hosting from EPrints experts
−
</div>
+
* [[Contact|Mailing lists]]
−
<!-- Pod2Wiki=head_synopsis -->
+
* [[IRC|IRC chat channel]]
−
==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= -->
+
* 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).
−
</div>
+
* [[Files/]] Wiki pages about scripts and patches.
−
<!-- Pod2Wiki=head_description -->
 
−
==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>
+
* [[:Category:New Features|New features in EPrints]] - released and proposed
−
<!-- Pod2Wiki=head_methods -->
+
* [[How to contribute|How to contribute to EPrints development]]
−
==METHODS==
+
* [http://trac.eprints.org/ EPrints Trac] - access nightly builds, tickets and changes (requires free registration to view source code)
−
<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 -->
 
  
 +
== 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:
+
==EPrints 2 and Older Versions==
  
−
  wiki_index - URL of the MediaWiki "index.php" page
+
The manual for older versions of EPrints are available on the [http://www.eprints.org/documentation/tech/php/intro.php main EPrints site].
−
  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 15:03, 1 March 2010


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

Download EPrints

Installation

Getting Started

Getting Support

Add-ons, patches and translations

  • 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).
  • Files/ 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

EPrints 2 and Older Versions

The manual for older versions of EPrints are available on the main EPrints site.

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