Being an administrator, you can customize WProofreader default settings such as user interface and application behavior described in this guide which covers the following topics: 1. Server and Cloud Version of WProofreaderIn general, WProofreader provides the same functionality for both Cloud and Server versions. The difference is mainly about the location of requests processing: it can be either on WebSpellChecker Cloud hosted on Amazon Web Services (AWS) in data centers in the USA or on your servers such as physical servers, VMs or instances. With Cloud version, to access the services, you need to use a special activation key in serviceId parameter. The path to WebSpellChecker Cloud will be obtained from the path to the wscbundle.js file. For the Server version, you need to instruct WProofreader where the requests will be processed by specifying the following parameters:
Example for setting up the Server version of WProofreader with the autoSearch option turned on:
For more details, refer to Get Started with WProofreader Server AutoSearch. Example for setting up the Cloud version of WProofreader with the autoSearch option turned on:
For more details, refer to Get Started with WProofreader Cloud AutoSearch. 1.2 AutoSearch OptionsOnce you have enabled autoSearch by adding autoSearch: true, in configuration, you can specify where the spelling and grammar check should be enabled on your webpage. By default, WProofreader with autoSearch function turned on will be enabled only in the area in focus. For the areas which are not focused, WProofreader will not be enabled by default until user places a cursor there and starts typing. For details, refer to the following AutoSearch Creation options:
1.3 AutoStartupThe autoStartup parameter is set to true by default meaning that WProofreader starts in enabled state and starts processing available text for grammar, spelling, and style errors. If for some reason, you do not want WProofreader to start checking text at once and allow your users to choose on when to start, you have an option to start WProofreader in the disabled state. To do so, set the autoStartup value as false, as shown below:
1.4 Deactivating Grammar CheckingGrammar checking is enabled by default in WProofreader. If you want to deactivate grammar checking, specify the enableGrammar parameter and set it to false as shown below:
1.5 Enable Proofreading in InputsBy default, WProofreader is disabled in HTML <input> editable elements. However, you can change this behavior by using the enableAutoSearchIn option:
1.6 Disabling Proofreading for Special CasesIn some cases, you may want to disable WProofreader for editable fields. To do so, you can use the disableAutoSearchIn option by passing an array of classes, ids, data attributes or just particular element types:
2. Customizing WProofreader User InterfaceWith WProofreader API you can customize:
2.1 Suggestions Balloon View and CommandsYou can customize WProofreader options available in suggestions balloon, for example:
2.1.1 Changing the Number of Spelling SuggestionsBy default, WProofreader offers 3 suggestions in its suggestions balloon. An admin can customize this number using an API option and provide both bigger and smaller number of suggestions. For Cloud version, up to 8 suggestions are available. For the Server version, this number can be increased. You can use the suggestionsCount parameter to increase or decrease the number of spelling suggestions shown to your end users.
To display only 2 suggestions:
2.1.2. Changing Action Items Order and AvailabilityUse the actionItems parameter to add or hide the menu items in the suggestions balloon and modify the order of these items. To do so, change the 'addWord', 'ignoreAll', 'settings', 'toggle', 'proofreadDialog' array values accordingly. For example, if you want to prevent your users from adding words to their personal user dictionary, remove the 'addWord' value from the array of parameter values:
To hide Settings dialog for your users, remove the 'settings' from the array of parameter values:
2.1.3 Enabling or Disabling the More Suggestions Sub-menu ItemBy default, the moreSuggestionsCount parameter is set to 0 meaning that additional suggestions if there are any more than specified in the SuggestionsCount parameter are not shown. To display 3 suggestions on the suggestions balloon view and show 5 more suggestions in the More Suggestions section:
2.2 WProofreader BadgeThe badge in the lower-right part of the editable area shows the status of the checking process (namely, the number of errors, the process itself – spinner, all checked) and allows to access more options:
Badge View and OptionsYou can change the following badge options:
Turning off Badge PulsationWhen WProofreader starts, the badge start pulsing three times to get the user’s attention to the discovered issues. If it turns out to be distracting for the users, you can disable pulsation setting the disableBadgePulsation parameter as true as shown in the sample below:
Removing a BadgeIf the enableBadgeButton parameter is set false, part of action items specifically Settings, Disable/Enable and Proofread in dialog from the badge area will be moved to the suggestions ballon:
Removing Actions from BadgeTo remove some actions from the badge, for example, Settings , Disable/enable WProofreader , or Proofread in dialog , use the actionItems parameter. Example below shows how you can allow the users to access proofreading in dialog only from the badge:
2.3 Settings DialogThe Settings dialog contains the following tabs: Options, Languages, Dictionaries, and About.
Depending on your web app usage preferences or requirements, you may want to customize the Settings dialog, for example:
With the settingsSections parameter you can change the Settings dialog tabs visibility and order. Example below places Options tab after Languages and Dictionaries tabs:
2.2.1. Options TabSettings on the Options tab let you define the following spelling exceptions:
You can change the default behavior using the following parameters:
To disable ignoring, set the value of the desired option as false. 2.2.2. Languages TabThe Languages tab of the Settings dialog contains the list of available languages for spelling and grammar checking and enables users to set the default checking language. To set the predefined language for all application users in the Languages tab, use the lang parameter and specify the desired language short code as shown in the Default Language for all Users section. To hide the Languages tab from your users so that they cannot modify the selected language, use the settingsSections parameter as shown below:
2.2.3. Dictionaries TabCustomizing Dictionaries tab User InterfaceThese are some options for altering Dictionaries tab user interface elements and features:
Hiding Preferences Section on the Dictionary TabThe Preferences section of the Dictionaries tab contains action items and buttons for managing user dictionaries specifically: create a new dictionary, connect/disconnect existing dictionary, rename and delete a dictionary. You may need to hide or remove the Preferences section when users have a company-wide predefined dictionary and you do not want your users make any changes to it except adding or removing words. For details, refer to setting up WProofreader Dictionaries tab section. To disable the dictionary preferences UI for your users, specify the disableDictionariesPreferences option as true:
Removing Dictionaries TabYou may want to remove the Dictionaries tab from user interface in the following cases:
Use the sample below:
2.2.4. About Tab
To remove the branding of WProofreader, namely the title on the UI of the product and About tab with copyrights and logo, set the removeBranding parameter value true as shown in the code sample below:
2.4 Actions for Proofreading in a DialogActions available for configuring WProofreader dialog mode are the same as for the suggestions balloon, namely:
You can turn off descriptions for discovered grammar issues both in suggestions balloon and WProofreader dialog. To do so, set the value disableProblemDescription as true.
To hide the Add to dictionary command, specify the actionItems parameter values as shown in the sample below:
To hide or remove the Settings icon so that the users cannot navigate and change WProofreader settings, exclude the settings value from the array of parameter values:
3. Languages and Dictionaries Settings3.1. Default Language OptionsThe default language setting for WProofreader users is American English (en_US). But being the administrator, you can change this default language for all users. Besides the default languages list, you can have more dictionaries to extend the linguistics coverage. Here are available options:
For details, contact WebSpellChecker support team. 3.2 Default Language for all UsersYou can specify the default language for all WProofreader users using the lang option. For example, if you set the lang: 'de_DE', German locale is specified for all users.
To enable the language locale, be sure to use the proper language code. For details, refer to the supported language short codes list.
3.3 User Interface Localization LanguageYou can change WProofreader interface localization to match the locale preferences. The default interface localization language is American English. For example, to set the German language as the localization option in WProofreader, use the localization parameter as in sample below:
3.4 Predefined User DictionaryTo activate one dictionary common for all users, specify the userDictionaryName parameter by providing the dictionary name. After that, all words added by users via the Add word command are added to this particular dictionary.
3.5 Extending the List of DictionariesIf you want to use some dictionaries different from the default ones, refer to the list of additional language dictionaries available on our web site and contact our sales team for purchasing details. 3.6 Custom DictionariesCustom dictionaries allow creating company-wide dictionaries and extending the vocabulary of the standard dictionary with words specific to industry or domain. To configure a global custom dictionary in WProofreader, use the customDictionaryIds parameter and add a string with required dictionaries IDs which should be separated by commas:
In the example above, ID is the unique dictionary ID will be assigned to your custom dictionary. For details on setting global custom dictionaries for Server version, refer to Configuring Server Global Custom Dictionaries section, namely: For details on setting custom dictionaries for Cloud version, refer to Configuring Cloud Custom Dictionaries guide. 4. Miscellaneous Options4.1 Minimal Word LengthBy default, WProofreader enables spell check starting with 3 and more letters per word. You can customize this option using the minWordLength API parameter:
After you have used this option, the words which have two (2) and more letters in them will be spell checked. 4.2 Excluding Elements From CheckingUse the ignoreElements parameter to instruct WProofreader not to check the elements in the text such as, typeface types, links, tables, and others. By default, links or text within the <a> tag are ignored as well as <style> and <script> tags. You can additionally choose to ignore spelling and grammar checking in certain web page markup elements, for example, headings tags and others. In example below, the <table> tag will be skipped during checking:
4.3 Disabling Proofreading in As You Type ModeProofreading during typing in the so called ‘as you type mode’ is enabled by default. You can disable this mode using the proofreadAsYouType parameter thus proofreading becomes possible only in dialog mode. To do so, change the value of proofreadAsYouType parameter to false:
After disabling proofread as you type mode, users can access proofreading by initiating WProofreader dialog mode from the badge by clicking Proofread in dialog icon. |