Modified: uima/sandbox/trunk/TextMarker/uima-docbook-textmarker/src/docbook/tools.textmarker.conditions.xml URL: http://svn.apache.org/viewvc/uima/sandbox/trunk/TextMarker/uima-docbook-textmarker/src/docbook/tools.textmarker.conditions.xml?rev=1363769&r1=1363768&r2=1363769&view=diff ============================================================================== --- uima/sandbox/trunk/TextMarker/uima-docbook-textmarker/src/docbook/tools.textmarker.conditions.xml (original) +++ uima/sandbox/trunk/TextMarker/uima-docbook-textmarker/src/docbook/tools.textmarker.conditions.xml Fri Jul 20 13:23:06 2012 @@ -6,15 +6,15 @@ %uimaents; ]> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor - license agreements. See the NOTICE file distributed with this work for additional - information regarding copyright ownership. The ASF licenses this file to - you under the Apache License, Version 2.0 (the "License"); you may not use - this file except in compliance with the License. You may obtain a copy of - the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required - by applicable law or agreed to in writing, software distributed under the - License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS - OF ANY KIND, either express or implied. See the License for the specific - language governing permissions and limitations under the License. --> + license agreements. See the NOTICE file distributed with this work for additional + information regarding copyright ownership. The ASF licenses this file to + you under the Apache License, Version 2.0 (the "License"); you may not use + this file except in compliance with the License. You may obtain a copy of + the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required + by applicable law or agreed to in writing, software distributed under the + License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS + OF ANY KIND, either express or implied. See the License for the specific + language governing permissions and limitations under the License. --> <section id="ugr.tools.tm.language.conditions"> <title>Conditions</title> @@ -23,12 +23,9 @@ <title>AFTER</title> <para> The AFTER condition evaluates true if the matched annotation - starts - after the beginning of an arbitrary annotation of the passed - type. - If a list of types is passed, this has to be true for at least - one - of them. + starts after the beginning of an arbitrary annotation of the passed + type. If a list of types is passed, this has to be true for at least + one of them. </para> <section> <title> @@ -43,14 +40,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - CW{AFTER(SW)}; - ]]></programlisting> + <programlisting><![CDATA[CW{AFTER(SW)};]]></programlisting> </para> <para> Here, the rule matches on a capitalized word if there is any - small - written word previously. + small written word previously. </para> </section> </section> @@ -59,17 +53,14 @@ <title>AND</title> <para> The AND condition is a composed condition and evaluates true if - all - contained conditions evaluate true. + all contained conditions evaluate true. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - AND(Condition1,...,ConditionN) - ]]></programlisting> + <programlisting><![CDATA[AND(Condition1,...,ConditionN)]]></programlisting> </para> </section> <section> @@ -77,17 +68,13 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{AND(PARTOF(Headline),CONTAINS(Keyword))->MARK(ImportantHeadline)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{AND(PARTOF(Headline),CONTAINS(Keyword)) + ->MARK(ImportantHeadline)};]]></programlisting> </para> <para> In this example a Paragraph is annotated with an - ImportantHeadline - annotation if it is part of a Headline and - contains - a Keyword - annotation. + ImportantHeadline annotation if it is part of a Headline and + contains a Keyword annotation. </para> </section> </section> @@ -96,21 +83,16 @@ <title>BEFORE</title> <para> The BEFORE condition evaluates true if the matched annotation - starts - before the beginning of an arbitrary annotation of the passed - type. - If a list of types is passed, this has to be true for at least - one - of them. + starts before the beginning of an arbitrary annotation of the passed + type. If a list of types is passed, this has to be true for at least + one of them. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - BEFORE(Type|TypeListExpression) - ]]></programlisting> + <programlisting><![CDATA[BEFORE(Type|TypeListExpression)]]></programlisting> </para> </section> <section> @@ -118,14 +100,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - CW{BEFORE(SW)}; - ]]></programlisting> + <programlisting><![CDATA[CW{BEFORE(SW)};]]></programlisting> </para> <para> Here, the rule matches on a capitalized word if there is any - small - written word afterwards. + small written word afterwards. </para> </section> </section> @@ -135,16 +114,15 @@ <para> The CONTAINS condition evaluates true on a matched annotation if - the - frequency of the passed type lies within an optionally passed + the frequency of the passed type lies within an optionally passed interval. The limits of the passed interval are per default - interpreted as absolut numeral values. By passing a further boolean + interpreted as absolute numeral values. By passing a further boolean parameter set to true the limits are interpreted as percental values. If no interval parameters are passed at all the condition checks whether the matched annotation contains at least one - occurence of the + occurrence of the passed type. </para> <section> @@ -152,9 +130,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - CONTAINS(Type(,NumberExpression,NumberExpression(,BooleanExpression)?)?) - ]]></programlisting> + <programlisting><![CDATA[CONTAINS(Type(,NumberExpression,NumberExpression(,BooleanExpression)?)?)]]></programlisting> </para> </section> <section> @@ -165,32 +141,28 @@ <programlisting><![CDATA[Paragraph{CONTAINS(Keyword)->MARK(KeywordParagraph)};]]></programlisting> </para> <para> - A Pararaph is annotated with a KeywordParagraph annotation if - it - contains a - Keyword annotation. + A Paragraph is annotated with a KeywordParagraph annotation if + it contains a Keyword annotation. </para> <para> <programlisting><![CDATA[Paragraph{CONTAINS(Keyword,2,4)->MARK(KeywordParagraph)};]]></programlisting> </para> <para> - A Pararaph is annotated with a KeywordParagraph annotation if - it - contains - between two and four Keyword annotations. + A Paragraph is annotated with a KeywordParagraph annotation if + it contains between two and four Keyword annotations. </para> <para> <programlisting><![CDATA[Paragraph{CONTAINS(Keyword,50,100,true)->MARK(KeywordParagraph)};]]></programlisting> </para> <para> - A Pararaph is annotated with a KeywordParagraph annotation if it + A Paragraph is annotated with a KeywordParagraph annotation if it contains between 50% and 100% Keyword annotations. This is calculated based on the tokens of the Paragraph. If the Paragraph - contains six basic annatotions (see + contains six basic annotations (see <xref linkend='ugr.tools.tm.language.seeding' /> ), two of them are part of one Keyword annotation and one basic annotation is also annotated with a Keyword annotation, then the - percantage of the contained Keywords is 50%. + percentage of the contained Keywords is 50%. </para> </section> </section> @@ -198,31 +170,20 @@ <section id="ugr.tools.tm.language.conditions.contextcount"> <title>CONTEXTCOUNT</title> <para> - The CONTEXTCOUNT condition numbers all occurences of the - matched - type - within the context of a passed type's annotation - consecutively, - thus - assigning an index to each occurence. - Additionally it stores the - index of the matched annotation in a - numerical variable if one is - passed. The condition evaluates true if - the index of the matched - annotation is within a passed interval. If - no interval is passed, - the - condition always evaluates true. + The CONTEXTCOUNT condition numbers all occurrences of the + matched type within the context of a passed type's annotation + consecutively, thus assigning an index to each occurrence. + Additionally it stores the index of the matched annotation in a + numerical variable if one is passed. The condition evaluates true if + the index of the matched annotation is within a passed interval. If + no interval is passed, the condition always evaluates true. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - CONTEXTCOUNT(Type(,NumberExpression,NumberExpression)?(,Variable)?) - ]]></programlisting> + <programlisting><![CDATA[CONTEXTCOUNT(Type(,NumberExpression,NumberExpression)?(,Variable)?)]]></programlisting> </para> </section> <section> @@ -230,18 +191,14 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Keyword{CONTEXTCOUNT(Paragraph,2,3,var)->MARK(SecondOrThirdKeywordInParagraph)}; - ]]></programlisting> + <programlisting><![CDATA[Keyword{CONTEXTCOUNT(Paragraph,2,3,var) + ->MARK(SecondOrThirdKeywordInParagraph)};]]></programlisting> </para> <para> Here, the position of the matched Keyword annotation within a - Paragraph - annotation is calculated and stored in the variable 'var'. - If the - counted value lies within the interval [2,3] the matched - Keyword is - annotated with the SecondOrThirdKeywordInParagraph + Paragraph annotation is calculated and stored in the variable 'var'. + If the counted value lies within the interval [2,3] the matched + Keyword is annotated with the SecondOrThirdKeywordInParagraph annotation. </para> </section> @@ -252,56 +209,28 @@ <para> The COUNT condition can be used in two different ways. In the first case (see first definition), it counts the number of - annotations of the - passed type within the window of the matched - annotation and stores - the amount in a numerical - variable if such a - variable is passed. The - condition - evaluates true - if the counted amount - is within a specified - interval. - If no interval - is passed, the condition - always evaluates - true. - In the second case (see second definition), it - counts the number of occurences of the passed VariableExpression - (second - parameter) within the passed list (first parameter) and - stores - the amount in a numerical - variable if such a - variable is passed. - Again - the - condition - evaluates true - if the counted amount - is within a - specified - interval. - If no interval - is passed, the condition - always - evaluates - true. + annotations of the passed type within the window of the matched + annotation and stores the amount in a numerical variable if such a + variable is passed. The condition evaluates true if the counted + amount is within a specified interval. If no interval is passed, the + condition always evaluates true. In the second case (see second + definition), it counts the number of occurrences of the passed + VariableExpression (second parameter) within the passed list (first + parameter) and stores the amount in a numerical variable if such a + variable is passed. Again the condition evaluates true if the counted + amount is within a specified interval. If no interval is passed, the + condition always evaluates true. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - COUNT(Type(,NumberExpression,NumberExpression)?(,NumberVariable)?) - ]]></programlisting> + <programlisting><![CDATA[COUNT(Type(,NumberExpression,NumberExpression)?(,NumberVariable)?)]]></programlisting> </para> <para> - <programlisting><![CDATA[ - COUNT(ListExpression,VariableExpression(,NumberExpression,NumberExpression)?(,NumberVariable)?) - ]]></programlisting> + <programlisting><![CDATA[COUNT(ListExpression,VariableExpression + (,NumberExpression,NumberExpression)?(,NumberVariable)?)]]></programlisting> </para> </section> <section> @@ -309,29 +238,21 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{COUNT(Keyword,1,10,var)->MARK(KeywordParagraph)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{COUNT(Keyword,1,10,var)->MARK(KeywordParagraph)};]]></programlisting> </para> <para> Here, the amount of Keyword annotations within a Paragraph is - calculated - and stored in the variable 'var'. If one to ten Keywords - were - counted, the Paragraph is marked with a KeywordParagraph + calculated and stored in the variable 'var'. If one to ten Keywords + were counted, the Paragraph is marked with a KeywordParagraph annotation. </para> <para> - <programlisting><![CDATA[ - Paragraph{COUNT(list,"author",5,7,var)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{COUNT(list,"author",5,7,var)};]]></programlisting> </para> <para> Here, the number of occurrences of STRING "author" within the - STRINGLIST 'list' is - counted and stored in the variable 'var'. If - "author" occurs five to seven times within 'list', - the condition + STRINGLIST 'list' is counted and stored in the variable 'var'. If + "author" occurs five to seven times within 'list', the condition evaluates true. </para> </section> @@ -340,20 +261,12 @@ <section id="ugr.tools.tm.language.conditions.currentcount"> <title>CURRENTCOUNT</title> <para> - The CURRENTCOUNT condition numbers all occurences of the - matched - type - within the whole document consecutively, thus assigning - an index - to - each occurence. Additionally it stores the index of the - matched - annotation in a numerical variable if one is passed. The - condition - evaluates true if the index of the matched annotation is - within a - specified interval. If no interval is passed, the condition - always + The CURRENTCOUNT condition numbers all occurences of the matched + type within the whole document consecutively, thus assigning an index + to each occurence. Additionally it stores the index of the matched + annotation in a numerical variable if one is passed. The condition + evaluates true if the index of the matched annotation is within a + specified interval. If no interval is passed, the condition always evaluates true. </para> <section> @@ -361,9 +274,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - CURRENTCOUNT(Type(,NumberExpression,NumberExpression)?(,Variable)?) - ]]></programlisting> + <programlisting><![CDATA[CURRENTCOUNT(Type(,NumberExpression,NumberExpression)?(,Variable)?)]]></programlisting> </para> </section> <section> @@ -371,14 +282,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{CURRENTCOUNT(Keyword,3,3,var)->MARK(ParagraphWithThirdKeyword)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{CURRENTCOUNT(Keyword,3,3,var)->MARK(ParagraphWithThirdKeyword)};]]></programlisting> </para> <para> Here, the Paragraph which contains the third Keyword of the - whole - document is annotated with the ParagraphWithThirdKeyword + whole document is annotated with the ParagraphWithThirdKeyword annotation. The index is stored in the variable 'var'. </para> </section> @@ -388,21 +296,16 @@ <title>ENDSWITH</title> <para> The ENDSWITH condition evaluates true if an annotation of the - given - type ends exactly at the same position as the matched - annotation. If - a list of types is passed, this has to be true for at - least one of - them. + given type ends exactly at the same position as the matched + annotation. If a list of types is passed, this has to be true for at + least one of them. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - ENDSWITH(Type|TypeListExpression) - ]]></programlisting> + <programlisting><![CDATA[ENDSWITH(Type|TypeListExpression) ]]></programlisting> </para> </section> <section> @@ -410,14 +313,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{ENDSWITH(SW)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{ENDSWITH(SW)};]]></programlisting> </para> <para> Here, the rule matches on a Paragraph annotation if it ends - with a small - written word. + with a small written word. </para> </section> </section> @@ -426,17 +326,14 @@ <title>FEATURE</title> <para> The FEATURE condition compares a feature of the matched - annotation with - the second argument. + annotation with the second argument. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - FEATURE(StringExpression,Expression) - ]]></programlisting> + <programlisting><![CDATA[FEATURE(StringExpression,Expression) ]]></programlisting> </para> </section> <section> @@ -444,14 +341,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Document{FEATURE("language",targetLanguage)} - ]]></programlisting> + <programlisting><![CDATA[Document{FEATURE("language",targetLanguage)}]]></programlisting> </para> <para> This rule matches if the feature named 'language' of the - document - annotation equals the value of the variable + document annotation equals the value of the variable 'targetLanguage'. </para> </section> @@ -461,17 +355,14 @@ <title>IF</title> <para> The IF condition evaluates true if the contained boolean - expression - does. + expression does. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - IF(BooleanExpression) - ]]></programlisting> + <programlisting><![CDATA[IF(BooleanExpression) ]]></programlisting> </para> </section> <section> @@ -479,9 +370,7 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{IF(keywordAmount > 5)->MARK(KeywordParagraph)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{IF(keywordAmount > 5)->MARK(KeywordParagraph)};]]></programlisting> </para> <para> A Paragraph annotation is annotated with a KeywordParagraph @@ -494,8 +383,7 @@ <section id="ugr.tools.tm.language.conditions.inlist"> <title>INLIST</title> <para> - The INLIST condition is fulfilled if the matched annotation is - listed + The INLIST condition is fulfilled if the matched annotation is listed in a given word or string list. The (relative) edit distance is currently disabled. @@ -507,14 +395,10 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - INLIST(WordList(,NumberExpression,(BooleanExpression)?)?) - ]]></programlisting> + <programlisting><![CDATA[INLIST(WordList(,NumberExpression,(BooleanExpression)?)?) ]]></programlisting> </para> <para> - <programlisting><![CDATA[ - INLIST(StringList(,NumberExpression,(BooleanExpression)?)?) - ]]></programlisting> + <programlisting><![CDATA[INLIST(StringList(,NumberExpression,(BooleanExpression)?)?) ]]></programlisting> </para> </section> <section> @@ -522,15 +406,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Keyword{INLIST(specialKeywords.txt)->MARK(SpecialKeyword)}; - ]]></programlisting> + <programlisting><![CDATA[Keyword{INLIST(specialKeywords.txt)->MARK(SpecialKeyword)};]]></programlisting> </para> <para> - A Keyword is annotated with the type SpecialKeyword if the - text - of - the Keyword annotation is listed in the word list + A Keyword is annotated with the type SpecialKeyword if the text + of the Keyword annotation is listed in the word list 'specialKeywords.txt'. </para> </section> @@ -539,14 +419,11 @@ <section id="ugr.tools.tm.language.conditions.is"> <title>IS</title> <para> - The IS condition evaluates true if there is an annotation of - the - given - type with the same beginning and ending offsets as the + The IS condition evaluates true if there is an annotation of the + given type with the same beginning and ending offsets as the matched annotation. If a list of types is given, the condition - evaluates - true + evaluates true if at least one of them fulfills the former condition. </para> <section> @@ -554,9 +431,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - IS(Type|TypeListExpression) - ]]></programlisting> + <programlisting><![CDATA[IS(Type|TypeListExpression) ]]></programlisting> </para> </section> <section> @@ -564,9 +439,7 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Author{IS(Englishman)->MARK(EnglishAuthor)}; - ]]></programlisting> + <programlisting><![CDATA[Author{IS(Englishman)->MARK(EnglishAuthor)};]]></programlisting> </para> <para> If an Author annotation is also annotated with an Englishman @@ -579,17 +452,14 @@ <title>LAST</title> <para> The LAST condition evaluates true if the type of the last token - within - the window of the matched annotation is of the given type. + within the window of the matched annotation is of the given type. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - LAST(TypeExpression) - ]]></programlisting> + <programlisting><![CDATA[LAST(TypeExpression) ]]></programlisting> </para> </section> <section> @@ -597,14 +467,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Document{LAST(CW)}; - ]]></programlisting> + <programlisting><![CDATA[Document{LAST(CW)};]]></programlisting> </para> <para> This rule fires if the last token of the document is a - capitalized - word. + capitalized word. </para> </section> </section> @@ -612,11 +479,8 @@ <section id="ugr.tools.tm.language.conditions.mofn"> <title>MOFN</title> <para> - The MOFN condition is a composed condition. It evaluates true - if - the - number of containing conditions evaluating true is within a - given + The MOFN condition is a composed condition. It evaluates true if + the number of containing conditions evaluating true is within a given interval. </para> <section> @@ -624,9 +488,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - MOFN(NumberExpression,NumberExpression,Condition1,...,ConditionN) - ]]></programlisting> + <programlisting><![CDATA[MOFN(NumberExpression,NumberExpression,Condition1,...,ConditionN) ]]></programlisting> </para> </section> <section> @@ -634,14 +496,12 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{MOFN(1,1,PARTOF(Headline),CONTAINS(Keyword))->MARK(HeadlineXORKeywords)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{MOFN(1,1,PARTOF(Headline),CONTAINS(Keyword)) + ->MARK(HeadlineXORKeywords)};]]></programlisting> </para> <para> A Paragraph is marked as a HeadlineXORKeywords if the matched - text - is either part of a Headline annotation or contains Keyword + text is either part of a Headline annotation or contains Keyword annotations. </para> </section> @@ -663,9 +523,8 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - NEAR(TypeExpression,NumberExpression,NumberExpression(,BooleanExpression(,BooleanExpression)?)?) - ]]></programlisting> + <programlisting><![CDATA[NEAR(TypeExpression,NumberExpression,NumberExpression + (,BooleanExpression(,BooleanExpression)?)?) ]]></programlisting> </para> </section> <section> @@ -673,9 +532,7 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{NEAR(Headline,0,10,false)->MARK(NoHeadline)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{NEAR(Headline,0,10,false)->MARK(NoHeadline)};]]></programlisting> </para> <para> A Paragraph that starts at most ten tokens after a Headline @@ -695,9 +552,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - "-"Condition - ]]></programlisting> + <programlisting><![CDATA["-"Condition]]></programlisting> </para> </section> <section> @@ -705,13 +560,10 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{-PARTOF(Headline)->MARK(Headline)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{-PARTOF(Headline)->MARK(Headline)};]]></programlisting> </para> <para> - A Paragraph that is not part of a Headline annotation so far - is + A Paragraph that is not part of a Headline annotation so far is annotated with a Headline annotation. </para> </section> @@ -721,17 +573,14 @@ <title>OR</title> <para> The OR Condition is a composed condition and evaluates true if - at least - one contained condition is evaluated true. + at least one contained condition is evaluated true. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - OR(Condition1,...,ConditionN) - ]]></programlisting> + <programlisting><![CDATA[OR(Condition1,...,ConditionN)]]></programlisting> </para> </section> <section> @@ -739,16 +588,12 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{OR(PARTOF(Headline),CONTAINS(Keyword))->MARK(ImportantParagraph)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{OR(PARTOF(Headline),CONTAINS(Keyword))->MARK(ImportantParagraph)};]]></programlisting> </para> <para> In this example a Paragraph is annotated with the - ImportantParagraph - annotation if it is a Headline or contains - Keyword - annotations. + ImportantParagraph annotation if it is a Headline or contains + Keyword annotations. </para> </section> </section> @@ -757,22 +602,16 @@ <title>PARSE</title> <para> The PARSE condition is fulfilled if the text covered by the - matched - annotation can be transformed into a value of the given - variable's - type. If this is possible, the parsed value is - additionally - assigned - to the passed variable. + matched annotation can be transformed into a value of the given + variable's type. If this is possible, the parsed value is + additionally assigned to the passed variable. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - PARSE(variable) - ]]></programlisting> + <programlisting><![CDATA[PARSE(variable)]]></programlisting> </para> </section> <section> @@ -780,14 +619,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - NUM{PARSE(var)}; - ]]></programlisting> + <programlisting><![CDATA[NUM{PARSE(var)};]]></programlisting> </para> <para> If the variable 'var' is of an appropriate numeric type, the - value of - NUM is parsed and subsequently stored in 'var'. + value of NUM is parsed and subsequently stored in 'var'. </para> </section> </section> @@ -796,16 +632,11 @@ <title>PARTOF</title> <para> The PARTOF condition is fulfilled if the matched annotation is - part of - an annotation of the given type. However it is not necessary - that - the matched annotation is smaller than the annotation of the - given - type. Use the (much slower) PARTOFNEQ condition instead if this - is - needed. If a type list is given, the condition evaluates true if - the - former described condition for a single type is fulfilled for at + part of an annotation of the given type. However it is not necessary + that the matched annotation is smaller than the annotation of the + given type. Use the (much slower) PARTOFNEQ condition instead if this + is needed. If a type list is given, the condition evaluates true if + the former described condition for a single type is fulfilled for at least one of the types in the list. </para> <section> @@ -813,9 +644,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - PARTOF(Type|TypeListExpression) - ]]></programlisting> + <programlisting><![CDATA[PARTOF(Type|TypeListExpression)]]></programlisting> </para> </section> <section> @@ -823,14 +652,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{PARTOF(Headline) -> MARK(ImportantParagraph)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{PARTOF(Headline) -> MARK(ImportantParagraph)};]]></programlisting> </para> <para> A Paragraph is an ImportantParagraph if the matched text is - part of - a Headline annotation. + part of a Headline annotation. </para> </section> </section> @@ -839,25 +665,18 @@ <title>PARTOFNEQ</title> <para> The PARTOFNEQ condition is fulfilled if the matched annotation - is part - of (smaller than and inside of) an annotation of the given - type. If - also annotations of the same size should be acceptable, use - the - PARTOF condition. If a type list is given, the condition - evaluates - true if the former described condition is fulfilled for at - least one - of the types in the list. + is part of (smaller than and inside of) an annotation of the given + type. If also annotations of the same size should be acceptable, use + the PARTOF condition. If a type list is given, the condition + evaluates true if the former described condition is fulfilled for at + least one of the types in the list. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - PARTOFNEQ(Type|TypeListExpression) - ]]></programlisting> + <programlisting><![CDATA[PARTOFNEQ(Type|TypeListExpression)]]></programlisting> </para> </section> <section> @@ -865,9 +684,7 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - W{PARTOFNEQ(Headline) -> MARK(ImportantWord)}; - ]]></programlisting> + <programlisting><![CDATA[W{PARTOFNEQ(Headline) -> MARK(ImportantWord)};]]></programlisting> </para> <para> A word is an ImportantWord if it is part of a headline. @@ -879,8 +696,7 @@ <title>POSITION</title> <para> The POSITION condition is fulfilled if the matched type is the - k-th - occurence of this type within the window of an annotation of the + k-th occurence of this type within the window of an annotation of the passed type, whereby k is defined by the value of the passed NumberExpression. </para> @@ -889,9 +705,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - POSITION(Type,NumberExpression) - ]]></programlisting> + <programlisting><![CDATA[POSITION(Type,NumberExpression)]]></programlisting> </para> </section> <section> @@ -899,9 +713,7 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Keyword{POSITION(Paragraph,2)->MARK(SecondKeyword)}; - ]]></programlisting> + <programlisting><![CDATA[Keyword{POSITION(Paragraph,2)->MARK(SecondKeyword)};]]></programlisting> </para> <para> The second Keyword in a Paragraph is annotated with the type @@ -913,8 +725,7 @@ <section id="ugr.tools.tm.language.conditions.regexp"> <title>REGEXP</title> <para> - The REGEXP condition is fulfilled if the given pattern matches on - the + The REGEXP condition is fulfilled if the given pattern matches on the matched annotation. For more details on the syntax of regular expressions, have a look at the <ulink @@ -927,9 +738,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - REGEXP(StringExpression(,BooleanExpression)?) - ]]></programlisting> + <programlisting><![CDATA[REGEXP(StringExpression(,BooleanExpression)?)]]></programlisting> </para> </section> <section> @@ -937,9 +746,7 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Keyword{REGEXP("..")->MARK(SmallKeyword)}; - ]]></programlisting> + <programlisting><![CDATA[Keyword{REGEXP("..")->MARK(SmallKeyword)};]]></programlisting> </para> <para> A Keyword that only consists of two chars is annotated with a @@ -951,13 +758,11 @@ <section id="ugr.tools.tm.language.conditions.score"> <title>SCORE</title> <para> - The SCORE condition evaluates the heuristic score of the - matched + The SCORE condition evaluates the heuristic score of the matched annotation. This score is set or changed by the MARK action. The condition is fulfilled if the score of the matched annotation is - in - a + in a given interval. Optionally the score can be stored in a variable. </para> @@ -966,9 +771,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - SCORE(NumberExpression,NumberExpression(,Variable)?) - ]]></programlisting> + <programlisting><![CDATA[SCORE(NumberExpression,NumberExpression(,Variable)?)]]></programlisting> </para> </section> <section> @@ -976,14 +779,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - MaybeHeadline{SCORE(40,100)->MARK(Headline)}; - ]]></programlisting> + <programlisting><![CDATA[MaybeHeadline{SCORE(40,100)->MARK(Headline)};]]></programlisting> </para> <para> A annotation of the type MaybeHeadline is annotated with - Headline if - its score is between 40 and 100. + Headline if its score is between 40 and 100. </para> </section> </section> @@ -992,12 +792,9 @@ <title>SIZE</title> <para> The SIZE contition counts the number of elements in the given - list. By - default this condition always evaluates true. If an interval - is - passed, it evaluates true if the counted number of list elements - is - within the interval. The counted number can be stored in an + list. By default this condition always evaluates true. If an interval + is passed, it evaluates true if the counted number of list elements + is within the interval. The counted number can be stored in an optionally passed numeral variable. </para> <section> @@ -1005,8 +802,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[SIZE(ListExpression(,NumberExpression,NumberExpression)?(,Variable)?) - ]]></programlisting> + <programlisting><![CDATA[SIZE(ListExpression(,NumberExpression,NumberExpression)?(,Variable)?)]]></programlisting> </para> </section> <section> @@ -1014,14 +810,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Document{SIZE(list,4,10,var)}; - ]]></programlisting> + <programlisting><![CDATA[Document{SIZE(list,4,10,var)};]]></programlisting> </para> <para> This rule fires if the given list contains between 4 and 10 - elements. - Additionally, the exact amount is stored in the variable + elements. Additionally, the exact amount is stored in the variable var. </para> </section> @@ -1031,21 +824,16 @@ <title>STARTSWITH</title> <para> The STARTSWITH condition evaluates true if an annotation of the - given - type starts exactly at the same position as the matched - annotation. - If a type list is given, the condition evaluates true if - the former - is true for at least one of the given types in the list. + given type starts exactly at the same position as the matched + annotation. If a type list is given, the condition evaluates true if + the former is true for at least one of the given types in the list. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - STARTSWITH(Type|TypeListExpression) - ]]></programlisting> + <programlisting><![CDATA[STARTSWITH(Type|TypeListExpression)]]></programlisting> </para> </section> <section> @@ -1053,14 +841,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{STARTSWITH(SW)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{STARTSWITH(SW)};]]></programlisting> </para> <para> Here, the rule matches on a Paragraph annotation if it starts - with small - written word. + with small written word. </para> </section> </section> @@ -1069,8 +854,7 @@ <title>TOTALCOUNT</title> <para> The TOTALCOUNT condition counts the annotations of the passed - type - within the whole document and stores the amount in an optionally + type within the whole document and stores the amount in an optionally passed numerical variable. The condition evaluates true if the amount is within the passed interval. If no interval is passed, the @@ -1081,9 +865,7 @@ <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - TOTALCOUNT(Type(,NumberExpression,NumberExpression(,Variable)?)?) - ]]></programlisting> + <programlisting><![CDATA[TOTALCOUNT(Type(,NumberExpression,NumberExpression(,Variable)?)?)]]></programlisting> </para> </section> <section> @@ -1091,18 +873,13 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{TOTALCOUNT(Keyword,1,10,var)->MARK(KeywordParagraph)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{TOTALCOUNT(Keyword,1,10,var)->MARK(KeywordParagraph)};]]></programlisting> </para> <para> Here, the amount of Keyword annotations within the whole - document is - calculated and stored in the variable 'var'. If one to - ten Keywords - were counted, the Paragraph is marked with a - KeywordParagraph - annotation. + document is calculated and stored in the variable 'var'. If one to + ten Keywords were counted, the Paragraph is marked with a + KeywordParagraph annotation. </para> </section> </section> @@ -1110,22 +887,16 @@ <section id="ugr.tools.tm.language.conditions.vote"> <title>VOTE</title> <para> - The VOTE condition counts the annotations of the given two - types - within - the window of the matched annotation and evaluates true - if it - found - more annotations of the first type. + The VOTE condition counts the annotations of the given two types + within the window of the matched annotation and evaluates true + if it found more annotations of the first type. </para> <section> <title> <emphasis role="bold">Definition:</emphasis> </title> <para> - <programlisting><![CDATA[ - VOTE(TypeExpression,TypeExpression) - ]]></programlisting> + <programlisting><![CDATA[VOTE(TypeExpression,TypeExpression)]]></programlisting> </para> </section> <section> @@ -1133,14 +904,11 @@ <emphasis role="bold">Example:</emphasis> </title> <para> - <programlisting><![CDATA[ - Paragraph{VOTE(FirstName,LastName)}; - ]]></programlisting> + <programlisting><![CDATA[Paragraph{VOTE(FirstName,LastName)};]]></programlisting> </para> <para> Here, this rule fires if a paragraph contains more firstnames - than - lastnames. + than lastnames. </para> </section> </section>
