Summary

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.

Development Cycle

Vivo's internationalization process is a five-step cycle:

1. At the beginning of the cycle, the first step is to compile, deploy, and run the Vivo instance on the local computer.
2. The second step is to test and identify problems related to internationalization.
3. If everything works properly this ends the development cycle.
   1. When a problem is identified it is necessary to search the code to find the problem.
   2. This involves doing a lot of pattern managing search activities.
4. In fourth place, comes the stage of correcting the problem.
   1. Once the problem has been identified, the professional must edit the concerned file to make correction.
5. In step five certain databases need to be initialized depending on the type of correction made.
   1. Then back to step one of recompiling and running vivo.

Starting Step

This step consists in setting up the software elements necessary to run an VIVO instance on a local host.

VIVO's software infrastructure installation

Development Framework

Here is the list of prerequisites for VIVO development

• Java 1.8
• Maven 3.6
• Git 2
• Bash

Apache Tomcat

The VIVO host application is Apache Tomcat. You will find here 3) Installing Tomcat 8.5 for Vivo-1.11.0-i18n its installation procedure.

Apache SOLR

Apache Solr is the application that speeds up the search process in VIVO. You can find the installation procedure here: Configure and Start Solr

GigHub extraction of VIVO's code

This step consists of extracting the code needed to compile and develop the VIVO internationalization.

Item 1) Creating the workspace

Whether 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

Item 2) Extracting VIVO from GitHub

To 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

VIVO Initial Configuration

item 1) Configuring SOLR