EPrints Documentation - User contributions [en-gb]

User:Csirmaz

2007-07-09T08:39:18Z

Csirmaz:

== László Csirmaz ==

A mathematician by education, Head of [http://www.ceu.hu/comp Computer and Statistics Center] of the [http://www.ceu.hu Central European University], [http://www.fsz.bme.hu/hungary/budapest/budapest.html Budapest].
Teaching Mathematical Logic at [http://www.cs.elte.hu| Eötvös Lorand University],
Theoretical Cryptography at [http://www.inf.unideb.hu University of Debrecen]. Check the web page at http://www.renyi.hu/~csirmaz/ for more info.

When asked to overlook the implementation of the [http://pdc.ceu.hu Policy Documentation Center], I have been fascianted by the clear programming style
and high usability of the EPrints software. ("Just the way such a thing should be done!") Since then ocassionally I throw in my 2 pence worth hoping that it migh be useful for the EPrints community.

Translation

2007-07-06T12:24:51Z

Csirmaz: /* Pluralising depends on language */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session:

$c->{set_document_defaults} = sub
{
my( $data, $session, $eprint ) = @_;
###### HERE:
$data->{language} = $session->get_langid();
$data->{security} = "public";
};

The available language values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is rendered as a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

<div style="padding: 1em;
border: 1px solid #6f2f2f;
color: black;
background-color: #ffe0e0;">
Due to a bug in GDOME, when you use GDOME, all XML files must be utf-8 encoded (see tech list [http://www.eprints.org/tech.php/7295.html 7295]).
</div>

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references; and this mechanism ensures that system-wide phrases are redefined by entries in a repository-dependent phrase file.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

Phrases are defined as follows:

<epp:phrase id="lib/dataset:no_language">Unknown/Other</epp:phrase>

This line defined the "<code>lib/dataset:no_language</code>" phrase to be equal to "<code>Unknown/Other</code>". A phrase must have a proper XML syntax (i.e. all tags must be balanced). In the definition you can refer to other phrases:

<epp:phrase id=double_ruler>
<epc:phrase ref="ruler"/><epc:phrase ref="ruler"/>
</epp:phrase>

Certain phrases use ''pins''. Pins are typically defined by the calling routine, and carry variable content, such as the document's name

<epp:phrase id="doc_title">Document: <epc:pin name="doc" /></epp:phrase>

or a URL (pins typically called "link") where the link text comes between "<code><epc:pin name=...></code>" and "<code></epc:pin></code>":

<epp:phrase id="show_help"><epc:pin name="link">
<img src="/images/help.gif" alt="+"></epc:pin></epp:phrase>

If a phrase requires a pin but none defined, you get an ugly error message about undefined pins. Thus if you use the "<code>show_help</code>" phrase in another one, you must supply the pin. It is done through "<code>epc:param</code>" tags. The pin in this case is an "<code><a /></code>" tag which defines the URL of the help text:

<epp:phrase id="use_help">Help using the show_help phrase:
<epc:phrase ref="show_help">
<nowiki><epc:param name="link"><a href="http://..." /></epc:param></nowiki>
</epc:phrase>
</epp:phrase>

You can use other [[EPrints_Control_Format|control format]] elements as well.

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095], [http://www.eprints.org/tech.php/7157.html 7157] and [http://www.eprints.org/tech.php/7300.html 7300].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

You might consider applying some of the [[#Patches|patches]].

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Pluralising depends on language|pluralising depens on language]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Pluralising depends on language ===

When invoking a phrase in a citation, the Escript constucts such as <code><epc:if test="..." /></code> or <code><epc print /></code> are not available any more. To transfer pluralising from the citation file into phrases file requires this feature which is achieved by the [[XML/EPC.pm.diff.2]] patch. See tech list [[http://www.eprints.org/tech.php/7300.html 7300]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields.pl]] file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-06T12:17:31Z

Csirmaz: /* Pluralising depends on language */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session:

$c->{set_document_defaults} = sub
{
my( $data, $session, $eprint ) = @_;
###### HERE:
$data->{language} = $session->get_langid();
$data->{security} = "public";
};

The available language values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is rendered as a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

<div style="padding: 1em;
border: 1px solid #6f2f2f;
color: black;
background-color: #ffe0e0;">
Due to a bug in GDOME, when you use GDOME, all XML files must be utf-8 encoded (see tech list [http://www.eprints.org/tech.php/7295.html 7295]).
</div>

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references; and this mechanism ensures that system-wide phrases are redefined by entries in a repository-dependent phrase file.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

Phrases are defined as follows:

<epp:phrase id="lib/dataset:no_language">Unknown/Other</epp:phrase>

This line defined the "<code>lib/dataset:no_language</code>" phrase to be equal to "<code>Unknown/Other</code>". A phrase must have a proper XML syntax (i.e. all tags must be balanced). In the definition you can refer to other phrases:

<epp:phrase id=double_ruler>
<epc:phrase ref="ruler"/><epc:phrase ref="ruler"/>
</epp:phrase>

Certain phrases use ''pins''. Pins are typically defined by the calling routine, and carry variable content, such as the document's name

<epp:phrase id="doc_title">Document: <epc:pin name="doc" /></epp:phrase>

or a URL (pins typically called "link") where the link text comes between "<code><epc:pin name=...></code>" and "<code></epc:pin></code>":

<epp:phrase id="show_help"><epc:pin name="link">
<img src="/images/help.gif" alt="+"></epc:pin></epp:phrase>

If a phrase requires a pin but none defined, you get an ugly error message about undefined pins. Thus if you use the "<code>show_help</code>" phrase in another one, you must supply the pin. It is done through "<code>epc:param</code>" tags. The pin in this case is an "<code><a /></code>" tag which defines the URL of the help text:

<epp:phrase id="use_help">Help using the show_help phrase:
<epc:phrase ref="show_help">
<nowiki><epc:param name="link"><a href="http://..." /></epc:param></nowiki>
</epc:phrase>
</epp:phrase>

You can use other [[EPrints_Control_Format|control format]] elements as well.

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095], [http://www.eprints.org/tech.php/7157.html 7157] and [http://www.eprints.org/tech.php/7300.html 7300].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

You might consider applying some of the [[#Patches|patches]].

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Pluralising depends on language|pluralising depens on language]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Pluralising depends on language ===

When invoking a phrase in a citation, the Escript constucts such as <code><epc:if test="..." /></code> or <code><epc print /></code> are not available any more. To transfer pluralising from the citation file into phrases file the [[XML/EPC.pm.diff.2]] patch is necessary. See tech list [[http://www.eprints.org/tech.php/7300.html 7300]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields.pl]] file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-06T12:12:32Z

Csirmaz: /* Other configuration files */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session:

$c->{set_document_defaults} = sub
{
my( $data, $session, $eprint ) = @_;
###### HERE:
$data->{language} = $session->get_langid();
$data->{security} = "public";
};

The available language values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is rendered as a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

<div style="padding: 1em;
border: 1px solid #6f2f2f;
color: black;
background-color: #ffe0e0;">
Due to a bug in GDOME, when you use GDOME, all XML files must be utf-8 encoded (see tech list [http://www.eprints.org/tech.php/7295.html 7295]).
</div>

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references; and this mechanism ensures that system-wide phrases are redefined by entries in a repository-dependent phrase file.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

Phrases are defined as follows:

<epp:phrase id="lib/dataset:no_language">Unknown/Other</epp:phrase>

This line defined the "<code>lib/dataset:no_language</code>" phrase to be equal to "<code>Unknown/Other</code>". A phrase must have a proper XML syntax (i.e. all tags must be balanced). In the definition you can refer to other phrases:

<epp:phrase id=double_ruler>
<epc:phrase ref="ruler"/><epc:phrase ref="ruler"/>
</epp:phrase>

Certain phrases use ''pins''. Pins are typically defined by the calling routine, and carry variable content, such as the document's name

<epp:phrase id="doc_title">Document: <epc:pin name="doc" /></epp:phrase>

or a URL (pins typically called "link") where the link text comes between "<code><epc:pin name=...></code>" and "<code></epc:pin></code>":

<epp:phrase id="show_help"><epc:pin name="link">
<img src="/images/help.gif" alt="+"></epc:pin></epp:phrase>

If a phrase requires a pin but none defined, you get an ugly error message about undefined pins. Thus if you use the "<code>show_help</code>" phrase in another one, you must supply the pin. It is done through "<code>epc:param</code>" tags. The pin in this case is an "<code><a /></code>" tag which defines the URL of the help text:

<epp:phrase id="use_help">Help using the show_help phrase:
<epc:phrase ref="show_help">
<nowiki><epc:param name="link"><a href="http://..." /></epc:param></nowiki>
</epc:phrase>
</epp:phrase>

You can use other [[EPrints_Control_Format|control format]] elements as well.

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095], [http://www.eprints.org/tech.php/7157.html 7157] and [http://www.eprints.org/tech.php/7300.html 7300].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

You might consider applying some of the [[#Patches|patches]].

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Pluralising depends on language|pluralising depens on language]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Pluralising depends on language ===

When invoking a phrase in a citation, the Escript constucts such as <code><epc:if test="..." /></code> or <code><epc print /></code> are not availble any more. To transfer pluralising from the citation file into phrases file the [[XML/EPC.pm.diff.2]] patch is necessary. See tech list [[http://www.eprints.org/tech.php/7300.html 7300]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields.pl]] file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-06T12:09:30Z

Csirmaz: /* Patches */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session:

$c->{set_document_defaults} = sub
{
my( $data, $session, $eprint ) = @_;
###### HERE:
$data->{language} = $session->get_langid();
$data->{security} = "public";
};

The available language values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is rendered as a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

<div style="padding: 1em;
border: 1px solid #6f2f2f;
color: black;
background-color: #ffe0e0;">
Due to a bug in GDOME, when you use GDOME, all XML files must be utf-8 encoded (see tech list [http://www.eprints.org/tech.php/7295.html 7295]).
</div>

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references; and this mechanism ensures that system-wide phrases are redefined by entries in a repository-dependent phrase file.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

Phrases are defined as follows:

<epp:phrase id="lib/dataset:no_language">Unknown/Other</epp:phrase>

This line defined the "<code>lib/dataset:no_language</code>" phrase to be equal to "<code>Unknown/Other</code>". A phrase must have a proper XML syntax (i.e. all tags must be balanced). In the definition you can refer to other phrases:

<epp:phrase id=double_ruler>
<epc:phrase ref="ruler"/><epc:phrase ref="ruler"/>
</epp:phrase>

Certain phrases use ''pins''. Pins are typically defined by the calling routine, and carry variable content, such as the document's name

<epp:phrase id="doc_title">Document: <epc:pin name="doc" /></epp:phrase>

or a URL (pins typically called "link") where the link text comes between "<code><epc:pin name=...></code>" and "<code></epc:pin></code>":

<epp:phrase id="show_help"><epc:pin name="link">
<img src="/images/help.gif" alt="+"></epc:pin></epp:phrase>

If a phrase requires a pin but none defined, you get an ugly error message about undefined pins. Thus if you use the "<code>show_help</code>" phrase in another one, you must supply the pin. It is done through "<code>epc:param</code>" tags. The pin in this case is an "<code><a /></code>" tag which defines the URL of the help text:

<epp:phrase id="use_help">Help using the show_help phrase:
<epc:phrase ref="show_help">
<nowiki><epc:param name="link"><a href="http://..." /></epc:param></nowiki>
</epc:phrase>
</epp:phrase>

You can use other [[EPrints_Control_Format|control format]] elements as well.

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Pluralising depends on language|pluralising depens on language]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Pluralising depends on language ===

When invoking a phrase in a citation, the Escript constucts such as <code><epc:if test="..." /></code> or <code><epc print /></code> are not availble any more. To transfer pluralising from the citation file into phrases file the [[XML/EPC.pm.diff.2]] patch is necessary. See tech list [[http://www.eprints.org/tech.php/7300.html 7300]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields.pl]] file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-06T09:15:51Z

Csirmaz: /* Phrases */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session:

$c->{set_document_defaults} = sub
{
my( $data, $session, $eprint ) = @_;
###### HERE:
$data->{language} = $session->get_langid();
$data->{security} = "public";
};

The available language values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is rendered as a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

<div style="padding: 1em;
border: 1px solid #6f2f2f;
color: black;
background-color: #ffe0e0;">
Due to a bug in GDOME, when you use GDOME, all XML files must be utf-8 encoded (see tech list [http://www.eprints.org/tech.php/7295.html 7295]).
</div>

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references; and this mechanism ensures that system-wide phrases are redefined by entries in a repository-dependent phrase file.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

Phrases are defined as follows:

<epp:phrase id="lib/dataset:no_language">Unknown/Other</epp:phrase>

This line defined the "<code>lib/dataset:no_language</code>" phrase to be equal to "<code>Unknown/Other</code>". A phrase must have a proper XML syntax (i.e. all tags must be balanced). In the definition you can refer to other phrases:

<epp:phrase id=double_ruler>
<epc:phrase ref="ruler"/><epc:phrase ref="ruler"/>
</epp:phrase>

Certain phrases use ''pins''. Pins are typically defined by the calling routine, and carry variable content, such as the document's name

<epp:phrase id="doc_title">Document: <epc:pin name="doc" /></epp:phrase>

or a URL (pins typically called "link") where the link text comes between "<code><epc:pin name=...></code>" and "<code></epc:pin></code>":

<epp:phrase id="show_help"><epc:pin name="link">
<img src="/images/help.gif" alt="+"></epc:pin></epp:phrase>

If a phrase requires a pin but none defined, you get an ugly error message about undefined pins. Thus if you use the "<code>show_help</code>" phrase in another one, you must supply the pin. It is done through "<code>epc:param</code>" tags. The pin in this case is an "<code><a /></code>" tag which defines the URL of the help text:

<epp:phrase id="use_help">Help using the show_help phrase:
<epc:phrase ref="show_help">
<nowiki><epc:param name="link"><a href="http://..." /></epc:param></nowiki>
</epc:phrase>
</epp:phrase>

You can use other [[EPrints_Control_Format|control format]] elements as well.

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields.pl]] file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T15:39:11Z

Csirmaz: /* Phrases */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session:

$c->{set_document_defaults} = sub
{
my( $data, $session, $eprint ) = @_;
###### HERE:
$data->{language} = $session->get_langid();
$data->{security} = "public";
};

The available language values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is rendered as a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

<div style="padding: 1em;
border: 1px solid #6f2f2f;
color: black;
background-color: #ffe0e0;">
Due to a bug in GDOME, when you use GDOME, all XML files must be utf-8 encoded (see tech list [http://www.eprints.org/tech.php/7295.html 7295]).
</div>

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references; and this mechanism ensures that system-wide phrases are redefined by entries in a repository-dependent phrase file.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

Phrases are defined as follows:

<epp:phrase id="lib/dataset:no_language">Unknown/Other</epp:phrase>

This line defined the "<code>lib/dataset:no_language</code>" phrase to be equal to "<code>Unknown/Other</code>". A phrase must have a proper XML syntax (i.e. all tags must be balanced). In the definition you can refer to other phrases:

<epp:phrase id=double_ruler>
<epc:phrase ref="ruler"/><epc:phrase ref="ruler"/>
</epp:phrase>

Certain phrases use ''pins''. Pins are typically defined by the calling routine, and carry variable content, such as the document's name

<epp:phrase id="doc_title">Document: <epc:pin name="doc" /></epp:phrase>

or a URL (pins typically called "link") where the link text comes between "<code><epc:pin name=...></code>" and "<code></epc:pin></code>":

<epp:phrase id="show_help"><epc:pin name="link">
<img src="/images/help.gif" alt="+"></epc:pin></epp:phrase>

If a phrase requires a pin but none defined, you get an ugly error message about undefined pins.

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields.pl]] file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T15:38:23Z

Csirmaz: /* Phrases */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session:

$c->{set_document_defaults} = sub
{
my( $data, $session, $eprint ) = @_;
###### HERE:
$data->{language} = $session->get_langid();
$data->{security} = "public";
};

The available language values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is rendered as a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

<div style="padding: 1em;
border: 1px solid #6f2f2f;
color: black;
background-color: #ffe0e0;">
Due to a bug in GDOME, when you use GDOME, all XML files must be utf-8 encoded (see tech list [http://www.eprints.org/tech.php/7295.html 7295]).
</div>

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references; and this mechanism ensures that system-wide phrases are redefined by entries in a repository-dependent phrase file.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

Phrases are defined as follows:

<epp:phrase id="lib/dataset:no_language">Unknown/Other</epp:phrase>

This line defined the "<code>lib/dataset:no_language</code>" phrase to be equal to "<code>Unknown/Other</code>". A phrase must have a proper XML syntax (i.e. all tags must be balanced). In the definition you can refer to other phrases:

<epp:phrase id=double_ruler>
<epc:phrase ref="ruler"/><epc:phrase ref="ruler"/>
</epp:phrase>

Certain phrases use ''pins''. Pins are typically defined by the calling routine, and carry variable content, such as the document's name

<epp:phrase id="doc_title">Document: <epc:pin name="doc" /></epp:phrase>

or a URL (pins typically called "link") where the link text comes between "<code><epc:pin name=...></code>" and "<code></epc:pin></code>":

<epp:phrase id="show_help"><epc:pin name="link">
<img src="/images/help.gif" alt="+"></epc:pin></epp:phrase>

If a phrase requires a pin but none defined, you've got an ungly formatted error message about undefined pins.

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields.pl]] file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T14:51:50Z

Csirmaz: /* Example: the citations/saved_search/default.xml file */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session:

$c->{set_document_defaults} = sub
{
my( $data, $session, $eprint ) = @_;
###### HERE:
$data->{language} = $session->get_langid();
$data->{security} = "public";
};

The available language values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is rendered as a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields.pl]] file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T14:36:37Z

Csirmaz: /* Setting document language */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session:

$c->{set_document_defaults} = sub
{
my( $data, $session, $eprint ) = @_;
###### HERE:
$data->{language} = $session->get_langid();
$data->{security} = "public";
};

The available language values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is rendered as a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
* Pin definition with an "epc:param" tag works only in citation files.
* You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields.pl]] file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T14:32:39Z

Csirmaz: /* Rendering user names depending on session language */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session. The available values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
* Pin definition with an "epc:param" tag works only in citation files.
* You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields.pl]] file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T14:25:40Z

Csirmaz: /* Example: the citations/saved_search/default.xml file */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session. The available values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' the search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
* Pin definition with an "epc:param" tag works only in citation files.
* You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of cfg.d/user_fields.pl file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T14:21:57Z

Csirmaz: /* Setting document language */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session. The available values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other')" >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' and search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
* Pin definition with an "epc:param" tag works only in citation files.
* You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of cfg.d/user_fields.pl file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T13:37:22Z

Csirmaz: /* Other configuration files */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session. The available values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other') >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

See also the tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' and search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
* Pin definition with an "epc:param" tag works only in citation files.
* You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of cfg.d/user_fields.pl file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T13:35:08Z

Csirmaz: /* Example: the citations/document/default.xml file */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session. The available values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other') >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' and search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
* Pin definition with an "epc:param" tag works only in citation files.
* You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a>, <a href="http://www.foolabs.com/xpdf/download.html"> Xpdf </a> or <a href="http://www.adobe.com/products/acrobat/"> Adobe Acrobat Reader </a></epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm"> GSview </a></epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

Use phrases instead:

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td colspan="2"><nowiki><epc:choose></nowiki></td></tr>
<tr><td valign="top">14</td><td> </td><td>
<nowiki><epc:when test="format = 'application/pdf'"> <epc:phrase ref="need_pdf_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">15</td><td> </td><td>
<nowiki><epc:when test="format = 'application/postscript'"> <epc:phrase ref="need_postscript_viewer"/> </epc:when></nowiki></td></tr>
<tr><td valign="top">16</td><td colspan="2">
<nowiki></epc:choose></nowiki></td></tr>
</table>

The appropriate English phrase definitions would run as follows:

<epp:phrase id="need_pdf_viewer"> - Requires a PDF viewer such as ...
</epp:phrase>
<epp_phrase id="need_postscript_viewer"> - Requires a viewer, such ...
</epp:phrase>

See tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of cfg.d/user_fields.pl file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T11:39:35Z

Csirmaz: /* Other configuration files */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session. The available values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other') >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

<hr>

=== Example: the citations/saved_search/default.xml file ===

In the default EPrints distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

<pre>
9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>
</pre>

Whenever a saved search is formatted using the default citation style '''and''' and search has no attached name, then the "otherwise" case in line 11 is chosen. It prints ''Untitled search #'' followed by the search internal number. This text should be language dependent and use a phrase. For example the replacement

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name" />
#<epc:print expr="id"/></epc:otherwise>
</pre>

would do the job. If you want to be more gentle to translators (probably to yourself) then you could rather use a phrase with a ''pin'' for the search number:

<pre>
11 <epc:otherwise><epc:phrase ref="saved_search_no_name_with_pin">
<epc:param name="n"><epc:print expr="id"/></epc:param>
</epc:phrase></epc:otherwise>
</pre>

In this last case the English definition of the phrase would be

<pre>
<epp:phrase id="saved_search_no_name_with_pin">
Untitled search #<epc:pin name="n"/>
</epp:phrase>
</pre>

<span style="color:red; font-weight:bold; ">WARNING!</span>
* Pin definition with an "epc:param" tag works only in citation files.
* You '''must''' apply the "Citation phrases with embedded pins" patch in the [[#Patches]] section for this work correctly.

<hr>

=== Example: the citations/document/default.xml file ===

This file describes how documents should be rendered. When the document's type is pdf or postscript, then a helper text appears, which informs the reader that a special viewer program is necessary (long lines are wrapped)

<table width="100%" cellpadding="3" style="padding: 1em;
border: 1px dashed #2f6fab;
color: black;
background-color: #f9f9f9;
line-height: 1.1em;" class="code"><tr>
<td>13</td><td><epc:choose></pre></tr>
<tr><td valign="top">14</td><td>
<epc:when test="format = 'application/pdf'"> - Requires a PDF viewer such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm">GSview</a>, <a href="http://www.foolabs.com/xpdf/download.html">Xpdf</a> or <a href="http://www.adobe.com/products/acrobat/">Adobe Acrobat Reader</a></epc:when></td></tr>
</table>

15 <epc:when test="format = 'application/postscript'"> - Requires a viewer, such as <a href="http://www.cs.wisc.edu/~ghost/gsview/index.htm">GSview</a></epc:when>

16 </epc:choose>
</div>

<hr>

See tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of cfg.d/user_fields.pl file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T09:33:37Z

Csirmaz: /* Other configuration files */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session. The available values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other') >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: "''Untitled search''"
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: "''Untitled subject''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14 and 15: "''Requires a viewer...''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: "''ed/eds''"; line 37: "''In...ed/eds''"; line 62: "''In''"; line 66: "''thesis''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: "''Item not available''" and "''Item availability restricted''"
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: "''ed/eds''"; line 30: "''deposited..''" <span style="color:red;">NOTE: the date format is fixed and does not change with the language.</span>
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_succeeds.xml]] line 10: as above
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|cfg/citations/user/default.xml]] line 11 and 12: "''Unnamed user''" (twice)
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]] lines 83, 248, 259, 268: component titles
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] lines 45, 54: component titles "''Editorial Alerts''"

<hr>

In the default distribution the [[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] file contains the following lines:

9 <cite:linkhere><epc:choose>
10 <epc:when test="name"><epc:print expr="name"/></epc:when>
11 <epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
12 </epc:choose></cite:linkhere>

See tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of cfg.d/user_fields.pl file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Translation

2007-07-05T09:08:23Z

Csirmaz: /* Other configuration files */

Making translation to Eprints3 is similar to that of earlier versions. Here only some of the differences are pointed out. Also, there is a difference between just translating, or making a multilingual site. If you are making a translation, then with little effort you can also make your site speak English too, a courtesy for casual visitors of your repository.

== Multilingual sites ==

In order to costumize EPrints you should make several changes to the configuration files. It is a good time to make yourself familiarize with the [[EPrints_Directory_Structure/eprints3|EPrints3 Directory Structure]]. Certain files are common for all archives – <span style="color:red;">change these files only if you ''really'' know what your are doing</span>. Other files are repository specific, any change affects that repository only.

Repository-dependent files are below [[EPrints_Directory_Structure/eprints3/archives|archives]], each repository has it own substructure. When creating a new repository, configuration files are copied from [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]]. Thus making changes in [[EPrints_Directory_Structure/eprints3/lib/defaultcfg|lib/defaultcfg]] or below will effect all ''newly created'' repositories but will have no effect on existing repositories. Probably you want to make certain changes before creating repositories, e.g. adding further languages to [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lib/defaultcfg/lang]] (and also to [[EPrints_Directory_Structure/eprints3/lib/lang|lib/lang]]), changing the default language and available languages in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|/lib/defaultcfg/cfg.d/languages.pl]], correcting files in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|lib/defaultcfg/citations]] and [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|lib/defaultcfg/workflows]], etc.

In the description below we assume that you've set the repository, and use directories and file names, whenever appropriate, relative to that repository. It should be straightforward to make these changes so that they will have effect for all newly created archives.

=== Selecting the session's language ===

In a multilingual site you probably let the visitors to choose the language of the session. It is determined by the default setting of the browser preferences, but sometimes users want to change this. Manual setting of the session's language can be done by the [http://files.eprints.org/264/ port] of the ''set_language'' script from earlier Eprints versions, and should go into the [[EPrints_Directory_Structure/eprints3/cgi|cgi]] directory. A handy place for the set_language URL is in the menu at the top of the page. As the the default page template is repository dependent, you should edit [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/en/templates/default.xml]], the English language template for that repository as follows (but see the remarks above):

<ul class="ep_tm_menu">
<li><a href="{$config{frontpage}}">Home</a></li>
<li><a ref="{$config{perl_url}}/set_lang">Language</a></li>
<li><a href="{$config{base_url}}/information.html">About</a></li>
...
</ul>

The template page on other languages should not contain this ''Language'' item as not neccessarily will people recognise it. Rather use a button which reverts the language to English, i.e. insert the following into [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|archives/ArchiveID/lang/XX/templates/default.xml]] for all other languages XX except for English:

<li><a href="{$config{perl_url}/set_lang?langid=en">In English</a></li>

If you want a little more fancy layout, you might consider using [http://files.eprints.org/40/ flag images] to be copied to the directory [[EPrints_Directory_Structure/eprints3/lib/static/style/images|lib/static/style/images/flags/]]. If you define a phrase (see the [[#Phrases]] section) of the form "cgi/set_lang:lang_XX" then the set_lang script will use that phrase to render a link to that language. A typical format could be

<epp:phrase id="cgi/set_lang:lang_hu"><epc:pin name="link">
<img src="/style/images/flags/flag_hu.png" alt="[hu]" />
Hungarian</epc:pin>
</epp:phrase>

=== Setting the language of outgoing e-mail messages ===

By default, all e-mail messages are sent out on the default language of the depository. You might let the users choose their preferred language so that they'll receive messages on that language. The ''lang'' (system) field is defined for all users; the value can be set automatically in
[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_fields_automatic.pl]] for example by

$c->{set_user_automatic_fields} = sub
{ my ( $user ) = @_;
if( !$user -> is_set( "frequency" ) )
{
$user->set_value("frequency","never");
}
## NEW: set default language to the session language
if( !$user -> is_set( "lang" ) )
{
$user->set_value("lang",$user->{session}->{lang}->{id});
}
}

and also let the user edit their own preference by inserting the ''lang'' field in the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|cfg/workflows/user/default.xml]] workflow, say in the personal section:

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
<field ref="name" required="yes" />
<field ref="lang"/> <-- NEW!!! edit preferred language -->
<field ref="dept"/>
<field ref="org"/>
<field ref="address"/>
<field ref="country"/>
<field ref="url"/>
</component>

Finally, you might want the default language appear on the user's profile pages. This needs editing the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/user_render.pl]] file by inserting the following into the place of your choice (I coose just next to "country"):

if( $user->is_set( "lang" ) )
{
$p->appendChild($session->>make_element( "br" ) );
$p->appendChild($session->html_phrase("user_preferred_language",
lang => $user->render_value( "lang" ) ) );
}

here the new phrase "user_preferred_language" should be defined in one of the phrase files (see the [[#Phrases]] section); in it the pin "lang" contains the language itself:

<epp:phrase id="user_preferred_language">Preferred language:
< epc:pin name="lang"/>
</epp:phrase>

<span style="color:red; font-weight:bold">WARNING!</span> While e-mail messages are sent out utf-8 encoded, they are not properly formatted. For non-English e-mails you must apply the "Proper utf-8 encoding for outgoing e-mails" patch from the [[#Patches]] section. Also, by default, the text version of the e-mail does not contain links. This is also corrected by this patch.

=== Setting document language ===

Each document file has its own language. The same document might be submitted in different languages. In the default eprints workflow the reference to the language field is commented out; you only has to enable it. It is in file [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|cfg/workflows/eprint/default.xml]], stage "files":

<stage name="files">
<component type="XHTML">...</component>
<component type="Upload">
<field ref="format" />
<field ref="formatdesc" />
<field ref="security" />
<field ref="license" />
<field ref="date_embargo" />
<field ref="language" /> 
</component>
</stage>

The default value is set in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg/cfg.d/document_fields_default.pl]] to the language of the session. The available values are listed in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/languages]], you might consider revising this set.
The "undefined" language is a question mark (?).

You might also want to print the language as well. To this end, edit the [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] file. Show the language only when it is set, and the document's mime type is ''text/plain'', ''application/pdf'', ''application/postscript'', ''application/msword'', or ''other''. (For a full list of available mime type see [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|cfg/namedsets/document]] )

<cite:linkhere>...</cite:linkhere>
<epc:if test="security != 'public'"> ... </epc:if>

<epc:if test="is_set(language) and format.one_of( 'text/plain' ,
'application/pdf', 'application/postscript', 'application/msword', 'other') >
<epc:phrase ref="citation:doc_language">
<epc:param name="lang">
<epc:print expr="language"/>
</epc:param>
</epc:phrase>
</epc:if>

and, of course, one has to define the "citation:doc_language" phrase (see below) in all languages. In the phrase definition we have the pin "lang" which contains the document language in the actual language (defined as the phrase "<tt>languages_typename_XX</tt>"):

<epp:phrase id="citation:doc_language">
(The document's language is <epc:pin name="lang"/>.)
</epp:phrase>

<span style="color: red; font-weight:bold">WARNING!</span> The example above works only after you've applied the "Citation phrases with embedded pins" patch in the [[#Patches]] section.

== Phrases ==

Phrase defintions are scattered in several places. There are repository independent ones and repository dependent ones. The latter has preference over the former: if the same entity is defined in both places then the repository dependent definition takes precedence.

Phrases are parsed and stored during web server initialization for all repositories. If you make any change in any of the phrase files, you ''must restart'' the apache server to see the effect.

System-wide (i.e. repository independent) phrases are contained in the files in [[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|lib/lang/XX/phrases/]] where '''XX''' is the language code. Repository dependent phrase files are in [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|archives/ARCHIVEID/cfg/lang/XX/phrases/]]. In both directories all files with extension ".xml" are scanned and read in in alphabetical order. You can split the data into several files instead having a single a huge phrase file.

All phrase files must have proper XML syntax. Use existing files as templates. The very first line tells you which encoding is applied in the file:

<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>

If no encoding is given, then utf-8 is assumed (and you get error messages if the actual encoding is not that one). Set the encoding into your favourite one. Don't forget that when using iso-8859-X then you can enter a limited set of characters only.

You can define as many new phrases as you want, and refer them in other phrases. During initialization all phrases are stored, and expanded only when used. If a phrase has several definitions, the one which has been read in last will be used. This means that you can have forward references.

<div style="font-size:small;">CAUTION: do not attempt to create recursive references, as only your web server will crash after consuming all available memory.</div>

== Other configuration files ==

Several language-independent configuration files contain hardwired English texts. All of them should be replaced by references to phrases, which, in turn, generate the phrases in all languages. First the list of these files and places, and then two examples of how they can be handled.
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/saved_search/default.xml]] line 11: ''Untitled search''
*[[EPrints_Directory_Structure/eprints3/lib/citations|lib/citations/subject/screen.xml]] line 11: ''Untitle subject''
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|cfg/citations/document/default.xml]] lines 14, 15: ''Require a PDF viewer'', ''Requires a viewer such ...''
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/default.xml]] line 16: ''ed/eds''; line 37: ''In...ed/eds"; line 62: ''In''; line 66: ''thesis''
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/result.xml]] lines 12, 13: ''Item no available'', ''Item availability restricted''
*[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|cfg/citations/eprint/thread_commentary.xml]] line 18: ''ed/eds''; line 30: ''deposited..'' <span style="color:red; font-weight: bold;">NOTE</span> the date is ''not'' in the current language.

