Pico-Search/README.md

Pico-Search

A plugin for the flat file CMS Pico. Allows you to create a very basic search form that searches through titles and content of your pages. The search results page filters the pages array to only contain pages matching the search terms.

You can optionally scope the search to only get results from within a certain folder. For example, on the page yoursite.com/blog/search/foobar, the pages array will only contain results from pages in the blog folder.

Search results can be paginated using a plugin such as Pico-Pagination. The search plugin should be executed before the pagination plugin (execution order is determined by file name).

Installation

• Copy the file 40-PicoSearch.php to the plugins sub-folder of your Pico installation directory.

• Add a file named search.md to your content root or the sub-folder you want to make searchable. This is your search results page. You can leave it empty of content, but set the Template meta tag to a template that loops through the pages and displays them. Your search.md might look like this:

  /*
  Title: Search results
  Template: search
  */
  

• Add a template file with the name defined in search.md. Your template file (search.html in the above example) should contain something like the following section, which lists the pages matching the search (substitute paged_pages for pages if using Pico-Pagination):

  <div class="SearchResults">
      {% if pages %}
          {% for page in pages %}
              <div class="SearchResult">
                  <h2><a href="{{ page.url }}">{{ page.title }}</a></h2>
                  {% if page.description %}<p>{{ page.description }}</p>{% endif %}
              </div>
          {% endfor %}
      {% else %}
          <p>No results found.</p>
      {% endif %}
  </div>
  

Now, you should be able to visit for example yoursite.com/search/foobar (adjust path accordingly if putting search.md in a sub-folder) and see the search results for "foobar" listed.

The search form

How to design your search form is up to you, but here's a very rudimentary example which you can put either in a template file or on a specific page.

<form id="search_form" action="/search">
    <label for="search_input">Search the site:</label>
    <input type="search" id="search_input" name="q" />
    <input type="submit" value="Search" />
</form>
<script type="text/javascript">
    // Intercept form submit and go to the search results page directly, avoiding a redirect
    document.getElementById('search_form').addEventListener('submit', function (e) {
        var search_terms = document.getElementById('search_input').value;
        location.href = '/search/' + encodeURIComponent(search_terms);
        e.preventDefault();
    });
</script>

Configuration options

You can exclude certain pages from being included in the search results by using the configuration option search_excludes. Set it to an array of pages you'd like to exclude, where each page is specified as its path relative to the content root:

$config['search_excludes'] = ['search', 'some/other/page'];