WordPress.org

Support

Support » Reviews » Useful for plugin documentation

Useful for plugin documentation

  • cubecolour
    Moderator

    @numeeja

    I included shortcode syntax on a post to document my tabby responsive tabs plugin using html entities for the square brackets so I could show shortcode syntax without the shortcodes being processed.

    Switching between the text editor to the visual editor caused the html entities to became converted into square brackets turning the example shortcodes into real shortcodes. These were converted into tabs by the tabby plugin turning my post into a confusing mess.

    I created this plugin to prevent this from happening again. The intention was to make a safe way to display example shortcode syntax on the frontend that will never be processed by WordPress.

    There is documentation on the codex which outlines the double bracket notation to enables shortcodes to be displayed, but the plugin may still be useful as it adds a span with a class that can be targeted in the stylesheet.

  • The topic ‘Useful for plugin documentation’ is closed to new replies.