WP Boilerplate Shortcode

1. 

   Editing Boilerplates in the WordPress admin.

2. 

   The example "Copyright" boilerplate with shortcode attribute callouts.

3. 

   Inserting the "Copyright" shortcode into a post.

4. 

   Output of the "Copyright" shortcode on the web.

5. 

   Use of the_boilerplate() template tag.

6. 

   The example "Payment Terms" boilerplate for reference.

7. 

   Inserting the "Payment Terms" shortcode into a post using most of the shortcode's attributes.

8. 

   Output of the "Payment Terms" shortcode on the web.

Where do add/edit my boilerplates?

Look on the left sidebar in your WordPress admin after you’ve activated the plugin for a menu called “Boilerplates.”

Can you give me examples of using the shortcode?

Sure. Here are some simple examples:

•  [boilerplate bytitle="Payment Terms"]

•  [boilerplate bypath="copyright"]

•  [boilerplate byid="971"]

Here are some more complex examples:

•  [boilerplate bytitle="Payment Terms" showtitle="true" title="Terms for Payment" titletag="strong" id="terms"]

•  [boilerplate bypath="copyright" class="boilerplate copyright"]

Where do I type the shortcode?

Type the shortcode into the body of any page, of any post, or of any custom post type where you want the boilerplate processed.

Does this plugin provide a boilerplate template tag?

Yes:

1. the_boilerplate('contact-methods'); // 'contact-methods' = the path of the boilerplate.

2. the_boilerplate('Contact Methods','title'); // 'Contact Methods' = the title of the boilerplate.

3. the_boilerplate(123,'id',array('showtitle'=>'true')); // 123 = boilerplate's post ID.

The array parameter in example #3 can contain any of these attributes

After Adding/Editing a Boilerplate if I click “View” I get an error. Why?

If you are still getting this error it’s because WordPress still hasn’t addressed this problem.

We decided to disallow boilerplates to be seen directly via a URL and as such when you try to view them WordPress tell you you cannot see it.

An example URL that you might see (assuming you were on the domain example.com and had a boilerplate called “Copyright“) might be as follows:

 http://example.com/boilerplates/copyright/

This URL will not work because boilerplates do not get a page of their own.

Hopefully WordPress will address this soon and you’ll be able to view your boilerplates from within the admin console.

What’s the syntax for the shortcode/template tag?

If you are into things from a technical persective it looks like this (angles <> indicate placeholders, a vertical bar | indicates “or“, elipsees indicate one or more, parens indicate grouping, and braces {} indicate optional):

• Shortcode:

  [boilerplate (bytitle|bypath|byid)="(||)"
     {showtitle="(true|false)"} {title=""} {titletag=""}
     {id=""} {class="}]

For the template tag the parens are not needed for grouping and the square brackets indicate optional, which is what most docs use for optional, when it doesn’t conflict with actual syntax:

• Template Tag:

  the_boilerplate(|| [, 'path'|'title'|'id']
     [, array(['showtitle'=> 'true'|false',] ['title' => '',]
     ['titletag' => '',] ['id' => '',] ['class' => '',] ));

1.0.2

• Screenshots!

1.0.1

• Added the_boilerplate() template tag.
• Restructured readme.txt and added FAQ items and more detailed installation instructions.
• Moved code structure to an encapsulated WPBoilerplateShortcode class with class methods instead independent functions.

1.0

• Initial release.