WordPress.org
Get WordPress

Plugin Directory

Changeset 1184784


Ignore:
Timestamp:
06/20/2015 03:47:02 PM (11 years ago)
Author:
nphaskins
Message:

go 0.8

Location:
wp-search-live
Files:
30 added
1 edited

Legend:

Unmodified
Added
Removed

  • wp-search-live/trunk/README.txt

    r1183875 r1184784  
    66Requires at least: 3.5.1
    77Tested up to: 4.2.1
    8 Stable tag: 0.7.1
     8Stable tag: 0.8
    99License: GPLv2 or later
    1010License URI: http://www.gnu.org/licenses/gpl-2.0.html
    … …  
    1414== Description ==
    1515
    16 WP Live Search is a search plugin for WordPress that returns results as the user types for what they are looking. It supports posts, pages and custom post types.   
     16WP Live Search (beta) is a search plugin for WordPress that returns results as the user types for what they are looking. It currently supports posts, pages, post types, including multiple post types, and design modes. 
    1717
    1818This is very much a working prototype, so please log any issues you find on the Github repo below. 
     19[https://github.com/bearded-avenger/wp-live-search](https://github.com/bearded-avenger/wp-live-search) 
    1920
    20 [https://github.com/bearded-avenger/wp-live-search](https://github.com/bearded-avenger/wp-live-search) 
     21Here's some documentation. 
     22[http://bearded-avenger.github.io/wp-live-search/](http://bearded-avenger.github.io/wp-live-search/) 
    2123
    2224Add the shortcode `[wp_live_search]` to a page or something. There's a few shortcode attributes that you can use, and are as follows: 
    2325
    24 type=“”  
     26type="" 
    2527Your choices are `posts` or `pages`. Defaults to `posts`. You can also pass `type,type` to search multiple post types. For example type="recipes,books"
    2628
    27 multi=“”  
     29multi="" 
    2830By default this is turned off. Set this to true only if you're using multiple post types above.
    2931
    30 placeholder=“” 
     32placeholder="" 
    3133The text displayed in the input. Defaults to `Search...`.
    3234
    33 results=“” 
     35number="" 
     36Total search result to return. Default is 20
     37
     38excerpt="true" 
     39Show the excerpt along with the title and featured image (if set)
     40
     41compact="true" 
     42Makes a tiny WP Live Search for use in header widgets and such
     43
     44dropdown="true" 
     45Display search results as a drop-down instead of pushing down the content around it
     46
     47results="" 
    3448The text displayed for the results. Defaults to `entries found`.
    3549
    36 number=""   
    37 Total search result to return. Default is 20
     50results_style="inside" 
     51Displays the "entries found" inside of the input area, useful for using in areas like header widgets where space is minimal.
    3852
    39 compact="true"   
    40 Makes a tiny WP Live Search for use in header widgets and such
    41 
    42 target=""   
     53target="" 
    4354An optional target UL parent to send the search results to. Example `target="#someotherdiv"`.
    4455
     56---
     57
     58Here are a couple examples:
     59
     60Default Usage: 
     61`[wp_live_search]`
     62
     63Use in Header Widget: 
     64`[wp_live_search compact="true" dropdown="true" results="found" results_style="inside"]`
     65
     66Search through multiple post types: 
     67`[wp_live_search multi="true" type="posts,page"]`
    4568
    4669== Installation ==
    … …  
    7194
    7295= Does it support showing content? =
    73 Not yet
     96Yes
    7497
    7598= Does it support custom post types? =
    … …  
    77100
    78101= Can I use multiple on one page? =
    79 No.
     102No
    80103
    81104= Can I disable the style sheet from loading? =
    82 Yes just use `define('WPLS_DISABLE_STYLE', true)` and the CSS file will not load.
     105Yes just use `define('WPLS_DISABLE_STYLE', true)` and the CSS file will not load. However you will want to make sure you at least copy over .wpls--show and .wpls--hide. JS uses these classes for things and the search may not appear correctly without them.
     106
     107= Can I override the display item? =
     108Yep! Just copy over the function from underscore-template.php (without the function exists) and drop it into any plugin. Note, pluggable functions wont run in a theme file, themes run too late, so this needs to be in a plugin file. From here you can modify the temlate as needed.
    83109
    84110== Screenshots ==
    … …  
    87113
    88114== Changelog ==
     115
     116= 0.8 =
     117* added "dropdown" option mode for use in small spaces
     118* added "results_style" option for use in small spaces
     119* added "excerpt" option to show excerpt
     120* added five action hooks
    89121
    90122= 0.7.1 =
Note: See TracChangeset for help on using the changeset viewer.