All terms (1-word and multi-word) are unknown to the term checker until they are specified in the disambiguation files. If you do not add your organization's Technical Names and the Technical Verbs to the term checker, the term checker will give many incorrect warnings. Temporarily, to evaluate the term checker, you can deactivate 'Rule 1.1. Use approved words [deactivate to ignore unknown terms]'.
To buy customization services, contact TechScribe.
To customize the term checker
- Add Technical Names and Technical Verbs to disambiguation-projectterms.xml.
- Add unapproved terms and misused terms to grammar-projectterms.xml.
- By default, the term checker identifies some capitalized text as a proper noun. Thus, the term checker does not give a warning for some misused text. (The text conforms to ASD-STE100, but the Technical Name is not correct.) To prevent this problem, in
grammar-ste6.xml, change rule 1.1 so that it does not ignore proper nouns.
- To make sure that the rules are correct, use 'testrules' (http://wiki.languagetool.org/development-overview#toc7). If you put a technical term that contains an STE approved term or a not-approved term into
disambiguation-projectterms.xml, you can cause 'testrules' to give an error message. To prevent the error message, in
disambiguation-ste6.xml, change the applicable example or put the example into comments. (With the evaluation version of the term checker, you cannot change
disambiguation-ste6.xml, because it is on the TechScribe website.)
The term checker contains Technical Names from these sources:
- All the Technical Names that are in the Dictionary. The Dictionary shows Technical Names with (TN). Example: BANK (TN).
- Most Technical Names that are in Rule 1.5.
- A small number of Technical Names that are applicable to most projects, but which are not in the STE specification.
The term checker contains many Technical Verbs that are in Rule 1.13.
For each approved term that is not in the term checker, add each inflection of the term. Use the rules that are in
disambiguation-projectterms.xml as templates. If a term is approved for only 1 meaning, and if you want to give guidelines to technical writers, then add a grammar rule for that term.
The term checker finds all unknown terms, but not proper nouns. Thus, rules for unapproved terms are not necessary. But, to give guidelines to technical writers, do these:
- Add an unapproved term in
disambiguation-projectterms.xml. If you do not add the unapproved term, then the term checker will give 2 warnings for the unapproved term. One warning will be 'unknown term' and the other warning will be the warning from the rule that you write in
- Add the unapproved term in
To clarify a noun cluster, you can "use hyphens to show the relationship between the most closely related words." Sometimes, hyphens in different locations are possible. For example, for the noun cluster filter unit top cover, hyphens in these locations are possible:
- Filter-unit top-cover. Add a Technical Name that has 2 tokens: filter-unit, top-cover.
- Filter unit-top cover. Add a Technical Name that has 3 tokens: filter, unit-top, cover.
- Filter unit top-cover. Add a Technical Name that has 3 tokens: filter, unit, top-cover.
To give guidelines to technical writers, add terms to
grammar-projectterms.xml. Typically, add rules for these:
- An unapproved term. For example, refer to rule PROJECT_NOT_APPROVED_technical-author.
- An approved term that is frequently misused. For an example, refer to
Sometimes, a 1-word approved project term is an unapproved STE term. For example, for software documentation, the term render is a Technical Verb. The rule in
grammar-ste6.xml will give correct results because of the exception. But, 'testrules' will give an error message. To prevent the error message, put the rule into comments or delete the rule from
grammar-ste6.xml. Optionally, add a rule in
grammar-projectterms.xml to tell technical writers to use the term only with its approved meaning.
In LanguageTool, proper nouns have the postag NNP. Examples: London, Saudi Arabia, Tuesday, September, HTML, John Smith.
The term checker has rules that identify capitalized text as a proper noun. The term checker gives these proper nouns the postag IS_NNP. To prevent the term checker from using these rules, in
grammar-ste6.xml rule STE_RULE_1_1_USE_APPROVED_WORDS, put this exception into comments:
<exception postag="IS_NNP"/><!-- Proper nouns are from disambiguation rulegroup STE_TN_NOUN-PROPER. -->
You can customize the rules to make other types of language quality-assurance software such as these:
- A term checker for other controlled languages
- A style checker for a style guide such as the Microsoft Manual of Style
- A style checker for plain English
- A pre-editor for machine translation.