No issue. Migrating wiki documentation to asciidoc.

dkpro-lab-doc/pom.xml

@@ -0,0 +1,99 @@
+<!--
+  Copyright 2015
+  Ubiquitous Knowledge Processing (UKP) Lab
+  Technische Universität Darmstadt
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>de.tudarmstadt.ukp.dkpro.lab</groupId>
+    <artifactId>dkpro-lab</artifactId>
+    <version>0.12.0-SNAPSHOT</version>
+  </parent>
+  <artifactId>dkpro-lab-doc</artifactId>
+  <packaging>pom</packaging>
+  <name>DKPro Lab - Documentation</name>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.asciidoctor</groupId>
+        <artifactId>asciidoctor-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>user-guide-html</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>process-asciidoc</goal>
+            </goals>
+            <configuration>
+              <backend>html5</backend>
+              <sourceHighlighter>coderay</sourceHighlighter>
+              <sourceDocumentName>user-guide.adoc</sourceDocumentName>
+              <imagesDir>./user-guide/images</imagesDir>
+              <attributes>
+                <toc>left</toc>
+                <include-dir>./user-guide/</include-dir>
+              </attributes>
+            </configuration>
+          </execution>
+          <execution>
+            <id>developer-guide-html</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>process-asciidoc</goal>
+            </goals>
+            <configuration>
+              <backend>html5</backend>
+              <sourceHighlighter>coderay</sourceHighlighter>
+              <sourceDocumentName>developer-guide.adoc</sourceDocumentName>
+              <imagesDir>./developer-guide/images</imagesDir>
+              <attributes>
+                <toc>left</toc>
+                <include-dir>./developer-guide/</include-dir>
+              </attributes>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <groupId>org.asciidoctor</groupId>
+          <artifactId>asciidoctor-maven-plugin</artifactId>
+          <version>1.5.2.1</version>
+          <configuration>
+            <attributes>
+              <toclevels>8</toclevels>
+              <sectanchors>true</sectanchors>
+              <docinfo1>true</docinfo1>
+              <project-version>${project.version}</project-version>
+              <revnumber>${project.version}</revnumber>
+              <icons>font</icons>
+            </attributes>
+          </configuration>
+          <dependencies>
+            <dependency>
+              <groupId>org.asciidoctor</groupId>
+              <artifactId>asciidoctorj-pdf</artifactId>
+              <version>1.5.0-alpha.9</version>
+            </dependency>
+          </dependencies>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+</project>

dkpro-lab-doc/src/main/asciidoc/developer-guide.adoc

@@ -0,0 +1,31 @@
+// Copyright 2015
+// Ubiquitous Knowledge Processing (UKP) Lab
+// Technische Universität Darmstadt
+// 
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// 
+// http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+    
+= DKPro Lab™ Developer Guide
+:Author: The DKPro Lab Team
+:toc-title: Developer Guide
+
+This document targets developers of DKPro Lab components.
+
+include::{include-dir}DeveloperSetup.adoc[]
+
+<<<
+
+include::{include-dir}ReleaseGuide.adoc[]
+
+<<<
+
+include::{include-dir}GuideToUsingWithGit.adoc[]

dkpro-lab-doc/src/main/asciidoc/developer-guide/DeveloperSetup.adoc

@@ -0,0 +1,19 @@
+// Copyright 2015
+// Ubiquitous Knowledge Processing (UKP) Lab
+// Technische Universität Darmstadt
+// 
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// 
+// http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+    
+## Developer Setup
+
+Nothing notable right now.

dkpro-lab-doc/src/main/asciidoc/developer-guide/GuideToUsingWithGit.adoc

