admin-help-docs
Last commit date
inc
1 day ago
admin-help-docs.php
1 day ago
index.php
1 day ago
readme.txt
1 day ago
uninstall.php
1 day ago
readme.txt
351 lines
| 1 | === Admin Help Docs === |
| 2 | Contributors: apos37 |
| 3 | Tags: help, documentation, instructions, how-to, admin |
| 4 | Requires at least: 6.0 |
| 5 | Tested up to: 7.1 |
| 6 | Requires PHP: 8.0 |
| 7 | Stable tag: 2.0.3 |
| 8 | License: GPLv2 or later |
| 9 | License URI: http://www.gnu.org/licenses/gpl-2.0.txt |
| 10 | |
| 11 | Site developers and operators can easily create help documentation and notices for the admin area. |
| 12 | |
| 13 | == Description == |
| 14 | |
| 15 | The "Admin Help Docs" WordPress plugin is a brilliant tool for streamlining administrative tasks and empowering website management! It allows you to create custom help documentation for your WordPress admin dashboard, making it easy to remind yourself or guide other administrators through complex tasks and settings. |
| 16 | |
| 17 | With this plugin, you can: |
| 18 | |
| 19 | * Add a section to your admin area where users can go to browse or search through help documentation that you create. |
| 20 | * Add instructions/notes to ANY admin page at the top, bottom, or other areas of the page. |
| 21 | * Add custom dashboard widgets, or replace your entire WordPress dashboard with help docs. |
| 22 | * Brand your help section and docs with your own logo and colors. |
| 23 | * Import and auto-feed docs remotely from other sites. |
| 24 | * Change the footer text in the admin area. |
| 25 | * Reorganize your admin menu in an order that makes more sense. |
| 26 | * Add a simple Support Contact form for your clients to contact you directly. |
| 27 | |
| 28 | Page locations include: |
| 29 | |
| 30 | * Top |
| 31 | * Bottom |
| 32 | * Side (if on post/page edit screens) |
| 33 | * Contextual help tab |
| 34 | * Next to specific elements (using a CSS selector) |
| 35 | * Anywhere else you can hook into if you're a developer by using a function |
| 36 | |
| 37 | By providing easy access to relevant information and guidance, "Admin Help Docs" saves time, reduces confusion, and makes WordPress administration more efficient and enjoyable! It's perfect for developers, designers, and site owners who want to simplify website management and focus on creating amazing content! |
| 38 | |
| 39 | == Installation == |
| 40 | 1. Install the plugin from your website's plugin directory, or upload the plugin to your plugins folder. |
| 41 | 2. Activate it. |
| 42 | 3. Go to Help Docs in your admin menu. |
| 43 | |
| 44 | == Frequently Asked Questions == |
| 45 | = Who can add a help section? = |
| 46 | Anyone that has the `Administrator` role, or other roles that you specify. |
| 47 | |
| 48 | = Who can view help docs? = |
| 49 | Anyone role or capability you specify in settings. You can also override the default role on a per-doc basis. |
| 50 | |
| 51 | = Can I use the same documentation across multiple sites? = |
| 52 | Yes, you can choose to automatically feed documents or copy them locally from a remote site with the same plugin. You can do so from the **Help Docs** > **Imports** section. |
| 53 | |
| 54 | = Where can I request features and get further support? = |
| 55 | We recommend using our [website support forum](https://pluginrx.com/support/plugin/admin-help-docs/) as the primary method for requesting features and getting help. You can also reach out via our [Discord support server](https://discord.gg/3HnzNEJVnR) or the [WordPress.org support forum](https://wordpress.org/support/plugin/admin-help-docs/), but please note that WordPress.org doesn’t always notify us of new posts, so it’s not ideal for time-sensitive issues. |
| 56 | |
| 57 | = I updated my import's API key or URL, but it still shows an error. = |
| 58 | The plugin temporarily remembers failed connection attempts for 15 minutes so a broken or misconfigured import doesn't slow down every admin page. After fixing the URL or API key, click "Fetch Docs" on the import's edit screen to check the connection immediately, or wait up to 15 minutes for it to retry automatically. |
| 59 | |
| 60 | = Can I migrate documentation from another plugin? = |
| 61 | Yes. Admin Help Docs includes a Migrate tab that can copy content from any post type into your Help Docs — including from other admin documentation plugins like WP Help. Just select the post type you want to migrate from, choose which posts to bring over, and they'll be published to your Main Documentation Page, organized into their own folder named after the source. |
| 62 | |
| 63 | == Demo == |
| 64 | https://youtu.be/8_JHpyOSunU |
| 65 | |
| 66 | == Screenshots == |
| 67 | 1. Main documentation page |
| 68 | 2. Page locations |
| 69 | 3. Gutenburg contextual help and side locations |
| 70 | 4. Replacing the WordPress Dashboard |
| 71 | 5. Organize your admin menu |
| 72 | 6. Settings page |
| 73 | 7. Contact Support form |
| 74 | 8. Flexible branding options |
| 75 | |
| 76 | == Changelog == |
| 77 | = 2.0.3 = |
| 78 | * Update: Added new Migrate tab for copying documents from another post type (e.g. an abandoned plugin like WP Help) into Admin Help Docs as published docs, filed into an auto-created folder named after the source (props Alan B. for the suggestion) |
| 79 | * Update: Added dismissible admin notice on known source plugins' screens (currently WP Help) linking directly to the Migrate tab with the source pre-selected |
| 80 | * Update: Added `helpdocs_migrate_known_sources` filter for registering additional migration source plugins |
| 81 | * Update: Added `helpdocs_migrate_eligible_post_types` filter for controlling which post types appear in the Migrate tab's dropdown |
| 82 | * Update: Added `helpdocs_migrate_post_imported` action, fired after each post is successfully migrated |
| 83 | |
| 84 | = 2.0.2 = |
| 85 | * Fix: Every admin page taking 20-30 seconds to load when an import was configured with an unreachable URL or invalid API key |
| 86 | * Fix: Failed remote import lookups were never cached, causing a blocking HTTP request on every page load |
| 87 | * Fix: Remote import data fetched multiple times per request instead of once |
| 88 | * Fix: Imports with a blank URL still triggering a remote request |
| 89 | * Tweak: Reduced remote request timeout from 20 to 5 seconds outside of manual fetches |
| 90 | * Tweak: Removed browser cache header detection as a trigger for clearing remote import data |
| 91 | * Update: Added an admin notice when a configured import cannot reach the remote site |
| 92 | * Tweak: Standardized header styling and fixed minor button sizing inconsistencies across admin pages |
| 93 | * Fix: Replacing the WordPress Dashboard was intercepting other plugins' ajax/iframe requests to index.php (e.g. Gravity Forms' Select Columns modal) |
| 94 | |
| 95 | = 2.0.1.1 = |
| 96 | * Compatibility: Increased minimum required WordPress version to 6.0 |
| 97 | * Compatibility: Tested with WordPress 7.0 |
| 98 | |
| 99 | = 2.0.1 = |
| 100 | * Update: Added several helpful shortcodes to be used in docs (see help guide on pluginrx.com) |
| 101 | * Fix: Warning - Uninitialized string offset 2 |
| 102 | |
| 103 | = 2.0.0.2 = |
| 104 | * Fix: Replacing dashboard wasn't working for some roles |
| 105 | * Tweak: Updated the dashboard docs (when replacing dashboard entirely) to be sorted by date |
| 106 | * Fix: Make a few minor CSS adjustments |
| 107 | * Fix: Save button icon wobbly |
| 108 | * Fix: Doc font color not taking on some docs |
| 109 | |
| 110 | = 2.0.0.1 = |
| 111 | * Fix: Update old image path to new one if using the stock page logo |
| 112 | |
| 113 | = 2.0.0 = |
| 114 | * Update: Complete rebuild for better performance and UI |
| 115 | * Update: Added ability to reset colors and all settings before save to test before keeping changes |
| 116 | * Update: Removed import/export settings API and replaced it with JSON upload/download |
| 117 | * Update: Added color themes and more color options |
| 118 | * Update: Added option for downloading/uploading colors only so people can share themes easily |
| 119 | * Update: Added more access control options, including per doc viewing roles |
| 120 | * Update: Added "Remove All Plugin Data on Uninstall" option |
| 121 | * Update: Removed Gravity Form User Merge Tags option as it has no place here; same functionality added to our other plugin, "Advanced Tools for Gravity Forms" |
| 122 | * Update: Removed "Hide Version" option and moved it to title attribute when hovering over logo and page title |
| 123 | * Update: Changed settings save functionality to ajax without refreshing the page, added Ctrl+S/Cmd+S capability as well |
| 124 | * Update: Added style option for main docs page navigation |
| 125 | * Update: Added support for multiple locations on a single help doc |
| 126 | * Update: Split option for enabling admin bar menu into backend and frontend enabling |
| 127 | * Update: Added option to include doc content in admin bar menu |
| 128 | * Fix: Footer text wasn't updating properly |
| 129 | * Update: Added a separate doc logo field and an option to hide it |
| 130 | * Update: Removed support for [helpdocs_css] shortcode, and added a css field in settings for the whole main docs page |
| 131 | * Tweak: Changed the [dont_do_shortcode] shortcode to allow wrapping shortcodes instead of only requiring them being in a content attribute with curly braces (see help guide) |
| 132 | * Fix: Gutenberg docs weren't showing up where they should be |
| 133 | * Update: Removed priority option from side page location and fixed it to the top of the sidebars so it can't be moved by the user |
| 134 | * Update: Added option to replace the WP Dashboard entirely |
| 135 | * Update: Redid the import page entirely; fetching data is now live with ajax and cached |
| 136 | * Update: Added an optional public access api key to secure sharing and importing |
| 137 | * Update: Added support for sorting imported docs on the main docs page |
| 138 | * Update: Removed User Preferences option as help docs on the post/page edit screen no longer use meta boxes that can be moved around |
| 139 | * Update: Added a bunch of developer hooks for further customization |
| 140 | * Update: All help guides and developer docs updated |
| 141 | * Update: Recorded new video tutorial |
| 142 | |
| 143 | = 1.4.3.2 = |
| 144 | * Fix: Default icon causing php warning "Undefined variable $di" |
| 145 | |
| 146 | = 1.4.3 = |
| 147 | * Update: Added new Admin Menu tab with an option to sort the admin parent menu items and colorize the separators |
| 148 | |
| 149 | = 1.4.2 = |
| 150 | * Fix: Timezone on main doc page meta was offset (props @eyesofjeremy for pointing it out) |
| 151 | |
| 152 | = 1.4.1 = |
| 153 | * Update: Added support for enqueuing frontend stylesheets in the backend, option to enable it in settings |
| 154 | * Update: Added support for Gutenberg editor, option to enable it in settings (props @derek for suggestion) |
| 155 | |
| 156 | = 1.4.0 = |
| 157 | * Update: Removed feedback form since it's not being utilized |
| 158 | * Update: New support links |
| 159 | |
| 160 | = 1.3.12 = |
| 161 | * Fix: If a doc is put into a folder and then changed to a different site location, folder still counts it on main doc page |
| 162 | * Fix: Importing folders only drops 1 doc into the folder (props pierre_miguel) |
| 163 | |
| 164 | = 1.3.11 = |
| 165 | * Fix: If importing site is updated before exporting site, a fatal error occurs on the importing site |
| 166 | |
| 167 | = 1.3.10 = |
| 168 | * Update: Added ability to import folders (props pierre_miguel for suggestion) |
| 169 | |
| 170 | = 1.3.9 = |
| 171 | * Fix: Importing doc notice escaping <strong></strong> |
| 172 | * Fix: Error when importing permanently to main documentation page |
| 173 | * Tweak: Changed filter names for imports to be unique from the main CPT |
| 174 | |
| 175 | = 1.3.8 = |
| 176 | * Update: Updated author name and website again per WordPress trademark policy |
| 177 | * Tweak: Updated default header sizes on main documentation page |
| 178 | |
| 179 | = 1.3.7 = |
| 180 | * Update: Added option to auto-generate TOC from headings on main documentation page (props @cpoakl for suggestion) |
| 181 | |
| 182 | = 1.3.6 = |
| 183 | * Update: Changed author name from Apos37 to WordPress Enhanced, new Author URI |
| 184 | * Tweak: Optimization of main file |
| 185 | * Fix: Deprecated - creation of dynamic property DateInterval::$w (props @georgestephanis) |
| 186 | |
| 187 | = 1.3.5.6 = |
| 188 | * Fix: Main documentation page removes full path from url on some sites |
| 189 | |
| 190 | = 1.3.5.5 = |
| 191 | * Update: Allow embedding videos with embed code (props Dan for suggestion) |
| 192 | |
| 193 | = 1.3.5.4 = |
| 194 | * Fix: Contextual help not working on block editor toolbar after v6.6 (props nshower) |
| 195 | |
| 196 | = 1.3.5.3 = |
| 197 | * Fix: Undefined property and array keys on class-imports.php |
| 198 | |
| 199 | = 1.3.5.2 = |
| 200 | * Fix: Shortcodes showing double brackets when not using Click-to-Copy option |
| 201 | * Fix: Shortcodes showing javascript with Click-to-Copy option (props tenacious_hare_45963) |
| 202 | |
| 203 | = 1.3.5.1 = |
| 204 | * Fix: Warning about folder nonce on all pages |
| 205 | |
| 206 | = 1.3.5 = |
| 207 | * Fix: Warnings from Plugin Checker |
| 208 | * Tweak: Reorganized some code for better readability |
| 209 | |
| 210 | = 1.3.4 = |
| 211 | * Fix: PHP 8.3 deprecation notices |
| 212 | |
| 213 | = 1.3.3 = |
| 214 | * Tweak: Removed checkboxes for adding to Dashboard TOC on imports that are not on Main Doc page |
| 215 | * Tweak: Updated Add All to Dashboard TOC checkbox on imports to include Main Docs only with notice to enable in settings |
| 216 | * Fix: Non-main documentation items from imports showing up on dashboard table of contents when selecting all |
| 217 | * Fix: Error on Imports page with not serializing array |
| 218 | * Tweak: Removed donate option; nobody ever donates |
| 219 | |
| 220 | = 1.3.2 = |
| 221 | * Fix: Some issues with folder docs not loading in folder on main docs page |
| 222 | |
| 223 | = 1.3.1 = |
| 224 | * Fix: Warning: session_start(): Session cannot be started after headers have already been sent (props pauloc) |
| 225 | * Fix: Click to copy shortcodes copying shortcode output instead of shortcode itself |
| 226 | |
| 227 | = 1.3.0 = |
| 228 | * Update: Added new plugin to About tab |
| 229 | * Tweak: Removed deactivation survey code and files permanently; only one legitimate response - not worth it |
| 230 | * Tweak: Updated some functions and techniques as recommended by WP Plugin team |
| 231 | |
| 232 | = 1.2.9 = |
| 233 | * Tweak: Updates to some areas affected by live preview |
| 234 | * Update: Added other plugins on About tab |
| 235 | |
| 236 | = 1.2.8.3 = |
| 237 | * Fix: Options page path error |
| 238 | * Update: Added live preview blueprints |
| 239 | |
| 240 | = 1.2.8 = |
| 241 | * Update: Add click-to-copy functionality to [dont_do_shortcode], can disable |
| 242 | * Update: Temporarily disable deactivation feedback form |
| 243 | |
| 244 | = 1.2.7 = |
| 245 | * Fix: Description showing endless characters in admin column |
| 246 | * Fix: Manage tab admin columns duplicating values |
| 247 | * Fix: Documentation page causing error if default doc is deleted |
| 248 | |
| 249 | = 1.2.6.1 = |
| 250 | * Fix: Session already open |
| 251 | |
| 252 | = 1.2.6 = |
| 253 | * Fix: Docs on pages were duplicating |
| 254 | |
| 255 | = 1.2.5 = |
| 256 | * Fix: Removed unneccesary instantiation of Discord class |
| 257 | * Tweak: Removed all unneccesary static declarations and usage |
| 258 | |
| 259 | = 1.2.4 = |
| 260 | * Fix: FAQ css example stylesheet path was missing a slash |
| 261 | * Tweak: Updated some CSS styles |
| 262 | * Tweak: Added version logging to deactivation feedback to make it easier to chase down errors |
| 263 | |
| 264 | = 1.2.3 = |
| 265 | * Fix: More than 5 files in a folder won't stay in the folder (props alex_p6577 for pointing this out) |
| 266 | * Tweak: Added an option to stop showing feedback form on deactivate; will automatically disable for certain choices |
| 267 | |
| 268 | = 1.2.2 = |
| 269 | * Tweak: Changed import feeds icon to a newspaper |
| 270 | * Update: Added notice that import feeds cannot be added to folders |
| 271 | |
| 272 | = 1.2.1 = |
| 273 | * Update: Added setting option to hide the created and last modified dates and authors (props chrismaclean for suggestion) |
| 274 | * Update: Added `[helpdocs_css]` shortcode for adding custom CSS to docs on the main doc page |
| 275 | * Update: Added setting option to select a default doc for the main doc page |
| 276 | * Tweak: Removed top border on first doc in main doc page and added borders to dragged doc instead |
| 277 | * Update: Added permalink and view button to top of edit screen if site location is main doc page |
| 278 | * Update: Added `[dont_do_shortcode]` shortcode to make it easier to share shortcodes without executing them |
| 279 | |
| 280 | = 1.2.0 = |
| 281 | * Tweak: Drag and drop sorting - added icons, linked entire cells instead of just text, removed sorting cursor |
| 282 | * Tweak: Added 150 ms delay to drag and drop sorting to prevent accidental dragging |
| 283 | * Update: Added folders for main documentation page (props alex_p6577 for suggestion) |
| 284 | * Tweak: Moved doc editing JS to its own file |
| 285 | * Update: Added support for WP Version to still be used in footer |
| 286 | * Tweak: Changed order of deactivate feedback form options |
| 287 | * Tweak: Planned Updates on About tab |
| 288 | * Update: Added search bar on main documentation page (props alex_p6577 for suggestion) |
| 289 | |
| 290 | = 1.1.5 = |
| 291 | * Fix: PHP warning about id variable not being found on every page load |
| 292 | |
| 293 | = 1.1.4 = |
| 294 | * Fix: Sorting by order column not in order (props alex_p6577 for pointing this out) |
| 295 | * Fix: Documentation page ordering issue (props alex_p6577 for pointing this out) |
| 296 | * Fix: Attempt to read property "singular_name" on null (props alex_p6577 for pointing this out) |
| 297 | |
| 298 | = 1.1.3 = |
| 299 | * Update: Added setting to change user capability |
| 300 | * Fix: Editors could view menu link and dashboard widget, but not view docs (props chrismaclean for pointing it out) |
| 301 | |
| 302 | = 1.1.2 = |
| 303 | * Update: Added setting to disable curly quotes site-wide that make sharing code difficult |
| 304 | * Fix: Resize cursor showing up on doc list items |
| 305 | |
| 306 | = 1.1.1 = |
| 307 | * Fix: Custom link fields not showing up for some people |
| 308 | |
| 309 | = 1.1.0 = |
| 310 | * Tweak: Highlighted "Enable This Site" checkbox on imports when disabled |
| 311 | * Update: Added deactivation survey |
| 312 | * Update: Added support for importing custom urls with auto-updating domain |
| 313 | * Update: Added new site location for custom url |
| 314 | |
| 315 | = 1.0.9 = |
| 316 | * Tweak: Updated Discord support link |
| 317 | |
| 318 | = 1.0.8 = |
| 319 | * Tweak: Added icons to dashboard TOC |
| 320 | * Tweak: Added ability to add imports/feeds to dashboard TOC |
| 321 | * Fix: Hid "Add to Dashboard TOC" by default |
| 322 | * Fix: Replaced early escapes with sanitizers |
| 323 | |
| 324 | = 1.0.7 = |
| 325 | * Update: Added dashboard table of contents (props chrismaclean for suggestion) |
| 326 | * Tweak: Updated changelog to use commonly used prefixes (Fix, Tweak, and Update) |
| 327 | |
| 328 | = 1.0.6 = |
| 329 | * Update: Added optional setting for allowing the addition of missing user meta merge tags to Gravity Forms dropdowns |
| 330 | * Update: Added missing `index.php` to `/classes/` and `/js/` folders |
| 331 | * Fix: Excerpt meta box title changing on other post types |
| 332 | |
| 333 | = 1.0.5 = |
| 334 | * Update: Added video to readme |
| 335 | * Tweak: When resetting settings, added a notice instead of attempting to refresh |
| 336 | |
| 337 | = 1.0.4 = |
| 338 | * Fix: Nested ordered lists on main documentation page not showing proper list types |
| 339 | * Update: Added links to plugins list page |
| 340 | |
| 341 | = 1.0.3 = |
| 342 | * Fix: Minor fixes |
| 343 | |
| 344 | = 1.0.2 = |
| 345 | * Update: Added feedback form to About tab |
| 346 | |
| 347 | = 1.0.1 = |
| 348 | * Initial release on WP.org January 23, 2023 |
| 349 | |
| 350 | = 1.0.0 = |
| 351 | * Created plugin on November 14, 2022 |