lib/citations/saved_search/default.xml
<cite:linkhere><epc:choose>
<epc:when test="name"><epc:print expr="name"/></epc:when>
<epc:otherwise>Untitled search #<epc:print expr="id"/></epc:otherwise>
</epc:choose></cite:linkhere>

++lib/citations/subject/screen.xml
Untitled subject

++archives/ipszilon/cfg/citations/document/default.xml
(Requires a viewer)

++archives/ipszilon/cfg/citations/eprint/default.xml
(ed -- eds) thesis

++archives/ipszilon/cfg/citations/eprint/result.xml
(Item not available online/availability restricted)

archives/ipszilon/cfg/citations/eprint/thread_commentary.xml
(ed -- eds) deposited !!!! (???)

archives/ipszilon/cfg/citations/eprint/thread_succeeds.xml
deposited

archives/ipszilon/cfg/citations/user/default.xml
Unnamed user with... (2x)

archives/ipszilon/cfg/workflows/eprint/default.xml
Publication details (several titles, e.g. Publication details)

archives/ipszilon/cfg/workflows/user/default.xml
Editorial alerts (title, 2x)

See tech list references [http://www.eprints.org/tech.php/7095.html 7095] and [http://www.eprints.org/tech.php/7157.html 7157].

== Subject list ==

== Patches ==

Apart from translating the language dependent phrase files, some other modification should be done for proper functioning. Theses patches are for Eprints version 3.0.1, please check your current version

* [[#Proper utf-8 encoding for outgoing e-mails|proper utf-8 encoding for outgoing e-mails]]
* [[#Citation phrases with embedded pins|citation phrases with embedded pins]]
* [[#Phrases using the same link twice|phrases using the same link twice]]
* [[#Language dependent date and time|expiration time for authentication codes (e.g. at registering) (hardcoded in English)]]
* generation time for browse pages (harcoded in English)
* [[#Rendering user names depending on session language|user name rendering depends on session language]]

=== Proper utf-8 encoding for outgoing e-mails ===

For outgoing e-mails the charset should be "utf-8". The mail headers (From, To, Subject, Reply-To, etc lines) might contain a restricted set of English characters only, other characters should be encoded. This [[EPrints.pm.diff]] [http://files.eprints.org/273 patch file] corrects these, PLUS it enables the URL text from links into the text version, PLUS converts wide characters to bytes (the Net::SMTP perl routine complains).

See the tech list references [http://www.eprints.org/tech.php/thread-5762.html 5762],
[http://www.eprints.org/tech.php/5783.html 5783] and
[http://www.eprints.org/tech.php/7114.html 7114].

=== Citation phrases with embedded pins ===

You need to apply the second half of the [[XML/EPC.pm.diff]] patch if want to use citations with embedded pins. See tech list [http://www.eprints.org/tech.php/7236.html 7236].

=== Phrases using the same link twice ===

If in a phrase you are using the same link pin twice, the second time it does not render correctly. E.g. if you want a picture AND a text refer to the same link, such as
<ep:phrase id="two_links">
<epc:pin ref="link"><img src="img.png" alt="[img]></epc:pin>
<epc:pin ref="link">Click here</epc:pin>
<ep:phrase>
For both links to work correctly please apply the first half of the [[XML/EPC.pm.diff]] patch. See tech list [[http://www.eprints.org/tech.php/6960.html 6960]].

=== Language dependent date and time ===

The wording of grace period (expiration time of the random pin number when someone registers or changes the email address) is generated in the Eprints/Time.pm script by the ''human_delay()'' routine. Also, the creation time at the bottom of browse pages are created here by ''human_time()'. The first routine always yields English text; the second one uses the server's locale setting for all languages.

[http://files.eprints.org/274 This patch] replaces ''human_delay()'' with reference to phrases for hour, day, week and their plural forms. See also tech list [http://www.eprints.org/tech.php/7243.html 7243]

=== Rendering user names depending on session language ===

All fields can have their separate rendering routine. This routine should be given as the value of the ''render_single_value'' attribute. In our case modify the top of cfg.d/user_fields.pl file which contains the definition of the user fields as follows:

$c->{fields}->{user} = [
{
'name' => 'name',
'type' => 'name',
'render_order' => 'gf',
'render_single_value' => \&my_namefield_rendering,
},
...

and insert the definition of ''my_namefield_rendering'' e.g. at the end of the same file:

sub my_namefield_rendering
{
my ($session,$field,$value,$object)=@_;
my $langid = $session->{lang}->{id};
my $format = {
# format: f, g - first, given; h - honourific, l - lineage
'en' => 'hfl,g',
'hu' => 'hlfg',
# Further lines should be added for other used languages
} -> {$langid}
my $all="";
foreach my $fmtchar ( split //, $format ) {
my $insert="";
if( $fmtchar eq "l" ) {$insert = $value->{lineage}; }
elsif( $fmtchar eq "f" ) { $insert = $value->{family}; }
elsif( $fmtchar eq "g" ) { $insert = $value->{given}; }
elsif( $fmtchar eq "h" ) { $insert = $value->{honourific}; }
elsif( $all ){ $all .= $fmtchar; }
next if( ! $insert );
$all .= $insert;
}
my $span=$session->make_element("span",class=>"person_name");
$span->appendChild($session->make_text($all));
$return $span;
}

== Indexing ==

Workflow Format

2007-07-05T08:41:30Z

Csirmaz: /* Components */

{{formats}}

The EPrints 3 workflow configuration files are stored in the repository's [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]] directory, within folders identifying the [[Data Object]]s to which they apply (e.g. eprint or user). Multiple workflows may be defined in each folder, although typically only the default.xml file will be necessary.

== Structure ==

At the centre of a workflow is a 'flow' description. This denotes the path through the workflow process from stage to stage. This may contain EPrints Control tags, allowing for the flow to vary depending on parameters of the data object (or other objects). For example, the flow may be different for users with certain roles. The flow is structured like so:

<flow>
<stage ref="type"/>
<stage ref="files"/>
<stage ref="core"/>
<stage ref="subjects"/>
</flow>

The 'ref' attribute of the stage element refers to the individual stages. The stage elements describe the components within each screen of the process and, like flow, may contain EPrints Control tags. The 'name' attribute of the stage element is identical to that of the stage element in the 'flow' section.

<stage name="core">
<component><field ref="title" required="yes" /></component>
<component><field ref="abstract"/></component>
</stage>

== Components ==

An EPrints component is responsible for the rendering of a graphical element in a workflow. This may be a text-box for title entry, a collection of fields in an appropriate grouping, or just a piece of XHTML. Six components are provided by default and, as they are plugins, it is straightforward to drop in new components when necessary. The type attribute of the component element corresponds to the plugin to be used.

If no type is given, type="Field" is assumed. For each component two further attributes are accepted: surround should be a plugin, by default it can be "None", "Normal", and "Light"; and collapse="yes". If collapse="yes" then it tries to render the component collapsed.

== Field-Related Components ==

=== Field Element ===

The majority of field-related components in EPrints 3 make use of the field element in their configuration. This provides a reference to a metafield and any attributes which may be relevant to rendering or operation. Several attributes are available to the element:

<table border="1">
<tr><th>Attribute</th><th>Values</th><th>Description</th></tr>
<tr><td>ref</td><td>A string</td><td>(required) Refers to the name of the metafield this field represents</td></tr>
<tr><td>required</td><td>yes/no</td><td>(optional) Whether a value is required in this field before the workflow may complete</td></tr>
<tr><td>help</td><td>An XHTML block</td><td>(optional) A block of XHTML to be rendered as help for the field</td></tr>
<tr><td>input_lookup_url</td><td>A URL</td><td>(optional) The location of an auto-lookup URL for the field</td></tr>
<tr><td>input_lookup_params</td><td>A string</td><td>(optional) An

Workflow Format

2007-07-05T08:16:11Z

Csirmaz: /* Components */

{{formats}}

The EPrints 3 workflow configuration files are stored in the repository's [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]] directory, within folders identifying the [[Data Object]]s to which they apply (e.g. eprint or user). Multiple workflows may be defined in each folder, although typically only the default.xml file will be necessary.

== Structure ==

At the centre of a workflow is a 'flow' description. This denotes the path through the workflow process from stage to stage. This may contain EPrints Control tags, allowing for the flow to vary depending on parameters of the data object (or other objects). For example, the flow may be different for users with certain roles. The flow is structured like so:

<flow>
<stage ref="type"/>
<stage ref="files"/>
<stage ref="core"/>
<stage ref="subjects"/>
</flow>

The 'ref' attribute of the stage element refers to the individual stages. The stage elements describe the components within each screen of the process and, like flow, may contain EPrints Control tags. The 'name' attribute of the stage element is identical to that of the stage element in the 'flow' section.

<stage name="core">
<component><field ref="title" required="yes" /></component>
<component><field ref="abstract"/></component>
</stage>

== Components ==

An EPrints component is responsible for the rendering of a graphical element in a workflow. This may be a text-box for title entry, a collection of fields in an appropriate grouping, or just a piece of XHTML. Six components are provided by default and, as they are plugins, it is straightforward to drop in new components when necessary. The type attribute of the component element corresponds to the plugin to be used.

If no type is given, type="Field" is assumed. Two further attributes are accepted: surround="whatever..." and collapse="yes". These attributes are passed to the appropriate plugin, the second one as if it were collapse="1".

== Field-Related Components ==

=== Field Element ===

The majority of field-related components in EPrints 3 make use of the field element in their configuration. This provides a reference to a metafield and any attributes which may be relevant to rendering or operation. Several attributes are available to the element:

<table border="1">
<tr><th>Attribute</th><th>Values</th><th>Description</th></tr>
<tr><td>ref</td><td>A string</td><td>(required) Refers to the name of the metafield this field represents</td></tr>
<tr><td>required</td><td>yes/no</td><td>(optional) Whether a value is required in this field before the workflow may complete</td></tr>
<tr><td>help</td><td>An XHTML block</td><td>(optional) A block of XHTML to be rendered as help for the field</td></tr>
<tr><td>input_lookup_url</td><td>A URL</td><td>(optional) The location of an auto-lookup URL for the field</td></tr>
<tr><td>input_lookup_params</td><td>A string</td><td>(optional) An

Translation

2007-07-05T07:13:09Z

Csirmaz: /* Phrases */

Translation

2007-07-05T07:12:15Z

Csirmaz: /* Phrases */

Translation

2007-07-05T06:54:43Z

Csirmaz: /* Patches */

Translation

2007-07-04T13:19:10Z

Csirmaz: /* Selecting the session's language */

EPrints Directory Structure Tree

2007-07-04T13:14:36Z

Csirmaz:

{{dirs}}

A graphical representation of the [[EPrints Directory Structure|EPrints3 directory structure]] after executing the install.pl command. Initially the "archives" directory is empty, it is populated when executing (as the eprints user) the "bin/epadmin create" command. The new repository is created using the data in the [[EPrints_Directory_Structure/eprints3/lib/defaultcfg]] directory.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>perl routines</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/bin|bin]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>command line and crontab tools</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cgi|cgi]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr>
<tr><td>defaultcfg </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>empty directory</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cfg|cfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>apache configuration for the whole site</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>tools and sample test data</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/var|var]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>apache include files plus indexer log</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/defaultcfg|defaultcfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>]</td></tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/saved_search|saved_search]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render a stored search</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/subject|subject]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render subjects</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render users</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png|"->"]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes|themes]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/example|example]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/green|green]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows/saved_search|saved_search]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>workflow for stored search pages</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>system-wide phrases</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>web pages and icons</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives|archives]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID|ArchiveID]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>see below</i>]</td>
</table>
</div>

The content of the "archives/[ArchiveID]/" directory. Any change you make here has effect on the particular repository only.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>uploaded files, extracted words, abstract pages, etc.</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>static files for the repository on all languages</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>various repository dependent files</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">subjects [<i>used for importing the subject tree</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static/images|images]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static/javascript|javascript]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static/style|style]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg.d]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>general configuration files as perl script fragments</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/autocomplete|autocomplete]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>data files for the autocompletion feature</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|document]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>document formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|eprint]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>eprints formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>user formats</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|namedsets]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>files containing the possible values for different sets</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|eprint]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>how an eprints is read in</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>define the user's data</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>phrases used locally</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>templates for static html pages</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|templates]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>default html page template</i>]</td>
</tr>
</table>
</div>

EPrints Directory Structure Tree

2007-07-04T12:59:40Z

Csirmaz:

{{dirs}}

A graphical representation of the [[EPrints Directory Structure|EPrints3 directory structure]] after executing the install.pl command. Initially the "archives" directory is empty, it is populated when executing (as the eprints user) the "bin/epadmin create" command. The new repository is created using the data in the [[EPrints_Directory_Structure/eprints3/lib/defaultcfg]] directory.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>perl routines</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/bin|bin]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>command line and crontab tools</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cgi|cgi]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr>
<tr><td>defaultcfg </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>empty directory</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cfg|cfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>apache configuration for the whole site</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>tools and sample test data</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/var|var]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>apache include files plus indexer log</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/defaultcfg|defaultcfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>]</td></tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/saved_search|saved_search]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render a stored search</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/subject|subject]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render subjects</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render users</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png|"->"]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes|themes]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/example|example]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/green|green]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows/saved_search|saved_search]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>workflow for stored search pages</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>system-wide phrases</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>web pages and icons</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives|archives]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID|ArchiveID]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>see below</i>]</td>
</table>
</div>

