You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2013/08/24 23:16:24 UTC
svn commit: r1517195 - in /uima/sandbox/uimafit/trunk:
uimafit-docbook/src/docbook/ uimafit-parent/
Author: rec
Date: Sat Aug 24 21:16:23 2013
New Revision: 1517195
URL: http://svn.apache.org/r1517195
Log:
[UIMA-3202] Fix documentation issues
- Fixed publication date
- Fixed grammar "allows + -ing"
- Updated references to org.uimafit
- Fixed long code lines in PDF
- Added TM to UIMA and uimaFIT
- Removed fixed-width font tags from titles as these are rendered in wrong font size in PDF
Modified:
uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/common_book_info.xml
uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.book.xml
uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.casutil.xml
uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.configurationparameters.xml
uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.experiments.xml
uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.externalresources.xml
uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.gettingstarted.xml
uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.maven.xml
uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.pipelines.xml
uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.typesystem.xml
uima/sandbox/uimafit/trunk/uimafit-parent/pom.xml
Modified: uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/common_book_info.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/common_book_info.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/common_book_info.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/common_book_info.xml Sat Aug 24 21:16:23 2013
@@ -23,10 +23,10 @@ under the License.
<releaseinfo>Version <?eval ${project.version}?></releaseinfo>
- <productname>Apache uimaFIT</productname>
+ <productname>Apache uimaFIT™</productname>
<authorgroup>
- <corpauthor>Written and maintained by the Apache UIMA Development Community</corpauthor>
+ <corpauthor>Written and maintained by the Apache UIMA™ Development Community</corpauthor>
</authorgroup>
<!--
@@ -47,7 +47,7 @@ under the License.
with the License. You may obtain a copy of the License at
<blockquote>
- <ulink url="http://www.apache.org/licenses/LICENSE-2.0"/>
+ <para><ulink url="http://www.apache.org/licenses/LICENSE-2.0"/></para>
</blockquote>
Unless required by applicable law or agreed to in writing,
Modified: uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.book.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.book.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.book.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.book.xml Sat Aug 24 21:16:23 2013
@@ -20,7 +20,7 @@ specific language governing permissions
under the License.
-->
<book lang="en">
- <title>Apache uimaFIT Guide and Reference</title>
+ <title>Apache uimaFIT™ Guide and Reference</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="common_book_info.xml"/>
<toc/>
Modified: uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.casutil.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.casutil.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.casutil.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.casutil.xml Sat Aug 24 21:16:23 2013
@@ -109,7 +109,8 @@
structures, e.g. <code>selectFS</code>.</para>
<para>Examples:</para>
<programlisting>// CAS version
-for (AnnotationFS token : CasUtil.select(cas, CasUtil.getType(cas, "my.Token"))) {
+Type tokenType = CasUtil.getType(cas, "my.Token");
+for (AnnotationFS token : CasUtil.select(cas, tokenType)) {
...
}
Modified: uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.configurationparameters.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.configurationparameters.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.configurationparameters.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.configurationparameters.xml Sat Aug 24 21:16:23 2013
@@ -83,7 +83,7 @@
</tgroup>
</table></para>
<programlisting>class MyAnalysisEngine
- extends org.uimafit.component.CasAnnotator_ImplBase {
+ extends org.apache.uima.fit.component.CasAnnotator_ImplBase {
/**
* Directory to read the data from.
Modified: uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.experiments.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.experiments.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.experiments.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.experiments.xml Sat Aug 24 21:16:23 2013
@@ -19,7 +19,7 @@
<chapter id="ugr.tools.uimafit.experiments">
<title>Running Experiments</title>
<para>The <emphasis>uimafit-examples</emphasis> module contains a package
- <package>org.uimafit.examples.experiment.pos</package> which demonstrates a very simple
+ <package>org.apache.uima.fit.examples.experiment.pos</package> which demonstrates a very simple
experimental setup for testing a part-of-speech tagger. You may find this example more
accessible if you check out the code from subversion and build it in your own
environment.</para>
@@ -32,7 +32,7 @@
evaluate how well your analysis engine works against that data. Here we are evaluating
<classname>BaselineTagger</classname> which is a (ridiculously) simple part-of-speech tagger
against the part-of-speech tags found in
- <filename>src/main/resources/org/uimafit/examples/pos/sample.txt.pos</filename></para>
+ <filename>src/main/resources/org/apache/uima/fit/examples/pos/sample-gold.txt</filename></para>
</blockquote>
<para>The basic strategy is as follows:</para>
<itemizedlist>
Modified: uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.externalresources.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.externalresources.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.externalresources.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.externalresources.xml Sat Aug 24 21:16:23 2013
@@ -31,7 +31,7 @@
loaded.</para>
<programlisting>// Simple model that only stores the URI it was loaded from. Normally data
// would be loaded from the URI instead and made accessible through methods
-// in this class. This simple example only allows to access the URI.
+// in this class. This simple example only allows accessing the URI.
public static final class SharedModel implements SharedResourceObject {
private String uri;
@@ -56,7 +56,8 @@ public static final class SharedModel im
public void initialize(UimaContext context)
throws ResourceInitializationException {
- configuredResource = (SharedModel) getContext().getResourceObject(MODEL_KEY);
+ configuredResource = (SharedModel)
+ getContext().getResourceObject(MODEL_KEY);
}
}</programlisting>
<para>uimaFIT can be used to inject external resources into such traditional components using
@@ -111,10 +112,10 @@ createDependencyAndBind(tokenizer, UimaU
</tbody>
</tgroup>
</table>
- <programlisting>// Example annotator that uses the SharedModel. In the process() we only test
-// if the model was properly initialized by uimaFIT
+ <programlisting>// Example annotator that uses the SharedModel. In the process() we only
+// test if the model was properly initialized by uimaFIT
public static class Annotator
- extends org.uimafit.component.JCasAnnotator_ImplBase {
+ extends org.apache.uima.fit.component.JCasAnnotator_ImplBase {
final static String MODEL_KEY = "Model";
@ExternalResource(key = MODEL_KEY)
@@ -198,7 +199,7 @@ ae.process(ae.newJCas());</programlistin
<emphasis>uimaFIT-examples</emphasis> project.</para>
</section>
<section>
- <title>Resources extending <classname>Resource_ImplBase</classname></title>
+ <title>Resources extending Resource_ImplBase</title>
<para>One kind of resources extend <classname>Resource_ImplBase</classname>. These are the
easiest to handle, because uimaFIT's version of <classname>Resource_ImplBase</classname>
already implements the necessary logic. Just be sure to call
@@ -219,7 +220,7 @@ ae.process(ae.newJCas());</programlistin
}</programlisting>
</section>
<section>
- <title>Resources implementing <interfacename>SharedResourceObject</interfacename></title>
+ <title>Resources implementing SharedResourceObject</title>
<para>The other kind of resources implement
<interfacename>SharedResourceObject</interfacename>. Since this is an interface, uimaFIT
cannot provide the initialization logic, so you have to implement a couple of things in the
Modified: uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.gettingstarted.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.gettingstarted.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.gettingstarted.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.gettingstarted.xml Sat Aug 24 21:16:23 2013
@@ -31,7 +31,7 @@
a project dependency by adding the following snippet of XML to your pom.xml file:</para>
<programlisting><dependency>
<groupId>org.apache.uima</groupId>
- <artifactId>uimafit</artifactId>
+ <artifactId>uimafit-core</artifactId>
<version><?eval ${project.version}?></version>
</dependency></programlisting>
<para>uimaFIT distributions are hosted by Maven Central and so no repository needs to be added
@@ -52,7 +52,7 @@
<para> Here is the complete analysis engine implementation for this example.</para>
<programlisting format="linespecific">public class GetStartedQuickAE
- extends org.uimafit.component.JCasAnnotator_ImplBase {
+ extends org.apache.uima.fit.component.JCasAnnotator_ImplBase {
public static final String PARAM_STRING = "stringParam";
@ConfigurationParameter(name = PARAM_STRING)
@@ -103,12 +103,12 @@ analysisEngine.process(jCas); </program
<para>Normally you would be using a type system with your analysis components. When using
uimaFIT, it is easiest to keep your type system descriptors in your source folders and make
them known to uimaFIT. To do so, create a file
- <filename>META-INF/org.uimafit/types.txt</filename> in a source folder and add references to
+ <filename>META-INF/org.apache.uima.fit/types.txt</filename> in a source folder and add references to
all your type descriptors to the file, one per line. You can also use wildcards. For example: </para>
- <programlisting>classpath*:org/uimafit/examples/type/Token.xml
-classpath*:org/uimafit/examples/type/Sentence.xml
-classpath*:org/uimafit/examples/tutorial/type/*.xml </programlisting>
+ <programlisting>classpath*:org/apache/uima/fit/examples/type/Token.xml
+classpath*:org/apache/uima/fit/examples/type/Sentence.xml
+classpath*:org/apache/uima/fit/examples/tutorial/type/*.xml </programlisting>
</section>
<section>
Modified: uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.maven.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.maven.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.maven.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.maven.xml Sat Aug 24 21:16:23 2013
@@ -31,8 +31,8 @@ under the License.
annotations in already compiled classes and to automatically generate XML descriptors from the
annotated classes.</para>
<section>
- <title><literal>enhance</literal> goal</title>
- <para>The goal enhance allows to automatically augment compiled classes with uimaFIT
+ <title>enhance goal</title>
+ <para>The goal enhance allows automatically augmenting compiled classes with uimaFIT
annotations. Information like vendor, copyright, or version can be obtained from the Maven
POM. Additionally, descriptions for parameters and components can be generated from Javadoc
comments. Existing annotations are not overwritten unless forced. </para>
@@ -87,15 +87,15 @@ under the License.
<!-- Constant name prefixes used for parameters and external resources,
e.g. "PARAM_". -->
<parameterNameConstantPrefixes>
- <parameterNameConstantPrefix>PARAM_<parameterNameConstantPrefix/>
+ <prefix>PARAM_<prefix/>
</parameterNameConstantPrefixes>
<!-- OPTIONAL -->
<!-- Fail on missing meta data. This setting has no effect unless
generateMissingMetaDataReport is enabled. -->
<externalResourceNameConstantPrefixes>
- <externalResourceNameConstantPrefix>KEY_<externalResourceNameConstantPrefix/>
- <externalResourceNameConstantPrefix>RES_<externalResourceNameConstantPrefix/>
+ <prefix>KEY_<prefix/>
+ <prefix>RES_<prefix/>
</externalResourceNameConstantPrefixes>
</configuration>
<executions>
@@ -132,7 +132,7 @@ private MyResource resource;</programlis
directory.</para>
</section>
<section>
- <title><literal>generate</literal> goal</title>
+ <title>generate goal</title>
<para>The generate goal generates XML component descriptors for UIMA components. </para>
<programlisting><plugin>
<groupId>org.apache.uima</groupId>
@@ -141,7 +141,9 @@ private MyResource resource;</programlis
<configuration>
<!-- OPTIONAL -->
<!-- Path where the generated resources are written. -->
- <outputDirectory>${project.build.directory}/generated-sources/uimafit</outputDirectory>
+ <outputDirectory>
+ ${project.build.directory}/generated-sources/uimafit
+ </outputDirectory>
<!-- OPTIONAL -->
<!-- Skip generation of META-INF/org.apache.uima.fit/components.txt -->
Modified: uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.pipelines.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.pipelines.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.pipelines.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.pipelines.xml Sat Aug 24 21:16:23 2013
@@ -18,7 +18,7 @@
-->
<chapter id="ugr.tools.uimafit.pipelines">
<title>Pipelines</title>
- <para>UIMA is a component-based architecture that allows to compose various processing components
+ <para>UIMA is a component-based architecture that allows composing various processing components
into a complex processing pipeline. A pipeline typically involves a <emphasis>collection
reader</emphasis> which ingests documents and <emphasis>analysis engines</emphasis> that do
the actual processing.</para>
@@ -67,6 +67,7 @@ AnalysisEngineDescription tokenizer =
Tokenizer.class);
for (JCas jcas : SimplePipeline.iteratePipeline(reader, tokenizer)) {
- System.out.printf("Found %d tokens%n", JCasUtil.select(jcas, Token.class).size());
+ System.out.printf("Found %d tokens%n",
+ JCasUtil.select(jcas, Token.class).size());
}</programlisting>
</chapter>
Modified: uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.typesystem.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.typesystem.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.typesystem.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-docbook/src/docbook/tools.uimafit.typesystem.xml Sat Aug 24 21:16:23 2013
@@ -63,17 +63,17 @@
<programlisting>AnalysisEngine ae = createEngine(MyEngine.class);</programlisting>
</section>
<section>
- <title>Multiple <filename>META-INF/org.uimafit/types.txt</filename> files</title>
+ <title>Multiple META-INF/org.apache.uima.fit/types.txt files</title>
<para>uimaFIT supports multiple `types.txt` files in the classpath (e.g. in differnt JARs). The
<filename>types.txt</filename> files are located via Spring using the classpath search
pattern: </para>
- <programlisting>TYPE_MANIFEST_PATTERN = "classpath*:META-INF/org.uimafit/types.txt" </programlisting>
+ <programlisting>TYPE_MANIFEST_PATTERN = "classpath*:META-INF/org.apache.uima.fit/types.txt" </programlisting>
<para>This resolves to a list URLs pointing to ALL <filename>types.txt</filename> files. The
resolved URLs are unique and will point either to a specific point in the file system or into
a specific JAR. These URLs can be handled by the standard Java URL loading mechanism.
Example:</para>
- <programlisting>jar:/path/to/syntax-types.jar!/META-INF/org.uimafit/types.txt
-jar:/path/to/token-types.jar!/META-INF/org.uimafit/types.txt</programlisting>
+ <programlisting>jar:/path/to/syntax-types.jar!/META-INF/org.apache.uima.fit/types.txt
+jar:/path/to/token-types.jar!/META-INF/org.apache.uima.fit/types.txt</programlisting>
<para>uimaFIT then reads all patters from all of these URLs and uses these to search the
classpath again. The patterns now resolve to a list of URLs pointing to the individual type
system XML descriptors. All of these URLs are collected in a set to avoid duplicate loading
@@ -112,7 +112,7 @@ classpath*:desc/type/Syntax.xml </progra
<para>The mechanism works fine. However, there are specific issues with Java in general that one
should be aware of.</para>
<section>
- <title>m2eclipse fails to copy descriptors to <filename>target/classes</filename></title>
+ <title>m2eclipse fails to copy descriptors to target/classes</title>
<para>There seems to be a bug in some older versions of m2eclipse that causes resources not
always to be copied to <filename>target/classes</filename>. If UIMA complains about type
definitions missing at runtime, try to <emphasis>clean/rebuild</emphasis> your project and
Modified: uima/sandbox/uimafit/trunk/uimafit-parent/pom.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uimafit/trunk/uimafit-parent/pom.xml?rev=1517195&r1=1517194&r2=1517195&view=diff
==============================================================================
--- uima/sandbox/uimafit/trunk/uimafit-parent/pom.xml (original)
+++ uima/sandbox/uimafit/trunk/uimafit-parent/pom.xml Sat Aug 24 21:16:23 2013
@@ -140,6 +140,34 @@
<build>
<plugins>
<plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>buildnumber-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>create-build-year</id>
+ <phase>validate</phase>
+ <goals>
+ <goal>create-timestamp</goal>
+ </goals>
+ <configuration>
+ <timestampFormat>yyyy</timestampFormat>
+ <timestampPropertyName>buildYear</timestampPropertyName>
+ </configuration>
+ </execution>
+ <execution>
+ <id>create-build-month</id>
+ <phase>validate</phase>
+ <goals>
+ <goal>create-timestamp</goal>
+ </goals>
+ <configuration>
+ <timestampFormat>MMMM</timestampFormat>
+ <timestampPropertyName>buildMonth</timestampPropertyName>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<configuration>
@@ -174,6 +202,11 @@
<pluginManagement>
<plugins>
<plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>buildnumber-maven-plugin</artifactId>
+ <version>1.2</version>
+ </plugin>
+ <plugin>
<groupId>org.apache.uima</groupId>
<artifactId>jcasgen-maven-plugin</artifactId>
<version>${uima.version}</version>