Good, but needs better (or any) user instructions

  • This works fine. However, it’s not obvious how to use it, and the sum total of usage instructions on the developer site is as follows:
    —
    Usage:
    Place the shortcode at the end.

    If you want the comment-out text to be enclosed in HTML comment syntax (the default), set the “type” attribute to “html”, or just leave out the “type” attribute altogether. If you want the commented-out text to be removed completely from the browser’s “View Source” window, set the “type” attribute to “hidden”.
    —
    Yes – what shortcode?? At the end of what??

    Fortunately, I found this on the www.ads-software.com page for the plugin:
    Simply place the opening shortcode [comment] at the beginning of the text you wish to comment out, and the closing shortcode [/comment] at the end.

    It’s not enough for a plugin to work, it needs to be apparent to a non-techy user how to make it work – so docked one star for lack of user instructions.

    Otherwise, it does exactly what it says and is very useful – thanks Tracy!

Viewing 2 replies - 1 through 2 (of 2 total)
  • Plugin Author Tracy Rotton

    (@taupecat)

    Noted, I will make an effort to clarify the usage instructions as soon as I get a chance.

    Thanks for the input!

    Plugin Author Tracy Rotton

    (@taupecat)

    Okay, I see what happened, and it seems as though I outsmarted myself. By actually using the square brackets, it was activating the plugin, and thus commenting out the text.

    When I first wrote that page, I must not have been using the plugin on my site, and then added it later without checking the page. D’oh!

    Anyway, it’s all fixed as you can see here: https://www.taupecat.com/wordpress-plugins/tc-comment-out

    Thanks for the catch, and you’re right to dock me a star for not checking my own site! ??

Viewing 2 replies - 1 through 2 (of 2 total)
  • The topic ‘Good, but needs better (or any) user instructions’ is closed to new replies.