The content of the "archives/[ArchiveID]/" directory. Any change you make here has effect on the particular repository only.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>uploaded files, extracted words, abstract pages, etc.</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>static files for the repository on all languages</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>various repository dependent files</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">subject [<i>used for importing the subject tree</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>images</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>javascript</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>style</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg.d]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>general configuration files as perl script fragments</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/autocomplete|autocomplete]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>data files for the autocompletion feature</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|document]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>document formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|eprint]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>eprints formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>user formats</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|namedsets]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>files containing the possible values for different sets</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|eprint]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>how an eprints is read in</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>define the user's data</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>phrases used locally</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>templates for static html pages</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|templates]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>default html page template</i>]</td>
</tr>
</table>
</div>

Translation

2007-07-04T12:47:13Z

Csirmaz: /* Phrases */

Translation

2007-07-04T11:41:34Z

Csirmaz: /* Setting document language */

Translation

2007-07-04T11:33:32Z

Csirmaz: /* Setting the language of outgoing e-mail messages */

EPrints Directory Structure Tree

2007-07-04T11:30:29Z

Csirmaz:

{{dirs}}

A graphical representation of the [[EPrints Directory Structure|EPrints3 directory structure]] after executing the install.pl command. Initially the "archives" directory is empty, it is populated when executing (as the eprints user) the "bin/epadmin create" command. The new repository is created using the data in the [[EPrints_Directory_Structure/eprints3/lib/defaultcfg]] directory.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>perl routines</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/bin|bin]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>command line and crontab tools</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cgi|cgi]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr>
<tr><td>defaultcfg </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>empty directory</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>tools and sample test data</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/defaultcfg|defaultcfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>]</td></tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/saved_search|saved_search]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render a stored search</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/subject|subject]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render subjects</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render users</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png|"->"]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes|themes]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/example|example]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/green|green]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows/saved_search|saved_search]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>workflow for stored search pages</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>system-wide phrases</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>web pages and icons</i>]</td>
</tr>
<tr><td>archives</td>
<td>[[Image:jobbra.png]]</td>
<td>ArchiveID</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>see below</i>]</td>
</table>
</div>

