WordPress.org

Ready to get started?Download WordPress

Plugin Directory

Dashboard Site Notes

Add notes as admin notices in contextual help tabs, as well as compile them into an instruction manual.

Can I put notes on the public part of the site, or in a shortcode?

I recommend using http://wordpress.org/extend/plugins/wp-announcements/ for public notices. However, a shortcode is available for notes that are explicitly set to allow it. The shortcode can then used like so: [sitenote id='123'] If you only want to show one note, and none of its child notes, set the depth parameter to 0, for example: [sitenote id='123' depth='0'] You can also change 'sitenote' to something else by adding the following line to your functions.php: define('DSN_SHORTCODE','your_shortcode_name_here');

I installed the plugin but I don't see anything!

If you use multisite, only super-admins can create notes. To also allow normal administrators to manage them, add this to your functions.php: define('DSN_ADMIN_CONFIG',true); If you aren't using multisite but still don't see site notes, they might be disabled. Try Settings->Site Notes and make sure the box next to Administrator is checked. Also, make sure that note management hasn't been disabled (see below).

I've finished adding notes and now I want to hide the management of Site Notes.

Go to Settings->Site Notes and uncheck the box next to Administrator and they will no longer be editable. To re-enable them, just come back to this page and turn it back on. You can also add define('DSN_DISABLE_CHANGES',true); to your functions.php to disable all changes completely, but note that if you do that, NOBODY will be able to make any changes whatsoever until you remove that line. At some point in a future version, it may be possible to choose a specific user who is able to maintain the notes while hiding it from others.

Why isn't one of my notes showing up in the dashboard/instructions?

If the note has a parent note, that parent must also be visible or else your note won't show up on the dashboard or in the instruction manual. Roles must also be selected; if you don't choose any roles, your note will not show up for anyone. Finally, make sure that you've checked the checkbox for appearing on the dashboard.

Why is one of my notes showing up with empty text?

Make sure that the excerpt field for your note is empty or contains the content you want to include. If it's still not showing up, trying disabling excerpt, excerpt filters, and/or content filters on the settings page.

What is planned for future versions?

Here are features planned for future versions (probably released about every 2-3 months): * 1.4: add ability to put notes in the admin bar * 1.4: add warnings if a note is created that can't be seen anywhere (no role or location selected) * 1.4: add note options for 'hide title in manual', 'hide title in widget', and 'hide title in shortcode' * 1.4: add ability to show site note management pages for only specific user(s) instead of just by role * 1.4: add taxonomy, links, comments, dashboard, and other positions (maybe just allow entering the filename and parameters, such as 'edit-tags.php?taxonomy=link_category') * 1.5: note featured image support * 1.5: note author name support * 1.5: refine capabilities management * 1.5: add option for stripping html/js from notes by role/capability so any roles could be allowed to create notes without security risk * 1.5: add option for displaying an 'edit' link next to each note for users with appropriate permissions * 1.5: add option for eliminating default wordpress contextual help; might be impossible - see wp-admin/includes/screen.php starting at 680

Features that will not be implemented:

Known issues?

  • content filters aren't applied to notes displayed on attachment pages and probably won't ever be unless people complain.
  • Very little testing has been done in the last few versions with multisite or child/parent notes, so if you're using those, it's possible you could see some strangeness.
  • translations are a bit out of date

Requires: 3.0 or higher
Compatible up to: 3.3.2
Last Updated: 2012-6-8
Downloads: 16,029

Ratings

4 stars
4.6 out of 5 stars

Support

0 of 1 support threads in the last two months have been resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

100,1,1
0,1,0
100,1,1 100,2,2 83,6,5 0,1,0 100,1,1
67,3,2 50,2,1
0,2,0 33,3,1 67,3,2
100,2,2
75,4,3
100,1,1 100,4,4
100,1,1
100,3,3
0,1,0
50,2,1
100,2,2
100,1,1
50,2,1