MultiLang Fields Bazaar Package - Revision history

Mamalos@eng.auth.gr at 10:28, 7 July 2016

2016-07-07T10:28:42Z

Mamalos@eng.auth.gr: /* Warning for already populated repositories */

2016-07-07T10:28:09Z

‎Warning for already populated repositories

Mamalos@eng.auth.gr: /* How to use the plugin */

2016-07-07T10:25:22Z

‎How to use the plugin

Mamalos@eng.auth.gr: /* Editing the phrase files */

2016-06-24T09:58:16Z

‎Editing the phrase files

Mamalos@eng.auth.gr: /* Editing the phrase files */

2016-06-24T09:57:36Z

‎Editing the phrase files

Mamalos@eng.auth.gr: /* Editing the phrase files */

2016-06-24T09:56:48Z

‎Editing the phrase files

Mamalos@eng.auth.gr at 09:54, 24 June 2016

2016-06-24T09:54:53Z

Mamalos@eng.auth.gr: /* Warning for already populated repositories */

2016-06-24T09:44:54Z

‎Warning for already populated repositories

Mamalos@eng.auth.gr: /* How the plugin works */

2016-06-07T10:55:14Z

‎How the plugin works

Mamalos@eng.auth.gr at 10:52, 7 June 2016

2016-06-07T10:52:27Z

@@ Line 11: / Line 11: @@
 == Warning for already populated repositories ==
-Once this plugin is installed, '''existing titles and abstracts''' will not be copied into their multilingual counterparts and '''access to them via the API will be lost'''! The users of this plugin are requested to use EPrints API to copy the values from the old fields to the new ones.
+Once this plugin is installed, '''existing titles and abstracts''' will not be copied into their multilingual counterparts and '''access to them via the API will be lost'''! The users of this plugin are requested to use EPrints API to copy the values from the old fields to the new ones. A script that copies the '''title''' value of each eprint to '''ml_title''' field's '''en''' and '''el''' languages can be found here:[https://github.com/mamalos/eprints/blob/master/help_scripts/set_ml_title.pl]. Please, use this script at your own risk and don't forget to change its content to reflect the languages of your repository. The same script can be used for copying the '''abstract''' field's values to '''ml_abstract''' '''en''' and '''el''' by replacing title with abstract in this script.
 == How to use the plugin ==
-Once the plugin has been installed, the user needs to edit the workflow to contain the multilingual fields' versions instead of the default ones. This procedure is explained in the next section. A script that copies the '''title''' value of each eprint to '''ml_title''' field's '''en''' and '''el''' languages can be found here:[https://github.com/mamalos/eprints/blob/master/help_scripts/set_ml_title.pl]. Please, use this script at your own risk and don't forget to change its content to reflect the languages of your repository. The same script can be used for copying the '''abstract''' field's values to '''ml_abstract''' '''en''' and '''el''' by replacing title with abstract in this script.
+Once the plugin has been installed, the user needs to edit the workflow to contain the multilingual fields' versions instead of the default ones. This procedure is explained in the next section.
 == Editing the workflow ==

@@ Line 11: / Line 11: @@
 == Warning for already populated repositories ==
-Once this plugin is installed, '''existing titles and abstracts''' will not be copied into their multilingual counterparts and '''access to them via the API will be lost'''! The users are requested to use EPrints API to copy the values from the old fields to the new ones.
+Once this plugin is installed, '''existing titles and abstracts''' will not be copied into their multilingual counterparts and '''access to them via the API will be lost'''! The users of this plugin are requested to use EPrints API to copy the values from the old fields to the new ones.
 == How to use the plugin ==

@@ Line 14: / Line 14: @@
 == How to use the plugin ==
-Once the plugin has been installed, the user needs to edit the workflow to contain the multilingual fields' versions instead of the default ones. This procedure is explained in the next section.
+Once the plugin has been installed, the user needs to edit the workflow to contain the multilingual fields' versions instead of the default ones. This procedure is explained in the next section. A script that copies the '''title''' value of each eprint to '''ml_title''' field's '''en''' and '''el''' languages can be found here:[https://github.com/mamalos/eprints/blob/master/help_scripts/set_ml_title.pl]. Please, use this script at your own risk and don't forget to change its content to reflect the languages of your repository. The same script can be used for copying the '''abstract''' field's values to '''ml_abstract''' '''en''' and '''el''' by replacing title with abstract in this script.
 == Editing the workflow ==

@@ Line 37: / Line 37: @@
 == Editing the phrase files ==
-The plugin updates the EPrints system by providing an English and a Greek phrase file for the new fields it creates. The new fields are named '''ml_title''' and '''ml_abstract'''. So, if this plugin is used for repositories in other languages than these, the site administrator needs to provide the appropriate phrase files for their languages manually. What they can do is copy the phrases from the English language phrase file located in '''~eprints/archives/<reponame>/cfg/lang/en/phrases/local.xml''' and copy them to a new file located in ~eprints/archives/<reponame>/cfg/lang/<your_lang>/phrases/'''. The file-name should have an '''xml''' extension (like '''local.xml''' in our example).
+The plugin updates the EPrints system by providing an English and a Greek phrase file for the new fields it creates. The new fields are named '''ml_title''' and '''ml_abstract'''. So, if this plugin is used for repositories in other languages than these, the site administrator needs to provide the appropriate phrase files for their languages manually. What they can do is copy the phrases from the English language phrase file located in '''~eprints/archives/<reponame>/cfg/lang/en/phrases/local.xml''' and copy them to a new file located in '''~eprints/archives/<reponame>/cfg/lang/<your_lang>/phrases/'''. The file-name should have an '''xml''' extension (like '''local.xml''' in our example).
 The phrases that need to be added are the following (excerpt from the Greek phrases file):

