Revision: 14984
http://gate.svn.sourceforge.net/gate/?rev=14984&view=rev
Author: markagreenwood
Date: 2012-01-10 14:58:59 +0000 (Tue, 10 Jan 2012)
Log Message:
-----------
moved the documentation of obsolete plugins into an appendix, but kept the
section names so help URLs etc. continue to work
Modified Paths:
--------------
userguide/trunk/misc-creole.tex
userguide/trunk/recent-changes.tex
userguide/trunk/tao_main.tex
Added Paths:
-----------
userguide/trunk/obsolete-plugins.tex
Modified: userguide/trunk/misc-creole.tex
===================================================================
--- userguide/trunk/misc-creole.tex 2012-01-10 14:57:57 UTC (rev 14983)
+++ userguide/trunk/misc-creole.tex 2012-01-10 14:58:59 UTC (rev 14984)
@@ -1550,71 +1550,8 @@
Corpus Pipeline and run it after crawling. You could combine the two functions
by carefully developing a Scriptable Controller (see
section~\ref{sec:api:groovy:controller} for details).
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\sect[sec:misc-creole:google]{Google Plugin}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-This plugin is no longer operational because the functionality, provided by
-Google, on which it depends, is no longer available.
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\sect[sec:misc-creole:yahoo]{Yahoo Plugin}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-The Yahoo API is now integrated with GATE, and can be used as a PR-based
-plugin. This plugin, `Web\_Search\_Yahoo', allows the user to query Yahoo and
-build a document corpus that contains the search results returned by Yahoo for
-the query. For more information about the Yahoo API please refer to
-\htlinkplain{http://developer.yahoo.com/search/}. In order to use the Yahoo
-PR, you need to obtain an application ID.
-
-The Yahoo PR can be used for a number of different application scenarios. For
-example, one use case is where a user wants to find the different named
-entities that can be associated with a particular individual. In this example,
-the user could build a collection of documents by querying Yahoo with the
-individual's name and then running ANNIE over the collection. This would
-annotate the results and show the different Organization, Location and other
-entities that are associated with the query.
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsect{Using the YahooPR}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-In order to use the PR, you first need to load the plugin using the
-GATE Developer plugin manager. Once the PR is loaded, it can be
-initialized by creating an instance of a new PR. Here you need to
-specify the Yahoo Application ID. Please use the license key assigned
-to you by registering with Yahoo.
-
-Once the Yahoo PR is initialized, it can be placed in a pipeline
-or a conditional pipeline application. This pipeline would contain the
instance
-of the Yahoo PR just initialized as above. There are a number of
-parameters to be set at runtime:
-
-\begin{itemize}
-\item \verb|corpus|: The corpus used by the plugin to add or append
-documents from the Web.
-
-\item \verb|corpusAppendMode|: If set to \verb|true|, will append documents
-to the corpus. If set to \verb|false|, will remove preexisting
-documents from the corpus, before adding the documents newly fetched by the PR
-
-\item \verb|limit|: A limit on the results returned by the search. Default set
to
-10.
-
-\item \verb|pagesToExclude|: This is an optional parameter. It is a list with
-URLs not to be included in the search.
-
-\item \verb|query|: The query sent to Yahoo. It is in the format
-accepted by Yahoo.
-
-\end{itemize}
-
-Once the required parameters are set we can run the pipeline. This
-will then download all the URLs in the results and create a document
-for each. These documents would be added to the corpus.
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\sect[sec:misc-creole:google-translate]{Google Translator PR}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -2065,67 +2002,7 @@
\item[Keyphrase annotation type] the type for the generated annotations.
\end{description}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\sect[sec:misc-creole:japec]{Ontotext JapeC Compiler}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\textit{Note: the JapeC compiler does not currently support the new JAPE
-language features introduced in July--September 2008. If you need to use
-negation, the \texttt{@length} and \texttt{@string} accessors, the contextual
-operators \texttt{within} and \texttt{contains}, or any comparison operators
-other than \texttt{==}, then you will need to use the standard JAPE
-transducer instead of JapeC.}
-
-JapeC is an alternative implementation of the JAPE language which works by
-compiling JAPE grammars into Java code. Compared to the standard
-implementation, these compiled grammars can be several times faster to run. At
-Ontotext, a modified version of the ANNIE sentence splitter using compiled
-grammars has been found to run up to five times as fast as the standard
-version. The compiler can be invoked manually from the command line, or used
-through the `Ontotext Japec Compiler' PR in the {\it Jape\_Compiler} plugin.
-
-The `Ontotext Japec Transducer' (com.ontotext.gate.japec.JapecTransducer) is
-a processing resource that is designed to be an alternative to the original
-Jape Transducer. You can simply replace gate.creole.Transducer with
-com.ontotext.gate.japec.JapecTransducer in your gate application and it should
-work as expected.
-
-The Japec transducer takes the same parameters as the standard JAPE transducer:
-\begin{description}
-\item[grammarURL] the URL from which the grammar is to be loaded. Note that
-the Japec Transducer will {\it only} work on {\tt file:} URLs. Also, the
-alternative {\it binaryGrammarURL} parameter of the standard transducer is not
-supported.
-\item[encoding] the character encoding used to load the grammars.
-\item[ontology] the ontology used for ontolog-aware transduction.
-\end{description}
-
-Its runtime parameters are likewise the same as those of the standard
-transducer:
-\begin{description}
-\item[document] the document to process.
-\item[inputASName] name of the AnnotationSet from which input annotations to
-the transducer are read.
-\item[outputASName] name of the AnnotationSet to which output annotations from
-the transducer are written.
-\end{description}
-
-The Japec compiler itself is written in Haskell. Compiled binaries are
-provided for Windows, Linux (x86) and Mac OS X (PowerPC), so no Haskell
-interpreter is required to run Japec on these platforms. For other platforms,
-or if you make changes to the compiler source code, you can build the compiler
-yourself using the Ant build file in the Jape\_Compiler plugin directory. You
-will need to install the latest version of the Glasgow Haskell
-Compiler\footnote{GHC version 6.4.1 was used to build the supplied binaries for
-Windows, Linux and Mac} and associated libraries. The japec compiler can then
-be built by running:
-\begin{verbatim}
-../../bin/ant japec.clean japec
-\end{verbatim}
-from the Jape\_Compiler plugin directory.
-
-
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\sect[sec:misc-creole:merging]{Annotation Merging Plugin}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Added: userguide/trunk/obsolete-plugins.tex
===================================================================
--- userguide/trunk/obsolete-plugins.tex (rev 0)
+++ userguide/trunk/obsolete-plugins.tex 2012-01-10 14:58:59 UTC (rev
14984)
@@ -0,0 +1,137 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\chapt[chap:obsolete-plugins]{Obsolete CREOLE Plugins}
+\markboth{Obsolete CREOLE Plugins}{Obsolete CREOLE Plugins}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+These plugins should not be needed for new development with GATE, but are
documented here
+in case they are required by an old application. Note that the obsolete
plugins do not
+appear in GATE's plugin manager by default.
+
+% The remainder of this appendix is maintained simply by moving the
documentation of
+% obsolete plugins from where they were originally included to here. Note that
you
+% must ensure that section labels etc. are maintained so that help URLs are not
+% broken when the documentation is moved here.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\sect[sec:misc-creole:japec]{Ontotext JapeC Compiler}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\textit{Note: the JapeC compiler does not currently support the new JAPE
+language features introduced in July--September 2008. If you need to use
+negation, the \texttt{@length} and \texttt{@string} accessors, the contextual
+operators \texttt{within} and \texttt{contains}, or any comparison operators
+other than \texttt{==}, then you will need to use the standard JAPE
+transducer instead of JapeC.}
+
+JapeC is an alternative implementation of the JAPE language which works by
+compiling JAPE grammars into Java code. Compared to the standard
+implementation, these compiled grammars can be several times faster to run. At
+Ontotext, a modified version of the ANNIE sentence splitter using compiled
+grammars has been found to run up to five times as fast as the standard
+version. The compiler can be invoked manually from the command line, or used
+through the `Ontotext Japec Compiler' PR in the {\it Jape\_Compiler} plugin.
+
+The `Ontotext Japec Transducer' (com.ontotext.gate.japec.JapecTransducer) is
+a processing resource that is designed to be an alternative to the original
+Jape Transducer. You can simply replace gate.creole.Transducer with
+com.ontotext.gate.japec.JapecTransducer in your gate application and it should
+work as expected.
+
+The Japec transducer takes the same parameters as the standard JAPE transducer:
+\begin{description}
+\item[grammarURL] the URL from which the grammar is to be loaded. Note that
+the Japec Transducer will {\it only} work on {\tt file:} URLs. Also, the
+alternative {\it binaryGrammarURL} parameter of the standard transducer is not
+supported.
+\item[encoding] the character encoding used to load the grammars.
+\item[ontology] the ontology used for ontolog-aware transduction.
+\end{description}
+
+Its runtime parameters are likewise the same as those of the standard
+transducer:
+\begin{description}
+\item[document] the document to process.
+\item[inputASName] name of the AnnotationSet from which input annotations to
+the transducer are read.
+\item[outputASName] name of the AnnotationSet to which output annotations from
+the transducer are written.
+\end{description}
+
+The Japec compiler itself is written in Haskell. Compiled binaries are
+provided for Windows, Linux (x86) and Mac OS X (PowerPC), so no Haskell
+interpreter is required to run Japec on these platforms. For other platforms,
+or if you make changes to the compiler source code, you can build the compiler
+yourself using the Ant build file in the Jape\_Compiler plugin directory. You
+will need to install the latest version of the Glasgow Haskell
+Compiler\footnote{GHC version 6.4.1 was used to build the supplied binaries for
+Windows, Linux and Mac} and associated libraries. The japec compiler can then
+be built by running:
+\begin{verbatim}
+../../bin/ant japec.clean japec
+\end{verbatim}
+from the Jape\_Compiler plugin directory.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\sect[sec:misc-creole:google]{Google Plugin}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+This plugin is no longer operational because the functionality, provided by
+Google, on which it depends, is no longer available.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\sect[sec:misc-creole:yahoo]{Yahoo Plugin}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+The Yahoo API is now integrated with GATE, and can be used as a PR-based
+plugin. This plugin, `Web\_Search\_Yahoo', allows the user to query Yahoo and
+build a document corpus that contains the search results returned by Yahoo for
+the query. For more information about the Yahoo API please refer to
+\htlinkplain{http://developer.yahoo.com/search/}. In order to use the Yahoo
+PR, you need to obtain an application ID.
+
+The Yahoo PR can be used for a number of different application scenarios. For
+example, one use case is where a user wants to find the different named
+entities that can be associated with a particular individual. In this example,
+the user could build a collection of documents by querying Yahoo with the
+individual's name and then running ANNIE over the collection. This would
+annotate the results and show the different Organization, Location and other
+entities that are associated with the query.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\subsect{Using the YahooPR}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+In order to use the PR, you first need to load the plugin using the
+GATE Developer plugin manager. Once the PR is loaded, it can be
+initialized by creating an instance of a new PR. Here you need to
+specify the Yahoo Application ID. Please use the license key assigned
+to you by registering with Yahoo.
+
+Once the Yahoo PR is initialized, it can be placed in a pipeline
+or a conditional pipeline application. This pipeline would contain the
instance
+of the Yahoo PR just initialized as above. There are a number of
+parameters to be set at runtime:
+
+\begin{itemize}
+\item \verb|corpus|: The corpus used by the plugin to add or append
+documents from the Web.
+
+\item \verb|corpusAppendMode|: If set to \verb|true|, will append documents
+to the corpus. If set to \verb|false|, will remove preexisting
+documents from the corpus, before adding the documents newly fetched by the PR
+
+\item \verb|limit|: A limit on the results returned by the search. Default set
to
+10.
+
+\item \verb|pagesToExclude|: This is an optional parameter. It is a list with
+URLs not to be included in the search.
+
+\item \verb|query|: The query sent to Yahoo. It is in the format
+accepted by Yahoo.
+
+\end{itemize}
+
+Once the required parameters are set we can run the pipeline. This
+will then download all the URLs in the results and create a document
+for each. These documents would be added to the corpus.
Modified: userguide/trunk/recent-changes.tex
===================================================================
--- userguide/trunk/recent-changes.tex 2012-01-10 14:57:57 UTC (rev 14983)
+++ userguide/trunk/recent-changes.tex 2012-01-10 14:58:59 UTC (rev 14984)
@@ -25,6 +25,10 @@
The folder BengaliNE has been deleted from the resources folder inside the
ANNIE plugin.
+The following plugins were made obsolete and were removed from the
distribution: Jape\_Compiler,
+Ontology\_OWLIM2, Web\_Search\_Google and Web\_Search\_Yahoo. Documentation of
obsolete plugins can
+now be found in Appendix~\ref{chap:obsolete-plugins}.
+
\rcSubsect{December 2011}
Segment Processing PR has two additional run-time parameters called
Modified: userguide/trunk/tao_main.tex
===================================================================
--- userguide/trunk/tao_main.tex 2012-01-10 14:57:57 UTC (rev 14983)
+++ userguide/trunk/tao_main.tex 2012-01-10 14:58:59 UTC (rev 14984)
@@ -693,6 +693,9 @@
\input{plugin-name-map} %final for book
+% should this be included in the book or not?
+\input{obsolete-plugins}
+
\ifprintedbook
\else
\input{design} %final for book
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Write once. Port to many.
Get the SDK and tools to simplify cross-platform app development. Create
new or port existing apps to sell to consumers worldwide. Explore the
Intel AppUpSM program developer opportunity. appdeveloper.intel.com/join
http://p.sf.net/sfu/intel-appdev
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
