Is there full documentation that includes actual shortcode or template examples?

  • Resolved DOnTheRiverC

    (@dontheriverc)


    10 years, 11 months ago

    Is there a page with full documentation for this plugin that includes examples for the shortcodes tags used etc.

    http://www.wpgeo.com/documentation/shortcodes

    The page above only contains the tags with no real detailed information on what the acceptable values are for shortcode parameters are and how they should be used. Think of it like the Bootstrap website it shows you exactly what you can use and how to use it with examples there.

    [wpgeo_mashup height=500px width=100%] etc…

    For example, I have been trying to do a very basic mashup map to show posts of a certain type:

    [wpgeo_mashup height=500px width=100% post_type=”Stores”]

    Which isn’t working but rather than being able to read through good quality documentation I have to put a post on this forum. I’m sure you can see how nonsensical this is and how irritating it is.

    http://wordpress.org/extend/plugins/wp-geo/

Viewing 2 replies - 1 through 2 (of 2 total)
  • FranceImage

    (@franceimage)

    10 years, 11 months ago

    Hi,

    Let me reword what you just wrote in a way you would answer the question if your were a (free) plugin developer:

    Hello,

    I’m trying to display a map with some custom posts.
    When I read your documentation, I think I should write

    [wpgeo_mashup height=500px width=100% post_type=”Stores”]

    I would expect to see my Stores but instead I see … (describe the result).

    Can you help me please

    Thanks

    And then, because you are treated with respect, you would answer …

    I think Stores is not the post_type name (it is a label instead)
    try with stores (caps off)

    If this does not work, you could look in the plugin that defines this post_type (look for a call to register_post_type())

    Plugin Author Ben Huson

    (@husobj)

    10 years, 11 months ago

    Please try @franceimage’s suggestion above and see if that works for you.

    Providing free support for a free plugin is in indeed a great deal of work.
    With that in mind I am aiming to move all the documentation for the plugin to GitHub where it should be possibly for the community to help improve documentation to make it more useful.

    Documentation will be moving to here as and when I can, or if other people are able to contribute to speed up the process.
    https://github.com/benhuson/WP-Geo/wiki

    Kind regards

    Ben

Viewing 2 replies - 1 through 2 (of 2 total)
  • The topic ‘Is there full documentation that includes actual shortcode or template examples?’ is closed to new replies.