@@ -0,0 +1,73 @@
+// Copyright 2015
+// Ubiquitous Knowledge Processing (UKP) Lab
+// Technische Universität Darmstadt
+// 
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// 
+// http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+    
+## Git and Eclipse.
+
+This is an introductory guide to using DKPro Lab with Git and Eclipse 4.3.1.
+
+### One time preparation
+
+We recommend installing `m2e-egit`, an Eclipse plug-in which add the option "Import Maven Projects..." to the context menu in the git repository view.
+
+   # In Eclipse, go to `Window` -> `Preferences` -> `Maven` -> `Discovery`.  Open `Catalog`.  Search for "m2e-egit".  Select it and Finish.
+   # Accept everything as default, agree to license, click Ok.  Keep installing unsigned content.
+   # Restart Eclipse when directed.
+
+### Create your local clone
+
+First, you need to create a clone of the remote repository on your local machine.
+
+   # Open Eclipse Git Repository Perspective.  Click "clone a git repository".
+   # In a browser, go to the DKPro Lab Google Code page, then `Source`.  Copy the "git clone" address, and paste it into the Eclipse `Clone Location URI`.  Other fields should auto-fill.  You will also need to get your Google Code password (from the GC DKPro Lab page, if you are signed in), and enter it here.  Username does not need to be your entire gmail address, which is different from when you commit svn to GC.  Use all other default options.
+   # Check out both "develop" and "master". Click `Next`
+   # Change `Initial branch` to `develop`.  This is the branch where your commits will go. Click `Finish`.
+
+Now, DKPro Lab should be listed in your Eclipse Git Repository.  You have made a local clone and have also checked out a branch to work on.  The next step is to make the java side of Eclipse aware of the local clone and checked-out branch's existence.
+
+Then you make a Maven copy for your Package Explorer.
+
+   # In Eclipse's Git Repository Perspective, open DKPro Lab, open `Working Directory`, right-click `de.tudarmstadt.ukp.dkpro.lab`, "Import Maven Projects..."
+   # Optionally, add it to the working set of your choice, then click Finish.
+
+Congradulations!  You are all set to begin developing DKPro lab.
+
+### Update your project
+
+   # Go to Git Repository Perspective, right-click, "pull."  This is just like svn update.  Now your local clone and your checked out branch are both updated and you are all set.
+
+### Commit your work
+
+When you are ready to merge your contributions with the main project, you can either commit entire files at once, or sets of changes from those files.
+
+#### To commit entire files
+
+   # Right-click on the Package Explorer files with your changes -> `Team` -> `addToIndex`.  Then the snowflake icon appears.
+   # Right-click on files with the changes -> `Team` -> `Commit`.  Add a commit message and click on the files you want to include.  Then, commit and push.  This is just like svn commit.
+
+#### To commit individual changes
+   # Go to Git Repository Perspective, then on the bottom of the screen go to `Git Staging`.  Click on your file.  It opens in a compare view.
+   # In between the 2 versions, click the arrow button for the changes you want to commit.  The changes are placed in the `index view`.
+   # Save this editor (Ctrl+s).
+   # Add a commit message, then commit and push.
+
+#### Committing with remote changes
+
+When you want to commit but someone else has committed since you last updated, you must stash your changes, update your local clone, and then replace your copy with the stash.  Git will not allow you to push your changes to the remote repository otherwise.
+
+   # Go to Git Repository Perspective.  Right-click on DKPro Lab -> "stash changes".  Call it "temp" or whatever.  Now, our local changes on the checked-out branch are gone, and saved in the Git Repository, in DKPro Lab, in "Stashed Commits."
+   # Right-click on project -> "pull."
+   # Right-click on your stashed commit("temp") -> "apply stashed changes."  Then our changes are back on our checked-out branch.  Delete the stashed copy.
+   # Now you are ready to commit.

dkpro-lab-doc/src/main/asciidoc/developer-guide/ReleaseGuide.adoc

@@ -0,0 +1,27 @@
+// Copyright 2015
+// Ubiquitous Knowledge Processing (UKP) Lab
+// Technische Universität Darmstadt
+// 
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// 
+// http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+    
+## Release guide
+
+  * Merge changes from development branch into master
+  * Make sure you are on the master branch
+  * For good measure, also change the system language to English on OS X in the System preferences and restart the terminal session
+  * `$ LANG='en_US.UTF-8'` -- switch to English to work around [http://jira.codehaus.org/browse/MRELEASE-812 MRELEASE-812]
+  * `$ mvn release:prepare -DautoVersionSubmodules=true` -- prepare the release
+  * `$ mvn release:perform` -- perform the release
+  * `$ cd target/checkout/de.tudarmstadt.ukp.dkpro.lab`
+  * `$ mvn javadoc:aggregate`
+  * Check out the *gh-pages* branch and place the new Javadoc under the appropriate release folder.

dkpro-lab-doc/src/main/asciidoc/user-guide.adoc

@@ -0,0 +1,27 @@
+// Copyright 2015
+// Ubiquitous Knowledge Processing (UKP) Lab
+// Technische Universität Darmstadt
+// 
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// 
+// http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+    
+= DKPro Lab™ User Guide and Reference
+:Author: The DKPro Lab Team
+:toc-title: User Guide
+
+This document targets users of DKPro Lab.
+
+include::{include-dir}TaskLifecycle.adoc[]
+
+<<<
+
+include::{include-dir}CrossValidation.adoc[]