Merge pull request #107 from tarsqi/develop

Develop
tarsqi · Mar 2, 2021 · 0850070 · 0850070
2 parents 7732730 + 9b13a0c
commit 0850070
Show file tree

Hide file tree

Showing 39 changed files with 1,005 additions and 179 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,13 @@ This project tries to adhere to [Semantic Versioning](http://semver.org/).
 
 
 
+## Version 3.0.1 — 2021-03-02
+
+- Overhauled the documentation for GitHub pages.
+- Fixed issue with GUTime failing because working directory is not on search path anymore (issue [#105](https://github.com/tarsqi/ttk/issues/105)).
+- Fixed issue with warning in Python 3 (issue [#104](https://github.com/tarsqi/ttk/issues/104)).
+- Changed how the TTK_ROOT variable is loaded into the environment (issue [#103](https://github.com/tarsqi/ttk/issues/103)).
+
 ## Version 3.0.0 — 2021-01-05
 
 - Identical to version 2.2.1 except for some changes in documentation and minor changes in this file and the version file.

diff --git a/README.md b/README.md
@@ -2,4 +2,5 @@
 
 This is the main repository for the Tarsqi Toolkit (TTK), a set of processing components for extracting temporal information from news wire texts. TTK extracts time expressions, events, subordination links and temporal links; in addition, it can ensure consistency of temporal information.
 
-To use the Tarsqi Toolkit first either clone this repository or download the most recent release from https://github.com/tarsqi/ttk/releases, then follow the instructions in the manual at `docs/manual/index.html`.
+To use the Tarsqi Toolkit first either clone this repository or download the most recent release from https://github.com/tarsqi/ttk/releases, then follow the instructions in the manual link at `docs/index.html`.
+
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-3.0.0
+3.0.1
diff --git a/components/common_modules/tree.py b/components/common_modules/tree.py
@@ -414,7 +414,7 @@ def addEvent(self, event):
             event_attrs['eiid'] = eiid
             # TODO: at least the second test does not seem needed anymore
             event_attrs = { k: v for k, v in event_attrs.items()
-                            if v is not None and k is not 'eventID' }
+                            if v is not None and k != 'eventID' }
             self.tarsqidoc.add_event(token.begin, token.end, event_attrs)
 
     def addLink(self, linkAttrs, linkType):

diff --git a/components/gutime/TimeTag.pl b/components/gutime/TimeTag.pl
@@ -32,6 +32,9 @@
 # Read one document at a time
 $/ = "<\/$docTag>";
 
+use File::Basename;
+use lib dirname (__FILE__);
+
 use  TempEx;
 use  TempEx qw($TEmonthabbr %Month2Num);
 

diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,36 @@
+<html>
+
+  <head>
+
+    <title>The Tarsqi Toolkit</title>
+
+    <link href="manual/manual.css" rel="stylesheet" type="text/css">
+
+  </head>
+
+
+  <body>
+
+    <h1>The Tarsqi Toolkit</h1>
+
+    <p>The Tarsqi Toolkit (TTK) is a set of processing components for extracting
+    temporal information from news wire texts. TTK extracts time expressions,
+    events, subordination links and temporal links; in addition, it can ensure
+    consistency of temporal information.</p>
+
+    <p>The most recent version of TTK is 3.0.1 and its manual is available
+    at <a href="versions/3.0.1/index.html">versions/3.0.1/index.html</a>.</p>
+
+    <p>See <a href="papers/index.html">papers/index.html</a> for a list of publications.</p>
+
+    <!--
+    <p>On-line documentation for all versions that run on Python 3 is available at the following pages:</p>
+
+    <ul>
+      <li><a href="versions/3.0.1/index.html">version 3.0.1</a></li>
+    </ul>
+    -->
+
+  </body>
+
+</html>
diff --git a/docs/manual/build/.gitignore b/docs/manual/build/.gitignore
@@ -0,0 +1,2 @@
+treetagger
+mallet
diff --git a/docs/manual/build/install-mallet-osx.sh b/docs/manual/build/install-mallet-osx.sh
@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Example script on how to install MALLET on OSX. The download, install and test
+# variables let you determine what steps need to be taken. With the current
+# defaults the only thing that happens is that bin/mallet is run to print a list
+# of commands. See http://mallet.cs.umass.edu/quick-start.php.
+
+download=false
+install=false
+test=true
+
+archive=http://mallet.cs.umass.edu/dist/mallet-2.0.8.tar.gz
+
+
+if [ ! -d mallet ];
+then
+    mkdir mallet
+fi
+
+cd mallet
+
+if [ $download = "true" ];
+then
+    curl -O $archive
+fi
+
+if [ $install = "true" ];
+then
+    gunzip -c mallet-2.0.8.tar.gz | tar xp
+fi
+
+if [ $test = "true" ];
+then
+    mallet-2.0.8/bin/mallet --help
+fi
diff --git a/docs/manual/build/install-treetagger-osx.sh b/docs/manual/build/install-treetagger-osx.sh
@@ -0,0 +1,45 @@
+#!/bin/bash
+
+# Example script on how to install the TreeTagger on OSX. The download, install
+# and test variables let you determine what steps need to be taken. With the
+# current defaults the only thing that happens is that a TreeTagger installation
+# in treetagger will be tested with the test recommended by the TreeTagger
+# website (http://www.cis.uni-muenchen.de/~schmid/tools/TreeTagger/).
+
+# It is possible for the test to fail while the TreeTagger may still be used by
+# TTK. This can be the case when you have an older version of Perl (for example
+# version 5.12). The TreeTagger test in this file uses a Perl script named
+# utf8-tokenize.perl which uses the regular expression \p{XPosixCntrl} was not
+# yet available. If you want you can edit utf8-tokenize.perl and replace
+# \p{XPosixCntrl} with \p{Cntrl}.
+
+download=false
+install=false
+test=true
+
+data_dir=https://www.cis.uni-muenchen.de/~schmid/tools/TreeTagger/data/
+
+if [ ! -d treetagger ]; 
+then
+    mkdir treetagger
+fi
+
+cd treetagger
+
+if [ $download = "true" ]; 
+then
+    curl -O $data_dir/tree-tagger-MacOSX-3.2.3.tar.gz
+    curl -O $data_dir/tagger-scripts.tar.gz
+    curl -O $data_dir/install-tagger.sh
+    curl -O $data_dir/english.par.gz
+fi
+
+if [ $install = "true" ];
+then
+    sh install-tagger.sh
+fi
+
+if [ $test = "true" ];
+then
+    echo 'Hello world!' | cmd/tree-tagger-english 
+fi