search

hltfbk / Excitement-Open-Platform

Excitement Open Platform for Recognizing Textual Entailments
http://hltfbk.github.io/Excitement-Open-Platform/
86 stars 74 forks source link

TreeTagger installation in documentation #202

Closed asher-stern closed 11 years ago

asher-stern commented 11 years ago

In the documentation - there is a link to “TreeTagger installation”. However, within that page there is no link to TreeTagger site/repository itself. There user has no way to know where to download TreeTagger from.

gilnoh commented 11 years ago

There user has no way to know where to download TreeTagger from.

Actually, the user don't need to visit TreeTagger homepage, nor download anything. He only needs to run the script. That's all. (The script first opens up the TreeTagger license text copied from TreeTagger homepage, and then downloads it, and then installs it. So all automatic).

Thus, can you elaborate a bit why this is problematic? --- Were you not able to run the script? or is it just a documentation "properly mentioning reference" issue that we should include tree tagger homepage for people who want to visit TreeTagger homepage ... or something else?

asher-stern commented 11 years ago

Well... This was not clear for me from the documentation. So, apparently the issue becomes to make it clearer in the documentation....

gilnoh commented 11 years ago

Oh. I think the confusion caused by my description "it is two steps: 1) download 2) install ". 1) is actually handled by the script; but the description is quite vague on the introduciton. If the user fully read the "instruction" part, it is quite clear IMO; but if the user stops at the instruction --- it can be confusing.

Okay. I will rewrite the introduction part and update this issue.

gilnoh commented 11 years ago

I've updated the documentation, to make it clearer. https://github.com/hltfbk/Excitement-Open-Platform/wiki/Treetagger-installation

I hope this version is clearler for the readers. Asher, can you please take a look at the page when you have some time? Feel free to close it, if the text reads clearer. If not, please leave me some comments :-). Thanks!

(The script directory also has the same documentation -- that has not been updated. Once this issue is closed, I will simply update the script-dir documentation by copying Wiki document.)

asher-stern commented 11 years ago

That's much better. So I think that this issue is resolved. However, to be on the safe side, and make sure that this specific confusion is prevented, you can add a sentence like: "Note - you don't have to download TreeTagger, neither to install it manually. The download and the installation is performed by the script." Perhaps even writing this sentence in bold would be a good idea.

gilnoh commented 11 years ago

"Note - you don't have to download TreeTagger, neither to install it manually. The download and the installation is performed by the script."Perhaps even writing this sentence in bold would be a good idea.

I fully agree to this statement ... but there is some reason why I intentionally avoided this type of "wording". In the document, I expressed explictely that everything is done by user, by his machine and his running of the script: that the user is downloading and user is explicitely agreeing, etc. Well --- because this is what actually happens in the installation steps.

It boils down to this question, "downloading and installation is done by EXCITEMENT? or the user?" I firmly believe that it is the user ... :-) especially the script has to be run by the user explicitely and the script shows and asks the license explicitely, etc.

Of course this is because of the license issue: currently Some discussion is going on between Helmut Schmid and Sebastian, about this. It seems that the treetagger owner feels that "if everything is done by script automatically, it is the same as redistributing the binary": Is this so, or not? kind of discussions.

Well, this is a gray area, and IMHO, providing script does not breaches TreeTagger license --- but if Helmut expresses his interpretation clearly, then we have to remove TreeTagger script all together --- which will make German users quite unhappy. I just don't want to give false impression that everything is handled by EXCITEMENT platform installation, and make sure it is the user who downloads and installs.

Thus, I won't touch the text for now ... Once dust settles and we get his understanding, I will add that sentence clearly, with big bold. :-) Or, we need to find something that works with GPL. Hmm... Maybe it would be actually faster for me to improve a Apache-licensed tagger :-( ( sigh )

Anyhow, I am closing the issue for now.