Acrolinx IQ. Acrolinx Linguistic Administration Guide Version: 3.0

Transcription

1 Acrolinx IQ Acrolinx Linguistic Administration Guide Version: 3.0

2 2 Copyright 2013 Acrolinx GmbH All rights reserved The software contains proprietary information of Acrolinx GmbH. It is provided under a license agreement containing restrictions on use and disclosure and is also protected by copyright law. Reverse engineering of the software is prohibited. Due to continued product development, this information may change without notice. The information and intellectual property contained in this document is confidential between Acrolinx GmbH and the customer, and remains the exclusive property of Acrolinx GmbH. If you find any errors in the documentation, please report them to us in writing. Acrolinx GmbH does not guarantee that this document is error-free. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of Acrolinx GmbH. Acrolinx is registered in the U.S. Patent and Trademark Office. Acrolinx is a trademark of Acrolinx GmbH. All trademarked and copyrighted names used within this and supplemental documents are the sole and exclusive property of their registered or common law owners. Acrolinx GmbH Friedrichstraße 100 D Berlin Germany Phone: Fax: support-americas@acrolinx.com Website: DocID: LAG-EN v3.0-b4791 NOTE: Because the Acrolinx user guides are updated frequently, there may be newer information in the online version of these help files. Click here to open an online version of this guide.

3 3 Contents Introduction 5 About this Guide...5 Configuring Segmentation Settings for your Organization 6 Classifying Elements for Segmentation...6 Server-Side Segmentation...8 Context Segmentation Definitions (CSDs)...9 Elements and Segmentation Rules...11 CSD Evaluation...14 Configuring Server-Side Segmentation...15 Centralized Plug-in Properties...18 Configuring the Location of the User Properties Files...18 Configuring the Model User...19 Configuring DTD References for a User Properties File...20 Configuring Soft Exclusion Elements...22 Configuring Scoring and Help Information 23 Configuring How Scores Are Calculated...23 How the Checking Score is Calculated...23 How the Quality Score is Calculated...24 Weighting the Category Scores...24 Configuring the Maximum Number of Issues per 100 Words...25 Configuring the Colors for the Checking Status and Category Status...26 Configuring How Help Information is Displayed...27 Customizing the Location of Help Files...27 Term Help Templates...28 Configuring Term Contribution from the Checking Report...32 Configuring the Checking Report to Display the Flesch Reading Ease Score...33 Customizing Terminology Information in the Plug-in Shortcut Menu...34 Configuring Checking Behavior 36 Language Configurations...36 Reloading the Language Servers...36 Disabling the Sequential Reloading of Language Servers...36 Configuring Language Servers to Reload Simultaneously...37 Using the Resource Manager...38 Activating and Deactivating Rules...38 Configuring the Maximum Length for the Sentence Too Long Rule...39 Configuring Term Sets in the Term Set Configuration Module...40 Configuring Reuse Repositories...45 Configuring Term Sets in the Language Configuration File...47 Loading Terms Using a Domain Reference...48 Loading Terms Using a Filter File...49 Configuring How the Sentence Too Long Rule Appears for Plug-in Users...53 Configuring Term Harvesting...54 Configuring Term Harvesting Behavior...54

4 4 Configuring the Appearance of the Term Harvesting CSV Reports...55 Configuring the Checking Behavior for Admitted Terms...57 Flagging Admitted Terms in the Deprecated Flag Color...57 Configuring a Separate Flag for Admitted Terms...58 Configuring Scoring for Admitted Terms...59 Configuring the Link Checker...60 Enabling and Configuring the Link Checker...61 How the Link Checker Detects and Flags Links...62 Link Checker Statuses...63 Comparative Checking...63 Enabling Comparative Checking...64 List of Supported Plug-ins...64 Preventing Reuse Flags from Overriding Other Flags...65 Defining Empty Elements for the Acrolinx Plug-ins...66 Preconfiguring and Restricting the Advanced Plug-in Options...67 Restricting the Available Dictionaries for the Add to Dictionary Feature...68 Acrolinx Properties 70

5 5 Chapter 1 Introduction About this Guide Purpose The Acrolinx Linguistic Administration Guide describes how to manage the linguistic resources for a team of plug-in or Batch Checker users. A linguistic resource includes any setting or file which can influence the result of a check such as, flagging behavior, help information, or checking scores. Audience This guide is intended for advanced users who manage check settings for a team of writers. It assumes that you: have write access to the Acrolinx Server installation directory. have an administrator login to the Acrolinx Server Dashboard. are familiar with the Acrolinx Server Administration Guide. are comfortable editing HTML and XML markup.

6 6 Configuring Segmentation Settings for your Organization Chapter 2 Configuring Segmentation Settings for your Organization Classifying Elements for Segmentation When checking XML documents with Acrolinx you must configure how Acrolinx interprets the structure of the text within specific XML elements. In the Acrolinx plug-ins that are available for various XML editors, you can classify specific XML elements in the segmentation and filter tabs of the options dialog box. The Acrolinx Plug-in for Microsoft Word also provides a filter tab in the options dialog. In the Acrolinx Batch Checker you classify the elements in a Context Segmentation Definition file (CSD file). You should classify an element if one of the following conditions is met: Classify As: Excluded element (filter options) When: The content of the element should not be checked. Example: <metadata>document ID12345< /metadata> NOTE: Excluded items that are found within included items are still excluded but all other excluded items are ignored. In the following example, the <note > element is included and the <ph> element is excluded. <note>thistextwilbechecked.<ph>thistextwilnotbechecked.</ph></note> The content in <ph> will still be excluded, even if it is contained within an included element. Empty element (filter options) The element does not contain any text but should still be treated as part of the sentence. Example: <image href="1.jpg"></image> Classify this element as an empty element the filter options. The plug-in replaces empty elements with a space when processing the

7 7 Classify As: When: text for checking. Sometimes empty elements can cause style or grammar rules to flag incorrectly if the empty element is part of the sentence structure. In the following example, the xref element contains no text but acts as a noun in the sentence. <para>slide the <xref xidtype= "IBSwitch" xrefid="ib001"></xref> firmly into place.</para> By default, the text "Slide the firmly into place." is sent to the server and the sentence is flagged for incorrect grammar. When you classify the elements as empty, you prevent this type of issue because empty elements are treated as nouns. Sentence break element (segmentation options) The end of the element should always be treated as a sentence end. Example: <title>this is a title</title> Sentence break elements make sure that the end of these elements is a sentence break (this is especially useful for end of sentences which do not have full stops, such as titles). Unexpected sentence_too_long flags which actually consist of several sentences are a clear sign that one or more elements must be defined as a sentence break. No break element (segmentation options) The element intersects a word. Example: H₂O concentration If <sub> is not classified, the incorrect text H 2 O concentration is sent to the server. If <sub> is a no break element, the correct text H2O concentration is sent to the server.

8 8 Configuring Segmentation Settings for your Organization Classify As: Parenthetical element (segmentation options) When: The content of the element separates two words which should be adjacent. Example: <p>this is the <footnote>this is a second sentence.</footnote> first sentence.</p> This type of element is fairly rare and should be classified as a parenthetical element in the segmentation options. A typical example is a footnote in the middle of a sentence. If <footnote> is not classified as a parenthetical element, the incorrect text This is the This is a second sentence.first sentence. is sent to the server. If <footnote> is classified as a parenthetical element, the correct text This is the first sentence. This is a second sentence. is sent to the server. All remaining elements which are not explicitly classified in are interpreted as default elements by Acrolinx. An element can be left as default if one of the following conditions is met: The element has nested elements which are sentence break elements. Example: <topiccollection>, <topic>, <caution>, and <table>, <row >, <tbody> Default elements typically concern paragraphs or domains. If you are unsure whether a "parent" element ends in a sentence break, define it as a sentence break element. However this action is usually not necessary, because these elements typically contain <para> tags which should normally be defined as a sentence break element. The element does not fall into any of the previously mentioned categories Examples: <indexentry>, <sortkey>, <caution> Server-Side Segmentation Segmentation is process used to determine the correct word and sentence boundaries when Acrolinx software extracts and checks the text in an XML document. Segmentation is normally performed by the Acrolinx clients, but you can also configure the Acrolinx Server to perform segmentation instead. This function is useful if:

9 9 you are developing custom client software which uses the Acrolinx Java API. Server-side segmentation eliminates the need to integrate with the XML extraction and segmentation components of the Java API. RESTRICTION: Server-side segmentation should not be used when the server is configured to save checking reports on the client computer. For more information about this setting, see the Acrolinx Server Administration Guide. you want to centralize the segmentation settings for Batch Checker users. Unlike the Acrolinx Plug-ins, the Batch Checker has no model user functionality for centralizing segmentation settings. Server-side segmentation is a way of getting around this restriction. RESTRICTION: When server-side segmentation is active in the Acrolinx Batch Checker, users can only check XML files. You define server-side segmentation settings by adding context segmentation definition (CSD) files to your server installation and updating your language configuration file. Context Segmentation Definitions (CSDs) What is the Purpose of CSDs? When a check is performed on HTML or XML files, the settings in a CSD (context segmentation definition) file determine the segmentation rules. The CSD specifies: The document types that are associated with the defined segmentation settings. Sentence-break elements. No-break elements. Elements to include or exclude when a check is performed. Attributes that have values which should be checked. CSD File Naming and Location CSDs are contained in files that have the following naming format: <FILENAME>.properties. Server-side CSD files usually are located in: %ACROLINX_CONFIGURATION_ROOT%\data\<LANGUAGE_ID> on Windows. on Unix-based operating systems. File Structure CSD files are composed of the following parameters:

