-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
318 lines (216 loc) · 19.4 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
=== WProofreader spell & grammar check plugin for WordPress ===
Contributors: webspellchecker
Tags: spell check, grammar, spelling, proofreading, corrector
Donate link: https://www.webspellchecker.com/
Requires at least: 5.2
Tested up to: 6.2.1
Stable tag: trunk
License: GPL-2.0+
Requires PHP: 7.0
License URI: http://www.gnu.org/licenses/gpl-2.0.txt
WProofreader plugin for WordPress adds AI based grammar and spell check capabilities to your website content in multiple languages.
== Description ==
WProofreader plugin for WordPress naturally scans and checks your website content not only limited to grammar and spell check but also punctuation and style of your content.
WProofreader plugin for WordPress uses the cloud-based WebSpellChecker spelling and grammar checking services governed by the [Terms of Service](https://webspellchecker.com/legal/terms-of-service/).
Caveat though, WProofreader plugin does not proofread the whole website at a time. **It proofreads only when the content on your website is in editing mode.**
Compatible with the following WordPress versions:
* WordPress 4.x
* WordPress 5.x
* WordPress 6.x
Here is a list of the supported content types:
Content of pages - Content of posts - Tag descriptions - Category descriptions - WooCommerce - WP eCommerce product descriptions - Any Custom Post type - Meta description fields of Yoast SEO plugin
**The plugin’s operation modes:**
- Check as you type spontaneously detects spelling and grammar mistakes and on hover provides suggestions.
- Check in floating dialog proofreads in floating dialog with aggregated suggestions.
**WProofreader plugin for WordPress promotes and serves your website by providing:**
= MULTI-LANGUAGE SUPPORT =
* The Pro version offers to select 17 languages from a [pool of 160](https://webspellchecker.com/additional-dictionaries/).
**Note!** Only a select set of languages scans for grammar checks. View the supported languages for grammar check [here](https://docs.webspellchecker.net/display/WebSpellCheckerCloud/Supported+languages).
* The free version supports only spell checking and is limited to 6 languages.
* American English
* British English
* French
* German
* Italian
* Spanish
Extra features language autodetect and spelling autocorrect speed up your writing. Autodetect checks multilingual texts instantly detecting the language and giving relevant spelling and grammar recommendations.
Autocorrect provides text replacements for commonly misspelled words like “hte”, “google, and “dont”. The feature is available for all supported languages and enabled by default.
= CUSTOMIZABLE DICTIONARY =
The Pro version is shipped with:
* **User-level custom dictionary** – All custom-added words and phrases are stored centrally on cloud and accessible from the browser.
* **Company-level custom dictionary** – Same as the user-level dictionary yet managed centrally – company wide – by the admin to ensure uniformity across the organization.
* Specialized medical for English, French and Spanish and legal dictionaries for English.
Free version dictionary – Company-level custom dictionary is not available for the free version.
The user-level custom dictionary content is saved on the browser storage.
= ELEGANT AND USER-FRIENDLY =
* Straightforward configuration
* There is NO BANNER ADDs
* Color-coded spelling, grammar, and punctuation
* Spelling autocorrect
* Language autodetection
* Easily toggle on/off button
* Add words to custom dictionary and access it everywhere
* Support the latest version of WordPress
= SCALABLE =
* Proofread up to 100 million words per year in the Pro version and supports up to 5 websites.
* The free version is limited to spell checking 10,000 words per day one a single website. Upon reaching the limit, it stops working until the next day.
= MODERN AND UP TO DATE =
* Seamlessly integrates with WordPress latest editor – Gutenberg and backward compatible with the classic editor of WordPress 4.x
* The following browsers are supported:
* Chrome
* Firefox
* Safari
* Microsoft Edge
* Internet Explorer 11
**For good measure, most of our clients use WProofreader plugin for WordPress because:**
* To save time proofreading using anyone of the two modes – check as you type and in floating dialog.
* They are heavy posters, with multiple articles to release.
* Create and maintain posts in different languages.
* Some editor work or proofread contents created by others.
* The nature of their business is highly competitive and cannot afford typos and poor-quality written content.
== Installation ==
= From your WordPress dashboard =
1. Visit 'Plugins > Add New'.
2. Search for 'WProofreader'.
3. Activate WProofreader from your Plugins page.
= From WordPress.org =
1. Download WProofreader plugin.
2. Upload the 'wproofreader' directory to your '/wp-content/plugins/' directory, using your favorite method (ftp, sftp, scp, etc...)
3. Activate WProofreader from your Plugins page.
= Updating =
Automatic updates should work like a charm; as always though, ensure you backup your site just in case.
== Frequently Asked Questions ==
= What is License Key or how to obtain one? =
A **license key** is a special data string that verifies authorized access to the Pro version of WProofreader plugin. The license key is provided by the WebSpellChecker when the Pro version is purchased.
= Does WProofreader plugin check the entire website? =
The plugin does not check the whole website at a time. It is enabled only when the content on your website is in editing mode. Here is the list of content types which can be checked by the plugin: content of pages, content of posts, tag descriptions, category descriptions, WooCommerce and WP eCommerce product descriptions, any Custom Post Type, Meta description fields of Yoast SEO plugin.
= What other languages are available for WProofreader plugin? =
The **free version of WProofreader plugin** is shipped by 6 languages, including:
* American English
* British English
* French
* German
* Italian
* Spanish
The **Pro version of WProofreader plugin** entitles you to select 17 languages from a pool of 160+ available languages.
Note that not all languages support grammar checks. [Here](https://docs.webspellchecker.net/display/WebSpellCheckerCloud/Supported+languages) is the list of available languages. Languages with grammar enabled are marked.
= What is custom dictionary and how can I create it? =
WProofreader plugin has a special functionality called **custom dictionary**. It allows creating personal dictionaries with custom words (complex words, acronyms, proper nouns, etc.) and use it across your website. Words added to a personal dictionary will not be marked as misspellings.
To create a new **user-level custom dictionary**, click the orange badge in the bottom right corner of the text field and select Settings. Then go to Dictionaries; Name your new dictionary and click Create. All new words will be added to the newly created dictionary. If you have several personal dictionaries, say, for different types of terms – the new words will be added to the one, currently in use.
To create a **Company-level custom dictionary** to be used across all the websites under your subscription, please follow the instructions in this [link](https://docs.webspellchecker.net/display/WebSpellCheckerCloud/Configuring+Cloud+Custom+Dictionary).
= Does WProofreader plugin check grammar as well? =
Not all listed languages support grammar checks. [Here](https://docs.webspellchecker.net/display/WebSpellCheckerCloud/Supported+languages) is the updated list of supported languages and the ones marked for grammar-check.
= Does WProofreader plugin work in Elementor? =
At the moment WProofreader plugin doesn't work in Elementor Website Builder. However, we may re-prioritize our backlog based on the demand. Contact us.
= Is Technical support available for WProofreader plugin? =
Support service is provided by WebSpellChecker LLC for Pro version users. For more details, please contact [[email protected]]([email protected]).
= What is the difference between Free and Pro versions? =
**Free version: ($0)**
* **Usage limit**: Up to 10,000 words processed per day for a single website. Once the daily limit is reached, the tool will stop working.
* **Allowed number of websites**: 1 website.
* **Languages available for spell checking**: (6 languages) American English, British English, French, German, Italian and Spanish.
* **Languages available for grammar checking**: Not available.
* **Personal User-level custom dictionary**: No cloud backup. The dictionary is only available in one browser on a single device. The dictionary is not available for review and modification.
* **Company-level custom dictionary**: No available.
**Pro version: ($49)**
* **Usage limit**: Up to 100 million words processed per year. No daily limits apply
* **Allowed number of websites**: Up to 5 websites
* **Languages available for spell checking**: Select up to 17 languages from a pool of 160+ languages.
* **Languages available for grammar checking**: Not all listed languages support grammar checks. [Here](https://docs.webspellchecker.net/display/WebSpellCheckerCloud/Supported+languages) is the updated list of supported languages and the ones marked for grammar-check.
* **Personal user-level custom dictionary**: Stored in the cloud, available from any browser or device. The user can freely access, review and modify the list of words in the dictionary.
* **Company-level custom dictionary**: The subscription admin can create global dictionaries that will be available across all the connected websites.
= How to add specialized medical or legal dictionary to the Pro version? =
With the Pro version, the default list of languages can be extended with specialized English [medical](https://webspellchecker.com/additional-dictionaries/#medical-dictionary) and [legal](https://webspellchecker.com/additional-dictionaries/#legal-dictionary) dictionaries.
Contact our [sales team](https://webspellchecker.com/contact-us/) for more details.
**Medical dictionary**
The medical dictionary includes over 192K terms related to anatomy, diseases, health care, generic and trademark drug names. Available for English, French and Spanish.
**Legal dictionary**
The legal dictionary contains about 5K terms related to jurisprudence, law, criminology, and law enforcement. Available for English.
= What is the price of additional languages and how can I order it? =
If you need to select more than 17 languages, please contact our [sales team](https://webspellchecker.com/contact-us/) for more details.
= What is a Company-level custom dictionary and how I can use it? =
The Company-level custom dictionary functionality is available in the Pro version only and is aimed at extending a list of words in the default dictionaries with your custom words and terms. It helps to improve the quality of spelling check services. Using an account on the WebSpellChecker website, you may create a custom wordlist which includes specific terms, abbreviations, etc. These words won’t be considered as misspellings.
= What are the Terms of Service? =
Please see the complete [Terms of Service](https://webspellchecker.com/legal/terms-of-service/) for the plugin here.
= Is my text secure? What is your Privacy Policy? =
We have an extensive Privacy Policy in place to protect your texts. Please see the details [here](https://webspellchecker.com/legal/privacy-policy/).
= What browsers are supported? =
The plugin supports latest versions of Chrome, Firefox, Safari, and MS Edge, and Internet Explorer 11.
= Can I suggest a feature? =
Sure, please let us know how we can make the plugin more useful for you. Create a new topic under the support section of this plugin.
= How can I uninstall the plugin? =
To uninstall the plugin, you need to be a website administrator. Please login to the website admin area and go to Plugins. Locate WProofreader on the list of the plugins and click Deactivate below the plugin title. The last step is to simply click Delete that appears after the deactivation.
= My website exceeded word usage quota. What does it mean? =
Both the Free and Pro versions of the plugin have usage limitations. One of them is the aggregated number of words checked during a certain period.
The Free version is limited to 10,000 words for a single website aggregated for all users per day. Once the aggregated usage for a website exceeds this number, the plugin stops checking text until the next day (00:00 UTC-0) and the next error message will be shown on the plugin's settings page: “Word usage quota for the free plan exceeded. Contact support for more details.“
Below is the example explaining how the usage is calculated. The plugin doesn't run in a background or doesn't generate false data usage. If the plugin is enabled, it works only when a page or blog post is in the **editing** mode.
Let's assume you have a page which contains 1000 words. You open it for editing and this is when the plugin starts. All the text from this page will be sent for checking. Thus, 1000 words are checked and recorded as usage. You still continue editing, let's say you decided to make some changes in the 2nd paragraph which contains 100 words. Since there were some changes, the plugin needs to recheck this part. As a result extra 100 words will be sent for checking. We can't send individual words as checking relies on sentences. So, now 1100 words are recorded in usage. Later you decide that you want to save the page as a draft and preview changes. After previewing changes, you decide to go back to editing and open the page for editing again (again this is when the plugin starts). The plugin doesn't know that this is the same page and does rechecking again. As a result plus 1000 words are added to the general statistics. The total is now 2100 words. Also, let's imagine that while editing mode is ON you have to reload a page a few times, the whole page will be rechecked after each reload of the page or browser.
== Screenshots ==
1. WProofreader Checks Spelling and Grammar on Posts.
2. WProofreader Spelling Correction Box.
3. WProofreader Grammar Correction Box.
4. WProofreader Badge Button with Opened Menu.
5. WProofreader Badge Button with Active Proofread in Dialog Mode.
6. Proofread in Dialog Mode of WProofreader with Active Spelling Error.
7. Proofread in Dialog Mode of WProofreader with Active Grammar Error.
8. WProofreader Settings with Options for Check Spelling.
9. WProofreader Settings with Languages List.
10. WProofreader Plugin Settings Pages.
== Changelog ==
= 2.6.8 – 2023-05-17 =
* Enabled the global badge view instead of the standard one. It will add just one badge at the very bottom of the page instead of adding a small badge on each editable element within Gutenber editor. This badge can be disabled from the plugin settings page.
* Fixed issue when WProofreader doesn't start automatically in classic editor inside default Gutenberg editor.
= 2.6.7 – 2022-09-14 =
* Fixed warning in class-wsc-settings.php on line 180.
= 2.6.6 – 2022-07-29 =
* Fixed issue with the dialog mode.
* Updated text.
= 2.6.5 – 2021-09-28 =
* Enabled WProofreader badge by default. If needed, it can be disabled from the plugin's settings tab.
* Enabled the General section on the settings dialog for managing spelling autocorrection. By default, the spelling autocorrection is enabled. If needed, the user can disable it. To do so, please navigate to the badge (orange bubble located at the right bottom corner of the editable block) > click on the gear icon > toggle “Correct spelling automatically”.
= 2.6.4 - 2020-11-26 =
* Fixed a minor issue with the plugin permissions and an error shown on the settings page.
= 2.6.3 - 2020-11-20 =
* WProofreader is disabled in the table element in the Gutenberg editor to prevent breaking a table and overall glitching.
= 2.6.2 - 2020-09-22 =
* Fixed the integration issue that appeared in v2.6 with the Classic editor when Gutenberg is disabled.
= 2.6.1 - 2020-09-21 =
* Enabled error logging mechanism. Now errors will be displayed on the plugin settings page, which will help to troubleshoot issues faster.
= 2.6 - 2020-09-14 =
* Improved the integration with the Gutenberg editor. Now WProofreader will be automatically started in all editable elements of the editor without the necessity to click on each element to enable the spelling/grammar checking.
* The orange badge is disabled by default for all types of elements including the Gutenberg editor. There is a setting allowing to reactivate the badge.
* The dialog mode option for proofreading is disabled by default for the Gutenberg editor.
= 2.5 - 2019-07-29 =
* Enabled spelling and grammar check in the Meta description fields of Yoast SEO plugin.
* Enabled support of Custom Post Types using the “wproofreader_add_cpt“ filter.
= 2.4 - 2019-04-15 =
* Added a new option “Disable WProofreader Badge” to the plugin settings which allows disabling an orange badge button. If disabled, the orange badge won’t appear in each editable box on the page. Users will see only underlined spelling and grammar errors that were detected by WProofreader.
* Fixed the issue with “Uncaught TypeError” in the browser console which appeared after the update of the event system in the WProofreader core.
= 2.3 - 2019-02-25 =
* Fixed the issue: The Gutenberg editor doesn’t react on the text changes (e.g. replace word) that were made by WProofreader.
* Blocked saving of WProofreader span elements to database.
* Fixed the issue: After replacing a word in IE11 or MS Edge, the word remains underlined in the Gutenberg editor.
* Fixed the issue: After replacing a word in IE11 or MS Edge, the input event doesn’t work properly in the Gutenberg editor.
= 2.2 - 2019-02-12 =
* Resolved the issue with not working plugin under PHP version 7.1. and higher. Consequently eliminated PHP warnings “Invalid argument supplied for foreach()“.
= 2.1 - 2019-01-29 =
* Fixed the issue with not working grammar checking option in the Pro version.
= 2.0 - 2018-12-21 =
The new version of the WProofreader (WebSpellChecker Proofreader) plugin introduces the following updates:
* Upgraded to be fully compatible with latest versions of WordPress: WordPress 4.x, WordPress 5.x and Gutenberg editor.
* Enabled two comfortable modes for proofreading: instant, underlining mistakes while you type, and dialog, proofreading all the text at once in a separate pop-up window.
* Improved engine to check not only spelling but grammar as well. Checking spelling for 6 languages in a Free version, checking both spelling and grammar for 14 in Pro + spell checking in Finnish and Norwegian Bokmal.
* Introduced new clean and comfy UI: intuitive suggestion boxes, spinner indicating the progress of proofreading, Maximize/Restore icon in a dialog mode, save changes notifications.
* Checks spelling and grammar on Pages, Posts, Tags, Categories, WooCommerce Product Descriptions, and WP eCommerce Product Descriptions including product tags and categories.
* Removed banner ad in the Free version.
* Extended the list of supported browsers: Chrome (the latest), Firefox (the latest), Safari (the latest), Internet Explorer 11, MS Edge (the latest).
= 1.1 =
New version of the WebSpellChecker plugin introduces the following updates:
* Support of the Yoast SEO and ACF text fields
* Spell Checking in the Titles field
* Fixes for minor issues
= 1.0 =
Initial Release of the WebSpellChecker plugin. The multi-language spell checking functionality is available for Visual Editor and excerpt all fields.
== Upgrade Notice ==
= 2.0 =
2.0 is a major update. Make a full site backup.