-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
265 lines (184 loc) · 12 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
=== Admin Expert Mode ===
Contributors: coffee2code
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6ARCFJ9TX3522
Tags: admin, expert, help, documentation, coffee2code
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Requires at least: 2.8
Tested up to: 5.8
Stable tag: 2.9
Allows users to hide inline documentation and help text that are geared for beginning users in the WordPress admin.
== Description ==
WordPress has long provided inline documentation throughout the administrative interface that provide explanations for various features and input fields. This includes an explanations of excerpts, trackbacks, custom fields, page parents, etc. These are great for newcomers to WordPress, but for those with sufficient familiarity these bits of text are no longer necessary and merely provide visual noise. This plugin gets rid of those descriptive texts.
The plugin's behavior is made available as a per-user profile option. Each user who wishes to enable expert mode for themselves must do so individually by going into their profile, checking the field 'Expert mode', and then pressing the 'Update Profile' button.
Specifically, this plugin removes:
* Dashboard
* Description of "Welcome to WordPress!" panel
* Categories
* Description of "Category Name"
* Description of "Category Slug"
* Description of "Category Parent"
* Description of "Description"
* Edit Post
* Description of "Custom Fields"
* Description of "Excerpts"
* Description of "Trackbacks"
* Edit Page
* Description of comment status
* Description of "Custom Fields"
* Verbose descriptions of "Attributes" (parent, template, and order)
* Edit Link
* Description of "Name"
* Description of "Web Address"
* Description of "Description"
* Description of "Target"
* Description of "Link Relationships (XFN)"
* Tags
* Description of "Tag name"
* Description of "Tag slug"
* Widgets
* Text indicating that widgets are added from the listing of widgets on the left.
* Install Themes
* Help text for search field
* Help text for "Feature Filter"
* Themes - Custom Header
* Help text simply stating you can upload files from you computer
* Manage Plugins
* Description of what plugins are and that they are activated/deactivated on that page
* Text indicating that broken plugins can be renamed to remove them from being active
* Description of the "Recently Active Plugins" section
* Add New Plugins
* Help text for search field
* Help text for "Popular Tags"
* Users - Your Profile
* Help text for "Biographical Info"
* Help text for "Sessions"
* Tools
* Description paragraphs for "Press This"
* Tools - Import
* Description paragraph for "Import"
* Tools - Export
* Description paragraphs for "Export"
* Settings - General
* Extra help text after input fields for "Tagline", "Site Address (URL)", "Email Address", "Timezone"
* Settings - Writing
* Label for "Update Services"
* Settings - Reading
* Extra description for "Search engine visibility"
* Settings - Discussion
* Description of what avatars are
* Description of purpose of default avatar
* Settings - Media
* Text that explains sizes represent maximum dimensions in pixels of images uploaded to Media Library
* Settings - Permalinks
* Help text about "Common Settings"
* Help text about "Optional"
* Settings - Privacy
* Paragraphs of text describing the Privacy Policy page
NOTE: This plugin does NOT remove input field labels or section headers, nor anything containing actual data. In a few cases, descriptive text is left intact when it is of enough importance to warrant retention, or the markup structure does not facilitate easy removal.
Links: [Plugin Homepage](https://coffee2code.com/wp-plugins/admin-expert-mode/) | [Plugin Directory Page](https://wordpress.org/plugins/admin-expert-mode/) | [GitHub](https://github.com/coffee2code/admin-expert-mode/) | [Author Homepage](https://coffee2code.com)
== Installation ==
1. Install via the built-in WordPress plugin installer. Or install the plugin code inside the plugins directory for your site (typically `/wp-content/plugins/`).
2. Activate the plugin through the 'Plugins' admin menu in WordPress
3. Each user who wishes to enable expert mode for themselves must do so individually by going into their profile, checking the checkbox 'Expert mode', and then pressing the 'Update Profile' button.
== Screenshots ==
1. A screenshot of some of the panels of the 'Edit Post' admin page *after* this plugin is activated.
2. A screenshot of the same panels of the 'Edit Post' admin page as they appear in a standard WP 3.3 installation. See the difference?
3. A screenshot of the plugin's profile checkbox on the user Profile page.
4. A screenshot of the form on the 'Categories' admin page *after* this plugin is activated.
5. A screenshot of the form on the 'Categories' admin page as they appear in a standard WP 3.3 installation. See the difference?
== Frequently Asked Questions ==
= Can I view an admin page with admin expert mode turned off without turning the feature off for my account or disabling the plugin entirely? =
Yes. Use the 'disable-admin-expert-mode' query parameter with a value of '1' to disable admin expert mode for the loaded page. This would yield a URL, for example, of `https://example.com/wp-admin/options-general.php?disable-admin-expert-mode=1`. If the URL already has query parameters specified (you'll see a "?" in the URL), then you have to add the new query parameter as an additional one joined with "&", e.g. `https://example.com/wp-admin/post-new.php?post_type=page&disable-admin-expert-mode=1`.
= Does this plugin include unit tests? =
Yes.
== Developer Documentation ==
Developer documentation can be found in [DEVELOPER-DOCS.md](https://github.com/coffee2code/admin-expert-mode/blob/master/DEVELOPER-DOCS.md). That documentation covers the hooks provided by the plugin.
As an overview, these are the hooks provided by the plugin:
* `c2c_admin_expert_mode` : Filter to dynamically determine whether the admin expert mode should be active.
* `c2c_admin_expert_mode_default` : Filter to customize whether admin expert mode should be active for users by default or not.
== Changelog ==
= 2.9 (2021-11-16) =
Highlights:
This minor release adds DEVELOPER-DOCS.md, notes compatibility through WP 5.8+, reorganizes unit tests, and minor tweaks.
Details:
* New: Add DEVELOPER-DOCS.md and move hooks documentation into it
* Change: Add newlines after output block tags and remove newline after label tag
* Change: Add translator comments to explain placeholders
* Change: Use stricter equality check in a conditional statement
* Change: Tweak inline function documentation (typo, verb tenses, bullet list syntax)
* Change: Tweak installation instruction
* Change: Note compatibility through WP 5.8+
* Change: Change a tag in readme.txt header
* Unit tests:
* Change: Use stricter regex in a couple tests
* Change: Restructure unit test file structure
* Change: Move `tests/test-*` into `tests/phpunit/tests/`
* Change: Move `tests/bootstrap.php` to `tests/phpunit/`
* Change: Move `bin/` into `phpunit/`
* Change: In bootstrap, store path to plugin file constant so its value can be used within that file and in test file
* Change: In bootstrap, add backcompat for PHPUnit pre-v6.0
* Change: Remove 'test-' prefix from unit test files
* Change: Rename `phpunit.xml` to `phpunit.xml.dist` per best practices
* New: Add a few more possible TODO items
= 2.8 (2021-03-24) =
Highlights:
This release is a recommended minor update that hides text in the welcome panel on the dashboard page, hides text on the "Settings - Writing" and "Settings - Reading" pages, and notes compatibility through WP 5.7+.
Details:
* New: Hide the description of the dashboard's welcome panel
* New: Hide the label for the "Update Services" on the "Settings - Writing" page
* New: Hide the extra description for the "Search engine visibility" on the "Settings - Reading" page
* Fix: Fix typo in plugin description
* Change: Note compatibility through WP 5.7+
* Change: Update copyright date (2021)
= 2.7 (2020-06-14) =
Highlights:
This release is a recommended minor update that updates hiding of text on "Privacy Settings" page, hides text on "Media Settings" page, hides text relating to avatars on "Discussion Setting" page, adds a TODO.md file, updates a few URLs to be HTTPS, expands unit testing, and notes compatibility through WP 5.4+.
Details:
* New: Hide the descriptions of what avatars and default avatars are on the "Discussion Settings" page
* New: Hide the intro paragraph for the "Media Settings" page
* New: Add TODO.md and move existing TODO list from top of main plugin file into it
* Fix: Re-hide descriptive paragraphs for "Privacy Settings" page
* Change: Note compatibility through WP 5.4+
* Change: Update links to coffee2code.com to be HTTPS
* Unit tests:
* Change: Enhance `test_default_hooks()` to support testing for direct function callbacks rather than just method callbacks
* Change: Remove unnecessary unregistering of hooks
* Change: Use HTTPS for link to WP SVN repository in bin script for configuring unit tests (and delete commented-out code)
== Upgrade Notice ==
= 2.9 =
Minor release: added DEVELOPER-DOCS.md, noted compatibility through WP 5.8+, reorganized unit tests, and minor tweaks.
= 2.8 =
Recommended minor update: hid text on "Welcome to WordPress!" panel on dashboard, hid text on "Setttings - Writing" and "Settings - Reading" pages, noted compatibility through WP 5.7+, and updated copyright date (2021).
= 2.7 =
Recommended minor update: updated hiding of text on "Privacy Settings" page, hid text on "Media Settings" page, hid text relating to avatars on "Discussion Setting" page, added TODO.md file, updated a few URLs to be HTTPS, expanded unit testing, and noted compatibility through WP 5.4+.
= 2.6 =
Recommended minor update: fixed bug with considering user setting value, added unit testing, noted compatibility through WP 5.3+, created CHANGELOG.md to store historical changelog outside of readme.txt, and updated copyright date (2020).
= 2.5 =
Minor update: permitted admins to see and edit the value of the setting for other users, tweaked plugin initialization, noted compatibility through WP 5.1+, updated copyright date (2019), more.
= 2.4 =
Minor update: added support for query arg to disable expert mode on a given page; updated hiding of newly added help text, added README.md, noted compatibility through WP 4.9+, updated copyright date (2018), and more.
= 2.3 =
Minor update: updated hiding of help text on the new term.php page, noted compatibility through WP 4.5+, added LICENSE file
= 2.2 =
Minor update: hide a few more recently added/changed help texts, adjustments to utilize language packs, minor unit test tweaks, noted compatibility through WP 4.4+, and updated copyright date
= 2.1 =
Minor update: updated hiding of a few existing help text; noted compatibility through WP 4.1+; updated copyright date (2015); added plugin icon
= 2.0 =
Minor update: updated hiding of a few existing help text; noted compatibility with WP 3.8+
= 1.9 =
Minor update: removed newly added and changed help text; noted compatibility with WP 3.5+
= 1.8.1 =
Trivial update: noted compatibility through WP 3.4+; explicitly stated license
= 1.8 =
Recommended update. Highlights: various code improvements; enqueue CSS; noted compatibility through WP 3.3+
= 1.7.2 =
Bugfix release. Fixed accidental hiding of permalink rules on permalinks settings page
= 1.7.1 =
Bugfix release! Fixed accidental hiding of submit button on permalinks settings page
= 1.7 =
Minor update: removed more help text and noted compatibility with WP 3.2+
= 1.6 =
Minor update: implementation changes; noted compatibility with WP 3.1+ and updated copyright date.
= 1.5 =
Recommended update! Highlights: hides newly added help text, displays reminder on plugin activation, added filters, localization support, dropped pre-WP 2.8 compatibility, added verified WP 3.0 compatibility.