10 10 Configuring Segmentation Settings for your Organization Parameter documenttypes input_type Description The document types which this CSD applies to. Example: For example, you create a CSD to define how DITA tasks are segmented. DITA task files contain the following doctype information. <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd"> The doctype is task, so the documenttypes should be set as follows: documenttypes=task To create a CSD for HTML files, define the property as follows: documenttypes=html The format of the file to be checked Values The name of the document type or a comma-separated list of document type names. Example:task, concept,ditabase html, xml sentence_break_eleme nts Sentence-break elements (see page 11) Element names, element names with attributes. no_break_elements default_inclusion_mo de No-break elements (see page 11) When you run a check, this parameter determines whether elements are included or excluded by default. The following elements are always excluded or included, regardless of the default_inclusion _mode value: Elements that are defined as exclusio Element names, element names with attributes. include, exclude

11 11 Parameter exclusion_elements inclusion_elements Description n_elements or incl usion_elements "Child" elements of exclusion or inclusion elements. Elements that are always excluded. "Child" elements of exclusion elements are also always excluded. Elements that are always included. "Child" elements of inclusion elements are also always included. Values Element names, element names with attributes. Element names, element names with attributes. empty_elements extract_attributes mark_excluded_elemen ts Elements that contain no content, but are part of the structure of a sentence should be treated as nouns. Attributes that have values which should be sent to the server for checking. Configure the server to insert placeholders for excluded elements when processing the text. This property prevents incorrect flags that are caused by excluded elements. For information on this property, see the Batch Checker documentation. Element names Attribute names, element names with attributes. true, false Elements and Segmentation Rules Background To check a document correctly, Acrolinx must be able to identify the following elements: Tokens: individual words, acronyms, numbers within the text Sentences: text strings that are treated like sentences Metadata: additional information about the text that is not checked

12 12 Configuring Segmentation Settings for your Organization In WYSIWYG ("what you see is what you get") editors like Microsoft Word, it is relatively easy for both humans and computers to recognize tokens, sentences, and metadata. In markup languages such as HTML and XML, this task becomes more difficult. Therefore, you must provide additional information about marked-up text. When analyzing a marked-up text, it is useful to divide elements into the following categories: Exclusion elements Sentence-break elements No-break elements Default elements Exclusion Elements Most documents contain text that Acrolinx should ignore when performing a check. You can specify which parts of a text should not be checked by defining exclusion elements. Metadata elements within a document do not form the text itself, but provide additional information about the text. In WYSIWYG editors, metadata is easy to identify visually: headers, footers, index entries, bookmarks, comments, and other elements are clearly not part of the document text. In marked-up documents, however, you must specify metadata as exclusion elements. Acrolinx then ignores the metadata when performing a check. You can also define other marked-up text, such as program code, as an exclusion element. Sentence-break Elements In text editors or WYSIWYG editors, the carriage return makes it easy to identify sentence breaks. It is clear where text strings such as titles begin and end. In marked-up text, specify these elements as sentence-break elements. No-break Elements Some text strings, such as chemical formulas, contain special elements that cause them to have a specific appearance when they are printed or displayed on-line. For example, the text string "HO 2 -concentration" appears in HTML as: HO₂-concentration For Acrolinx to evaluate the string as a single token, you must specify the element <sub> as a no-break element. Empty Elements Empty elements are XML, GML, or HTML elements that do not contain any text. For example, the element <image href="1.jpg"></image> is an empty element. Acrolinx replaces empty elements with a space when processing the text for checking. Sometimes empty elements can cause style or grammar rules to flag incorrectly if the empty element is part of the sentence structure.

13 13 In the following example, the xref element contains no text but acts as a noun in the sentence. <para>slide the <xref xidtype="ibswitch" xrefid="ib001"></xref> firmly into place.</para> By default, the text "Slide the firmly into place." is sent to the server and the sentence is flagged for incorrect grammar. To prevent this issue, you can define empty elements in a CSD file so that empty elements are treated as nouns. Empty elements are similar to exclusion elements. The advantage of empty elements is that they do not lead to incorrect sentence counts and less text has to be sent to the server. Use empty elements to specifically isolate empty elements and differentiate them from excluded elements. Classification Guidelines Use the following guidelines when you classify elements: Elements with "child" elements that are sentence-break elements: If the element concerns paragraphs or domains, it is typically a default element. For XML files, the element name often provides a hint, for example: <topiccollection> <topic> <caution> <table> <row> <tbody> TIP: You can often also classify these elements as sentence-break elements. However, since these elements typically contain sentence-break elements such as <para>, it is not necessary. Titles are typically sentence-break elements, for example: <title> <subtitle> Elements that contain text that ends with a sentence break are usually sentence-break elements, for example: <usersuppliedtext> <paragraph> Elements such as metadata and indexes are typically exclusion elements, for example: <metadata> <index> Elements that are inside a word are typically no-break elements, for example: <sub> (subscript) <sup> (superscript)

14 14 Configuring Segmentation Settings for your Organization TIP: When "sentence too long" false alarms occur, the element that ends the undetected sentence end is probably a sentence-break element. If you are not sure whether an element is a sentence-break element or a default element, keep it as a default element. "Sentence too long" false alarms are easy to identify. CSD Evaluation If you work with different document types and have associated several CSD files with the same rule set, you should ensure that the server is selecting the correct CSD file when you run a check. The order in which CSD files are assessed depends on how you have configured your CSD files. To ensure that the server selects the most appropriate CSD file for your document, review settings in your CSD files to ensure that the most appropriate CSDs are evaluated first. CSD Evaluation Sequence The sequence in which CSDs are evaluated is based on how the document Types property is defined. 1 CSDs that are not specific to any document type are evaluated first. 2 CSDs that are specific to one or more document types are evaluated second. The evaluation based on how many document types the CSD applies to, starting with the CSD that is specific to the greatest number of document types. CSDs that are only specific to one document type are assessed last. 3 If there are no CSDs available that are applicable to the checked document, the server uses a hard-coded backup CSD to process the file. For example, suppose that you have created a CSD that is specific to DITA tasks and contains the property documenttypes=task. You also create a general CSD file that is not specific to any document type. When a user checks a DITA task, the general CSD will be selected instead of the more specific CSD file that you configured for DITA tasks. To avoid these kinds of issues, you can ensure that a document type is specified every CSD file or create CSD for each document type. Backup CSDs The backup CSDs are used when a user checks a file that has no document type or if you have not defined any CSD files at all. There are two backup CSDs - one for HTML and one for XML. These CSDs are hard-coded in the Acrolinx Server and cannot be changed. The backup CSD for HTML files contains the following settings:

15 15 documenttypes=html input_type=html sentence_break_elements=address,base,basefont,blockquote,body, br,button,caption,center,col,dd,del,dir,div,dl,dt,fieldset,form, frame,frameset,h1,h2,h3,h4,h5,h6,head,hr,html,iframe,input,ins, isindex,label,legend,li,map,menu,meta,noframes,noscript,ol, optgroup,option,p,pre,select,table,tbody,td,tfoot,th,thead,title, tr,ul,textarea no_break_elements=a,abbr,acronym,b,big,cite,code,dfn,em,font,i, kbd,q,s,samp,small,span,strike,strong,sub,sup,tt,u,var default_inclusion_mode=include exclusion_elements=applet,area,bdo,colgroup,img,link,object,param, script,style inclusion_elements= empty_elements= The backup CSD for XML files contains the following settings: documenttypes= input_type=xml sentence_break_elements= no_break_elements= default_inclusion_mode=include exclusion_elements= inclusion_elements= empty_elements= Most properties in backup CSD for XML files are empty except for the default inclusion mode. By default, all XML elements are checked when this CSD is used. Configuring Server-Side Segmentation â To configure server-side segmentation, follow these steps: 1 Create a server-side CSD file (see "Creating and Modifying Server-Side CSD Files" on page 15). 2 Associate the server-side CSD file with a language or rule-set (see "Associating Server-Side CSD Files with Languages and Rule Sets" on page 16). 3 (Optional) Configure Acrolinx Server to generate an annotated copy of the checked document (see "Configuring Annotated Output" on page 17). 4 Enable server-side segmentation in your client software (see "Enabling Server-Side Segmentation in Your Client Application" on page 17). Creating and Modifying Server-Side CSD Files â To create a CSD file, follow these steps: 1 Create a text file <FILENAME>.properties and save the file in your server configuration directory. Example: %ACROLINX_CONFIGURATION_ROOT%\data\<LANGUAGE_ID> 2 Copy the following parameters into the text file:

16 16 Configuring Segmentation Settings for your Organization documenttypes= input_type= sentence_break_elements= no_break_elements= default_inclusion_mode= exclusion_elements= inclusion_elements= empty_elements= 3 Type values for each of the parameters (see "Context Segmentation Definitions (CSDs)" on page 9). 4 Save and close the CSD file. â To modify an existing CSD file, follow these steps: 1 Find and open the CSD text file in the directory where your CSD profiles are stored. Example: %ACROLINX_CONFIGURATION_ROOT%\data\<LANGUAGE_ID> 2 Edit the parameters (see "Context Segmentation Definitions (CSDs)" on page 9). 3 Save and close the CSD file. Associating Server-Side CSD Files with Languages and Rule Sets When a check is performed on XML files, the settings in a CSD (context segmentation definition) file determine the segmentation rules. To select server-side CSD files for checking, you define the CSD file in your language configuration file. â To associate a server-side CSD file with a rule set, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add one or more the following properties: [RULE_SET].contextSegmentationDefinitions=<CSD_LOCATION>.properties Add this line to associate a CSD file or set of CSD files with a specific rule set. contextsegmentationdefinitions=<csd_location>.properties Add this line to associate a CSD file or set of CSD files with all checks in your selected language. If a user selects a rule set that is not associated with any CSD files, the server falls back to the CSD files that are defined in this property. The CSD location is relative to the location of the language configuration file. For example, if your CSD file is stored in the directory %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>, you would enter the property as follows: Standard.contextSegmentationDefinitions=default.properties

