Topic: Using the DHConvalidator with ConfTool Pro  (Read 48537 times)

We would like to use the DHConvalidator with ConfTool Pro. How do we proceed?

DHConvalidator setup for ADHO supported conferences managed with ConfTool

1.Installation of a new DHConvalidator instance

For ADHO supported conferences that are managed with ConfTool ADHO already offers a
DHConvalidator service running on the ADHO server.

For each conference a new DHConvalidator instance has to be installed at
/var/www/vhosts/adho.org/dhconvalidator/base/webapps
on that server.

Take the latest release from the DHConvalidator release site and unzip the release file into a new
folder named dhconvalidator-[conference acronym and year], for example:
/var/www/vhosts/adho.org/dhconvalidator/base/webapps/dhconvalidator-dhd2016

Note the name of the folder you created as you will need it in section 2.


2. Obtaining a publishable URL for the new instance

Internally the new DHConvalidator instance is already reachable. To obtain a publishable web
address that the DHConvalidator users can use to access the tool, you need to ask the administrator of the ADHO server to setup a new web domain that points to the internal address.

For example let's say in section 1 you created a folder named
dhconvalidator-dhd2016
Then the administrator of the ADHO server should create a publishable URL
http://www.adho.org/dhconvalidator-dhd2016
that points to the internal URL
http://www.digitalhumanities.org:8181/dhconvalidator-dhd2016

Note the publishable URL as you will need it in section 3 for the configuration of the new
DHConvalidator instance.


3. Configuration of a new DHConvalidator instance

In the folder you created in section 1 copy the file dhconvalidator.properties.example to
dhconvalidator.properties. Use this file dhconvalidator.properties to make the following
configurations. You need to restart the DHConvalidator for the changes to take effect, see section 4.

3.1. Base URL setting (mandatory)
Set the property base_url to the publishable URL you obtained in section 2 for example:
base_url=http://www.adho.org/dhconvalidator-dhd2016

3.2. ConfTool settings (mandatory)
The DHConvalidator requires the setting of three properties to communicate with ConfTool:
conftool_shared_pass, conftool_rest_url and conftool_login_url.
During setup of the ConfTool REST interface you should have collected the values for these three
properties:
  • conftool_shared_pass – REST interface password
  • conftool_rest_url – The URL of the REST interface
  • conftool_login_url – The URL of the login page of the ConfTool instance

3.3. Publisher settings (mandatory)
The property publicationStmt controls the publication statement of the TEI files. The value of this
property is usually provided by the local organizers of the conference or the publishers of the Book
Of Abstracts. For example the value for the DH 2015 in Sidney is:

Code: [Select]
<publicationStmt xmlns="http://www.tei-c.org/ns/1.0">
   <publisher>Paul Arthur, University of Western Sidney</publisher>
      <address>
         <addrLine>Locked Bag 1797</addrLine>
         <addrLine>Penrith NSW 2751</addrLine>
         <addrLine>Australia</addrLine>
         <addrLine>Paul Arthur</addrLine>
      </address>
</publicationStmt>
In contrary to the example above do not use line breaks in the property file!

3.4. Image requirements validation settings (optional)
The DHConvalidator can enforce a minimum resolution for embedded images. The default is
200x200 pixels:
image_min_resolution_width=200
image_min_resolution_height=200

Currently the DHConvalidator does not support the TIFF image format. See section 7.


4. Starting and stopping the new DHConvalidator instance

Start the DHConvalidator service with
/etc/init.d/dhconvalidator-jetty start
Stop the DHConvalidator service with
/etc/init.d/dhconvalidator-jetty stop


5. Integration of the DHConvalidator (optional)

The DHConvalidator should now already be accessible via the domain provided by the ADHO
server admin (see section 1). However the Login Box of the DHConvalidator can also be embedded
into the hosting conference site via an iframe:
<iframe src="http://www.adho.org/dhconvalidator-dhd2016/" height="230"
width="250" frameborder="0"></iframe>



6. Publishing the TEI files on the web

The DHConvalidator produces a .dhc file that contains
 
 1. the submission in TEI/XML format,
 2. the submission in HTML format,
 3. and embedded media such as images.

The .dhc file is a ZIP encoded file which can be unpacked with the usual tools such as unzip or
7Zip. The submission in HTML format already provides a web publishable file. All the .dhc files
unzipped in one folder are therefore already publishable as static web content. Each HTML file
contains a link on its corresponding TEI/XML file. As a last step all that is needed is an index file
that lists links to all the HTML files. One possibility would be to export the schedule from
ConfTool with links to the uploaded (.dhc) files and use that as an index file.

Steps:

 1. Unzip all .dhc file into one folder.
 2. Export the schedule as a single HTML file with embedded links to the uploaded files from
     ConfTool and put that file into the same folder.
 3. Search and replace all .dhc file endings in the schedule file with .html file endings.
 4. Copy the folder to a web folder and serve it as static content.

This is of course only one possibility to publish the Book Of Abstracts as HTML and TEI/XML.


7. Known Issues

You'll find known issues here.

We would like to thank Marco Petris for providing the description.

ConfTool setup for DHConvalidator support

Enabling the ConfTool REST interface

This short manual only describes the necessary steps to enable DHConvalidator support, for a
detailed description refer to the ConfTool documentation avaible in the posting REST Interface for Accessing Data in ConfTool Pro.

1. The URL of the Login page of your ConfTool instance should look like the following:
https:/ /www.conftool.pro/my_conference

2. Note the URL of the Login interface to be used later during DHConvalidator setup.

3. Login to your ConfTool instance.

4. Navigate to Overview=>Settings=>Main Setup

5. Enable the expert settings by adding “&advanced=1” to the URL of the page.

6. Reload the page.

7. Scroll down to “REST Interface Password” to define a shared pass phrase and enable the
interface. The pass phrase must have at least 8 characters.

8. Note the pass phrase to be used later during DHConvalidator setup.

9. Below the field you can find the URL of the REST interface. It looks like the following:
https:/ /www.conftool.pro/my_conference/rest.php

10. Note the URL of the REST interface to be used later during DHConvalidator setup.
The ConfTool REST interface should now be enabled to work with the DHConvalidator and you
should have collected three items that will be used later during DHConvalidator setup:
  • URL of the ConfTool Login page
  • REST Interface Password
  • URL of the ConfTool REST interface

We would like to thank Marco Petris for providing the description.