WP Help 1.0

My WP Help plugin just got a huge update. Version 1.0 is really worth checking out. I’m quite proud of it.

WP Help

WP Help is a plugin for creating documentation for display within the WordPress admin. Many WordPress installs are customized, and it’s really helpful to have a centralized resource for documenting those features. You can create documents about creating content, editing content, moderating comments, or whatever you want! If you have clients who can’t seem to remember how to do X, you should install WP Help and document it for them. WP Help is powered by WordPress Custom Post Types, so you create content using the full WordPress editor.

Document Syncing

Oh yeah. This is the feature you’ve all been waiting for. If you have a standard set of help documents you want to use on multiple sites, this lets you do that. Create the documents, grab the (secret) sync URL for that site, and then plug that URL in to other sites. Those other sites will automatically pull down those documents, and keep them up-to-date (even handling new documents, deleted documents, renamed documents, and re-parented documents). Any internal links in the original document will be rewritten to be local to the destination WP Help install. So go ahead and use the WP internal linking functionality on your source site and know that those links will work on all the destination sites!

Menu Placement

The menu item for the help documents can now be placed in one of four locations:

  1. As a Dashboard submenu
  2. Top level, above the Dashboard
  3. Top level, below the Dashboard
  4. Top level, at the bottom

You get a live preview of this (yeah, I know, super fancy).

Menu Name

The menu name (and page title) can be changed. Just doubleclick the page title, edit it, and hit return. Boom. Again, this has a live preview.

Topics List Name

Likewise the topics list header can be renamed. Doubleclick, edit, return. Live preview.

Edit Links & Management Links

If you can edit help documents, you’ll get an edit link. When editing, there is a handy “Manage” link to jump you back to the documents management interface. Navigating in general has been improved quite a bit.

Dashboard Widget

There is now a simple dashboard widget, listing all of your help documents.

Better Default Access

A lot of you said that you have Contributor-level users who need documentation just like authors do. So now they can view documentation by default (there’s a hook if you want to change the capability required to view help documents).

Lots of Little Tweaks

There are numerous little tweaks to improve your experience. Check out out!

Roadmap

Things I’m considering:

  • Restricting individual documents to users with a certain level of access
  • Multiple sync sources

Any other ideas?

