Merge pull request #20 from adamretter/master

Switch to Maven

.gitignore

@@ -1,2 +1,3 @@
-expath-pkg.xml
-build
+target/
+*.iml
+.idea/

.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+
+language: java
+
+jdk:
+  - oraclejdk8
+  - oraclejdk9
+
+script: mvn -B test package
+
+notifications:
+  hipchat: ec8fcfa661addc56a361a8ef536320@integrations

LGPL2.1-template.txt

@@ -0,0 +1,17 @@
+${project.name}
+${project.description}
+Copyright (C) ${project.inceptionYear} ${organization}
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

README.md

@@ -1,3 +1,33 @@
-# function-documentation
+# eXist-db Function Documentation Browser App
+[![Build Status](https://travis-ci.org/eXist-db/function-documentation.svg?branch=master)](https://travis-ci.org/eXist-db/function-documentation)
+[![eXist-db version](https://img.shields.io/badge/eXist_db-4.0.0-blue.svg)](http://www.exist-db.org/exist/apps/homepage/index.html)
 
-XQuery Function Documentation and Browser App
+<img src="src/main/xar-resources/icon.png" align="left" width="15%"/>
+
+This repository contains the function documentation borwser app for the [eXist-db native XML database](http://www.exist-db.org).
+
+## Dependencies
+-   [Maven](https://maven.apache.org): 3.5.2
+-   [eXist-db](http://exist-db.org): 4.0.0
+
+## Installation
+-   Just go to your eXist server's Dashboard and select Function Documentation.
+-   Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at [http://exist-db.org/exist/apps/public-repo/](http://exist-db.org/exist/apps/public-repo/).
+
+## Building from source
+1.  Clone the repository to your system:
+    ```bash
+    $ git clone https://github.com/exist-db/function-documentation.git
+    ```
+
+2.  Build the function documentation application:
+    ```bash
+    $ cd function-documentation
+    $ mvn clean package
+    ```
+    The compiled `.xar` file is located in the `/target` directory
+
+3.  Install this file via the Dashboard > Package Manager.
+
+## License
+LGPLv2.1 [eXist-db.org](http://exist-db.org/exist/apps/homepage/index.html)

pom.xml

@@ -0,0 +1,148 @@
+<?xml version="1.0"?>
+<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>org.exist-db</groupId>
+        <artifactId>exist-apps-parent</artifactId>
+        <version>1.5</version>
+        <relativePath />
+    </parent>
+
+    <groupId>org.exist-db</groupId>
+    <artifactId>exist-function-documentation</artifactId>
+    <version>1.1-SNAPSHOT</version>
+
+    <name>XQuery Function Documentation</name>
+    <description>XQuery Function Documentation package for eXist-db</description>
+    <url>https://www.github.com/exist-db/documentation</url>
+    <inceptionYear>2001</inceptionYear>
+
+    <organization>
+        <name>eXist-db</name>
+        <url>http://exist-db.org</url>
+    </organization>
+
+    <licenses>
+        <license>
+            <name>GNU Lesser General Public License, version 2.1</name>
+            <url>http://opensource.org/licenses/LGPL-2.1</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+
+    <scm>
+        <url>https://www.github.com/exist-db/function-documentation.git</url>
+        <connection>scm:git:https://www.github.com/exist-db/function-documentation.git</connection>
+        <developerConnection>scm:git:https://www.github.com/exist-db/function-documentation.git</developerConnection>
+      <tag>HEAD</tag>
+  </scm>
+    <issueManagement>
+        <system>GitHub</system>
+        <url>https://github.com/eXist-db/function-documentation/issues</url>
+    </issueManagement>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.build.source>1.8</project.build.source>
+        <project.build.target>1.8</project.build.target>
+
+        <exist.version>4.0.0</exist.version>
+
+        <package-name>http://exist-db.org/apps/fundocs</package-name>
+	<package-abbrev>fundocs</package-abbrev>  <!-- override the default which is artifactId :-/ -->
+    </properties>
+
+    <reporting>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-changes-plugin</artifactId>
+                <version>2.12.1</version>
+                <configuration>
+                    <onlyCurrentVersion>true</onlyCurrentVersion>
+                    <columnNames>Type, Summary</columnNames>
+                </configuration>
+                <reportSets>
+                    <reportSet>
+                        <reports>
+                            <report>github-report</report>
+                        </reports>
+                    </reportSet>
+                </reportSets>
+            </plugin>
+        </plugins>
+    </reporting>
+
+    <build>
+        <resources>
+            <resource>
+                <directory>src/main/xar-resources</directory>
+                <filtering>true</filtering>
+                <includes>
+                    <include>templates/**</include>
+                </includes>
+            </resource>
+            <resource>
+                <directory>src/main/xar-resources</directory>
+                <filtering>false</filtering>
+                <excludes>
+                    <exclude>templates/**</exclude>
+                </excludes>
+            </resource>
+        </resources>
+
+        <plugins>
+
+            <plugin>
+                <groupId>ro.kuberam.maven.plugins</groupId>
+                <artifactId>kuberam-expath-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>create-xar</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>make-xar</goal>
+                        </goals>
+                        <configuration>
+                            <descriptor>xar-assembly.xml</descriptor>
+                            <finalName>${package-final-name}</finalName>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-gpg-plugin</artifactId>
+                <configuration>
+                    <useAgent>true</useAgent>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-release-plugin</artifactId>
+                <configuration>
+                    <mavenExecutorId>forked-path
+                    </mavenExecutorId> <!-- avoid a bug with GPG plugin hanging http://jira.codehaus.org/browse/MGPG-9 -->
+                    <autoVersionSubmodules>true</autoVersionSubmodules>
+                    <tagNameFormat>@{project.version}</tagNameFormat>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <repositories>
+        <repository>
+            <id>exist</id>
+            <url>https://raw.github.com/eXist-db/mvn-repo/master/</url>
+        </repository>
+    </repositories>
+
+    <pluginRepositories>
+        <pluginRepository>
+            <id>clojars.org</id>
+            <url>http://clojars.org/repo</url>
+        </pluginRepository>
+    </pluginRepositories>
+</project>