Being an administrator, you can customize WProofreader default settings such as user interface and application behavior, for example: There are several options letting you initialize WProofreader functionality in your web app, namely using: For details, refer to Get Started with WProofreader Server (autoSearch) guide and Get Started with WProofreader Cloud autoSearch. After you have initialized WProofreader, you can customize the above-mentioned settings using WProofreader API. You can also configure some parameters using WProofreader API for grammar, spelling check, and WProofreader dialog user interface. The autoSearch feature enables detecting new editable fields on the page and proofreading the text they contain automatically on hover selection. If you choose this option, WProofreader is enabled in the selected WYSIWYG editor or HTML editable control, and no additional actions are required. Initialization using inline attributes is suitable if you want to have a single script with basic options definitions. Please note that with this type of initialization array or number API parameters are not supported. Thus, you cannot modify such parameters as actionItems, suggestionsCount, and moreSuggestionsCount described further in this section. autoSearch is useful when your web page which has multiple controls, you add one script which is enabled in the areas in focus automatically compared with creating an init() for each control. From the performance point of view, autoSearch also has a better performance as the grammar and spelling and style are checked only in active area compared with checking in all controls like in init(). Another advantage of autoSearch for dynamic page where some fields can be hidden or added at a certain point, autoSearch is enabled automatically and releases the memory automatically as well helping to avoid possible memory leaks. The init() method is a reasonable choice when you clearly know in which control you want to initialize in WProofreader. More than that you are aware of your page controls, and additional controls do not appear dynamically. Consider the following situation when your web application page has several text areas where you want to initialize WProofreader. As soon as the user loads the page, WProofreader is enabled automatically, and it’s not required to select the area to enable grammar and spelling check in it compared with autoSearch method. With dynamic web page load using init() method, administrator needs to be monitor when it’s necessary to start WProofreader and. From the performance point of view, grammar and spelling and style are checked in all controls like in init() which implies performance increase. In 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 server or using other Cloud services providers. With Cloud version, to validate the access to our server, you need to use a special activation key in service ID parameter. The path to WProofreader Cloud will be obtained from the path to to wscbundle.js file. For the Server version, you need to instruct WProofreader to be aware where the requests will be processed by specifying the following parameters: Example for setting up the Server version of WProofreader: For more details, refer to Get Started with WProofreader Server AutoSearch. Example for setting up the Cloud version of WProofreader: For more details, refer to Get Started with WProofreader Cloud AutoSearch. Example of specifying a path to wscbundle.js: The serviceId parameter value in code sample above is an example. Once 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 focus, WProofreader will not be not enabled by default until user places a cursor there and starts typing. For details, refer to the following AutoSearchCreation options: WProofreader will be enabled on all types of editable controls on the page if they are in focus. The only exception is <input> control which is disabled by default as not supported by default. The CONFIG can be added in a script or loaded from the file as mentioned in Get Started with WProofreader Cloud Auto-search and Get Started with WProofreader Server Auto-search guides as well as added into inline data attributes. The autoStartup parameter is set to true by default for autoSearch initialization and init() method 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: When WProofreader starts in disabled state, and the badge is grayed out. To activate it, users need to go to badge and click the turn on icon. Grammar 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: After you have deactivated grammar checking, it becomes disabled for all languages. Only spell check will be performed then. With WProofreader API you can customize: Here you can find the full list of API options and methods available for WProofreader. You can customize WProofreader options available in suggestions balloon, for example: The latter is possible only in case of disabled orange badge. All the action items from the badge are moved to the suggestions balloon then. For details, see Changing the Badge View and Options section. Use 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: Removing the addWord from the array of parameter values removes the Add word command for both suggestion balloon and for proofreading in a dialog mode. To hide Settings dialog for your users, remove the 'settings' from the array of parameter values: By default, WProofreader offers 3 suggestions in its suggestions balloon. As 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. Displaying a significant number of suggestions may decrease the speed of the service. To display only 2 suggestions: By 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: With WProofreader API you can customize the user interface of the Settings dialog, namely, change the order of the tabs in user interface or hide some elements or disabling or enabling some commands for users so that they have the admin-defined settings and presets only. Depending on your web app usage preferences or requirements, you can customize the Settings dialog tabs availability and modify its user interface elements. With the settingsSections parameter you can change the Settings dialog tabs visibility and order, i.e hide one of the sections, change the order of the mostly used tabs first or remove some sections from the user interface if, for example, you don’t want your users to have access to them and have access to admin-predefined settings only. Example below places Options tab after Languages and Dictionaries tabs: You can remove the About tab of WProofreader dialog only if you have purchased a Custom Server or Cloud version of WProofreader package. Settings on the Options tab let you define the following spelling exceptions: Use the parameters values in sample below to enable or select these elements of the Options tab: To deselect some of the elements, set the value of the desired element as false. You can set predefined language for all application users in the Languages tab and hide it from your users so that they cannot modify the selected language using the settingsSections parameter as shown below: These are some options for altering Dictionaries tab user interface elements and features: To disable the dictionary preferences UI for your users, specify the disableDictionariesPreferences option as true: You can disable the Dictionaries area user interface for end-users so that they can use a predefined company-wide user dictionary only using the sample script below: For details refer to Configuring Server Personal Dictionaries and Configuring Cloud Personal User Dictionaries, Personal User Dictionary Interface in WProofreader sections and FAQ section. 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: You can remove the About tab of WProofreader dialog and branding information if you have purchased a Custom or a Server version of WProofreader package. Actions 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 disable switching from Settings to WProofreader dialog and vice versa, exclude the settings value from the array of parameter values: You can change the following orange badge options: If 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: When 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: The default language setting for WProofreader users is American English. 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. You 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. Users can modify the default language locale using the Languages tab of the Settings dialog but the locale they have selected will be used until they reload the browser. After reloading the browser a language specified by the administrator is used again. You can change WProofreader interface localization to match the locale preferences. For example, to set German language as the localization option in WProofreader, use the localization parameter: To activate one dictionary common for all application 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. Users can add words to a dictionary for spelling suggestions only. Grammar suggestions cannot be added to the dictionary. If 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. Custom dictionaries allow to create company-wide dictionaries and extend 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. By 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. Use the ignoreElements parameter to instruct WProofreader not to check the elements text such as, typeface types, links, tables and others. By default, links or text within the <a> tag are ignored. You can additionally choose to ignore spelling and grammar checking in certain web page markup elements, for example, headings tags and others. Proofreading during typing is enabled by default for users of the web applications where WProofreader is integrated. You can disable this mode using the proofreadAsYouType parameter so that proofreading becomes possible only in dialog mode. To do so, change the value of proofreadAsYouType parameter to false: After disabling proofreading in as you type mode, application users can access proofreading by initiating WProofreader dialog mode from the orange badge. To enable WProofreader on touch devices such as smartphones or tablets, specify the enableOnTouchDevices value as true: WProofreader Initialization Options
autoSearch description and advantages
init() method description and advantages
Simultaneous usage of CONFIG and init() methods
When you initialize WProofreader using this method, in init () method we declare the container where WProofreader should be started. The options are to be obtained from the settings. Server and Cloud Version of WProofreader
<script>
window.WEBSPELLCHECKER_CONFIG = {
autoSearch: true,
enableGrammar: true,
serviceProtocol: 'https',
serviceHost: 'your_host_name',
servicePort: '2880',
servicePath: '/'
};
</script>
<script>
window.WEBSPELLCHECKER_CONFIG = {
autoSearch:true,
serviceId: '1:j47ai-r4SLN1-dG5xP1-UuonU-WqXUZ3-0bzqZ1-QI8OP1-bQZcb1-KQuPE3-nWbcY3-aA4Zk4-wT9'
};
</script>
<script type="text/javascript" src="[path_to_config]/wscbundle_config.js">
</script>
AutoSearch Options
<script>
window.WEBSPELLCHECKER_CONFIG = {
autoSearch: true,
disableAutoSearchIn: ['.class', '#id', '[data-attribute]', 'textarea'],
enableAutoSearchIn: ['.class', '#id', '[data-attribute]', 'textarea'],
...
}
</script>
AutoStartup
autoStartup: false,
1.4 Deactivating Grammar Checking
enableGrammar: false,
Customizing WProofreader User Interface
Suggestions Balloon
2.1.1. Changing Action Items Order and Availability
actionItems: ['ignoreAll', 'settings', 'toggle', 'proofreadDialog'],
actionItems: ['addWord', 'ignoreAll', 'toggle', 'proofreadDialog'],
2.1.2 Changing the Number of Spelling Suggestions
suggestionsCount:2,
2.1.3 Enabling or Disabling the More Suggestions Sub-menu Item
suggestionsCount:3,
moreSuggestionsCount:5,
2.2 Settings Dialog Tabs
settingsSections: ['languages', 'dictionaries', 'options'],
Tab name Available actions Options Predefine some or all available options for application users. Languages Hide the tab from your users so that they use only predefined options and set predefined language for all of them. Dictionaries Hide the tab from your users so that they use only predefined options and set predefined user dictionary for all of them. About Hide the branding information if you have a fully-fledged version of WebSpellChecker. 2.2.1. Options Tab
ignoreAllCapsWords: true,
ignoreDomainNames: true,
ignoreWordsWithMixedCases: true,
ignoreWordsWithNumbers: true,
2.2.2. Languages Tab
settingsSections: ['options', 'dictionaries', 'about'],
2.2.3. Dictionaries Tab
Customizing Dictionaries tab User Interface
Hiding or Removing Preferences Section on the Dictionary Tab
disableDictionariesPreferences: true,
Removing Dictionaries Tab
settingsSections: ['languages', 'options'],
2.2.4. About Tab
removeBranding:true,
2.4 Proofreading in a Dialog
disableProblemDescription:true,
actionItems: ['ignoreAll', 'settings', 'toggle', 'proofreadDialog'],
actionItems: ['ignoreAll', 'toggle', 'proofreadDialog'],
2.5 Badge View and Options
enableBadgeButton:false,
disableBadgePulsation:true,
3. Languages and Dictionaries Settings
3.1. Default Language Options
3.2 Default Language for all Users
lang: 'de_DE',
3.3 User Interface Localization Language
localization: 'de',
3.4 Predefined Dictionary for All Users
userDictionaryName='user_dictionary_name',
3.5 Extending the List of Dictionaries
3.6 Custom Dictionaries
customDictionaryIds: 100694, 100695,
4. Miscellaneous Options
4.1 Minimal Word Length
minWordLength: 2,
4.2 Excluding Some Elements of Web Page Markup From Spelling and Grammar Checking
4.3 Disabling Proofreading in As You Type Mode
proofreadAsYouType: false,
4.4 Enabling WProofreader on Touch Devices
enableOnTouchDevices: true,