The content of the "archives/[ArchiveID]/" directory. Any change you make here has effect on the particular repository only.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>uploaded files, extracted words, abstract pages, etc.</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>static files for the repository on all languages</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>various repository dependent files</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">subject [<i>used for importing the subject tree</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>images</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>javascript</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>style</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg.d]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>general configuration files as perl script fragments</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/autocomplete|autocomplete]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>data files for the autocompletion feature</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|document]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>document formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|eprint]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>eprints formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>user formats</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|namedsets]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>files containing the possible values for different sets</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|eprint]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>how an eprints is read in</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>define the user's data</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>phrases used locally</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>templates for static html pages</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|templates]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>default html page template</i>]</td>
</tr>
</table>
</div>

EPrints Directory Structure Tree

2007-07-04T11:28:25Z

Csirmaz:

{{dirs}}

A graphical representation of the [[EPrints Directory Structure|EPrints3 directory structure]] after executing the install.pl command. Initially the "archives" directory is empty, it is populated when executing (as the eprints user) the "bin/epadmin create" command. The new repository is created using the data in the [[EPrints_Directory_Structure/eprints3/lib/defaultcfg]] directory.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>perl routines</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/bin|bin]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>command line and crontab tools</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cgi|cgi]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr>
<tr><td>defaultcfg </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>empty directory</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>tools and sample test data</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/defaultcfg|defaultcfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>]</td></tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/saved_search|saved_search]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render a stored search</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/subject|subject]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render subjects</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render users</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png|"->"]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes|themes]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/example|example]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/green|green]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows/saved_search|saved_search]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>workflow for stored search pages</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>system-wide phrases</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>web pages and icons</i>]</td>
</tr>
<tr><td>archives</td>
<td>[[Image:jobbra.png]]</td>
<td>ArchiveID</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>see below</i>]</td>
</table>
</div>

