WordPress.org
Get WordPress

Plugin Directory

Changeset 643645


Ignore:
Timestamp:
12/23/2012 12:45:16 PM (13 years ago)
Author:
iTux
Message:

Updated the plugin documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • post-index/tags/0.7/readme.txt

    r643100 r643645  
    99License: GPLv2 or later
    1010
    11 Build an index of all posts found for a specific category and display it in any page or post.
     11Generates an index of your posts that can be used in any page or post.
    1212
    1313
    … …  
    1818***
    1919
    20 This plugin summarises all found blog posts added to a specific category and lists them alphabetically or grouped by the used subcategory. Additional custom fields could be used to display links to other pages or additional information to a post.
     20The plugin summarises all found blog posts added to a specific category or of a specific post type and lists them alphabetically or grouped by the used subcategory. Additional custom fields could be used to display links to other pages or additional information to a post.
    2121
    22 What comes next?
     22Upcoming features:
    2323
    24 * Additional text to a link from custom fields and an admin setting to change the link name
     24* Customisable templates for the index entries to add any additional information:
     25  * additional text
     26  * custom field values
     27  * subcategories
    2528* Or any idea, you post me :)
    2629
    … …  
    6164The base shortcode is `[post_index]`. You can add any of the following attributes to change the output of the index. There are some options which makes no sense to combine. For example to use the category and categoryslug attribute as they will both indicate which category has to be used.
    6265
    63 * **category**: Lists all entries that are in the given category, referenced by it's name.
    64 * **categoryslug**: Same as category but references by the slug.
     66* **category**: Lists all entries that are in the given category, searched by it's name.
     67* **categoryslug**: Same as category but searched by the slug.
    6568* **groupby**: Grouping as explaned in `How to change the grouping`
    6669* **post_type**: The index will be build for the given post type instead of the standard type `post`. Please see [WordPress Codex, Post Types](http://codex.wordpress.org/Post_Types "WordPress Codex, Post Types") for details.
Note: See TracChangeset for help on using the changeset viewer.