Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
sewmyheadon committed Sep 26, 2013
1 parent 65f48b3 commit 7bb09cc
Showing 3 changed files with 78 additions and 58 deletions.
116 changes: 62 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Posts in Page #
**Contributors:** dgilfoy, ivycat, sewmyheadon
**Donate link:** http://www.ivycat.com/contribute/
**Tags:** shortcode, pages, posts, custom post types
**Requires at least:** 3.0
**Tested up to:** 3.5.2
**Stable tag:** 1.2.2
**License:** GPLv2 or later
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
=== Posts in Page ===
Contributors: sewmyheadon, ivycat, gehidore, dgilfoy
Donate link: http://www.ivycat.com/contribute/
Tags: shortcode, pages, posts, custom post types
Requires at least: 3.0
Tested up to: 3.5.1
Stable tag: 1.2.4
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Easily add one or more posts to any page using simple shortcodes.

## Description ##
== Description ==

Easily add one or more posts to any page using simple shortcodes.

@@ -24,7 +24,7 @@ This is a minimal plugin, function over form. If you would like to extend it, o

Give us feedback and contribute to this plugin on its [GitHub page](https://github.com/ivycat/Posts-in-Page)

## Installation ##
== Installation ==

You can install from within WordPress using the Plugin/Add New feature, or if you wish to manually install:

@@ -48,7 +48,7 @@ To 'pull' posts into a page, you can either:
* `[ic_add_posts showposts='5']` - limit number of posts (or override default setting)
* `[ic_add_posts orderby='title' order='ASC']` - orderby title - supports all WP orderby variables. Order is optional, WP default is 'DESC'.
* `[ic_add_posts category='category-slug']` - Show posts within a specific category. Uses slugs, can have multiple but separate by commas. category-1,category2, etc (no spaces.)
* `[ic_add_posts exclude_category'category-slug']` - Exclude posts within specific category. Uses slugs, can have multiple but seperate by commas. category-1,category2, etc (no spaces.)
* `[ic_add_posts exclude_category='category-slug']` - Exclude posts within specific category. Uses slugs, can have multiple slugs seperated by commas. category-1,category2, etc (no spaces.)
* `[ic_add_posts tag='tag-slug']` - Show posts using a specific tag. Like categories, it uses slugs, and can accommodate multiple tags separate by commas. tag-1,tag-2, etc (no spaces.)
* `[ic_add_posts tax='taxonomy' term='term']` - limit posts to those that exist in a taxonomy and have a specific term. Both are required for either one to work
* `[ic_add_posts template='template-in-theme-dir.php']` - In case you want to style your markup, add meta data, etc. Each shortcode can reference a different template. These templates must exist in the theme directory.
@@ -78,9 +78,9 @@ Alright, now lets say that you want to pull in all posts from two categories int
Now, you're ambitious and want to try something complex. Let's say you've got a page called _Plugins Are Awesome_ and, in it, you want to pull in posts that match the following criteria:

* posts from a custom post type called _Testimonials_,
* posts that are in the _Testimonial Type_ custom taxonomy using the term _Customer_
* posts that are in the _Testimonial Type_ custom taxonomy using the term _Customer_,
* you want to display six testimonials per page,
* you'd like them displayed in ascending order
* you'd like them displayed in ascending order,
* finally, you've created a custom template to use in presenting these posts and named it `my-posts-in-page-template.php`

Your shortcode might look like this:
@@ -93,122 +93,130 @@ If you'd like to use this plugin to pull posts directly into your theme's templa

`<?php echo do_shortcode("[shortcode]"); ?>`

## Frequently Asked Questions ##
== Frequently Asked Questions ==

### What is the point of this plugin? ###
= What is the point of this plugin? =

Some of our clients wanted to output some posts in a specific page without fiddling with templates.

This plugin goes well with our [Simple Page Specific Sidebars](http://wordpress.org/extend/plugins/page-specific-sidebars/) plugin, and gives you more granular control of sidebars on specific categories, post-types, etc.

### How do I change the output template ###
= How do I change the output template =

Simply copy the `posts_loop_template.php` to your theme directory and make changes as necessary.

You can even rename it - but make sure to indicate that in the shortcode using the `template='template_name.php'`.

You can even use different templates for each shortcode if you like.

### Does it work with custom post types? ###
= Does it work with custom post types? =

Absolutely.

### How about with custom taxonomies?
= How about with custom taxonomies?

You bet.
###
### Will it make me coffee?

= Will it make me coffee?

Not likely, but let us know if it does; then we'll know we have something special.
###
## Screenshots ##

###1. Embed a shortcode into a page and it will automatically pull in the post(s) you need.###
![Embed a shortcode into a page and it will automatically pull in the post(s) you need.](http://s.wordpress.org/extend/plugins/posts-in-page/screenshot-1.png)
== Screenshots ==

1. Embed a shortcode into a page and it will automatically pull in the post(s) you need.
2. Embed shortcodes directly in your template using `do_shortcode`.

###2. Embed shortcodes directly in your template using `do_shortcode`.###
![Embed shortcodes directly in your template using `do_shortcode`.](http://s.wordpress.org/extend/plugins/posts-in-page/screenshot-2.png)
== Changelog ==

= 1.2.4 =
* now you can set `more_tag=""` to remove the `[...] &hellip;` that unfortunetly shows up as `&hellip`

## Changelog ##
= 1.2.3 =
* Added minor doc tweaks.

### 1.2.2 ###
= 1.2.2 =
* Added pagination, tweaked to turn off by default.
* Bug fixes.

### 1.2.1 ###
= 1.2.1 =
* Added code to allow ignoring, or showing of sticky posts. By default, sticky posts are ignored, but can be re-enabled using the shortcode `[ic_add_posts ignore_sticky_posts='no']`.

### 1.2.0 ###
= 1.2.0 =
* Code maintenance to better comply with standards
* Added post pagination
* Plugin now honors default post reading settings under Settings/Reading in the WordPress Dashboard.
* Improved and simplified documentation.

### 1.1.1 ###
= 1.1.1 =
* Code maintenance, fix for category bug, also added ability for multiple post types per shortcode.

### 1.1.0 ###
= 1.1.0 =
* Code maintenance, squash non-critical debug notices.

### 1.0.10 ###
= 1.0.10 =
* Added check for published/private posts.

### 1.0.9 ###
= 1.0.9 =
* Fixed template bug introduced by comments.

### 1.0.8 ###
= 1.0.8 =
* Code cleanup & indentation
*** Added comments and notes to output template file:** `posts_loop_template.php`
* Added comments and notes to output template file: `posts_loop_template.php`

### 1.0.7 ###
= 1.0.7 =
* Added Help Page under Setting in WP Dashboard.

### 1.0.6 ###
= 1.0.6 =
* More plugin housekeeping.

### 1.0.4 ###
= 1.0.4 =
* Minor housekeeping, added author, updated readme.txt.

### 1.0.3 ###
= 1.0.3 =
* Added single post or specific post capabilities.

## Upgrade Notice ##
== Upgrade Notice ==

= 1.2.4 =
* Presentational fixes: clean up whitespace, extra tabs, add in customization of more tag.

= 1.2.3 =
* Housekeeping only; not urgent.

### 1.2.2 ###
= 1.2.2 =
* Small bug fixes for tags, pagination; not critical.

### 1.2.1 ###
= 1.2.1 =
* Small feature update, not critical.

### 1.2.0 ###
= 1.2.0 =
* Important feature update - please upgrade.

### 1.1.1 ###
= 1.1.1 =
* Small bug fix; please upgrade.

### 1.1.0 ###
= 1.1.0 =
* Code maintenance & housekeeping - non-critical update.

### 1.0.10 ###
= 1.0.10 =
* Added feature - non-critical update.

### 1.0.9 ###
= 1.0.9 =
* Fixed template bug - please update.

### 1.0.8 ###
= 1.0.8 =
* Added features and documentation - non-critical update.

### 1.0.7 ###
= 1.0.7 =
* Added Help Page - non-critical update.

### 1.0.6 ###
= 1.0.6 =
* Plugin housekeeping - non-critical update.

### 1.0.4 ###
= 1.0.4 =
* Minor housekeeping, added author, updated readme.txt. Non-critical update.

### 1.0.3 ###
= 1.0.3 =
* Added single post or specific post capabilities. Important feature.


2 changes: 1 addition & 1 deletion posts_in_page.php
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@
* Description: Easily add one or more posts to any page using simple shortcodes. Supports categories, tags, custom post types, custom taxonomies, and more.
* Author: IvyCat Web Services
* Author URI: http://www.ivycat.com
* version: 1.2.2
* version: 1.2.4
* License: GNU General Public License v2.0
* License URI: http://www.gnu.org/licenses/gpl-2.0.html
18 changes: 15 additions & 3 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
=== Posts in Page ===
Contributors: dgilfoy, ivycat, sewmyheadon
Contributors: sewmyheadon, ivycat, gehidore, dgilfoy
Donate link: http://www.ivycat.com/contribute/
Tags: shortcode, pages, posts, custom post types
Requires at least: 3.0
Tested up to: 3.5.1
Stable tag: 1.2.2
Stable tag: 1.2.4
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

@@ -48,7 +48,7 @@ To 'pull' posts into a page, you can either:
* `[ic_add_posts showposts='5']` - limit number of posts (or override default setting)
* `[ic_add_posts orderby='title' order='ASC']` - orderby title - supports all WP orderby variables. Order is optional, WP default is 'DESC'.
* `[ic_add_posts category='category-slug']` - Show posts within a specific category. Uses slugs, can have multiple but separate by commas. category-1,category2, etc (no spaces.)
* `[ic_add_posts exclude_category'category-slug']` - Exclude posts within specific category. Uses slugs, can have multiple but seperate by commas. category-1,category2, etc (no spaces.)
* `[ic_add_posts exclude_category='category-slug']` - Exclude posts within specific category. Uses slugs, can have multiple slugs seperated by commas. category-1,category2, etc (no spaces.)
* `[ic_add_posts tag='tag-slug']` - Show posts using a specific tag. Like categories, it uses slugs, and can accommodate multiple tags separate by commas. tag-1,tag-2, etc (no spaces.)
* `[ic_add_posts tax='taxonomy' term='term']` - limit posts to those that exist in a taxonomy and have a specific term. Both are required for either one to work
* `[ic_add_posts template='template-in-theme-dir.php']` - In case you want to style your markup, add meta data, etc. Each shortcode can reference a different template. These templates must exist in the theme directory.
@@ -128,6 +128,12 @@ Not likely, but let us know if it does; then we'll know we have something specia

== Changelog ==

= 1.2.4 =
* now you can set `more_tag=""` to remove the `[...] &hellip;` that unfortunetly shows up as `&hellip`

= 1.2.3 =
* Added minor doc tweaks.

= 1.2.2 =
* Added pagination, tweaked to turn off by default.
* Bug fixes.
@@ -171,6 +177,12 @@ Not likely, but let us know if it does; then we'll know we have something specia

== Upgrade Notice ==

= 1.2.4 =
* Presentational fixes: clean up whitespace, extra tabs, add in customization of more tag.

= 1.2.3 =
* Housekeeping only; not urgent.

= 1.2.2 =
* Small bug fixes for tags, pagination; not critical.

0 comments on commit 7bb09cc

Please sign in to comment.