17 17 If you want to associate several CSDs with different document types, you can also add a comma-separated list of CSD files. Example: Standard.contextSegmentation Definitions=default1.properties,default2.properties 3 Save your changes and reload the relevant language server configuration. Configuring Annotated Output When server-side segmentation is used, the Acrolinx Server generates an annotated copy of the checked document in the server output directory. Example: <INSTALL_DIR>\server\www\output\en\<FILENAME>_annotated.xml. By default, the document is annotated with processing instructions which indicate flagged text. This function is useful if you have an automated workflow which can process documents based on meta content. You can change how the server generates the annotated output file with the core server property xml.annotationtype. â To configure annotated output, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add the following property: xml.annotationtype=<value> Use the value: none to prevent the server from generating an annotated copy of the checked document. pi to annotate the document with processing instructions. element to annotate the document with acrolinx-specific XML elements. The default value is pi. 3 Save your changes and reload the relevant language server configuration. TIP: If you are using the Acrolinx Java API, you can get the location of the annotated output file by calling the method getannotatedxmluri() in the interface CheckResult. Enabling Server-Side Segmentation in Your Client Application You enable server-side segmentation by configuring your client software to include XML markup when sending text to the Acrolinx Server and to use the CSD files that are stored on the server instead of the local computer.

18 18 Configuring Segmentation Settings for your Organization â To enabling server-side segmentation in your client application, follow these steps: 1 Configure the property useserversidexmlextraction so that your client uses the server-side CSD files. If you are using the Acrolinx Java API, ensure that you configure your client application to send the property useserversidexmlextraction=true. If you are using the Acrolinx Batch Checker, add the system property useserversidexmlextraction=true. For more information, see the topic 'Activating Server-Side Segmentation' in the Acrolinx Batch Checker User Guide. 2 Configure your client application to send the content of XML files as text. You make this configuration to prevent the client from stripping out the XML markup before it is sent to the server. If you are using the Acrolinx Java API, ensure that you configure your client application to set the property input_type=text when checking XML files. If you are using the Acrolinx Batch Checker check XML files, add the extension.xml to the file type Text in the Manage File Types dialog box. Centralized Plug-in Properties Most of the settings that are visible in the Acrolinx Plug-in options dialog are saved in a user properties file which is stored on the Acrolinx Server. These properties include basic plug-in preferences, segmentation and filter settings, and checking options. You can configure the server so that most settings are already configured for the user before they start checking with an Acrolinx Plug-in. IMPORTANT: The server location, the GUI language and the installation path are still stored in the registry of the client computer. Configuring the Location of the User Properties Files When a user registers with the Acrolinx Server for the first time, the server creates a user properties file (USER_NAME.properties) which is stored in the default location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_EN> If desired, you can set a new location to store the user properties files. â To change the location where user properties are stored, follow these steps: 1 Open your overlay of the core server properties file. You find the overlay for the core server properties file in the following location:

19 19 %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties 2 Add the following property: clientpropertiespath=<path> Replace <PATH> with a relative or absolute path pointing to the new location. Relative paths must relative to the directory: %ACROLINX_CONFIGURATION_ROOT%\server\bin\ The default value is:../../data/clients 3 Save your changes and restart the core server. Configuring the Model User To set the default properties for each new user, you must create a model user properties file. The model user properties file acts as a template when the server creates new user properties files. Creating the Model User Properties File and Setting the Model User â To create the model user properties file and select the model user, follow these steps: 1 Open a host client with the relevant Acrolinx plug-in installed. 2 Open a document that your users are likely to check. TIP: If you work mainly with XML documents, ensure that the document is based on a DTD which is widely used in your team (see "Configuring DTD References for a User Properties File" on page 20). All users will then inherit the segmentation and filter settings, regardless of what XML editor they use. 3 Open the Acrolinx Options. 4 Connect to your Acrolinx Server, and if prompted, register using the desired model user ID. Ensure that the user has a role with the privilege Edit plug-in segmentation and filter settings. 5 Configure the desired options for the model user and click OK (refer to the relevant plug-in user guide for more information). RESTRICTION: The settings that you define on the Check tab in the plug-in options are only distributed to users who check with the same plug-in as you. For example, if you select the checking options "Spelling", "Grammar", and "Terminology" in the Acrolinx Plug-in for Microsoft Word, users who check with the Acrolinx Plug-in for JustSystems XMetaL will not receive these settings as their default check settings. Only Word plug-in users receive these settings. To ensure that the check settings are consistent for all plug-ins that your users have installed, define the check settings in each plug-in that is deployed in your organization.

20 20 Configuring Segmentation Settings for your Organization 6 Navigate to the location where your user properties are stored, and check that a properties file has been created for your model user ID. By default, user properties are stored in the directory %ACROLINX_CONFIGURATION_ROOT%\data\clients. 7 In the Dashboard, navigate to the Users page and select the Model user by clicking the Change button and entering the desired model user ID. 8 Click OK and restart the core server. Updating the Model User Properties If you update the model user properties, all users automatically inherit the changes. However, if your users have the appropriate privileges, they can update their plug-in options and override specific settings. If you update the model user properties, users only inherit the settings that do not conflict with their changes. For example, if you change the list of excluded elements for the model user, any user who has also made changes to the list of excluded elements will not automatically inherit the new list from the model user. This behavior ensures that changes that users make are not lost when the model user properties are updated. To ensure that all users in inherit all changes to the model user properties, you must remove any user-specific settings first. â To update the model user properties file, follow these steps: 1 Open your editor application. 2 Open the Acrolinx Options. 3 Connect to your Acrolinx Server, and if prompted, register using the model user ID. 4 Update the options for the model user (refer to the relevant plug-in user guide for more information). 5 Click OK. 6 (Optional) To ensure all users inherit all of your updates, check for any user properties that conflict with your changes. You can remove conflicting user properties by individually removing the conflicting properties from each user properties file or by deleting all user properties files. If you delete an entire user properties file, you also delete any other changes that the user has made to their settings - even if the changes do not conflict with the changes you have made to the model user. 7 Restart the core server. 8 Have an end user open their plug-in options and check that the user has received the new settings. Configuring DTD References for a User Properties File The plug-in segmentation and filter settings are saved in numbered sets which related to the DTD of the document which was open when the settings were saved. When a user opens a document, the plug-in checks to see if the DTD used by the document is referenced in the plug-in user properties. If the plug-in

21 21 cannot find a reference for the DTD, the plug-in adds a new reference in the properties file and creates an empty set of segmentation settings for the new DTD. The DTD reference in the user properties file is a combination of the Public ID and System ID that are found in the <!DOCTYPE> tag of an open document. Example The user properties file refers to a document with the doctype tag: <!DOCTYPE book PUBLIC "-//MYCOMPANY//DTD UG XML Book//EN" "mydocbook.dtd"> using the reference segmentation.xml.dtds=-//mycompany//dtd UG XML Book//ENmydocbook. dtd In certain environments, different locations of a specific DTD file will cause multiple references to the same DTD. If user opens another document with the doctype tag: <!DOCTYPE book PUBLIC "-//MYCOMPANY//DTD UG XML Book//EN" "C: \doctypes\mydocbook.dtd"> an extra DTD reference is added in a comma-separated list: segmentation.xml.dtds=-//mycompany//dtd UG XML Book//ENmydocbook. dtd,-//mycompany//dtd UG XML Book//ENC:\doctypes\mydocbook.dtd, The different locations of the DTD cause the Plug-in to create an empty set of segmentation and filter settings for each DTD reference, even though the DTD file is identical in each case. This behavior prevents end users from inheriting segmentation and filter settings from the model user. You can solve this problem by manually changing the main DTD reference to the Public ID of the desired DTD. â To use the Public ID as a DTD reference follow these steps: 1 Open the model user properties file 2 Edit the line:segmentation.xml.dtds 3 Remove the System ID from the end of the DTD reference. (if necessary, refer to the <!DOCTYPE> tag in a sample document to identify the system ID) Example: For the DTD reference -//MYCOMPANY//DTD UG XML Book//ENC:\doctypes\mydocbook.dtd shorten the DTD reference to -//MYCOMPANY//DTD UG XML Book//EN 4 Save the file and follow the procedure for updating a model user (see "Configuring the Model User" on page 19).

22 22 Configuring Segmentation Settings for your Organization Configuring Soft Exclusion Elements Excluded elements in your segmentation settings may sometimes have a negative influence on the way Acrolinx analyzes the grammatical structure of a sentence. Normally, this behavior occurs when you exclude elements which appear inline within a sentence. Example: You have the sentence: <para>see the topic 'customizing your server' in the <emphasis >administration guide</emphasis> for more information.</para> You have set the element <emphasis> to be excluded. As a result, the plug-in sends the following text to the server: See the topic 'customizing your server' in the for more information. The text administration guide is removed and Acrolinx flags the text in the for more information as a grammar issue. To avoid this problem, you can configure the Acrolinx to recognize text in excluded elements but ignore any issues in the excluded text. This type of configuration is called soft exclusion. ATTENTION: Changing this setting will increase the amount of text sent to the server when the relevant rule set is used. As a result, processing times may increase for documents which contain large amounts of text in excluded elements. â To configure soft exclusion, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add the following property: <RULE_SET>.useHardExclusion=false 3 Save your changes and reload the relevant language server configuration. 4 To configure soft exclusion for the Acrolinx Batch Checker, follow these additional steps: a) Close the Batch Checker. b) Open the system.properties file in the Batch Checker installation directory. c) Add the property standard_exclusion=false. d) Save the system.properties file and restart the Batch Checker.