@@ Line 47: / Line 47: @@
      <epp:phrase id="eprint_fieldname_ml_title_lang">Γλώσσα</epp:phrase>
      <epp:phrase id="eprint_fieldhelp_ml_title">Ο τίτλος του τεκμηρίου. Ο τίτλος δεν πρέπει να τελειώνει με τελεία, αλλά μπορεί να τελειώνει με ερωτηματικό. Δεν υπάρχει τρόπος να γράψετε με πλάγια γράμματα, παρακαλώ χρησιμοποιήστε απλό κείμενο. Εάν έχετε έναν υπότιτλο, θα πρέπει να προηγείται η άνω και κάτω τελεία του υπότιτλου [:]. Χρησιμοποιήστε κεφαλαία γράμματα μόνο στην πρώτη λέξη και στα κύρια ονόματα.
-<br/>Παράδειγμα: <span class="ep_form_example">Μια σύντομη ιστορία</span>
+        <br/>Παράδειγμα: <span class="ep_form_example">Μια σύντομη ιστορία</span>
-<br/>Παράδειγμα: <span class="ep_form_example">Καβάφης: η βιογραφία</span>
+        <br/>Παράδειγμα: <span class="ep_form_example">Καβάφης: η βιογραφία</span>
-<br/>Παράδειγμα: <span class="ep_form_example">Μαθηματικά για μηχανικούς και επιστήμονες. 5η έκδοση</span>
+        <br/>Παράδειγμα: <span class="ep_form_example">Μαθηματικά για μηχανικούς και επιστήμονες. 5η έκδοση</span>
-<br/>Παράδειγμα: <span class="ep_form_example">Οικοσυστήματα του πλανήτη. Τόμ. 26. Εκβολές του πλανήτη.</span>
+        <br/>Παράδειγμα: <span class="ep_form_example">Οικοσυστήματα του πλανήτη. Τόμ. 26. Εκβολές του πλανήτη.</span>
-</epp:phrase>
+    </epp:phrase>
 <!-- multilang abstract related phrases -->

@@ Line 34: / Line 34: @@
 <source lang="bash">
 ./epadmin reload reponame
 </source>

@@ Line 46: / Line 46: @@
 == How the plugin works ==
-Basically, what the plugin does is that it replaces EPrints default '''title''' and '''abstract''' fields with two new fields that support multiple languages. The procedure that we followed in order to achieve this functionality was the following:
+Basically, what the plugin does is that it replaces EPrints default '''title''' and '''abstract''' field types with a type that supports storing and retrieving information on multilingual fields. The procedure that we followed in order to achieve this functionality was the following:
 * We introduced a new field's type, '''virtualwithvalue''', that would allow our fields to override EPrints fields' default behaviour.

← Older revision		Revision as of 10:52, 7 June 2016
Line 14:		Line 14:

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