VIVO Documentation
Old Release
This documentation relates to an old version of VIVO, version 1.12.x.
Looking for another version? See all documentation.
This document presents the process required to develop a new language to be integrated into VIVO and Vitro. It is intended for any developer who wishes to develop a new integrated language. The development process requires a good knowledge of the VIVO internal structure and its internal working mechanisms. This document describes the development cycle of new languages as well as the components required for this development.
Vivo's internationalization process is a five-step cycle:
This step consists in setting up the software elements necessary to run an VIVO instance on a local host.
First it is necessary to install Java, Maven, GIT, and SOLR. If necessary, you will find instructions at the following link: Starting with basic installation: Java-Maven-Solr-GIT
Secondly, it is essential to install the Apache Tomcat application server. You will find the necessary instructions for its installation at the following link: Installing Tomcat 8.5 for VIVO
Step | Action |
---|---|
1) Creating the GIT directoryWhether under Windows or on Unix it is necessary to create a space in which it is possible to work. As proposals we suggest creating a directory called under the Tomcat root directory. In the case of users and Unix we suggest to carry out the operations under the tomcat username. This precaution facilitates the management of credentials associated with development under Linux. | sudo -i -u tomcat # sudo in Linux - not on Windows mkdir $TOMCAT_HOME/GIT # $TOMCAT_HOME is predefined at the installation of Tomcat cd $TOMCAT_HOME/GIT |
2) Retrieving the codeTo VIVO internationalization, it is necessary to extract the four following GitHub repo: | git clone https://github.com/vivo-project/Vitro.git Vitro -b branch_name_to_be_coming git clone https://github.com/vivo-project/VIVO.git VIVO -b branch_name_to_be_coming git clone https://github.com/vivo-project/VIVO-languages VIVO-languages -b branch_name_to_be_coming git clone https://github.com/vivo-project/Vitro-languages Vitro-languages -b branch_name_to_be_coming |
Step | Action |
---|---|
1) Configuring SOLR | suivre les étapes de configuration disponible à ce lien: Configure and Start Solr |
2) Check vivocore in Solr | sudo systemctl start solr http://localhost:8983/solr/#/vivocoreIsabelle/core-overview |
Step | Action |
---|---|
1) Create VIVO home | sudo -i -u tomcat # for Linux user mkdir -p $TOMCAT_HOME/vivo_i18n/home cp -r $TOMCAT_HOME/GIT/vivo-uqam-i18n/vivo-project-i18n-config/vivo_i18n/home/* $TOMCAT_HOME/vivo_i18n/home/ |
2) Edit runtime.properties fileMake sure that attribute properties fit with current installation | sudo -u tomcat vi /opt/tomcat/vivo_i18n/home/config/runtime.properties runtime.properties Vitro.defaultNamespace = http://<adresse-ip-du-serveur>:8080/vivo/individual/ ... rootUser.emailAddress = vivo_i18n@uqam.ca ... VitroConnection.DataSource.url = jdbc:mysql://localhost/vivo_i18n VitroConnection.DataSource.username = vivo_i18n VitroConnection.DataSource.password = VIVO_I18N_MYSQL_PASSWORD ... vitro.local.solr.url = http://<server-ip-adress>:8983/solr/vivocore_i18n ... RDFService.languageFilter = true languages.selectableLocales = fr_CA, en_US, de_DE |
3) Edit and configure VIVO installation setting fileCheck that the file contains the following code: | sudo -u tomcat cp example_settings_i18n_linux.xml settings_i18n_linux.xml sudo -u tomcat vi settings_i18n_linux.xml settings_i18n_uqam.xml <settings xmlns="http://maven.apache.org/SETTINGS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd"> <profiles> <profile> <id>defaults</id> <properties> <app-name>vivo_i18n</app-name> <vivo-dir>/opt/tomcat/vivo_i18n/home</vivo-dir> <tomcat-dir>/opt/tomcat</tomcat-dir> <default-theme>wilma</default-theme> </properties> </profile> </profiles> <activeProfiles> <activeProfile>defaults</activeProfile> </activeProfiles> </settings> |