23 23 Chapter 3 Configuring Scoring and Help Information Configuring How Scores Are Calculated When you check with an Acrolinx plug-in, you receive a quality score for the document in the Acrolinx Results dialog box. The quality score expresses the checking score as a standardized score out of 100 that is easier for most users to understand. The higher the score, the higher the quality of the content. You can influence the quality score by configuring how many issues are allowed per 100 words. Additionally, the Acrolinx Server generates a checking report which includes an overall checking score and a checking status that is similar to the colors on a traffic light. In this case, a high score indicates low-quality content. Each issue category, such as spelling and grammar, contributes to the checking score. You can configure the server so that some issue categories affect the score more than others. How the Checking Score is Calculated The checking score is a sum total of the category scores for each issue category: Spelling Grammar Style Terminology (deprecated terms) Admitted terms NOTE: Weighting for admitted terms is only available when a separate flag is configured for admitted terms (see "Configuring a Separate Flag for Admitted Terms" on page 58). Reuse SEO NOTE: The checking score takes into account the number of SEO warnings instead of the number of issues. The number of warnings indicates how many different types of warnings were identified. If the same warning is required for all SEO issues in the document, the number of warnings is 1. The Acrolinx server uses this number when calculating the checking score. The category score is an expression of the number of issues per 10,000 words in your document for a certain category. If your document contains fewer than 10,000 words, the server estimates how many issues there would be if the document contained 10,000 words. Example: Your document contains 325 words and 13 spelling issues. 13 is 4% of 325

24 24 Configuring Scoring and Help Information 4% of 10,000 is 400 The category score for spelling would be 400 If there were 13 issues each for spelling, grammar, style, terminology, and reuse, the total checking score would be 2,000 (spelling, grammar, style, terminology, and reuse would each have a score of 400). How the Quality Score is Calculated The quality score expresses the checking score as a standardized score out of 100 that is easy for most users to understand and compare with other documents. If you have weighted some of the flag categories for the checking score, these weightings are still taken into account because the server uses the checking score when calculating the quality score. You can influence how the quality score is calculated by configuring the maximum number of issues that are allowed per 100 words. If a document contains more than the allowed number of issues, the quality score is always 0 out of 100. The default maximum number of allowed issues is 10 issues per 100 words. The following example describes how the quality score is calculated: Suppose that your document contains 325 words and 20 issues - the total number of 20 issues is comprised of 5 issues in each of the main categories: spelling, grammar, style, and terminology. You are using the default maximum number of issues allowed per 100 words which is 25 issues. According to checking score calculation (see "How the Checking Score is Calculated" on page 23), your checking score would be: 615 The server divides the checking score (615) by the maximum number of issues per 100 words (10) multiplied by 100 (1000). The result is 0.61 The final calculation to get the score out of 100 is: (1-0.61)*100. The final result is a low quality score of 39/100. Weighting the Category Scores You can configure the server to increase or decrease the influence that a flag category has on the checking score. Weighting a flag category helps writers prioritize the issues to correct in a document. Example: You want to encourage writers to remove all spelling issues in a document before addressing other issues. You set the weighting for the spelling category to 200%. The calculation for a document which contains 325 words and 13 spelling flags would now be as follows: 13 is 4% of 325 4% of 10,000 is * 200% = 800 The category score for spelling would be 800 and would contribute twice as much to the checking score as the same number of flags in any other category.

25 25 â To configure the weighting for a category score, follow these steps: 1 Open your overlay of the following file: thresholds.xml If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\server\www\xsl Do not edit the installed version of the file. Instead, always edit your overlay copy in the configuration directory. 2 Edit the projectthreshold element: <projectthreshold red="200" yellow="100" styleweight="100" grammarweight="100" termsweight="100" admittermsweight="50" spellingweight="150" reuseweight="100"/> Enter a new weighting value for one or more <CATEGORY_NAME>Weight attributes. For example, to change the weighting for spelling, update the value for the attribute spellingweight. 3 Save your changes and restart the core server. Configuring the Maximum Number of Issues per 100 Words You can influence the How the Quality Score is Calculated on page 24 by changing the maximum number of issues that are allowed per 100 words. You can use this setting in addition to the category score weightings for specific flag types. This setting provides a more general way to weight the quality score. The higher the number, the easier it is for users to get a high-quality score. The default maximum is 10 issues per 100 words. â To change the maximum number of issues per 100 words, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add the following property: <RULE_SET>.maxIssuesPerHundredWords=<NUMBER> For example, to change the maximum number of flags per 100 words for the rule set "Standard US", add the following property: StandardUS.maxIssuesPerHundredWords=15 3 Save your changes and restart the relevant language servers.

26 26 Configuring Scoring and Help Information Configuring the Colors for the Checking Status and Category Status The checking status and the category status are colors which reflect the range of acceptability of the checking score and the category score respectively. The checking status and category status can have one of three colors: Green - excellent Yellow - acceptable Red - unacceptable The checking status reflects the integrity of the document, or set of documents and appears in the following components of Acrolinx: The Acrolinx Checking Report (appears as a colored icon) The Acrolinx Results dialog (appears as a colored icon) The Summary Tab of the aggregated report (appears as a highlighted status name) The Results Tab of the aggregated report (appears as a highlighting for the file names and checking scores) The category status appears on the Results Tab of the aggregated report, and reflects the level of acceptability for an individual flag category within a set of documents. The category status is expressed in the coloring of the numbers in the checking score column for each flag category. You can use color thresholds to configure the minimum checking score or category score that a document must reach before a specific checking status or category status is applied. â To configure the colors for the check and category status, follow these steps: 1 Open your overlay of the following file: thresholds.xml If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\server\www\ xsl Do not edit the installed version of the file. Instead, always edit your overlay copy in the configuration directory. 2 To change the color for the checking status, edit the projectthreshold element: <projectthreshold red="200" yellow="1 00" styleweight="100" grammarweight="100" termsweight="100" admittermsweight="50" spellingweight="150" reuseweight="100"/> Enter a new checking score threshold for the red and yellow attributes. TIP: If the checking score is less than the yellow threshold, the checking status defaults to green. 3 To change the color for a category status, edit one or more of the elements with the naming convention <CATEGORY_NAME>Threshold.

27 27 For example, to change the color threshold for spelling edit the following element: <SpellingThreshold red="30" yellow="10"/> Enter a new checking score threshold for the red and yellow attributes. 4 Save your changes and restart the core server. Configuring How Help Information is Displayed Customizing the Location of Help Files When checking documents in an Acrolinx Plug-in, you can use the shortcut menu to access help files which offer information about a specific flag. These help files are located on the server and fall into two categories: Issue specific and generic. Issue-specific help files offer information that is specific to a style or grammar rule. The location of issue-specific help files is configured by the Acrolinx linguistic support team within the individual rule files. One exception is the sentence to long style issue. The behavior of the sentence to long rule is configured in the language server properties, including the location of the help file. Generic help files offer general information for all issues within a flag type. The Acrolinx Plug-in displays a generic help file for spelling, reuse, and terminology issues. You can create your own generic help files and store them in an accessible location on your network. Adapt the language server properties to store your generic help files at a different location to the default installation directory. TIP: In the case of terminology help, the help template file is generic but the information within the help file adapts dynamically to the term which is flagged. The location of the terminology help template is configured in the core server properties (for more information, see the Administrative Tasks chapter of the Acrolinx Terminology Manager User Guide.) â To configure the location of a generic help file, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add one or more the following properties:

28 28 Configuring Scoring and Help Information Property spellcheckerhelp=<file_path> Description Customize the location of the generic spelling help. lengthchecker.sentencetoolonghelp=<file_path> Customize the location of the help information for the sentence too long rule. reusesentencehelp=<file_path> Customize the location of the help file that displays when the link checker finds a broken link. linkchecker.pagenotfoundhelp=<file_path> linkchecker.pageredirectedhelp=<file_path> Customize the location of the help file that displays when the link checker finds a redirected link. Customize the location of the generic help for new terms. newtermhelp=<file_path> Customize the location of the generic help for new terms. The default directory for all generic help files is: <INSTALL_DIR>\server\www\htmldata\<LANGUAGE_ID>\rules\help\ 3 Save your changes and reload the relevant language server configuration. Term Help Templates A term help template defines the appearance of the term help file. The term help file displays key information about a term when users click a help link in the Acrolinx Plug-in shortcut menu or open a term in the Term Browser. You can preview the appearance of the Term Help file on the Term Edit Page of the Terminology Manager. The Default Term Help Template The Terminology Manager comes installed with a default term help template which uses Acrolinx branding and displays some sample information. The template is stored in the Acrolinx Server installation directory in the path: <INSTALL_DIR>\data\ common\term_help_template.vm The Term Browser Term Help Templates If you use the Term Browser, you can also configure separate term help templates for the standard and translation views. Because the Term Browser displays term help a frame, you might use separate templates to adapt the appearance of the term help file when it is viewed in the Term Browser. You can create separate term help template files by making copies of the default term template with the following names: term_browser_help_template.vm translation_browser_help_template.vm If these files are not present, the default term help template is used for the standard and translation views.

29 29 By default, all template files are stored in the directory: <INSTALL_DIR>\data\ common\ If you want to change your existing templates or create new templates, create overlay files for the templates in your configuration directory. You create your template overlay files in the following location: %ACROLINX_CONFIGURATION_ROOT%\data\ common The Term Help Template Language The term help templates are based on a Java-based template engine called Velocity. You can find more information about Velocity templates on the Apache WebsiteApache Website. If you create multiple templates and are comfortable with the Velocity template language, you can use velocity directives #include and #parse to minimize the amount of code duplication in your template structure. Relative File References When customizing term help templates it is good practice to ensure that any paths to images or style sheets are relative and can adapt to changes in your server environment. For example, the paths to some files might break if you configure your server to redirect requests to another base URL. When referencing files, use the $externalbaseurl About Term Help Template Variables on page 29 to ensure that file references are as flexible as possible. About Term Help Template Variables You can display the contents of term fields in your term help file by adding the following variables to the term help template: Field Name Term Entry ID Term Entry UUD Variable $termentryid $termentryuuid Description Displays the term entry ID. Displays the Universally Unique Identifier for the term entry. Term Entry $termentry. <SYSTEM_ FIELD_NAME> $termentry.custom Fields.<CUSTOM_FIELD _NAME> Displays information related to the whole term entry by referring to the attributes of the head term. Use in combination with other variables. Example: $termentry. surface Head Term Term Name $istermentry $surface Indicates if the term is a head term, by display a true or false value. Displays the term name.