The content of the "archives/[ArchiveID]/" directory. Any change you make here has effect on the particular repository only.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>uploaded files, extracted words, abstract pages, etc.</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>static files for the repository on all languages</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>various repository dependent files</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">subject [<i>used for importing the subject tree</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>images</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>javascript</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>style</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg.d]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>general configuration files as perl script fragments</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/autocomplete|autocomplete]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>data files for the autocompletion feature</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|document]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>document formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|eprint]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>eprints formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>user formats</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|namedsets]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>files containing the possible values for different sets</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/eprint|eprint]]
<td colspan="3">[<i>how an eprints is read in</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows/user|user]]
<td colspan="3">[<i>define the user's data</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>phrases used locally</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>templates for static html pages</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|templates]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>default html page template</i>]</td>
</tr>
</table>
</div>

Translation

2007-07-04T11:07:23Z

Csirmaz: /* Selecting the session's language */

Translation

2007-07-04T10:58:03Z

Csirmaz: /* Multilingual sites */

Translation

2007-07-04T10:19:19Z

Csirmaz:

EPrints Directory Structure Tree

2007-07-04T09:16:19Z

Csirmaz:

{{dirs}}

A graphical representation of the [[EPrints Directory Structure|EPrints3 directory structure]] after executing the install.pl command. Initially the "archives" directory is empty, it is populated when executing (as the eprints user) the "bin/epadmin create" command. The new repository is created using the data in the [[EPrints_Directory_Structure/eprints3/lib/defaultcfg]] directory.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>perl routines</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/bin|bin]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>command line and crontab tools</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cgi|cgi]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr>
<tr><td>defaultcfg </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>empty directory</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>tools and sample test data</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/defaultcfg|defaultcfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>]</td></tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/saved_search|saved_search]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render a stored search</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/subject|subject]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render subjects</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render users</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png|"->"]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes|themes]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/example|example]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/green|green]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows/saved_search|saved_search]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>workflow for stored search pages</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>system-wide phrases</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>web pages and icons</i>]</td>
</tr>
<tr><td>archives</td>
<td>[[Image:jobbra.png]]</td>
<td>ArchiveID</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>see below</i>]</td>
</table>
</div>

