Skip to content

Commit 7230a6a

Browse files
Merge pull request #15 from Edirom/update-main-branch
Update main branch
2 parents 40e4903 + 1b2361e commit 7230a6a

19 files changed

Lines changed: 6685 additions & 38 deletions

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*.xpr
2+
build/
3+
4+
*.DS_Store
5+
.existdb.json
6+
dist/*

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
1-
# EditionExample
2-
An example edition for Edirom Online
1+
# Edition Example
2+
This example edition is to build a sample edition data set that can be installed in [eXist-db](https://github.com/eXist-db/exist) alongside [_Edirom Online_](https://github.com/Edirom/Edirom-Online). The data set is to provide two perspectives on Edirom Online:
3+
4+
1. A feature based perspective providing test respective sample data for single features available in _Edirom Online_ that can be used to:
5+
1. test the implementation of certain features
6+
2. explore the steps necessary to provide a certain feature in the context of your edition's data
7+
2. A user or content based perspective illustrating the capabilities of _Edirom Online_ in an annotated manner
8+
9+
# License Information
10+
This project is generally licensed und the terms of [Creative Commons Attribution 4.0 International (CC-BY 4.0)](https://creativecommons.org/licenses/by/4.0/) except for files stating otherwise.
11+
12+
[![CC-BY-4.0](https://i.creativecommons.org/l/by/4.0/88x31.png "Creative Commons Attribution 4.0 International License")](http://creativecommons.org/licenses/by/4.0/)
13+
14+
# Building
15+
16+
1. In order to build a [EXPath Package](http://exist-db.org/exist/apps/doc/repo.xml) you need Apache ANT installed on your system.
17+
2. Download the EditionExample code or clone it via git.
18+
3. Then open your command line prompt and navigate to the EditionExample folder, e.g.
19+
```terminal
20+
cd /Users/User/GitHub/EditionExample
21+
```
22+
4. Then launch the build process by executing
23+
```terminal
24+
ant
25+
```
26+
The default build target `xar` of `build.xml` will generate a folder "dist" in the Repository containing `EditionExample-VERSION.xar` e.g. `EditionExample-0.1.xar`. This file can be uploaded to your _eXist-db_ instance.

build.properties

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#
2+
# Don't directly modify this file.
3+
# Instead, copy it to local.build.properties and edit that.
4+
#
5+
project.app=EditionExample
6+
dist.dir=dist

build.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project default="xar" name="EditionExample" basedir=".">
3+
4+
<!-- import default properties -->
5+
<property file="build.properties"/>
6+
<xmlproperty file="expath-pkg.xml"/>
7+
8+
<property name="project.version" value="${package(version)}"/>
9+
<property name="project.name" value="${package(name)}"/>
10+
11+
<target name="xar">
12+
<mkdir dir="${dist.dir}"/>
13+
<zip basedir="." destfile="${dist.dir}/${project.app}-${project.version}.xar" excludes="${dist.dir}/"/>
14+
</target>
15+
16+
</project>

collection.xconf

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<collection xmlns="http://exist-db.org/collection-config/1.0">
2+
<index xmlns:tei="http://www.tei-c.org/ns/1.0">
3+
<!-- Full text index based on Lucene -->
4+
<lucene>
5+
<analyzer class="org.apache.lucene.analysis.standard.StandardAnalyzer"/>
6+
<analyzer id="ws" class="org.apache.lucene.analysis.core.WhitespaceAnalyzer"/>
7+
<text qname="tei:title" boost="2.0"/>
8+
<text qname="@type" analyzer="ws"/>
9+
<text qname="@key" analyzer="ws"/>
10+
<text qname="tei:persName" boost="2.0"/>
11+
<text qname="tei:orgName" boost="2.0"/>
12+
<text qname="tei:settlement" boost="2.0"/>
13+
14+
</lucene>
15+
16+
<!-- Range indexes -->
17+
<range>
18+
<create qname="tei:title" type="xs:string"/>
19+
<create qname="tei:bibl" type="xs:string"/>
20+
<create qname="tei:persName" type="xs:string"/>
21+
<create qname="tei:persName" type="xs:string">
22+
<field name="persName-key" match="@key" type="xs:string"/>
23+
</create>
24+
<create qname="tei:objectDesc">
25+
<field name="objectDesc-form" match="@form" type="xs:string"/>
26+
</create>
27+
<create qname="tei:correspAction">
28+
<field name="correspAction-type" match="@type" type="xs:string"/>
29+
</create>
30+
<create qname="tei:date">
31+
<field name="date-type" match="@type" type="xs:string"/>
32+
<field name="date-when" match="@when" type="xs:date"/>
33+
</create>
34+
<create qname="tei:note">
35+
<field name="note-type" match="@type" type="xs:string"/>
36+
</create>
37+
<create qname="@type" type="xs:string"/>
38+
<create qname="tei:collection" type="xs:string">
39+
<field name="collection-key" match="@key" type="xs:string"/>
40+
</create>
41+
<create qname="tei:repository" type="xs:string">
42+
<field name="repository-key" match="@key" type="xs:string"/>
43+
</create>
44+
45+
<!--<create qname="author" type="xs:string"/>
46+
<create qname="year" type="xs:integer"/>-->
47+
</range>
48+
<!-- N-gram indexes -->
49+
<!--<ngram qname="author"/>
50+
<ngram qname="title"/>-->
51+
</index>
52+
<triggers>
53+
<trigger event="store,update,remove,create,rename,delete" class="org.exist.collections.triggers.HistoryTrigger"/>
54+
</triggers>
55+
</collection>

0 commit comments

Comments
 (0)