30 30 Configuring Scoring and Help Information Field Name Language Domains Status Creation Date Creator User Name Last Modification Date Last Modifier User Name Term UUID Term ID Term Database ID Frequency Linked Terms Custom Fields Variable $language $domaindisplaynames String $status $creationdate $creatorusername $lastmodification Date $lastmodifieruser Name $UUID $externalidentifier $id $frequency #foreach($link in $links) $link.surface ( $link.status) <br/> #end $customfields.<field _NAME> Description Displays the language of the term. Displays the domains which the term belongs to. Displays the term status. Displays the creation date of the term. Displays the name of the user who created the term. Displays the date that the term was last modified. Displays the name of the user who last modified the term. Displays the Universally Unique Identifier for the term. Displays the term ID. Displays the term database ID. Displays the frequency of the terms which were imported from an Acrolinx Term Harvesting report. Displays a list of linked terms with the term status in parentheses. Displays the contents of any custom field, and can be used multiple times in the term help template. Use the Field Manager to find the correct field name. Example: $custom Fields.context

31 31 Field Name Comment on this Term Comments Variable #if ($comments) <a href="/term Contribution.html #addcomment/term DatabaseId/$id" target="blank"> Comment on this Term </a> #end #foreach($comment in $comments) <span style="font -weight: bold;"> $comment.username on $comment.date</span> <p/> $comment.text <p/> #end Description Displays a link to add a comment to the term. Displays the comments created for a term. Adding a Variable to a Term Help Template You add variables to term help templates change the content that is displayed to users in the term help file. For example, you might update the term help template so that users can see the source of the term when they review the help information. â To add a variable to a term help template, follow these steps: 1 Open your overlay of the following file: term_help_template.vm If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\common Do not edit the installed version of the file. Instead, always edit your overlay copy in the configuration directory. 2 Edit the relevant XHTML code and add your desired variable. For example, to update the default template with another table row that displays the term context, add the following line: <tr><td class="left">context:</td><td class="right">$custom Fields.context</td></tr> above the table closing tag: </table> 3 Save your changes. To see your changes, open the Term Help Page for a term. Expand the Help Panel, and click the Refresh button.

32 32 Configuring Scoring and Help Information Your new field is displayed in the help file. Configuring the Location of the Term Help Templates If you plan to make advanced customization to your term help templates, you might want to configure the server to load the templates from a location that is easier for other teams or systems to access. â To change the location of the term help templates, follow these steps: 1 Open your overlay of the following file: termbrowser.properties If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\ 2 Add the following property: termhelp.template.root=<directory_path> This property defines the root directory for all template files. The file path can be a relative path or absolute path. Example: termhelp.template.root=p:/resources/shared Relative paths are relative to the directory: %ACROLINX_CONFIGURATION_ROOT%\data\ The default value is termhelp.template.root=./common 3 Save your changes and restart the core server. 4 Reload the term help in your web browser. The changes take effect immediately. Configuring Term Contribution from the Checking Report By default, the checking report enables users to click a new term to open the term contribution form. When the form opens, the term and context fields are automatically filled out. The function makes it easier for your users to contribute terms. You can change this behavior in the core server properties file. â To configure term contribution from the checking report, follow these steps: 1 Open your overlay of the core server properties file. You find the overlay for the core server properties file in the following location: %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties 2 Add the following property: termcontributionurl.isenabled=<true/false> If this property is not present, the default value is true.

33 33 3 If you have added a context field to your term contribution template, add the property termcontributionurl.contextfieldname=<name_of_context_field> For example, if your terminology database field stores context information in a field called sampleusage, add the following property: termcontributionurl.contextfieldname=sampleusage If this property is not present, the default value is context. This property ensures that context information can be transferred from the checking report to the term contribution form. Context information helps users understand the contexts in which they can use a term. For more information about the term contribution template see the Acrolinx Term Contribution User Guide. 4 Save your changes and restart the core server. Configuring the Checking Report to Display the Flesch Reading Ease Score The Flesch Reading Ease formula was developed by Rudolph Flesch in 1948 to indicate the difficulty and the appropriate reading age of a piece of text. The checking report does not display the Flesch Reading score by default. However, you might configure the checking report to display the Flesch Reading Ease score so that users with English or German language resources have an additional score for measuring the quality or their content. â To configure the checking report to display the Flesch Reading Ease score, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add the following property: showfleschreadingease=true You can also configure the checking report to display the Flesch Reading Ease score when a user checks with a specific rule set only. To restrict the Flesch Reading Ease score to a specific rule set, add the property with the following syntax: <RULE_SET_NAME>.showFleschReadingEase=true For example, to display the Flesch Reading Ease score only when a user checks with the rule set "Standard US", add the property as follows: Standard_US.showFleschReadingEase=true 3 Save your changes and reload the relevant language server configuration.

34 34 Configuring Scoring and Help Information Customizing Terminology Information in the Plug-in Shortcut Menu When you click on a terminology flag after checking a document, you see some basic information about the term in the header of the plug-in shortcut menu. You can customize the information that is displayed in the shortcut menu header for terminology flags. You might customize the plug-in shortcut menu to simplify the information that users see when reviewing a terminology flag or to display the terminology information in another language. â To customize the terminology information in the plug-in shortcut menu, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add the following property: terminology.flagdescriptionformatstring=<header_text_pattern> Where <HEADER_TEXT_PATTERN> includes the static text that you want to appear in the shortcut menu header as well as any variables. You use the variables to display information that is specific to the flagged term. The following table contains information about the variables that you can use in the header text. Options %i %t %s %T %d %e %r %v{...,...} Description Displays the flagged text. Displays the term name. Displays the term status. Displays the name of the term set that was used to load the term. Displays the names of the domains that the term belongs to. Displays any custom fields that are configured to display in the plug-in shortcut menu. You can use the field manager in the Terminology Manager to configure custom fields to display in the plug-in shortcut menu. When displayed in the shortcut menu, each field automatically appears on a new line. Displays the match ranking. This information is intended only for internal debugging by the Acrolinx linguistic team. Displays some text to indicate whether the flagged text was a variant or an exact match of a term in the terminology database. You can enter text in the parentheses before and after the comma. Enter some text before the comma to define what appears when the flag is a variant. Enter some text after the comma to define what appears when the flag is an exact match. By default, no extra text appears for exact matches.

35 35 Options %n %% Description Inserts a new line. Inserts the % character. The following example shows how the header information is displayed in the plug-in shortcut menu by default: Variant of Term: 'machine' Status: deprecated Term Set: Standard Terminology Domains: Demo Switches The default header information is based on the following header text pattern: terminology.flagdescriptionformatstring.=%v{variant of,}term : '%t'%nstatus: %s%nterm Set: %T%nDomains: %d%e You can copy and customize the default pattern to change how the header information appears for your organization. 3 Save your changes and reload the relevant language server configuration.

36 36 Configuring Checking Behavior Chapter 4 Configuring Checking Behavior Language Configurations A language configuration is a group of settings that influences checking in a particular language. Language configurations include settings for components of your linguistic resources such as terminology, rule checking, and reuse. You can update these components in the language configuration file and the Dashboard. When you make changes to any of these components, you must reload the relevant language configurations so that your changes are available for checking. If you have allocated several language servers to one language, you must reload the language configuration on each language server. If you reload all language configurations, the core server queues the language configurations so that language servers are reloaded one at a time. This behavior ensures that at least one language server is always available during the reloading process. However, if you are reloading a language configuration which is allocated to multiple language servers, some users might get differing checking results. Checking results can vary if users run checks when only some of the language servers have loaded the new language configuration. You can prevent users from checking until all language servers have reloaded the new language configuration by disabling the sequential loading of language configurations (see page 36). You can also make the loading process faster by configuring the core server to load language configurations simultaneously (see page 37). Reloading the Language Servers When you make changes to components like the terminology database, reuse repositories or term sets, you must reload the relevant language servers. To reload the language servers, you have the following options: Reload the server directly when prompted after making any changes in the relevant section. Reload one or all servers by using the relevant buttons (Reload Server Configuration or Reload All Language Servers) on the Servers page. You need a role with the privilege Restart servers to use this feature. Disabling the Sequential Reloading of Language Servers You disable the sequential reloading of language servers to ensure that all users get the same checking results when checking with multiple language servers. However, users must wait until all relevant language servers have reloaded before they can run checks. Sequential reloading ensures users can still check when a language configuration is being reloaded on several language servers. If you disable

37 37 sequential reloading, language servers are still loaded one at a time, but the core server waits until the last language server has reloaded before making the language servers available for checking again. â To disable the sequential reloading of language servers, follow these steps: 1 Open your overlay of the core server properties file. You find the overlay for the core server properties file in the following location: %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties 2 Add the following property: serializedresourcereloading=false When this property is not present, the default is true. 3 Save your changes and restart the core server. Configuring Language Servers to Reload Simultaneously By default, language servers reload language configurations one at a time. If you have several language servers you can make the loading process faster by configuring language servers to load language configurations simultaneously. Before you use this configuration, ensure that your hardware is capable of reloading language servers simultaneously. You should use this configuration only if your computer has a dedicated CPU for each configured language server or if you have a distributed installation. â To configure language configurations to reload simultaneously, follow these steps: 1 Open your overlay of the core server properties file. You find the overlay for the core server properties file in the following location: %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties 2 Add the following property: 3 maxparallelresourceloadrequests=<number> For example, if you add the property maxparallelresourceloadrequests=3, the core server loads the first three language servers simultaneously. Any remaining language servers are loaded one at a time. 4 Save your changes and restart the core server.

