Plugin Directory

Changeset 606627


Ignore:
Timestamp:
10/01/2012 06:01:45 PM (13 years ago)
Author:
bbuster79
Message:

update readme.txt

File:
1 edited

Legend:

Unmodified
Added
Removed
  • query-from-content-shortcode/tags/01/0.1/readme.txt

    r606221 r606627  
    1 Contributors: Brandon Buster
    2 Plugin Name: Query From Content Shortcode
    3 Tags: WP_Query, query, shortcode, related posts, custom query
    4 Author: Brandon Buster
     1=== Query From Content Shortcode ===
     2Contributors: Brandon Buster
     3Tags: WP_Query, query, shortcode, related posts, custom query, query shortcode
    54Requires at least: 3.0
    6 Stable: 0.1
     5Tested up to: 3.4.2
     6Stable tag: 0.1
     7License: GPLv2 or later
     8License URI: http://www.gnu.org/licenses/gpl-2.0.html
    79
     10Feature specific posts and categories inside your post-content
    811
    9 Setup:
     12== Description ==
    1013
    11 No additional setup or configuration is needed to use Query From Content. Just activate the plugin and use the QFC shortcode inside your posts and pages.
    12 
    13 
    14 
    15 
    16 Usage:
    17 
    18 QFC is a shortcode plugin that allows you to target exactly the posts you’re looking for and list them in your content. Further, you can specify your own list header,
    19 include your current CSS styles to format the search results, and even specify whether or not you want your results to display their thumbnails and excerpts.
     14QFC is a shortcode plugin that allows you to target exactly the posts you’re looking for and list them in your content. Further, you can specify your own list header, include your current CSS styles to format the search results, and even specify whether or not you want your results to display their thumbnails and excerpts.
    2015
    2116Basic format of the QFC shortcode should follow the example below:
     
    2318[qfc]A Basic Header[/qfc]
    2419
    25 The above example defaults to showing your five latest blog posts, no styling, no excerpt, no featured image. To customize your results, we can tell QFC to add
    26 some CSS and the images and excerpts we’ve been talking about. That shortcode should be placed inside your post content like so:
     20The above example defaults to showing your five latest blog posts, no styling, no excerpt, no featured image. To customize your results, we can tell QFC to add some CSS and the images and excerpts we’ve been talking about. That shortcode should be placed inside your post content like so:
    2721
    2822[qfc class=”my-css-class” id=”my-css-id” image=”yes” excerpt=”yes”]Some Bells & Whistles[/qfc]
    2923
    30 Further, you can format your QFC search results with more than just one CSS class or ID: 
     24Further, you can format your QFC search results with more than just one CSS class or ID: 
    3125
    3226[qfc class=”my-css-class, another-css-class” id=”my-css-id, another-css-id”]We Like CSS![/qfc]
     
    3630Here’s another quick example. This one specifies a category, a tag and an author:
    3731
    38 [qfc category_name=”Italian-recipes” tag=”lasagna” author_name=”luigi”]Great Italian Recipes![/qfc]
     32[qfc category\_name=”Italian-recipes” tag=”lasagna” author\_name=”luigi”]Great Italian Recipes![/qfc]
    3933
    40 QFC reads the parameters above and feeds them to the WP_Query class. If you are familiar with the WP_Query class, you may’ve recognized the parameters used in the
    41 above QFC code match exactly the parameters used in WP_Query. All your QFC search parameters must match exactly with the WP_Query parameters.
     34QFC reads the parameters above and feeds them to the WP\_Query class. If you are familiar with the WP\_Query class, you may’ve recognized the parameters used in the above QFC code match exactly the parameters used in WP\_Query. All your QFC search parameters must match exactly with the WP\_Query parameters. 
    4235
     36For information on advanced usage of Query From Content, visit the Wordpress codex page for <a href=\"https://codex.wordpress.org/Class\_Reference/WP\_Query\">WP_Query</a>.
    4337
     38<div>
     39  <br />
     40</div>
    4441
    45 For information on advanced usage of Query From Content, visit the Wordpress codex page for WP_Query: https://codex.wordpress.org/Class_Reference/WP_Query
     42== Installation ==
     43
     44Extract the zip file and just drop the contents in the wp-content/plugins/ directory of your WordPress installation and then activate the Plugin from Plugins page.
     45
     46==Readme Generator==
     47
     48This Readme file was generated using <a href = 'http://sudarmuthu.com/wordpress/wp-readme'>wp-readme</a>, which generates readme files for WordPress Plugins.
Note: See TracChangeset for help on using the changeset viewer.