On 26.02.2013 16:04, Marshall Schor wrote:
On 2/26/2013 8:52 AM, Peter Klügl wrote:
On 26.02.2013 14:33, Marshall Schor wrote:
On 2/26/2013 6:16 AM, Jörn Kottmann wrote:
On 02/26/2013 10:29 AM, Peter Klügl wrote:
I think I have to reread the howtos. I thought the License/Notice files only
have to cover the stuff in the binaries. If antlr needs to be covered, what
about the htmlparser?
That is correct, you must only mention artifacts which are redistributed.
If the anltr or htmlparser jar is not included in the binary distribution you
should not mention them.
+1.
The reason I thought you needed to include the Antlr things was because in the
JAR's META-INF/DEPENDENCIES file, antlr things (and, yes, HTML Parser things,
too) are listed.
I believe this is because the POM specifies these as dependencies. But I see
they are not included (embedded) in the JAR. But I guess the JAR has calls out
to ANTLR and HTML Parser APIs.
Is this JAR (which is the only non-Eclipse plugin JAR in the binary zip/tar, I
think), intended to be used in a non-Eclipse setup?
Since I found this JAR in the "convenience" binary assembly, I presume there is
some intent that people who download this and unzip it want to be able to run
something. The normal convention for "convenience" binaries is to include
dependent JARs in a lib/ directory, or provide some install information that
tells the user what they need to do to complete an install of the binary. But I
don't see Jars for these included in the convenience binary assembly.
So, I'm probably just confused as to the purpose of the binary assembly - what
the expectation is that a user would do with this... I thought it was for
non-Eclipse, non- workbench uses. I took a quick look in the textmarker book to
see if this packaging was described and had install / use instructions but
didn't see this (but maybe I missed it).
So - bottom line - the Antlr and HTML parser license/notice do not have to be
included in this JAR (because these artifacts are not included with the JAR).
Since the JAR has dependencies on these, if it is intended to be used in a
non-Eclipse environment, then a convenience binary should include these JARs or
tell the user how to get them, I think.
Yes. I did not include the jars of the dependencies (antlr) in the binary
distribution because then I probably should also include the complete uimaj
release since textmarker won't do anything without the uimaj implementation.
Actually, the engine plugins contains all dependencies but the uimaj plugins.
Should I create an additional ("binary") README file, which mentions where to
find the jars of the additional dependencies?
I personally would wait until someone conplains about it.
What is the purpose of the binary convenience assembly? If not obvious, is some
section in the textmarker book needed to explain how to set this up and make use
of it?
You had a good point in your mail "Suggestion to add a binary zip/tar
distributable": A distribution for users that do not use maven or
eclipse, but want to use the AE or the example project. Thus, the
distribution contains, for example, the example project and the engine
plugin, which can be used to run the AE if you have uima in your classpath.
I have refrained from including everything textmarker needs to be
applied because this would also include uimaj, but maybe it is
reasonable to include only the other dependencies. In a scenario like
"download the UIMA Java framework and then the UIMA TextMarker dist",
the "uima-textmarker.jar" (which should be renamed to
textmarker-core.jar!) would still be not very useful since the other
dependencies are not included. On the other hand, the engine plugin
should do the job, even if using an eclipse bundle is not a very nice
solution.
The documentation contains no information about setting up projects in a
normal java environment right now, but focuses on the language and the
workbench. Maybe I am a bit naive, but I thought that the targeted users
already know what needs to be done to set up a java/uima project (e.g.,
adding the libs to your classpath). Such a description should also cover
how to include textmarker in maven-based projects.
I would add this kind of information rather to a webpage than to the
documentation, which remind me that something should be done about the
web-presence of textmarker.
I see five options to proceed:
1. remove the binary assembly from the release
2. keep it as it is right now
3. keep it as it is, but add a description somewhere how to set up java
projects
4. extend it by adding the other dependencies (e.g., antlr) and add a
note about downloading the UIMA Java framework
5. extend it by adding everything including uimaj
I prefer the former options (especially 2.) and would improve the usage
of textmarker in other scenarios in the following releases :-)
Peter
-Marshall
Peter
-Marshall
Jörn
