Plugin Directory

Changeset 588145


Ignore:
Timestamp:
08/21/2012 02:35:50 AM (14 years ago)
Author:
ivycat
Message:

readme.txt beautification

File:
1 edited

Legend:

Unmodified
Added
Removed
  • posts-in-page/trunk/readme.txt

    r588140 r588145  
    88License: GPLv3 or later
    99License URI: http://www.gnu.org/licenses/gpl-3.0.html
     10
    1011==Short Description ==
    1112
     
    2728
    28291. Download the plugin.
    29 1. Upload the entire ic_posts_in_page directory to your plugins folder
     301. Upload the entire `ic_posts_in_page` directory to your plugins folder
    30311. Activate the plugin in your WordPress plugin page
    31321. Start embedding your posts in whatever pages you like.
     
    3536Shortcode usage:
    3637
    37 * [ic_add_posts]  - Add all posts to a page (limit to what number posts in WordPress is set to), essentially adds blog "page" to page.
    38 * [ic_add_posts post_type='post_type' ids='1,2,3'] - show posts with certain IDs (currently only one post type per category)
    39 * [ic_add_posts id='1'] - show a single post with the given ID ( must give post type if not post )
    40 * [ic_add_posts showposts='5'] - limit number of posts (or override default setting)
    41 * [ic_add_posts orderby='title' order='ASC'] - orderby title - supports all WP orderby variables.  Order is optional, WP default
    42 * [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.)
    43 * [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.)
    44 * [ic_add_posts post_type='post-type'] - Show posts that are a specific post type (only one post type right now)
    45 * [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
    46 * [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.
     38* `[ic_add_posts]`  - Add all posts to a page (limit to what number posts in WordPress is set to), essentially adds blog "page" to page.
     39* `[ic_add_posts post_type='post_type' ids='1,2,3']` - show posts with certain IDs (currently only one post type per category)
     40* `[ic_add_posts id='1']` - show a single post with the given ID ( must give post type if not post )
     41* `[ic_add_posts showposts='5']` - limit number of posts (or override default setting)
     42* `[ic_add_posts orderby='title' order='ASC']` - orderby title - supports all WP orderby variables.  Order is optional, WP default
     43* `[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.)
     44* `[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.)
     45* `[ic_add_posts post_type='post-type']` - Show posts that are a specific post type (only one post type right now)
     46* `[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
     47* `[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.
    4748
    4849Or any combination above.
     
    5051== Screenshots ==
    5152
    52 1. Embed a shortcode into a page and it'll automatically pull in the post(s) you need.
     531. Embed a shortcode into a page and it will automatically pull in the post(s) you need.
    5354
    5455== Frequently Asked Questions ==
Note: See TracChangeset for help on using the changeset viewer.