The content of the "archives/[ArchiveID]/" directory. Any change you make here has effect on the particular repository only.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>uploaded files, extracted words, abstract pages, etc.</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>static files for the repository on all languages</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>various repository dependent files</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">subject [<i>used for importing the subject tree</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>images</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>javascript</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>style</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg.d]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>general configuration files as perl script fragments</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/autocomplete|autocomplete]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>data files for the autocompletion feature</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|document]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>document formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|eprint]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>eprints formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>user formats</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|namedsets]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>files containing the possible values for different sets</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>phrases used locally</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>templates for static html pages</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|templates]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>default html page template</i>]</td>
</tr>
</table>
</div>

EPrints Directory Structure Tree

2007-07-04T07:23:47Z

Csirmaz:

{{dirs}}

A graphical representation of the [[EPrints Directory Structure|EPrints3 directory structure]] after executing the install.pl command. Initially the "archives" directory is empty, it is populated when executing (as the eprints user) the "bin/epadmin create" command. The new repository is created using the data in the [[EPrints_Directory_Structure/eprints3/lib/defaultcfg]] directory.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>perl routines</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/bin|bin]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>command line and crontab tools</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cgi|cgi]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr>
<tr><td>defaultcfg </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>empty directory</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>tools and sample test data</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/defaultcfg|defaultcfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>]</td></tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/saved_search|saved_search]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render a stored search</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/subject|subject]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render subjects</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render users</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png|"->"]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes|themes]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/example|example]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/green|green]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows/saved_search|saved_search]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>workflow for stored search pages</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>system-wide phrases</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>web pages and icons</i>]</td>
</tr>
<tr><td>archives</td>
<td>[[Image:jobbra.png]]</td>
<td>ArchiveID</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>see below</i>]</td>
</table>
</div>

