ghost-ocular-implants v1.0.2

Ghost Ocular Implants Upgrade

Cost: 100 Mineral 100 Gas

Increases ghost sight range by 2 (to 11), making sight range greater than the nuke blast radius and allowing ghost to search for posts by title and tag names.

Usage

Above all you need to activate the public API by logging into the admin, then click on Labs, then click on public API. Follow these instructions for further info.

Now, you need to define some html markup, a form with an input element will do the trick.

    <form action="/">
        <input type="text" name="search" class="search" />
    </form>
    <ul id="results"></ul>

Then you need some javascript like:

    $('.search').ghostOcularImplants();

Et Voilà! You can now search through the post list and display results into a result box.

Options

You can customize certain parameters on how this plugin will behave:

Results

By default and as a fallback, the results are appended to a results element identified by id="results" or to the body but you better define a results box of your own. Create a results box like the example below

    <ul class="post-results"></ul>

Once you have to defined a searchbox, you can pass it by setting the name in the parameters.

    $('.search').ghostOcularImplants({results: '.post-results'});

Template

The default template is a list item with a link pointing to the post url, the post title, the post tags and the post date. You can have a custom template as well, and you can define the field outputs in àla handlebars fashion.

    {template: '<li>{{title}}</li>'}

This later will be replaced by the post title under a list item. You can have access to the response, if you further read the ghostapi-post response you can state what entities or properties you want to output in your template.

    {template: '<li>{{slug}} - {{title}} - {{author.name}}<li>'}

The above will output a list item with the post slug - the title - author name

About the {{tags}} entity: This 'special' entity will output the post tags automatically for you, so you need only to place the entity and done, all post tags will be shown separated by comma.

About the {{tags_class: prefix}} This 'special' entity will output the post tags separated by a space, you can define a prefix for the tag class. You can use it as follows:

    <div class="{{tags_class: tag-}}">

This above will output

    <div class="tag-insights tag-ghost tag-planes tag-honduras">

About the {{date: date format This 'special' entity will output the post date in a friendly way, as ghost blog stores the save date as string in javascript date format we can have access to it and modify it as we see fit, but this plugin has a more friendly way to present dates other than "2017-01-10T17:24:55.000Z". Now you can simply use:

    {template: '<li>{{title}} on: {{date: MM-DD-YYYY}}</li>'}

That above will output the post date in the MM-DD-YYYY format, sadfuly for now you can only use the following formats:

• MM-DD-YYYY
• MMM-DD-YYYY
• DD-MM-YYYY
• DD-MMM-YYYY
• YYYY-MM-DD
• YYYY-MMM-DD

and all the above with the two digit year format (YY).

About the {{time: time-format }} This 'special' entity will output the post time in a friendly way, this entity can be used in the same fashion as the date entity.

About the {{excerpt: words length }} This 'special' entity will output a post excerpt based on the post html, will display a defined word number. Easy as that!

    {template: '<li>{{title}} >> {{excerpt: 10}}</li>'}

This excerpt will have 10 words long from the begining of the post.

No results template

You can define a custom template when no results are found, you can set it by passing the following option:

    {noresults: '<p>Welp! No results, no fun!</p>'}

The above defines a custom message for the user, easy!

Hide Post Selector

Welp, its kinda ankward to present duplicated results on screen, that means that current visible post and posts in results will be mixed, making it a not clean solution. Now with the hidePostsSelector option you can easy tell the plugin which posts to hide, with a tiny catch, by adding in your CSS if not already two utility css classes:

    .visible {
      display: block; // or visibility: visible; height: auto;
    }
    .hidden {
      display: none; // or visibility: hidden; height: 0;
    }

Note: that those are the names coded in the plugin for the utility classes that the plugin will look for, they are quite common, I promise to add a option to further define your class names, if you don't feel their names :P

    {hidePostsSelector: '.hide-these'}

The above will search for .hide-these class and when the user is typing, the plugin + your utility classes will do the trick. Rememeber to add that class name to the posts in the theme templates. If you do not define any name it will search for ..post-wrap class, so please make sure this class name exists in the template.

Todos

• Write Tests
• Output debugging method
• More date formats
• Time entity

About

This plugin was written by me, willmer, if you have further comments reach me at @wubarahona. I hope you find this little plugin useful :) feel free to fork it and extend it.

License

GNU GENERAL PUBLIC LICENSE