-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathreadme.txt
204 lines (126 loc) · 6.71 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
=== Pinyin Slugs ===
Contributors: senlin
Tags: pinyin, permalinks, slugs, Mandarin Chinese, traditional and simplified
Requires at least: 4.4
Tested up to: 6.6
Stable tag: 2.3.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Transforms Simplified or Traditional Chinese character titles into Pinyin to create a permalink friendly slug.
== Description ==
Chinese characters don't come out good in permalinks. Without the Pinyin Slugs plugin activated, the example post I made for the screenshot will get a slug like this: *%e6%90%9c%e7%b4%a2%e5%bc%95%e6%93%8e%e4%bc%98%e5%8c%96*. With the plugin the slug automatically becomes *sousuoyinqingyouhua*.
Search engines such as [Baidu](https://www.baidu.com) cannot make much of the first slug, but they can handle pinyin perfectly, especially when it is written as one long string without hyphens or underscores.
It is possible to limit the amount of characters in the slug. The default is 100, which should be plenty for most.
The Pinyin Slugs plugin was forked from the [Pinyin Permalinks](https://wordpress.org/plugins/pinyin-permalink/) plugin by user [xiaole_tao](https://profiles.wordpress.org/xiaole_tao/) as that project seemed abandoned. There have been many improvements since; read the changelog for details.
I have decided to only support this plugin through [Github](https://github.com/senlin/pinyin-slugs/issues). Therefore, if you have any questions, need help and/or want to make a feature request, please open an issue over at Github. You can also browse through open and closed issues to find what you are looking for and perhaps even help others.
**PLEASE DO NOT POST YOUR ISSUES VIA THE WORDPRESS FORUMS**
Thanks for your understanding and cooperation.
== Other Notes ==
= WPML Compatible =
The Pinyin Slugs plugin has received the [WPML Certification of Compatibility](https://wpml.org/plugin/pinyin-slugs/) and is featured on the WPML website with the article [How to Build a WordPress Website in China and Reach an International Audience](https://wpml.org/documentation/how-to-build-a-wordpress-site-in-china/).
== Installation ==
= WordPress =
Search for "Pinyin Slugs" and install with the **Plugins > Add New** back-end page.
… OR …
Follow these steps:
1. Download zip file.
2. Upload the zip file via the Plugins > Add New > Upload page … OR … unpack and upload with your favorite FTP client to the /plugins/ folder.
3. Activate the plugin on the Plugins page.
Done!
== Frequently Asked Questions ==
= Does Pinyin Slugs work with Simplified Chinese characters? =
Yes, the plugin transforms Simplified Chinese slugs into pinyin.
= Does Pinyin Slugs work with Traditional Chinese characters? =
Yes, since September 2020 the plugin also can transform Traditional Chinese slugs into pinyin.
= Does Pinyin Slugs work with the WP block editor? =
Yes, it does, although one caveat is that to be able to see the change of slug, the post/page first needs to be saved. The same applies for edits.
= Known Issues =
Pinyin Slugs will not auto-transform existing slugs, you will have to change them manually.
= I have an issue with this plugin, where can I get support? =
Please open an issue over at [Github](https://github.com/senlin/so-pinyin-slugs/issues), as **I will not use the support forums** here on WordPress.org
== Screenshots ==
1. Settings page
2. New Post with title in Chinese characters and auto-generated pinyin slug; Baidu Search Results page underneath
3. WPML Compatible
== Changelog ==
= 2.3.3 =
* date: July 9, 2024
* add new $autoload parameter (WP 6.6)
* tested up to WP 6.6
* removed logo from Settings page
= 2.3.2 =
* date: November 27, 2023
* last security fix introduced problem where spaces in Title where no longer replaced by hyphens, this version brings back those hyphens ([issue 23](https://github.com/senlin/pinyin-slugs/issues/23) thanks for pointing it out @nhimthaoan)
= 2.3.1 =
* date: November 23, 2023
* security fix CVE-2023-47511 Cross Site Scripting (XSS) vulnerability ([issue 22](https://github.com/senlin/pinyin-slugs/issues/22) thanks for pointing it out @ramiror)
= 2.3.0 =
* date: August 27, 2023
* fix Slug Length function ([issue 19](https://github.com/senlin/pinyin-slugs/issues/19) thanks for reporting @zhouLife)
= 2.2.1 =
* date: October 25, 2022
* edits in readme files and on Settings page
= 2.2.0 =
* date: September 16, 2020
* dictionary update: UniHan database using the kMandarin Reading field as pinyin phonetic keys (https://unicode.org/charts/unihan.html); with many thanks to [Yun-yu Shen @ujamer](https://github.com/senlin/pinyin-slugs/pull/16)
* edits in readme files and on Settings page
= 2.1.4 =
* date: October 29, 2018
* tested up to WP 5.0
* tested up to ClassicPress 1.0.0
= 2.1.3 =
* date: July 8, 2018
* tested up to WP 4.9.7
= 2.1.2 =
* date: March 15, 2017
* add sanitize_title filter once the file has been included as per [suggestion](https://github.com/senlin/so-pinyin-slugs/issues/6#issuecomment-284342159) of Polylang author [@Chouby](https://github.com/Chouby)
* tidying up
= 2.1.1 =
* date: November 29, 2016
* remove version check
* tested up to WP 4.7
= 2.1.0 =
* date: March 10, 2016
* fix to not ignore alphanumerical characters by [vanabel](https://github.com/vanabel), closes [issue #4](https://github.com/senlin/so-pinyin-slugs/issues/4)
= 2.0.4 =
* date: August 7, 2015
* TWEAK: header settings page; only showed half logo after 2.0.3 update
= 2.0.3 =
* date: August 5, 2015
* changed header settings page to h1 (https://make.wordpress.org/plugins/2015/08/03/4-3-change-to-plugin-dashboard-pages/)
* show 4.3 compatibility
= 2.0.2 =
* date: June 19, 2015
* revert to [semantic versioning](http://semver.org/)
= 2.0.1 =
* date: April 9, 2015
* changed logos
* new banner image for WP.org Repo by [Joschko Hammermann](https://unsplash.com/hmmrmnn)
= 2.0.0 =
* date: July 29, 2014
* due to non-compatibility issues with WP 4.0, complete rewrite of the plugin from the ground up
* bump minimum required WP version up to 3.8
= 1.0.1 =
* date: December 28, 2013
* fix reported [bug](https://github.com/senlin/so-pinyin-slugs/issues/1) that causes entire admin to be a maximum width of 48rem
= 1.0.0 =
* date: December 26, 2013
* tested up to WP 3.9-alpha
* settings page overhaul to better match WP 3.8 style
* change version number format
* change links
= 0.1.3 =
* change text domain to prepare for language packs (via Otto - http://otto42.com/el)
= 0.1.2 =
* compatible up to WordPress 3.7
* redo version check, min. requirement WordPress 3.6
* change Github link
* add Dutch language files
* add WPML accreditation
= 0.1.1 =
* separate dictionary.php file
* add Mandarin Chinese language files
* edit readme.txt and readme.md
* fix textdomain issue
= 0.1 =
* First stable release