38 38 Configuring Checking Behavior Using the Resource Manager The Resource Manager enables you to configure the most important components of your linguistic resources. The Resource Manager contains the following modules: Rule activation Term set configuration Activating and Deactivating Rules The rule activation module enables you to activate or deactivate rules within the rule sets that are delivered with your linguistic resources. â To activate or deactivate rules within a rule set, follow these steps: 1 Navigate to Resources > Rules. 2 The Rule Set Overview appears with a list of rules sets grouped by language. Figure 1: Rule Set Overview 3 Click the name of a rule set.

39 39 4 The rule list for the selected rule set appears. Figure 2: Rule List Use the: Filter field to filter the rule list by rule name. The rule list is filtered as soon as you start to type characters in the Filter field. Rule type radio buttons to show only grammar or style rules. 5 Select or deselect checkboxes in the Activated column to activate or deactivate rules. 6 Click Save. A dialog appears which prompts you to choose one of the following options: Reload the language server configuration Continue without reloading TIP: If you click Continue Without Reloading, your changes are saved but are not available for plug-in users until you have reloaded the language server configuration. Rule Set Configuration Files All changes you make to a rule set are saved in language-specific configuration files in the directory: %ACROLINX_CONFIGURATION_ROOT%\data\rule configuration\ To ensure that your settings are retained when upgrading your linguistic resources, the uninstaller does not remove the rule set configuration files when uninstalling Acrolinx Configuring the Maximum Length for the Sentence Too Long Rule The 'sentence too long' rule flags sentences which contain too many words and is included in the standard set of Acrolinx style rules. The 'sentence too

40 40 Configuring Checking Behavior long' rule flags sentences which contain more than the default maximum of 25 words. However, you can also configure a different maximum number of words when checking with specific rule sets. â To configure the maximum length for the 'sentence too long' rule, follow these steps: 1 Navigate to Resources > Rules. The Rule Set Overview appears with a list of rules sets grouped by language. 2 Click the name of a rule set. The rule list for the selected rule set appears. 3 Locate the 'sentence too long' rule. Figure 3: Filtering for the sentence_too_long Rule You can use the Filter field to filter the rule list by rule name. The rule list is filtered as soon as you start to type characters in the Filter field. 4 Click the name of the 'sentence too long' rule. The Rule Settings dialog box appears. 5 Enter a new maximum length for sentences in the Maximum sentence length field and click OK. 6 Click Save on the rule list page. A dialog appears which prompts you to choose one of the following options: Reload the language server configuration Continue without reloading TIP: If you click Continue Without Reloading, your changes are saved but are not available for plug-in users until you have reloaded the language server configuration. Configuring Term Sets in the Term Set Configuration Module The term set configuration module enables you to quickly add new term sets which load terms based on domains. You can also deactivate or activate existing term sets. A term set configuration page is available for each of the languages configured in your resources. â To open the term set configuration page: Navigate to Resources > Term Sets.

