Merge pull request #67 from aramiscd/master

Preparing a new release
ADHO · Jul 3, 2018 · f84d21f · f84d21f
2 parents 4e0a72f + bb9ddbe
commit f84d21f
Show file tree

Hide file tree

Showing 246 changed files with 20,157 additions and 7,703 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,11 +1,2 @@
-.classpath
-.project
-.settings
-testdata
-build
-WebContent/dhconvalidator_*.properties
-WebContent/dhconvalidator.properties
-WebContent/VAADIN/themes/dhconvalidator/styles.css
-WebContent/VAADIN/widgetsets
-scratch.jpage
-deploy
+/.gradle/
+/build/
diff --git a/LICENCE b/LICENCE
diff --git a/README.md b/README.md
@@ -1,33 +1,59 @@
 # DHConvalidator
 
-The goal of the DHConvalidator is a simplification of the creation of a consistent [TEI] (http://www.tei-c.org) text base of Digital Humanities (DH) conference abstracts for further processing like the generation of the book of abstracts. The idea was to offer the user the possibility to edit the final version of the submission with her tool of choice starting with two of the most popular systems Libre Office and Microsoft Word. 
-
-The DHConvalidator works together with the conference management tool [ConfTool] (http://www.conftool.net/) and uses [OxGarage] (http://www.tei-c.org/oxgarage/) to do the bulk conversion.
-
-The submission of the final version is composed of four steps after logging in:
-
-1. Generates a template for each of his submissions for one of the supported editing systems via the Template Generation Service.
-2. Adding subtitle (optional), content, notes (optional) and references (optional) to the template.
-3. Converting the template to a .dhc package via the Conversion and Validation Service
+**Offical Repository:**
+[ADHO/dhconvalidator](https://github.com/ADHO/dhconvalidator)
+
+The goal of the DHConvalidator is a simplification of the creation of a
+consistent [TEI] (http://www.tei-c.org) text base of Digital Humanities
+(DH) conference abstracts for further processing like the generation of
+the book of abstracts. The idea was to offer the user the possibility to
+edit the final version of the submission with her tool of choice
+starting with two of the most popular systems Libre Office and Microsoft
+Word. 
+
+The DHConvalidator works together with the conference management tool
+[ConfTool] (http://www.conftool.net/) and uses [OxGarage]
+(http://www.tei-c.org/oxgarage/) to do the bulk conversion.
+
+The submission of the final version is composed of four steps after
+logging in:
+
+1. Generates a template for each of his submissions for one of the
+   supported editing systems via the Template Generation Service.
+2. Adding subtitle (optional), content, notes (optional) and references
+   (optional) to the template.
+3. Converting the template to a .dhc package via the Conversion and
+   Validation Service
 4. Uploading the .dhc package to ConfTool
 
-The .dhc package contains the original edited template file (docx or odt), the TEI version, integrated media files and a HTML version of the submission.
+The .dhc package contains the original edited template file (docx or
+odt), the TEI version, integrated media files and a HTML version of the
+submission.
 
 ## Installation
-Take the latest [WAR file release] (https://github.com/mpetris/dhconvalidator/blob/master/release/) or create a WAR file yourself and extract it to a Servlet container (Jetty 9 or higher, Tomcat 8 or higher). 
 
-Copy the dhconvalidator.properties.example to dhconvalidator.properties and edit it as needed:
+Take the latest [WAR file release]
+(https://github.com/mpetris/dhconvalidator/blob/master/release/) or
+create a WAR file yourself and extract it to a Servlet container (Jetty
+9 or higher, Tomcat 8 or higher). 
+
+Copy the dhconvalidator.properties.example to dhconvalidator.properties
+and edit it as needed:
 - Set the ConfTool REST interface settings like URL and shared password. 
-- Set the OxGarage webservice URL (Note that the dhconvalidator TEI/Stylesheets profile must be installed for the OxGarage webservice)
-- Edit settings for validation, min resolution, publication statement and so on.
+- Set the OxGarage webservice URL (Note that the dhconvalidator
+- TEI/Stylesheets profile must be installed for the OxGarage webservice)
+- Edit settings for validation, min resolution, publication statement
+- and so on.
 
 ## Optional integration into a conference host page
-Integration of the DHConvalidator is done via integrating an IFRAME into the host site:
+
+Integration of the DHConvalidator is done via integrating an IFRAME into
+the host site:
 
 ```
 <iframe src="http://mydomain/dhconvalidator/" height="230" width="250" frameborder="0">
 </iframe>`
 ```
 
-To avoid cross site scripting issues the domain should be the same as the domain of the host site. 
-
+To avoid cross site scripting issues the domain should be the same as
+the domain of the host site. 
diff --git a/WebContent/META-INF/MANIFEST.MF b/WebContent/META-INF/MANIFEST.MF
diff --git a/WebContent/dhconvalidator.properties.example b/WebContent/dhconvalidator.properties.example
diff --git a/build.gradle b/build.gradle
@@ -0,0 +1,25 @@
+apply plugin: 'war'
+
+repositories { flatDir { dirs 'libs' } }
+
+dependencies {
+  compile name: 'commons-io-2.1'
+  compile name: 'flute-1.3.0.gg2'
+  compile name: 'guava-16.0.1.vaadin1'
+  compile name: 'guava-18.0'
+  compile name: 'jsoup-1.8.1'
+  compile name: 'org.restlet'
+  compile name: 'org.restlet.ext.html'
+  compile name: 'sac-1.3'
+  compile name: 'serializer'
+  compile name: 'streamhtmlparser-jsilver-0.0.10.vaadin1'
+  compile name: 'vaadin-client-compiled-7.5.5'
+  compile name: 'vaadin-sass-compiler-0.9.12'
+  compile name: 'vaadin-server-7.5.5'
+  compile name: 'vaadin-shared-7.5.5'
+  compile name: 'vaadin-themes-7.5.5'
+  compile name: 'xercesImpl-2.8.1'
+  compile name: 'xml-apis'
+  compile name: 'xom-1.2.7'
+  providedCompile name: 'javax.servlet-api-3.0.1'
+}
diff --git a/ivy.xml b/ivy.xml
diff --git a/ivysettings.xml b/ivysettings.xml
diff --git a/WebContent/WEB-INF/lib/commons-io-2.1.jar → libs/commons-io-2.1.jar b/WebContent/WEB-INF/lib/commons-io-2.1.jar → libs/commons-io-2.1.jar
diff --git a/libs/flute-1.3.0.gg2.jar b/libs/flute-1.3.0.gg2.jar
diff --git a/libs/guava-16.0.1.vaadin1.jar b/libs/guava-16.0.1.vaadin1.jar
diff --git a/WebContent/WEB-INF/lib/guava-18.0.jar → libs/guava-18.0.jar b/WebContent/WEB-INF/lib/guava-18.0.jar → libs/guava-18.0.jar
diff --git a/libs/javax.servlet-api-3.0.1.jar b/libs/javax.servlet-api-3.0.1.jar
diff --git a/libs/jsoup-1.8.1.jar b/libs/jsoup-1.8.1.jar
diff --git a/...tent/WEB-INF/lib/org.restlet.ext.html.jar → libs/org.restlet.ext.html.jar b/...tent/WEB-INF/lib/org.restlet.ext.html.jar → libs/org.restlet.ext.html.jar
diff --git a/WebContent/WEB-INF/lib/org.restlet.jar → libs/org.restlet.jar b/WebContent/WEB-INF/lib/org.restlet.jar → libs/org.restlet.jar
diff --git a/libs/sac-1.3.jar b/libs/sac-1.3.jar
diff --git a/WebContent/WEB-INF/lib/serializer.jar → libs/serializer.jar b/WebContent/WEB-INF/lib/serializer.jar → libs/serializer.jar
diff --git a/libs/streamhtmlparser-jsilver-0.0.10.vaadin1.jar b/libs/streamhtmlparser-jsilver-0.0.10.vaadin1.jar
diff --git a/libs/vaadin-client-compiled-7.5.5.jar b/libs/vaadin-client-compiled-7.5.5.jar
diff --git a/libs/vaadin-sass-compiler-0.9.12.jar b/libs/vaadin-sass-compiler-0.9.12.jar
diff --git a/libs/vaadin-server-7.5.5.jar b/libs/vaadin-server-7.5.5.jar
diff --git a/libs/vaadin-shared-7.5.5.jar b/libs/vaadin-shared-7.5.5.jar
diff --git a/libs/vaadin-themes-7.5.5.jar b/libs/vaadin-themes-7.5.5.jar
diff --git a/WebContent/WEB-INF/lib/xercesImpl-2.8.1.jar → libs/xercesImpl-2.8.1.jar b/WebContent/WEB-INF/lib/xercesImpl-2.8.1.jar → libs/xercesImpl-2.8.1.jar
diff --git a/WebContent/WEB-INF/lib/xml-apis.jar → libs/xml-apis.jar b/WebContent/WEB-INF/lib/xml-apis.jar → libs/xml-apis.jar
diff --git a/WebContent/WEB-INF/lib/xom-1.2.7.jar → libs/xom-1.2.7.jar b/WebContent/WEB-INF/lib/xom-1.2.7.jar → libs/xom-1.2.7.jar
diff --git a/release/dhconvalidator_1_0.war b/release/dhconvalidator_1_0.war
diff --git a/release/dhconvalidator_1_1.war b/release/dhconvalidator_1_1.war
diff --git a/release/dhconvalidator_1_10.war b/release/dhconvalidator_1_10.war
diff --git a/release/dhconvalidator_1_11.war b/release/dhconvalidator_1_11.war
diff --git a/release/dhconvalidator_1_12.war b/release/dhconvalidator_1_12.war
diff --git a/release/dhconvalidator_1_13.war b/release/dhconvalidator_1_13.war
diff --git a/release/dhconvalidator_1_14.war b/release/dhconvalidator_1_14.war
diff --git a/release/dhconvalidator_1_15.war b/release/dhconvalidator_1_15.war
diff --git a/release/dhconvalidator_1_16.war b/release/dhconvalidator_1_16.war
diff --git a/release/dhconvalidator_1_17.war b/release/dhconvalidator_1_17.war
diff --git a/release/dhconvalidator_1_18.war b/release/dhconvalidator_1_18.war
diff --git a/release/dhconvalidator_1_19.war b/release/dhconvalidator_1_19.war
diff --git a/release/dhconvalidator_1_2.war b/release/dhconvalidator_1_2.war
diff --git a/release/dhconvalidator_1_20.war b/release/dhconvalidator_1_20.war
diff --git a/release/dhconvalidator_1_21.war b/release/dhconvalidator_1_21.war
diff --git a/release/dhconvalidator_1_3.war b/release/dhconvalidator_1_3.war
diff --git a/release/dhconvalidator_1_4.war b/release/dhconvalidator_1_4.war
diff --git a/release/dhconvalidator_1_5.war b/release/dhconvalidator_1_5.war
diff --git a/release/dhconvalidator_1_6.war b/release/dhconvalidator_1_6.war
diff --git a/release/dhconvalidator_1_7.war b/release/dhconvalidator_1_7.war
diff --git a/release/dhconvalidator_1_8.war b/release/dhconvalidator_1_8.war
diff --git a/release/dhconvalidator_1_9.war b/release/dhconvalidator_1_9.war
diff --git a/src/de/catma/backgroundservice/DefaultBackgroundService.java b/src/de/catma/backgroundservice/DefaultBackgroundService.java
diff --git a/.../backgroundservice/BackgroundService.java → .../backgroundservice/BackgroundService.java b/.../backgroundservice/BackgroundService.java → .../backgroundservice/BackgroundService.java
@@ -1,6 +1,6 @@
-/*   
+/*
  *   CATMA Computer Aided Text Markup and Analysis
- *   
+ *
  *   Copyright (C) 2009  University Of Hamburg
  *
  *   This program is free software: you can redistribute it and/or modify
@@ -15,35 +15,29 @@
  *
  *   You should have received a copy of the GNU General Public License
  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */   
-
+ */
 
 package de.catma.backgroundservice;
 
-
 /**
- * Executes background tasks. An  {@link ExecutionListener} is notified when 
- * the task is done. The notification takes place in the initiating Thread.<br>
+ * Executes background tasks. An {@link ExecutionListener} is notified when the task is done. The
+ * notification takes place in the initiating Thread.<br>
  * <br>
  *
  * @author Marco Petris
- *
  */
 public interface BackgroundService {
-
-	/**
-	 * @param <T> the type of the {@link ExecutionListener} and 
-	 * 		the {@link ProgressCallable}.
-	 *  
-	 * @param callable the task which should be done in the background 
-	 * @param listener this one will be notified when the task is 
-	 * 		done (within the initiating thread)
-	 * @param progressListener the listener for progress. The implementer 
-	 *		of the {@link ProgressCallable} which defines the task can
-	 *		call this listener to notify progress to the initiating thread.
-	 */
-	public <T> void submit( 
-			final ProgressCallable<T> callable, 
-			final ExecutionListener<T> listener,
-			final ProgressListener progressListener);	
+
+  /**
+   * @param <T> the type of the {@link ExecutionListener} and the {@link ProgressCallable}.
+   * @param callable the task which should be done in the background
+   * @param listener this one will be notified when the task is done (within the initiating thread)
+   * @param progressListener the listener for progress. The implementer of the {@link
+   *     ProgressCallable} which defines the task can call this listener to notify progress to the
+   *     initiating thread.
+   */
+  public <T> void submit(
+      final ProgressCallable<T> callable,
+      final ExecutionListener<T> listener,
+      final ProgressListener progressListener);
 }