On 2/26/2013 11:06 AM, Peter Klügl wrote: > 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. >>>> <snip> > > 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 :-) >
I think that because this is a Sandbox release, and the first one, that it's OK to have some unfinished rough edges. I do think it ought to have a certain level of internal consistency, though. Because there's currently no documentation on how users would use the binary assembly, and, indeed, there may be undocumented install steps, such as stated above - renaming a JAR, I think the user community would get the best impression of this new project's first release if we went with option 1. I would be OK, also, with option 2, but think it might reduce the impression new users would have of this project, a bit, so I prefer it less :-). -Marshall