41 41 In the left-hand navigation menu, a menu item appears for each of the available languages. The Resource Manager displays the term set configuration page for the first language in the list. To view the term sets for another language, click the relevant menu item. About the Term Set Configuration Page The term set configuration page has the following parts: Figure 4: Term Set Configuration Page Part Term sets table Use To View term set information and edit existing term sets. The term set table contains columns with the following functions: Active - Activate or deactivate term sets (see "Activating and Deactivating Term Sets" on page 44) Delete - Delete term sets (see "Deleting Term Sets" on page 44) Domains - View or edit the domains in the term set (see "Editing Term Sets" on page 43) Term Set Name - View or edit the term set name (see "Editing Term Sets" on page 43) Rule Sets - View or edit the rule sets for a term set (see "Editing Term Sets" on page 43) External Source - View the name of any external source files may define the loading criteria of the term set. You can use an external source as an alternative to specifying domains. One example of an external source is a filter file (see "Loading Terms Using a Filter File" on page 49). Status - View the loading status of the term set (see "About

42 42 Configuring Checking Behavior Part Add Term Set button Save button Undo All Changes/Refresh button Preconfigured term set(s) User-defined term set(s) Use To Loading Statuses and Warnings" on page 44) Add new term sets. (see "Creating Term Sets" on page 42) Save all changes made on the term set configuration page. Undo all changes made on the term set configuration page since the last save. When you have not made any changes since the last save, this button displays as a Refresh button. If you click Refresh, all the information in the term sets table is refreshed, including the loading statuses (see "About Loading Statuses and Warnings" on page 44). View term sets which have been defined directly in the language configuration file. Your linguistic resources are always delivered with at least one preconfigured term set. Preconfigured term sets cannot be edited or deleted from the term set configuration page, and must be edited in the relevant language configuration file. However you can still deactivate or reactivate a preconfigured term set (see "Activating and Deactivating Term Sets" on page 44). You identify preconfigured term sets by looking for rows which have no delete button. View term sets which have been defined on the term set configuration page. Rows for user-defined term sets are editable and always contain a delete button Creating Term Sets â To create a new term set, follow these steps: 1 Navigate to the term set configuration page for the relevant language.

43 43 2 Click Add Term Set. 3 In the dialog that appears, select a domain. A new row appears in the term sets table. The selected domain appears in the Domain column along with a Choose Domain button. To add more domains, click Choose Domain. Term Set Name column contains a text field with domain name as the default name for the term set. To rename the term set, type the new name in the term set name field. RESTRICTION: The 1.4 Server does not support term set names with non-ascii characters such as umlauts or Japanese characters. The term set is added to all rule sets by default, and a Choose Rule Set button appears the Rule Sets column. To add the term set to specific rule sets, click Choose Rule Set. 4 Click Save. A dialog appears which prompts you to choose one of the following options: Reload the language server configuration Continue without reloading TIP: If you click Continue Without Reloading, your changes are saved but are not available for plug-in users until you have reloaded the language server configuration. Editing Term Sets â To edit a term set, follow these steps: 1 Navigate to the term set configuration page for the relevant language. 2 (Optional) In the Domains column, click Choose Domain to add more domains. To remove a domain, click the domain name. In the shortcut menu, click Remove Item. 3 (Optional) In the Term Set Name column, enter a new name for the term set. 4 (Optional) In the Rule Sets column, click Choose Rule Set to add the term set to specific rule sets. To remove a rule set, click the rule set name. In the shortcut menu, click Remove Item. 5 Click Save. A dialog appears which prompts you to choose one of the following options: Reload the language server configuration Continue without reloading

44 44 Configuring Checking Behavior TIP: If you click Continue Without Reloading, your changes are saved but are not available for plug-in users until you have reloaded the language server configuration. Activating and Deactivating Term Sets You can control whether a term set is loaded by the language servers by using the checkboxes in the Activate column. This functionality enables you to take a term set offline without deleting it permanently. â To activate or deactivate a term set, follow these steps: 1 In the relevant term set rows, select or deselect the checkbox in the Active column to activate or deactivate the term set. 2 Click Save. A dialog appears which prompts you to choose one of the following options: Reload the language server configuration Continue without reloading TIP: If you click Continue Without Reloading, your changes are saved but are not available for plug-in users until you have reloaded the language server configuration. Deleting Term Sets â To delete a term set, follow these steps: 1 In the relevant rows click the delete icon in the Delete column. The term set is marked for deletion and the table row becomes inactive. 2 Click Save. A dialog appears which prompts you to choose one of the following options: Reload the language server configuration Continue without reloading TIP: If you click Continue Without Reloading, your changes are saved but are not available for plug-in users until you have reloaded the language server configuration. The row is removed from the table. About Loading Statuses and Warnings The term sets table contains a Status column which displays the loading status of each term set. The loading status indicates the availability of the term set to plug-in users. Domain and rule set names can also display in red as a warning that the term set has been affected by changes made outside of the Resource Manager.

45 45 Loading Statuses The following table describes the possible loading statuses. Status Loaded Loading Not loaded Changes not loaded Language configuration unavailable Language server unavailable Description The relevant language servers have loaded the term set and the term set is available to plug-in users. The relevant language servers are in the process of loading the term set. The term set has not been loaded by the relevant language servers and is not available to plug-in users. The term set has been edited on the term set configuration page but the changes have not yet been loaded by the relevant language servers. The term set was created for a language which is no longer configured. The most likely cause for this status is a missing language configuration file. There is no running language server configured with the language required by this term set. Term Set Warnings Figure 5: Term Set Warning for Domains Domain names display in red if a domain in a term set has been deleted on the category manager page of the Terminology Manager. Rule set names display in red if a rule set for a term set has been removed from the relevant language configuration file. If all the domain or rule set names in your term set are red, the term set is not loaded. You can remove the term set warnings by removing the affected domains or rule sets. Configuring Reuse Repositories A repository is not enabled for checking until you assign the repository to a rule set. You assign new reuse repositories to rule sets on the Reuse Repositories page in the Resources section. You can also deactivate or activate existing assignments. A reuse repository configuration page is available for each of the languages configured in your resources.

46 46 Configuring Checking Behavior Assigning a Reuse Repository to a Rule Set To enable a repository for checking, you must assign the repository to a rule set. You can assign the same repository to one or more rule sets, but you can assign only one repository to each rule set. â To assign a reuse repository to a rule set, follow these steps: 1 Navigate to Resources > Reuse Repositories. 2 Navigate to the reuse repository configuration page for the relevant language. 3 In the Repository column, select the repository for the rule set that you want to assign repository to. 4 Select the checkbox in the Active column to activate the assignment for checking. 5 Click Save. Activating or Deactivating Repositories You can control whether a reuse repository is loaded by the language servers by using the checkboxes in the Active column. If you want to update the contents of the repository but do not want users to check with a repository that might change, you can deactivate the repository. â To activate or deactivate a repository assignment: In the relevant rows, select or deselect the checkbox in the Active column to activate or deactivate the assignment between the rule set and the resue repository and click Save. Language Server Statuses and Warnings The table on the Reuse Repositories Configuration page contains a Status column which displays the language server status of each reuse repository. The language server status indicates the availability of the reuse repository to plug-in users. Language Server Statuses The following table describes the possible loading statuses. Status Loaded Loading Not loaded Changes not loaded Description The language server loaded the reuse repository and the reuse repository is available to plug-in users. The language server is in the process of loading the reuse repository. The reuse repository was loaded by the language server and is not available to plug-in users. The reuse repository was edited on the reuse repository configuration

47 47 Status Language configuration unavailable Description page but the changes are not yet loaded by the language server. The reuse repository was created for a language which is no longer configured. This status is usually displayed when the server cannot locate the language configuration file configuration.properties in either one of the following directories: <INSTALL_DIR>\data\<LANG_ID>\ %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\ If the language configuration file does not exist, copy your backup of this file to the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\ If no backup copy exists, reinstall your linguistic resources. Language server unavailable A language server is configured with the language that is required by this repository. However, the language server is not running. Start the language server for the language that you are working with. Reuse Repository Warnings If the directory which stores the reuse repository has been deleted from your resources, the name of the reuse repository appears with a red border on the Reuse Repository Configuration page. Figure 6: Reuse Repository Warning After you select another valid repository and save your changes, the red border is removed and the missing repository is removed from the repositories dropdown. Configuring Term Sets in the Language Configuration File The linguistic resources delivered with your Acrolinx Server normally include a terminology database and one or more language configuration files. The language configuration file contains instructions for the server on which term sets to load for the Acrolinx Plug-ins.

48 48 Configuring Checking Behavior After you update your terminology and data model, you may wish to make new term sets available to Acrolinx plug-in users. The quickest way to add a term set is in the term set configuration module (see "Configuring Term Sets in the Term Set Configuration Module" on page 40). However you can also configure a term set directly in the language configuration file. There are two ways to configure a new term set in a language configuration file: Add a Domain Reference to configure a basic term set based on the domain category Add a Filter File Reference to configure an advanced term set based on several filter criteria TIP: Regardless of the criteria defined for a term set, the Acrolinx Server only loads terms in the language which is defined in the language configuration file and any terms which have the language value Multiple Languages. Loading Terms Using a Domain Reference â To load a new term set based one or more domains, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add the following property: <RULE_SET>.terminology.sources=<DOMAIN_REFERENCES> Add each domain reference using the following syntax: att:<domain_name> separated by a semicolon. Example: Standard.terminology.sources=att:acrolinx;att:switches RESTRICTION: You cannot use spaces when referencing domains. If your domain name contains a space within the Terminology Manager interface, replace the space with an underscore when referencing the domain in the properties file. For example, if your domain is called 'test terms', add the reference att:test_terms. You can also load terms from multiple domains into one term set by using the syntax: att:<domain_name_1>,<domain_name_2>[set=<set_name>] Example: Standard.terminology.sources=att:planes,trains,automobiles[set=AllTransportDomains]; att:switches TIP: The set parameter is an optional setting which enables you to customize the name of the term set. If you do not use this parameter, the server assigns a default name to the term set based on the domain

49 49 names. If the previous example did not contain the set parameter, the term set name would be planes_trains_automobiles. 3 Save your changes and reload the relevant language server configuration. ATTENTION: If you have entered domain names or term set names which contain non-ascii characters (such as umlauts or Japanese characters), save the configuration file with the encoding UTF-8. If the configuration file does not have UTF-encoding, term set names may not display correctly in the Acrolinx plug-in interface. Loading Terms Using a Filter File â To load a new term set based on a filter file, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add the following property: <RULE_SET>.terminology.sources=<FILTER_FILE_REFERENCE> Add a reference to the filter file using the following syntax: att:file:<file_name>.xml[set=<set_name>] with multiple term sets separated by a semicolon. Example: Standard.terminology.sources=att:file:auto_cmpnts xml[set=Components]; att:switches TIP: The set parameter is an optional setting which enables you to customize the name of the term set. If you do not use this parameter, the server uses the name of the filter file as the term set name. 3 Save your changes and reload the relevant language server configuration. The Structure of Filter File XML A Filter File is an xml file which can query the terminology database using several different criteria simultaneously. This functionality is very similar in structure to the filters in the Terminology Manager interface. Filter Files are useful for creating term sets which represent different cross-sections of your terminology. The following table lists the XML elements which you can use in a Filter File, with hierarchy indicated in the Level column:

50 50 Configuring Checking Behavior Level Element Name compositefilter composition negated categoryfilter category Use To Enclose a set of multiple categoryfilter or surfacefilter criteria. You can use this element several times to nest different sets of criteria. Select a Boolean value for set of criteria in a composite filter You must use this element within compositefilter. Exclude a set of criteria from a composite filter. Enclose a search for terms within a given category The categoryfilter element has the attribute inclusive which you can set to true or false. Set the inclusive attribute to true to include terms which are associated with subcategories of the specified category value. Set the inclusive attribute to false to exclude subcategories and filter for terms which only have the exactly the matching category value. You can use this element several times within a compositefilter Define the value of the category to filter on. You must use this element within categoryfilter

51 51 Level Element Name categorytype surfacefilter Use To Define the name of the category to filter on. You must use this element within category. Enclose a search for terms whose names match a certain pattern. You can also include the element <iscasesensitive> to ensure the matching takes case into account surface Example: <surfacefilter> <iscasesensitive> true</iscasesensitive> <surface>a%</surface> </surfacefilter> Define a search pattern to filter on. You must use this element within surfacefilter. The follow illustration is an example of a Filter File which uses nested filters and multiple criteria:

52 52 Configuring Checking Behavior Figure 7: Illustration of a Filter File The Filter Description for this filter would be: Load all terms: where the category ProductType is ElectronicComponents and where the category domain is Switches or ACME or where the term name is like '%electric% but not if the category WorkflowStatus is UnderReview Creating a New Filter File â To create a new filter file, follow these steps: 1 Create a term export filter in the Dashboard. a) In the Dashboard, navigate to Terminology Import and Export Export b) Expand the Term Filter Selection panel, click Filter, and define the criteria for the terms to load. If you have not used a filter before, see the topic Using the Filter first.

53 53 c) Enter a file name so that the Save Export Configuration button is enabled, and save the export configuration. 2 Copy the filter XML. a) In the Dashboard, navigate to Terminology Import and Export Saved Configurations b) Select the export configuration that you saved in when you created the term export filter and click Download. c) In the window that appears, click the link to open the properties file in a text editor. d) Find the property exportfilter and copy the filter XML from the value of the property. The following example shows the filter XML for a filter that finds English terms in the domain "Standard_Terminology" with the process status "Finalized". <?xml version='1.0' encoding='utf-8'?><compositefilter> <composition>and</composition> <categoryfilter inclusive="true"> <category>standard_terminology<categorytype>domain</categorytype> </category></categoryfilter> <customfieldcategoryfilter inclusive="true"><category>finalized <categorytype>process status</categorytype></category> <customfield>processstatus</customfield></customfieldcategoryfilter> <categoryfilter inclusive="true"><category>en<categorytype>language</categorytype> </category></categoryfilter> </compositefilter> 3 Paste the filter XML into a new file at the following location: <INSTALL_DIR>\data\<LANG_ID>\ terms\<file_name>.xml For example, to create a filter file for product terms in English, you would save the file at the following location: <INSTALL_DIR>\data\ en\terms\productterms.xml 4 Save your changes. 5 (Optional) Configure your language server to load terms using the filter file (see "Loading Terms Using a Filter File" on page 49). Configuring How the Sentence Too Long Rule Appears for Plug-in Users You can configure the plug-in to display the number of words that a flagged sentence contained so that users know how many words to remove. You can also configure an alternative name for the 'sentence too long' rule in the checking report. â To configure the shortcut menu to display the number of words for 'sentence too long' flags, follow these steps: â To configure an alternative name for the 'sentence too long' rule, follow these steps:

54 54 Configuring Checking Behavior 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Locate the group of properties for your desired rule set. 3 Add the following property: <RULE_SET>.lengthChecker.sentenceTooLongPhrase=<PHRASE> You can use the variable $words to display the number of words in the flagged sentence. Example: Standard.lengthChecker.sentenceTooLongPhrase=Sentence too long: Counted $words words. TIP: You can also define this property for all rule sets by entering the property without the rule set prefix. Example: lengthchecker.sentencetoolongphrase=sentence too long: Counted $words words 4 (Optional) To configure an alternative name for the 'sentence too long' rule, add the following property: <RULE_SET>.lengthChecker.sentenceTooLongRuleName=<RULE_NAME> Example: StandardDE.lengthChecker.sentenceTooLongRuleName=Satz zu lang TIP: You can also define this property for all rule sets by entering the property without the rule set prefix. Example: lengthchecker.sentencetoolongrulename=satz zu lang 5 Save your changes and reload the relevant language server configuration. The new name appears in the checking report. Configuring Term Harvesting Configuring Term Harvesting Behavior The Term Harvesting component is configured by the Acrolinx linguistic team, who add Term Harvesting rules to specific rule sets within your linguistic resources. A Term Harvesting report is always generated when users run checks with a rule set that contains Term Harvesting rules. However, you can configure the Acrolinx Server so that you and your users have more control over when Term Harvesting reports are generated. You can update a language configuration to do the following: Allow users to activate or deactivate Term Harvesting using the plug-in checking options.