71 thoughts on “WP Help 1.0

  1. Mark, this is great, I especially love the syncing feature. May I assume that “synced documents” mean any WP Help cpt that I create on one site (including embedded video content, etc.) is in fact the “document” that gets synced between installs?

    • Attachments aren’t transferred — but if they’re hotlinked, they should continue to work. It is the post_title and post_content that are transferred, mainly. Yes, for all WP Help documents created on the site.

    • Thanks Mark, understood. I use the Easy Video Player 2 script to embed tutorial videos for my clients (allows me to put call-to-action buttons within my videos). Now I just need to start testing this out and see if it works for including these in all my client sites.

      Very cool update and thanks for making it available!

  2. Great!
    I would like to be able to sync only parts of the document source on the remote site. For remote documents, something like a remove action on the management page. When a remote page is removed, all the sub-documents are removed, too (opt-out). Or implemented as the opposite, so that when you add a sync source, select top level documents of that site to sync, including sub-documents (opt-in).

  3. rayhunnsdon says:

    Hooray!!!!

    I sent you an email about this plugin some months ago as it was getting a bit out of date.

    I don’t know if you got it but great, it’s now updated! Excellent carry on the good work.

  4. rayhunnsdon says:

    Ahh!

    Problem! I use Adminimize plugin for detailed control of users backend. Now after the update I can’t lockout the editor role from editing the help topics due to the plugin allowing users editing capabilities with ‘admin & editor’ roles.

    Any ideas on a fix or work around, as I used to be able to remove anyone who wasn’t an editor from making changes to the topics.

    • Hi Mark

      Sorry I am not an advanced user and need instructions on how to do that. I have edited files before but with instructions. Any assistance please.

    • hi Jan Beck

      I tried this but getting a 500 error now and the site doesn’t load at all until I remove it.

      Any help would be appreciated, thanks. Or if you can guide me in the right direction to get it to work.

    • I think there is some confusion. The filter described above allows you to define who can *read* WP Help docs. As far as I can tell it doesn’t affect who can *edit* the docs.

      In fact, the “Add new” and “Manage” buttons are displayed to any user with the publish_pages capability, and this is coded into the template, NOT the post type capabilities array. Take a look at wp-help/templates/list-documents.php on line 8:

      if ( current_user_can( ‘publish_pages’ ) ) : [buttons displayed here, etc]

      As you can see this is hard coded into the plugin, and there’s no way to hide those buttons without hacking the plugin core.

      I’m with @rayhunnsdon: It would be a great addition to this fine plugin if it were possible to have fine grained control over who can *edit* as well as who can *read*.

  5. Hi, one great improvement would be to make the “items order” system more user friendly!

    Using just number is so Joomla like and it’s a pain if you want to insert a new item in the middle of the list.

  6. I’m interested in letting subscribers see the docs written with WP Help. Could you explain how to achieve? Although my PHP skills are very limited, I have been able to get it by changing “edit_posts” capability by “read” in wp-help.php, lines 111, 155, 483 and 485, but I know this is not the right way.

    By the way, great, great plugin.

  7. Carlos says:

    The syncing sounds very advanced, but how about something very simple: MultiSite support? Allow me to create one help, managed from the network admin screen, that all of my sites can see.

  8. Thank you very much for the clue, Mark. I’ve written a short review of your plugin: http://wp.me/p12llC-z4 (in spanish). In this article I’ve included the code of a function inspired by your answer. Feel free to correct my code in case I make some mistake.

    At the end of the post, you can find my updated and upgraded spanish translation of version 1.0. I’ve added to it all the missing text strings which Knut Sparhell pointed. So, I think that this translation is much more comprehensive than the previous one.

  9. Right here is the perfect webpage for anyone who wants to find out about this topic. You know a whole lot its almost tough to argue with you (not that I actually would want to…HaHa). You definitely put a brand new spin on a subject that’s been written about for years. Wonderful stuff, just great!
    BR Removal Services
    27a Jade Close Unit 2
    London
    E16 3TY
    United Kingdom
    0800 001 6111

  10. junkfood says:

    Hi Mark !! Is possible extend permission to read for contributor ? In plugin description you describe this function but when user whit this role can try to access to page he receive this error :

    The requested help document could not be found.

  11. Is it possible to assign user roles to a help document? (next version?)
    That because an editor could do more than a contributor, so he needs different help contents (but some will be the same, so please use checkboxes :-) .). And who can edit the help? If the admin could assign who can edit the help… That would be a perfect next version!

  12. I absolutely love this plugin. But is there any way to make it readable to non-members? I always thought this would make for a great FAQ/help page for new readers to my site.

  13. Lauren Darman says:

    Dear Mr. Jaquith, Is it possible to let my brother know that you are not personally helping him? Allen Darman believes you are. Thank you. Lauren

  14. Josh says:

    It appears current version does not allow video embed to appear on sync sites? Any work around or fix for this issue. I would love to be able to include videos in the help docs. Thanks for an amazing plugin.

  15. Gabe says:

    I really like the plugin, but I have a question. Is there a simple way to make the plugin read-only (i.e. can’t access settings or edit help items) for site administrators on a multisite install and only allow super admins to modify/access settings? Thanks.

  16. Sad says:

    My partner and I stumbled over here different web page and thought I might check things out. I like what I see so now i’m following you. Look forward to looking at your web page repeatedly.

  17. Many celebrities happen to be fascinated with all the retro looks
    of for the reason that, as an illustration, Oprah, Paris Hilton, Pamela
    Anderson and Kate Hudson etc. The artist material moisture from your feet, keep it cold and dry.
    The unique qualities with the sheepskin mean that they can will keep your feet warm in the coldest of
    weather, but that if you use them in summer they won’t overheat your foot.

  18. We are a bunch of volunteers and opening a brand new scheme in our
    community. Your site offered us with useful info to work on.
    You’ve done an impressive task and our entire neighborhood shall be thankful to you.

  19. Thanks on your marvelous posting! I seriously enjoyed
    reading it, you can be a great author.I will always
    bookmark your blog and will come back later in life.
    I want to encourage you continue your great work,
    have a nice holiday weekend!
    My partner and I absolutely love your blog and find almost all
    of your post’s to be precisely what I’m looking for.

    can you offer guest writers to write content to suit your needs?
    I wouldn’t mind composing a post or elaborating on a few of the subjects you write related to here. Again, awesome web log!
    We stumbled over here different web address and thought I should check things out. I like what I see so i am just following you. Look forward to looking at your web page for a second time.
    I love what you guys are up too. Such clever work and reporting! Keep up the superb works guys I’ve incorporated you guys to blogroll.

    Hey there I am so glad I found your weblog, I really found you by mistake,
    while I was searching on Yahoo for something else, Anyhow I am here now
    and would just like to say thank you for a marvelous
    post and a all round enjoyable blog (I also love the theme/design), I
    don’t have time to read it all at the moment but I have book-marked it and also
    added in your RSS feeds, so when I have time I will be back to read a lot more,
    Please do keep up the great work.
    Admiring the time and effort you put into your website and detailed
    information you offer. It’s good to come across a blog every once in a while that isn’t the same
    out of date rehashed information. Great read! I’ve bookmarked your site and I’m adding your RSS feeds to my Google account.

    Greetings! I’ve been reading your weblog for some time now and finally got the courage to go ahead and give you a shout out from Houston Texas! Just wanted to say keep up the fantastic work!
    I’m really enjoying the theme/design of your blog.
    Do you ever run into any browser compatibility issues?
    A handful of my blog visitors have complained about my
    blog not working correctly in Explorer but looks great
    in Opera. Do you have any recommendations to help fix this problem?

    I’m curious to find out what blog platform you are working with? I’m
    having some minor security issues with my latest blog and I
    would like to find something more safe. Do you have any suggestions?

    Hmm it looks like your blog ate my first comment (it was super long) so I guess I’ll just sum it up what I had written and say, I’m thoroughly enjoying
    your blog. I too am an aspiring blog writer but I’m still new to everything. Do you have any tips and hints for first-time blog writers? I’d certainly appreciate it.

    Woah! I’m really loving the template/theme of this site. It’s
    simple, yet effective. A lot of times it’s hard to get that “perfect balance” between user friendliness and visual appeal. I must say that you’ve done a excellent job with this.
    Additionally, the blog loads super quick for me on Firefox.
    Excellent Blog!
    Do you mind if I quote a couple of your articles as long as
    I provide credit and sources back to your weblog?
    My blog is in the exact same niche as yours and
    my visitors would truly benefit from a lot of the information you provide here.
    Please let me know if this ok with you. Thanks!
    Hi would you mind letting me know which web host you’re working with? I’ve
    loaded your blog in 3 completely different internet browsers and I must say this blog loads a lot faster then most.

    Can you recommend a good internet hosting provider at
    a reasonable price? Many thanks, I appreciate it!

    Awesome website you have here but I was wondering if you
    knew of any user discussion forums that cover the same topics discussed here?
    I’d really love to be a part of community where I can get advice from other experienced individuals that share the same interest. If you have any suggestions, please let me know. Thanks!
    Hey there! This is my first comment here so I just wanted to give a quick shout out and tell you I really enjoy reading through your posts. Can you recommend any other blogs/websites/forums that cover the same subjects? Thank you so much!
    Do you have a spam issue on this blog; I also am a blogger, and I was wanting to know your situation; we have created some nice methods and we are looking to trade solutions with others, why not shoot me an email if interested.
    Please let me know if you’re looking for a
    author for your site. You have some really good posts and I think I would be a good asset.
    If you ever want to take some of the load off,
    I’d love to write some material for your blog in exchange for a link back to mine. Please send me an email if interested. Thanks!
    Have you ever considered about adding a little bit more than just your articles? I mean, what you say is fundamental and all. Nevertheless just imagine if you added some great visuals or videos to give your posts more, “pop”! Your content is excellent but with images and videos, this site could certainly be one of the very best in its field. Terrific blog!
    Neat blog! Is your theme custom made or did you download it from somewhere? A theme like yours with a few simple adjustements would really make my blog stand out. Please let me know where you got your design. Bless you
    Hey would you mind sharing which blog platform you’re working with?
    I’m going to start my own blog soon but I’m having a hard time making a decision between BlogEngine/Wordpress/B2evolution
    and Drupal. The reason I ask is because your layout seems different then most blogs
    and I’m looking for something unique. P.S Apologies for being off-topic but I had to ask!
    Hi there just wanted to give you a quick heads up. The words in your post seem to be running off the screen in Chrome. I’m not sure if this
    is a formatting issue or something to do with internet browser
    compatibility but I figured I’d post to let you know. The design look great though! Hope you get the problem solved soon. Thanks
    With havin so much content do you ever run into any problems of plagorism or copyright violation? My site has a lot of exclusive content I’ve either created myself or outsourced but it appears a lot of it
    is popping it up all over the web without my agreement.
    Do you know any methods to help stop content from being ripped off?
    I’d really appreciate it.
    Have you ever thought about publishing an ebook or guest authoring on other blogs? I have a blog based upon on the same ideas you discuss and would really like to have you share some stories/information. I know my audience would enjoy your work. If you are even remotely interested, feel free to shoot me an e mail.
    Hello! Someone in my Facebook group shared this website with us so I came to check it out. I’m definitely enjoying the information.
    I’m book-marking and will be tweeting this to my followers! Exceptional blog and fantastic design and style.
    Amazing blog! Do you have any tips and hints for aspiring writers? I’m hoping to start my own site soon but I’m a little lost on everything. Would you recommend starting with a free platform like WordPress or go for a paid option? There are so many options out there that I’m completely overwhelmed .
    . Any ideas? Kudos!
    My coder is trying to convince me to move to .net from PHP.
    I have always disliked the idea because of the costs.
    But he’s tryiong none the less. I’ve been using WordPress on various websites
    for about a year and am anxious about switching to
    another platform. I have heard great things about blogengine.
    net. Is there a way I can transfer all my wordpress content into
    it? Any kind of help would be greatly appreciated!
    Does your site have a contact page? I’m having problems locating it but, I’d like to
    send you an e-mail. I’ve got some ideas for your blog you might be interested in hearing. Either way, great website and I look forward to seeing it expand over time.
    It’s a pity you don’t have a donate button! I’d definitely donate to
    this outstanding blog! I guess for now i’ll settle for bookmarking and adding your RSS feed to my Google account. I look forward to brand new updates and will share this website with my Facebook group. Chat soon!
    Greetings from Idaho! I’m bored to tears at work so I decided to browse your blog on my iphone during
    lunch break. I love the knowledge you provide here and can’t wait to take a look when I get home. I’m
    surprised at how fast your blog loaded on my phone .. I’m not even using WIFI, just 3G .. Anyhow, fantastic site!
    Hey there! I know this is kinda off topic but I’d figured I’d ask. Would you be interested in exchanging links or maybe guest authoring a blog post or vice-versa? My website goes over a lot of the same topics as yours and I feel we could greatly benefit from each other. If you’re interested feel free
    to shoot me an e-mail. I look forward to hearing from you!
    Wonderful blog by the way!
    Currently it seems like Drupal is the best blogging platform out
    there right now. (from what I’ve read) Is that what you’re using on your
    blog?
    Outstanding post but I was wondering if you could
    write a litte more on this topic? I’d be very thankful if you could elaborate a little bit more. Kudos!
    Howdy! I know this is kind of off topic but I was wondering if you knew where I could locate a captcha plugin for my comment form? I’m using the same blog platform as yours and I’m having trouble finding one? Thanks a lot!
    When I initially commented I clicked the “Notify me when new comments are added” checkbox and now each time a comment is added I get four e-mails with the same comment. Is there any way you can remove people from that service? Bless you!
    Hello there! This is my first visit to your blog! We are a team of volunteers and starting a new project in a community in the same niche. Your blog provided us beneficial information to work on. You have done a marvellous job!
    Good day! I know this is kinda off topic but I was wondering which blog platform are you using for this website? I’m getting sick and tired of WordPress because
    I’ve had issues with hackers and I’m looking at options for another
    platform. I would be great if you could point me in the direction of a good platform.

    Hey there! This post could not be written any better!
    Reading this post reminds me of my old room mate! He always kept chatting about this.
    I will forward this article to him. Pretty sure he will have a good read.
    Thank you for sharing!
    Write more, thats all I have to say. Literally,
    it seems as though you relied on the video to make your point.
    You obviously know what youre talking about, why throw
    away your intelligence on just posting videos to your site when you could be giving us something
    enlightening to read?
    Today, I went to the beach with my kids. I found a sea shell and gave it to my 4 year
    old daughter and said “You can hear the ocean if you put this to your ear.”
    She placed the shell to her ear and screamed. There was a hermit crab inside and it pinched her ear.

    She never wants to go back! LoL I know this is entirely off topic
    but I had to tell someone!
    Today, while I was at work, my sister stole my apple ipad and tested to see if it can survive a twenty five foot drop, just so she can be a youtube sensation.

    My apple ipad is now broken and she has 83 views.
    I know this is completely off topic but I had to share it with
    someone!
    I was curious if you ever thought of changing the layout of your website?

    Its very well written; I love what youve got to say. But maybe you could
    a little more in the way of content so people could connect with it better.
    Youve got an awful lot of text for only having 1 or two pictures.

    Maybe you could space it out better?
    Hi there, i read your blog occasionally and i own a similar one
    and i was just wondering if you get a lot of spam feedback?
    If so how do you protect against it, any plugin or anything you can recommend?

    I get so much lately it’s driving me insane so any help is very much appreciated.
    This design is steller! You definitely know how to keep a reader amused. Between your wit and your videos, I was almost moved to start my own blog (well, almost…HaHa!) Excellent job. I really loved what you had to say, and more than that, how you presented it. Too cool!
    I’m really enjoying the design and layout of your website.
    It’s a very easy on the eyes which makes it much more enjoyable for me to come here and visit more often. Did you hire out a designer to create your theme? Outstanding work!
    Hey! I could have sworn I’ve been to this site before but after reading through some
    of the post I realized it’s new to me. Nonetheless, I’m definitely delighted I found it and I’ll be book-marking and checking back frequently!
    Hello there! Would you mind if I share your blog with my zynga group? There’s a lot of people that I think would really enjoy your
    content. Please let me know. Thanks
    Hey, I think your blog might be having browser compatibility issues.
    When I look at your blog in Firefox, it looks fine
    but when opening in Internet Explorer, it has some overlapping.
    I just wanted to give you a quick heads up! Other then that, fantastic blog!

    Wonderful blog! I found it while surfing around on Yahoo News.
    Do you have any suggestions on how to get listed in Yahoo News?

    I’ve been trying for a while but I never seem to get there! Appreciate it
    Good day! This is kind of off topic but I need some guidance from an established blog. Is it tough to set up your own blog? I’m not very techincal but I can figure
    things out pretty quick. I’m thinking about creating my own but I’m not
    sure where to begin. Do you have any points or
    suggestions? Appreciate it
    Howdy! Quick question that’s totally off topic. Do you know how to make your site mobile friendly? My blog looks weird when browsing from my apple iphone. I’m trying to find a template or plugin that might be able to resolve this issue.
    If you have any suggestions, please share. Thank you!
    I’m not that much of a online reader to be honest but your blogs
    really nice, keep it up! I’ll go ahead and bookmark your site to come back down the road. Many thanks
    I love your blog.. very nice colors & theme. Did you design this website yourself or did you hire someone to do it for you? Plz reply as I’m looking to construct my own blog and would like to know where u got this from.
    cheers
    Amazing! This blog looks just like my old one!

    It’s on a totally different subject but it has pretty much the same layout and design. Wonderful choice of colors!
    Hi there just wanted to give you a brief heads up and let you know a few of the pictures aren’t loading properly.

    I’m not sure why but I think its a linking issue. I’ve tried it
    in two different internet browsers and both show the same outcome.

    Howdy are using WordPress for your blog platform? I’m new to the blog world but I’m
    trying to get started and create my own. Do
    you need any coding knowledge to make your own blog?
    Any help would be greatly appreciated!
    Howdy this is kinda of off topic but I was wondering if blogs use WYSIWYG editors or if you have to manually code with
    HTML. I’m starting a blog soon but have no coding knowledge so I wanted to get guidance from someone with experience. Any help would be enormously appreciated!
    Hi there! I just wanted to ask if you ever have any trouble with hackers? My last blog (wordpress) was hacked and I ended up losing several weeks of hard work due to no backup. Do you have any methods to protect against hackers?
    Hi! Do you use Twitter? I’d like to follow you if that would be okay.

    I’m absolutely enjoying your blog and look forward to new updates.
    Hi there! Do you know if they make any plugins to safeguard against hackers? I’m kinda paranoid about losing everything
    I’ve worked hard on. Any recommendations?
    Good day! Do you know if they make any plugins to assist with SEO? I’m trying
    to get my blog to rank for some targeted keywords but I’m not seeing very good results. If you know of any please share. Thank you!
    I know this if off topic but I’m looking into starting my own blog and was
    curious what all is needed to get setup? I’m assuming having a blog like yours would cost a pretty penny? I’m
    not very internet smart so I’m not 100% sure. Any tips or advice would be greatly appreciated. Many thanks
    Hmm is anyone else encountering problems with the images on this blog loading? I’m trying to figure out if
    its a problem on my end or if it’s the blog. Any feedback would be greatly appreciated.
    I’m not sure exactly why but this blog is loading extremely slow for me.
    Is anyone else having this problem or is it a issue on my end?
    I’ll check back later on and see if the problem still exists.
    Hi there! I’m at work browsing your blog from my new iphone!

    Just wanted to say I love reading your blog and look forward
    to all your posts! Carry on the excellent work!
    Wow that was unusual. I just wrote an very long comment but after I clicked submit my comment didn’t show up. Grrrr… well I’m not writing
    all that over again. Anyway, just wanted to say fantastic
    blog!

  20. Hola Marcos! Es posible ampliar el permiso de leer por contribuyente? En la descripción plugin que describe esta función, pero cuando el usuario ápice este papel puede tratar de acceder a la página que recibe este error:

    El documento de ayuda solicitada no se pudo encontrar.

  21. The New Gucci Jackie Shoulder Huge Purse has a rugged traditional leather layout with an captivating type.
    Jimmy Choo’s Spring Selection of designer purses features the very best leathers, classic types, fashionable hobos and sassy shoulder baggage. As a result, you can conveniently have close to the frequent vital things in a leather-based bag devoid of any issue.

  22. Outstanding post but I was wondering if you could
    write a litte more on this topic? I’d be very thankful if you could elaborate a little bit more. Kudos!
    Howdy! I know this is kind of off topic but I was wondering if you knew where I could locate a captcha plugin for my comment form? I’m using the same blog platform as yours and I’m having trouble finding one? Thanks a lot!
    When I initially commented I clicked the “Notify me when new comments are added” checkbox and now each time a comment is added I get four e-mails with the same comment. Is there any way you can remove people from that service? Bless you!

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s