-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
93 lines (60 loc) · 3.29 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
# RedPen WordPress plugin
Contributors: redpen, takahi-i
Donate link: https://donate.doctorswithoutborders.org/
Tags: validation, proofreading, spelling, english, japanese
Requires at least: 4.0
Tested up to: 4.4.1
License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html
Stable tag: trunk
This plugin integrates RedPen text validation into the WordPress editor.
## Description
[RedPen](http://redpen.cc) is a proofreading tool to help writers or programmers who write technical documents or manuals that need to adhere to a writing standard.
This plugin integrates text validation provided by [RedPen Server](http://redpen.cc/docs/latest/index.html#server) into the WordPress editor.
### Features
* Validates text with RedPen as you type
* Supports both Visual and Text WordPress editors
* Validation errors are marked in Visual editor in-place
* Validation error messages are also listed below and highlighted in the editor on click
* Autodetection of supported languages and variants (currently, English or Japanese)
* RedPen [validators](http://redpen.cc/docs/latest/index.html#validator) and [symbols](http://redpen.cc/docs/latest/index.html#setting-symbols)
can be configured directly in WordPress panel below the editor
* Configuration is stored for next visit with the same browser
## Screenshots
1. Here's a screenshot of it in action
2. RedPen configuration can be easily tuned.
## Installation
By default, the plugin uses public RedPen installation at https://redpen.herokuapp.com/ for validation.
See below if you want to use your own installation of [RedPen Server](http://redpen.cc/docs/latest/index.html#server).
* The plugin is available in [WordPress Plugin Directory](https://wordpress.org/plugins/redpen/), so you can install it directly form there.
* Or you can [download redpen.zip](https://downloads.wordpress.org/plugin/redpen.zip) and upload it on the WordPress Plugins page.
Alternatively, extract the zip file to WordPress subdirectory `/wp-content/plugins/`.
* Activate the plugin in WordPress Admin console -> Plugins -> Installed plugins.
### Using an own instance of RedPen Server
If you are uncomfortable sending your text for validation to an external server, you can use your own instance.
To use the plugin, you need to have **RedPen Server** v1.4.5 or newer.
Please refer to [RedPen Server documentation](http://redpen.cc/docs/latest/index.html#server) for more details on how to start it.
By default, local RedPen Server will respond at `http://localhost:8080/`.
Make sure that it is accessible from your client machine (browser), possibly opening its port (8080) on the firewall.
Then, go to WordPress Settings -> Writing and define a new RenPen Server URL.
## Frequently Asked Questions ##
None yet
## Changelog
### 1.1.3
* Fixed js error on first usage of RedPen Plugin
### 1.1.2
* Add support for custom post types
### 1.1.1
* Add support for Multisite installation
### 1.1
* More secure proxy-less communication with RedPen Server (1.4.5 or newer)
* RedPen Server's URL can be configured in WordPress Settings
### 1.0
* Added in-place highlighting and RedPen configuration
* Use public RedPen Server installation by default for ease of installation
### 0.1
* Initial version
## Upgrade Notice
None