The content of the "archives/[ArchiveID]/" directory:
<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>uploaded files, extracted words, abstract pages, etc.</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>static files for the repository on all languages</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>various repository dependent files</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">subject [<i>used for importing the subject tree</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>images</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>javascript</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>style</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg.d]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>general configuration files as perl script fragments</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/autocomplete|autocomplete]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>data files for the autocompletion feature</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|document]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>document formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|eprint]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>eprints formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>user formats</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|namedsets]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>files containing the possible values for different sets</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>phrases used locally</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>templates for static html pages</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|templates]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>default html page template</i>]</td>
</tr>
</table>
</div>

EPrints Directory Structure Tree

2007-07-03T14:47:11Z

Csirmaz:

{{dirs}}

A graphical representation of the [[EPrints Directory Structure|EPrints3 directory structure]] after executing the install.pl command.

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>perl routines</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/bin|bin]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>command line and crontab tools</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cgi|cgi]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr>
<tr><td>defaultcfg </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>empty directory</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>tools and sample test data</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/defaultcfg|defaultcfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>]</td></tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/saved_search|saved_search]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render a stored search</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/subject|subject]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render subjects</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render users</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png|"->"]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes|themes]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/example|example]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/green|green]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows/saved_search|saved_search]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>workflow for stored search pages</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>system-wide phrases</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>web pages and icons</i>]</td>
</tr>
<tr><td>archives</td>
<td>[[Image:jobbra.png]]</td>
<td>ArchiveID</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>see below</i>]</td>
</table>
</div>

The content of the "archives/[ArchiveID]/" directory:
<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>uploaded files, extracted words, abstract pages, etc.</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>static files for the repository on all languages</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>various repository dependent files</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">subject [<i>used for importing the subject tree</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>images</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>javascript</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>style</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg.d]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>general configuration files as perl script fragments</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/autocomplete|autocomplete]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>data files for the autocompletion feature</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|document]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>document formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|eprint]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>eprints formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>user formats</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|namedsets]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>files containing the possible values for different sets</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>phrases used locally</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>templates for static html pages</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|templates]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>default html page template</i>]</td>
</tr>
</table>
</div>

EPrints Directory Structure Tree

2007-07-03T14:33:41Z

Csirmaz:

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>perl routines</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/bin|bin]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>command line and crontab tools</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cgi|cgi]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr>
<tr><td>defaultcfg </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>empty directory</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>tools and sample test data</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/defaultcfg|defaultcfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>]</td></tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/lib/citations/saved_search|saved_search]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render a stored search</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/subject|subject]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render subjects</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render users</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png|"->"]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes|themes]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/example|example]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/green|green]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows/saved_search|saved_search]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>workflow for stored search pages</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>system-wide phrases</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>web pages and icons</i>]</td>
</tr>
<tr><td>archives</td>
<td>[[Image:jobbra.png]]</td>
<td>ArchiveID</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>see below</i>]</td>
</table>
</div>

The content of the "archives/[ArchiveID]/" directory:
<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px; background-color:#e9e9e9;">
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>uploaded files, extracted words, abstract pages, etc.</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>static files for the repository on all languages</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>various repository dependent files</i>]</td>
</tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">subject [<i>used for importing the subject tree</i></td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>images</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>javascript</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>style</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d|cfg.d]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>general configuration files as perl script fragments</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/autocomplete|autocomplete]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>data files for the autocompletion feature</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|document]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>document formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint">eprint</a></td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>eprints formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="3">[<i>user formats</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets|namedsets]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="5">[<i>files containing the possible values for different sets</i>]</td>
</tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>phrases used locally</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>templates for static html pages</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates|templates]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>default html page template</i>]</td>
</tr>
</table>
</div>

EPrints Directory Structure Tree

2007-07-03T14:19:45Z

Csirmaz:

