=== Admin Notes WP ===
Contributors: stevepuddick
Donate link: https://webrockstar.net
Tags: admin, help, notice, customer, support, notices, client, note, service, training, tab
Requires at least: 4.0
Tested up to: 5.6
Stable tag: 1.0.0
Requires PHP: 7.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Create an embedded training manual and leave a virtual business card directly in the WordPress admin.

== Description ==

Admin Notes WP enhances the built in WordPress contextual help tabs and screen notice functionality, and also offers the ability to include custom footer text in the WordPress admin. The help tab and notice post types allow you to easily manage help and notice content just like your blog posts and pages. Embed useful information for website editors, in the form of contextual help and notices, directly on the relevant WordPress admin page. The Screen ID helper makes it easy to identify what admin screen you would like your contextual help or notice to appear on.

As a web freelancer, agency, or internal IT/digital department, Admin Notes WP can help you:

* encourage follow up business from your existing clients and customers
* reduce customer support requests
* make training your clients and customers faster, easier, and more effective
* easily and more effectively communicate the nuances of how the WordPress website you created works and how components
(including free plugins, pro plugins, custom plugins, and your theme) are intended to be used and work together
* integrate instructions and notifications directly on the relevant WordPress admin pages. Your customers won't have to
go digging through emails or PDF instructions to learn how something works. You can even provide instructions on third party plugins
* provide a subtle and unobtrusive information about who setup/created the site within the WordPress admin of your clients' websites
* maintain a connection to your client's business, even after your direct contacts at the company may have left

**Features Include**:

* Help Tab Post Type
* Notice Post Type
* Custom Admin Footer Text
* Hide Default Help Tabs
* Global Help Tab
* Admin Screen ID Identifier Tool
* Help Tab bounce animation (similar to MacOS icon bounce). Displays once per user until clicked to help with discoverability

Components that are not relevant for your unique needs can be easily deactivated, removing them from the admin menus.
In it's most basic form Admin Notes WP can be used simply to include footer text and a single, short global help tab.

If you are a web designer/developer freelancer, agency, or represent an internal IT/Digital department in your company or organization,
Admin Notes WP would be a valuable plugin to install in almost all cases.

== Installation ==

After plugin activation go to /wp-admin/options-general.php?page=crb_carbon_fields_container_wp_admin_notes.php to configure
Admin Notes WP to your needs. This link is available in **Settings** > **Admin Notes WP**.


== Frequently Asked Questions ==

= Screen ID Helper Tool Not Displaying =

The 'Help Tab' or 'Notice' post type must be enabled in order for the 'Screen ID' header toolbar link to display.
'Help Tab' and 'Notice' post type enabling/disabling can be managed on the settings page in **Settings** > **Admin Notes WP Settings**.

= How do I find the screen id I want to display a help tab or notice on? =

The easiest way to obtain the screen id for the desired admin page is to use the 'Screen ID' helper tool. This is located
in the admin header toolbar. Just visit the desired admin page you would like the notice or help tab to appear on.
Click on the submenu link and the screen id will automatically be copied to your clipboard.  Refer to the screenshot
section to see what this looks like.

= User Capabilities =

In order to access the Admin Notes WP settings page, the user must have the **manage_options** capability. It should be
noted that the built in 'Administrator' role has this capability. In addition, the 'Administrator' role is also given the
following capabilities related to the 'Help Tab' and 'Notice' post type are also added to the Administrator role:

- edit_wpan_help_tab
- edit_wpan_help_tabs
- edit_others_wpan_help_tabs
- publish_wpan_help_tabs
- read_wpan_help_tab
- read_private_wpan_help_tabs
- delete_wpan_help_tab
- edit_published_wpan_help_tabs
- delete_published_wpan_help_tabs

- edit_wpan_notice
- edit_wpan_notices
- edit_others_wpan_notices
- publish_wpan_notices
- read_wpan_notice
- read_private_wpan_notices
- delete_wpan_notice
- edit_published_wpan_notices
- delete_published_wpan_notices

You can assign these capabilities to other user roles if desired. This can be done directly in your website code (https://developer.wordpress.org/plugins/users/roles-and-capabilities/#adding-capabilities)
or with a third party plugin like [User Role Editor](https://en-ca.wordpress.org/plugins/user-role-editor/).

= Screen ID 'copy to clipboard' link is not working =

The WordPress Admin must be viewed under SSL (the https:// URL) for the 'copy to clipboard' functionality to work.

= Help Tab not Appearing =

If you are using the WordPress Block Editor, the post edit page does not support help tabs. It will not display on that
particular page.

== Screenshots ==

1. The Global Help Tab is separate from the Help Tab post type. This special help tab appears on every admin page.
2. The admin footer text is a great, subtle way to leave your 'calling card'. It can be used to briefly state the company
or individual that created the site and contact information.
3. The Screen ID helper link in the toolbar makes identifying WordPress admin screen ids very easy
4. The main Admin Notes WP settings page
5. The Help Tab post type 'edit post' admin page
6. The Help Tab post type display
7. The Notice post type 'edit post' admin page
8. The Notice post type display
9. To help with discoverability of the help tab (some users are not aware of it), a bounce animation (similar to the MacOS icon bounce) can be enabled to occur once per user

== Useful Third Party Plugins and Other Techniques ==

The following are some additional third party plugins and useful techniques which can nicely enhance the functionality
of Admin Notes WP.

**Post Expirator**

The [Post Expirator](https://wordpress.org/plugins/post-expirator/) can allow you to set Help Tab and Notice
posts to expire (not display) after a certain time or date.

**Post Dating Posts**

Setting the Help Tab or Notice post published date in the future will cause that post to only start appearing once that
date and time has been reached.

**User Role Editor**

The [User Role Editor](https://en-ca.wordpress.org/plugins/user-role-editor/) plugin allows you to manage the user capabilities
associated with Admin Notes WP. Refer to the Frequently Asked Questions section for the full list.

== Changelog ==

= 1.0.0 =
* Initial Release