|Acrolinx Server||4.3, 4.4, 4.5, 4.6, 4.7, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 2018.10|
writing guides .
When checking documents in an Acrolinx Plug-in, you can use the shortcut menu to open a help page that provides guidance about a specific issue. This help information is contained in XML files that are stored in your server installation directory. There are different types of help files that you can customize in various ways. These help files fall into two main categories: help files that apply to a specific guideline and help files that apply to an issue type in general.
Administering Guideline-Specific Help
Guideline-specific help files offer information that is specific to a style or grammar guideline. For example, the help information for the guideline "a/an distinction" gives you guidelines on how to use those words correctly and provides usage examples. Most guideline-specific help files provide both good and bad examples for a specific guideline.
Help File Administration
The location of guideline-specific help files is configured by the Acrolinx linguistic support team within the individual guideline files.
All guideline-specific help files are stored in the following directory:
One exception is the sentence to long style issue. The behavior of the sentence to long guideline is configured in the language configuration properties, including the location of the help file. You administer this help file in the same way as you would a general help file .
You can change the text of a guideline-specific help file by editing the relevant XML file in the "help" directory. If you want to store the help files in a location that is easier for you to access, you can also configure the Acrolinx to load the help files from a custom location.
General help files offer basic information for all issues within an issue type, such as reuse or spelling. It is usually impossible to provide good and bad examples for these issues since they are always context-specific. Unlike guideline-help files, generic help files apply for all languages so a translation is provided for each language in your guidance package (formerly linguistic resources).
Help File Administration
General help files are stored in the following directory, alongside the guideline-specific help files.
There is also a configuration file that stores the locations for the help file in each language. Each general help file has a corresponding configuration file that is stored in the following location:
For example, the help file for spelling issues has a configuration file called "spelling_flag.xml". This file contains paths to each version of the spelling help file for each of your installed languages. These paths are all relative to the following directory:
You can also create your own general help files and store them in an accessible location on your network. You can also adapt the language configuration properties to store your general help files at a different location to the default installation directory.
Term Help is an Exception
Terminology help is not administered in the same way as other issue types. The help template file for terminology is general for all terms but the information within the help file adapts dynamically to the term that is flagged. The term help template contains variables that load information from the relevant term entry. For example, you get the usage guide that is specific to the term which Acrolinx flagged. You can fully customize the location and the contents of the term help template .
Customizing the Location of Help Files
By default, Acrolinx loads the help files from a location in the server installation directory. However, you can configure the server to load the help files from another location. You might configure a different location if you regularly customize your help files and want to use a location that is easier for you to access.
To customize the location of a help file, follow these steps:
- Open your overlay of the relevant language configuration file.
Create a copy of the configuration file that loads the localizations for your general help.
You can find this file in the following directory:
For example, to customize the location of your spelling help, create a copy of the file "spelling_flag.xml" and call it something like "spelling_flag_custom.xml".
Edit the file that you created in the previous step and update the paths to point to your customized help files.
By default, the paths are relative to the directory <INSTALL_DIR>\server\www\ . For example, the default path for the English version of the spelling help is /htmldata/en/rules/help/spelling_flag.xml .
To customize the location of the English spelling help, you could replace the path with another path that is relative to the directory <INSTALL_DIR>\server\www\ .
Add one or more the following properties:
These properties should point to the location of the customized configuration file that you created in step 2. The paths are relative to the location of the language configuration file.
Property Description spellCheckerHelp=<FILE_PATH> Customize the location of the generic spelling help.
For example: ../common/spelling_flag_custom.xml
lengthChecker.sentenceTooLongHelp=<FILE_PATH> Customize the location of the help information for the sentence too long guideline.
For example: ../common/sentence_too_long_custom.xml
reuseSentenceHelp=<FILE_PATH> Customize the location of the help file that displays when the link checker finds a broken link.
For example: ../common/reuse_sentence_custom.xml
linkChecker.pageNotFoundHelp=<FILE_PATH> Customize the location of the help file that displays when the link checker finds a redirected link.
For example: ../common/page_not_found_custom.xml
linkChecker.pageRedirectedHelp=<FILE_PATH> Customize the location of the generic help for new terms.
For example: ../common/page_redirected_custom.xml
newTermHelp=<FILE_PATH> Customize the location of the generic help for new terms.
For example: ../common/new_term_flag_custom.xml
- Save your changes and reload the language configuration on the relevant language servers.