<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px;">
<tr><td>[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>perl routines</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/bin|bin]]</td>
<td>[[Image:jobbra.png|->]]</td>
<td colspan="10">[<i>command line and crontab tools</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/cgi|cgi]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>dynamic (cgi) EPrints web pages</i>]</td></tr>
<tr><td>defaultcfg </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>empty directory</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/testdata|testdata]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="10">[<i>tools and sample test data</i>]</td></tr>
<tr><td>[[EPrints_Directory_Structure/eprints3/lib|lib]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/defaultcfg|defaultcfg]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>the content of</i> archives/ID/cfg/ <i>is copied from here</i>]</td></tr>
<tr><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations|citations]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/lib/citations/saved_search|saved_search]] </td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render a stored search</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/subject|subject]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render subjects</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/citations/user|user]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>how to render users</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png|"->"]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes|themes]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/example|example]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/themes/green|green]]</td>
<td>[[Image:jobbra.png]]</td>
<td>static </td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>style files and pictures</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows|workflows]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/workflows/saved_search|saved_search]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="4">[<i>workflow for stored search pages</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td>[[Image:jobbra.png]]></td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang|lang]]</td>
<td>[[Image:jobbra.png]]</td>
<td>XX (langid)</td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/phrases|phrases]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>system-wide phrases</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td>[[Image:jobbra.png]]</td>
<td>[[EPrints_Directory_Structure/eprints3/lib/lang/en/static|static]]</td>
<td>[[Image:jobbra.png]]</td>
<td>[<i>web pages and icons</i>]</td>
</tr>
<tr><td>archives</td>
<td>[[Image:jobbra.png]]</td>
<td>ArchiveID</td>
<td>[[Image:jobbra.png]]</td>
<td colspan="7">[<i>see below</i>]</td>
</table>
</div>

The content of the "archives/[ArchiveID]/" directory:
<div style="margin:2em; background-color:#e9e9e9;">
<table cellpadding="0" cellspacing="2" style="margin: 6px;">
<tr><td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents">documents</a> </td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="7">[<i>uploaded files, extracted words, abstract pages, etc.</i>]</td>
</tr>
<tr><td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html">html</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="7">[<i>static files for the repository on all languages</i>]</td>
</tr>
<tr><td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var">var</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="7">[<i>various repository dependent files</i>]</td>
</tr>
<tr><td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg">cfg</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/static">static</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="7">subject [<i>used for importing the subject tree</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td>images</td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td>javascript</td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td>style</td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="3">[<i>files to be copied to the html directory</i>]</td>
</tr>
<tr><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/cfg.d">cfg.d</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="5">[<i>general configuration files as perl script fragments</i>]</td>
</tr>
<tr><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/autocomplete">autocomplete</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="5">[<i>data files for the autocompletion feature</i>]</td>
</tr>
<tr><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations">citations</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document">document</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="3">[<i>document formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint">eprint</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="3">[<i>eprints formats</i>]</td>
</tr>
<tr><td></td><td></td><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user">user</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="3">[<i>user formats</i>]</td>
</tr>
<tr><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/namedsets">namedsets</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td colspan="5">[<i>files containing the possible values for different sets</i>]</td>
</tr>
<tr><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang">lang</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td>XX (langid)</td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases">phrases</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td>[<i>phrases used locally</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/static">static</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td>[<i>templates for static html pages</i>]</td>
</tr>
<tr><td></td><td></td><td></td><td></td><td></td>
<td><img src="jobbra.png" alt="->"</td>
<td><a href="http://wiki.eprints.org/w/EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/lang/en/templates">templates</a></td>
<td><img src="jobbra.png" alt="->"</td>
<td>[<i>default html page template</i>]</td>
</tr>
</table>
</div>

File:Jobbra.png

2007-07-03T13:55:44Z

Csirmaz: right arrow

right arrow

File:Image-jobbra.png

2007-07-03T13:49:43Z

Csirmaz: right arrow

right arrow

EPrints Directory Structure

2007-07-03T13:28:53Z

Csirmaz:

{{dirs}}
*eprints3/
** '''AUTHORS''' - Text file telling you who did what in EPrints.
** '''CHANGELOG''' - Text file documenting every single change made since EPrints 2 Alpha.
** '''COPYING''' - The GPL License
** '''NEWS''' - Summary of major changes between versions.
** '''README''' - Text file telling you how to install and where to find help.
** '''SIGNATURES''' - Checksums of installed files. Used by upgrade tool to see if files have been modified since installation.
** '''VERSION''' - The current version of EPrints.
** '''[[EPrints_Directory_Structure/eprints3/archives|archives/]]''' - Contains configuration and data for each repository
** '''[[EPrints_Directory_Structure/eprints3/bin|bin/]]''' - Contains command line tools.
** '''[[EPrints_Directory_Structure/eprints3/cfg|cfg/]]''' - Contains site-wide configuration files.
** '''[[EPrints_Directory_Structure/eprints3/cgi|cgi/]]''' - Contains CGI files (dynamic web pages)
** '''[[EPrints_Directory_Structure/eprints3/lib|lib/]]''' - Contains the read-only data used by EPrints (do not edit!)
** '''[[EPrints_Directory_Structure/eprints3/perl_lib|perl_lib/]]''' - Contains the perl-libraries used by EPrints
** '''[[EPrints_Directory_Structure/eprints3/testdata|testdata/]]''' - Contains a tool + data to import example data into your repository.
** '''[[EPrints_Directory_Structure/eprints3/var|var/]]''' - Used to store files output by EPrints including logs and process ID files.

A graphical tree-like [[EPrints Directory Structure Tree|expansion]] of this structure.

Archives/ARCHIVEID/

2007-07-03T12:19:39Z

Csirmaz:

{{dirs}}
This is the top level directory for a single repository.

It would not be called "ARCHIVEID" it would be called a sensible lowercase string to identify this repository.

*'''[[EPrints_Directory_Structure/eprints3|eprints3]]/[[EPrints_Directory_Structure/eprints3/archives|archives]]/ARCHIVEID'''
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg/]]''' - The repository configuration files.
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/documents|documents/]]''' - Uploaded documents. Also contains per-record files such as full-text caches, thumbnails and revision history.
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/html|html/]]''' - The website for this repository. Do not edit by hand.
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/var|var/]]''' - Files generated by eprints specific to this repository.
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/static|static/]]''' - Files which are copied to the website without any processing

Archives/ARCHIVEID/cfg/citations/

2007-07-03T11:15:59Z

Csirmaz:

{{dirs}}
This directory contains sub-directories for different types of [[Data Object]].

*'''[[EPrints_Directory_Structure/eprints3|eprints3]]/[[EPrints_Directory_Structure/eprints3/archives|archives]]/[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID|ARCHIVEID]]/[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]/citations'''
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/document|document/]]''' - [[Document Object]] citation configurations.
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/eprint|eprint/]]''' - [[EPrint Object]] citation configurations.
** '''[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/citations/user|user/]]''' - [[User Object]] citation configurations.

Translation

2007-07-03T08:18:20Z

Csirmaz: /* Setting document language */

Translation

2007-07-03T08:04:21Z

Csirmaz: /* Setting the language of outgoing e-mail messages */

Translation

2007-07-03T07:56:17Z

Csirmaz: /* Selecting the session's language */

Manual

2007-07-03T07:22:52Z

Csirmaz: /* Misc */

See the [[Main Page]] for other areas of this wiki.
__NOTOC__
= Introduction =

* [[Introduction]]
* How to Get Help/Support
* [[History]]

= Installing EPrints & Getting Started =

* [[Required software]]
* [[Installation|Installing EPrints]]
** [[Recommended Platforms]]
** [[Installing Eprints 3 on Fedora Core 6]]
** [[Installing EPrints 3 on RedHat Enterprise 4]]
** [[Installing EPrints 3 on OS X]]
** [[Installing EPrints 3 on Ubuntu 6.10]]
** ''[[:Category:Installation|other platforms]]''
* [[Upgrading EPrints 3 versions]]
* [[Migration|Migrating from EPrints 2.3]]
* [[Getting Started with EPrints 3|Getting Started]]
* [[Backups]]
* [[Troubleshooting]]
* Advanced Installation
** [[Https3]]
* [[:Category:Installation|Installing]] EPrints on various platforms.

= How-to Guides =

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

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

= Misc =

* [[Preservation Support]] in GNU EPrints 3
* [[i18n]]
* [[How to contribute]]
** [[Extension Packages]]

= Technical Reference =

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

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

Translation

2007-07-02T15:04:01Z

Csirmaz: /* Citation phrases with embedded pins */

Translation

2007-07-02T07:19:56Z

Csirmaz: /* Language dependent date and time */