55 55 TIP: By default, the new terms option is deactivated in the plug-in checking settings. Allow the server administrator to control which users can run Term Harvesting with the Run Term Harvesting privilege. TIP: By default, the Run Term Harvesting privilege is ignored by the server. â To change the Term Harvesting behavior, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add the following property: <RULE_SET>.termharvesting.onlyServerSide=false 3 Save your changes and reload the relevant language server configuration. After the server configuration has reloaded, users who connect the server can select the new terms option in the plug-in checking options. If a user runs a check with the new terms option selected (in combination with a rule set that contains Term Harvesting rules): new term candidates are marked in the document and included in the checking report a separate Term Harvesting report is generated. If a user runs a check without the new terms option selected, a Term Harvesting report is not generated and new term candidates are not included in the checking report. If a user does not have a role with the privilege Run Term Harvesting the new terms option is not available. NOTE: This property only works in rule sets that are configured for Term Harvesting. To run Term Harvesting, a rule set must also contain the property: <RULE_SET>.harvestingRules=rules/<LANGUAGE_ID>-harvesting Additionally, a Term Harvesting rule file (indicated by the extension *. thrul) must exist in the directory %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\rules. The Acrolinx linguistic team normally configures rule sets for Term Harvesting when linguistic resources are created. Configuring the Appearance of the Term Harvesting CSV Reports When you run a check for new terms, the Acrolinx Server generates a Term Harvesting report that is available in OLIF and CSV formats. You can configure

56 56 Configuring Checking Behavior the CSV encoding and delimiter settings to ensure that the CSV files display correctly on your system. The CSV and OLIF versions of the Term Harvesting report are generated in the server output directory: <INSTALL_DIR>\server\www\output\TH\<LANG_ID> The OLIF version of the Term Harvesting report contains a link to the CSV version. The following table contains information on the default CSV settings that are applied when no properties are configured: Property termharvestcsv.encoding termharvestcsv.elementdelimiter termharvestcsv.recorddelimiter termharvestcsv.contextdelimiter termharvestcsv.textdelimiter Description File encoding Column delimiter Row delimiter Context delimiter. A context is a sentence where the new term was found. A cell can contain multiple contexts. Text delimiter Default Value utf-16 ; \n (line break) \n (line break) " To ensure that a CSV file is displayed correctly in Excel, it is often advised to use the text import wizard instead of opening the file directly. However, the default encoding UTF-16 is not available as an encoding option in the Excel text import wizard. If you use the default encoding UTF-16, you can ensure that the CSV file displays correctly in Excel by double clicking the file to open it directly. When opening the CSV version of the Term Harvesting report, a byte order mark is displayed as the first character in the first cell of the file. Delete the byte order mark if you intend to import the file into the Terminology Manager or another application. You can change the default delimiter values to any printable character encoded in UTF-8. To ensure compatibility, do not use control characters or backslashes. â To configure the appearance of the Term Harvesting CSV report, follow these steps: 1 Open your overlay of the core server properties file. You find the overlay for the core server properties file in the following location: %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties 2 Add one or more the following properties:

57 57 termharvestcsv.encoding=<encoding_type> termharvestcsv.elementdelimiter=<character> termharvestcsv.recorddelimiter=<character> termharvestcsv.contextdelimiter=<character> termharvestcsv.textdelimiter=<character> For example, to change the column delimiter to a comma, add the following property: termharvestcsv.elementdelimiter=, RESTRICTION: Although the character \n is the default record and context delimiter, you cannot configure \n as a value for the configuration properties. For example, if you have configured an alternative record delimiter and want to return to the default delimiter \n, do not change the value of the record delimiter property to \n. Remove the entire record delimiter property instead. 3 Save your changes and restart the core server. Configuring the Checking Behavior for Admitted Terms Admitted terms are terms that are permitted when the preferred term is not suitable for a specific context. You can configure how Acrolinx handles these admitted terms when checking with the plug-ins. The following questions help you identify which properties you have to set: Do you want to treat admitted terms as valid or as deprecated terms? (see "Flagging Admitted Terms in the Deprecated Flag Color" on page 57) Do you want to flag admitted terms separately from other terms and activate a separate checking option in the clients? (see "Configuring a Separate Flag for Admitted Terms" on page 58) Do you want admitted terms to contribute to the checking score? (see "Configuring Scoring for Admitted Terms" on page 59) Flagging Admitted Terms in the Deprecated Flag Color By default, admitted terms are flagged if you select the Valid terms option in the plug-ins. The plug-in then marks preferred and admitted terms in the document with an orange flag. This information can be useful when creating a glossary of terms that are used in the document. Depending on the requirements of your company, you might want to flag admitted terms together with deprecated terms. The plug-in then marks admitted terms in the same color as deprecated terms if you run a check for Deprecated terms. This behavior ensures that users are aware of potential terminology issues and are encouraged to check that the context of the term is correct. ATTENTION: In the default setting false, Acrolinx Server treats and evaluates admitted terms like preferred terms. This is important if you use this property together with other properties that affect admitted terms.

58 58 Configuring Checking Behavior TIP: By default, admitted terms contribute to the checking score when they are marked in the deprecated color. However, you can configure the server to prevent admitted terms from contributing to the checking score (see "Configuring Scoring for Admitted Terms" on page 59). â To configure admitted terms to be flagged in the deprecated flag color, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add the following property: terminology.markadmittedterms=true When this setting is enabled and users run checks with the Deprecated terms option selected, the plug-ins mark admitted terms in the deprecated color. When this property is not present in the configuration file, the default behavior is false and admitted terms are marked in the valid term color. 3 Save your changes and reload the relevant language server configuration. Configuring a Separate Flag for Admitted Terms In newer versions of Acrolinx you can configure the Acrolinx Plug-ins and Acrolinx Clients to display an option to specifically check for admitted terms and flag these terms separately from deprecated and valid terms. You can also customize the name of the admitted term status. This feature works in combination with the following Acrolinx products: Acrolinx Server version 1.3 or later. Acrolinx Batch Checker version 1.2 or later. Acrolinx Desktop Checker all versions. All Acrolinx Plug-ins version 2.0 or later (excluding plug-ins for web-based applications). REMEMBER: The flagging behavior for admitted terms also depends on the property terminology.markadmittedterms (see "Flagging Admitted Terms in the Deprecated Flag Color" on page 57). â To configure a separate flag type and customized name for admitted terms, follow these steps: 1 Open your overlay of the core server properties file. You find the overlay for the core server properties file in the following location: %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties 2 Add the following property: usecustomizableadmittedtermflag=true

59 59 3 (Optional) To prevent the plug-ins from suggesting admitted terms as replacements for terminology flags, add the following property: suggestadmittedterms=false When this property is not present in the core server properties file, the clients display admitted terms in the suggested replacements for terminology flags. 4 Save your changes and restart the core server. 5 (Optional) To customize the name of the admitted term status, updated the status name in the Dashboard. a) Open the Dashboard and select Terminology > Customize > Category Manager. b) Rename the category admitted to the name of your choice. The changes are visible in the checking options of the Acrolinx Client after you refresh the connection to the server. Configuring Scoring for Admitted Terms By default, admitted terms contribute to the checking score when they are marked in the deprecated color or configured to have a separate flag. Depending on the requirements of your organization, you may wish to prevent admitted terms from contributing to the checking score. â To configure scoring for admitted terms, follow these steps: 1 Open your overlay of the relevant language configuration file. If you have not yet created an overlay of this file, create a new version of the file at the following location: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties If this location does not yet exist, create the required sub directories first. 2 Add the following property: terminology.scoreadmittedterms=<true/false> When this property is set to false, admitted terms never contribute to the checking score. When this property is not present in the configuration file, the default behavior is true and admitted terms always contribute to the checking score. 3 (Optional) Configure a score weighting for admitted terms (see "Weighting the Category Scores" on page 24). IMPORTANT: Score weighting for admitted terms is only possible when you configure a separate flag for admitted terms. 4 Save your changes and reload the relevant language server configuration.

60 60 Configuring Checking Behavior Configuring the Link Checker What is the Link Checker? The link checker is a new feature which enables you to check the validity of URLs used in documentation, and is available in versions 1.3 or later of the Acrolinx Server. When you check documents with an Acrolinx plug-in, the Acrolinx Server attempts to visit the URL destination to see if the URL is still valid. URLs which are not valid are listed in the checking report as style issues. How Does Link Checking work? When you run a check in a plug-in, the server detects URLs in the document according to specific rules (see "How the Link Checker Detects and Flags Links" on page 62). The server attempts to retrieve HTTP header information from each new URL, and saves the URL in a link cache which is stored on the core server. Each URL is saved in the link cache with a timestamp which indicates when it was checked and a status (see "Link Checker Statuses" on page 63) which indicates the validity of the URL. Every 5 minutes the core server reviews the cache to see if there are any links that are due for rechecking. The default time interval for checking a link in the link cache is every 12 hours (see "Enabling and Configuring the Link Checker" on page 61). The core server rechecks any links that are older than this limit, and updates the timestamp and status information. When you check documents, the server searches the link cache for URLs that have already been validated during previous checks. If the server finds a match in the link cache, the server retrieves the validation information for the URL. If the status indicates an invalid link, the server passes the status information back to the plug-in or Batch Checker as a style issue. You can view a CSV version of the cache in the server output directory: %ACROLINX_CONFIGURATION_ROOT%\server\www\output\linkchecker\linkrepository.csv You can also open the CSV version of the cache in a web browser with the URL: Figure 8: Link Cache