Skip to content

Latest commit

 

History

History
162 lines (110 loc) · 5.87 KB

README.md

File metadata and controls

162 lines (110 loc) · 5.87 KB
Raw

TecArt GmbH

TecArt Search Plugin

This README.md file should be modified to describe the features, installation, configuration, and general usage of the plugin.

The Tec Art Search Plugin is an extension for Grav CMS. Search Grav Pages in Frontend. Search based on jQuery. Useful for static websites when webserver does not support PHP. When typing into searchbox autosuggestion the results are shown in a livesearch layer. There is no extra result page for all pages with that content. you can directly click one of the pages in a search result layer.

Searchword / string is searched in title and content of pages.

Screenshot

Screenshot

Required

  • jQuery

Installation

Installing the TecArt Search plugin can be done in one of three ways: The GPM (Grav Package Manager) installation method lets you quickly install the plugin with a simple terminal command, the manual method lets you do so via a zip file, and the admin method lets you do so via the Admin Plugin.

GPM Installation (Preferred)

To install the plugin via the GPM, through your system's terminal (also called the command line), navigate to the root of your Grav-installation, and enter:

bin/gpm install tecart-search

This will install the TecArt Search plugin into your /user/plugins-directory within Grav. Its files can be found under /your/site/grav/user/plugins/tecart-search.

Manual Installation

To install the plugin manually, download the zip-version of this repository and unzip it under /your/site/grav/user/plugins. Then rename the folder to tecart-search. You can find these files on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/tecart-search

NOTE: This plugin is a modular component for Grav which may require other plugins to operate, please see its blueprints.yaml-file on GitHub.

Admin Plugin

If you use the Admin Plugin, you can install the plugin directly by browsing the Plugins-menu and clicking on the Add button.

Configuration

Before configuring this plugin, you should copy the user/plugins/tecart-search/tecart-search.yaml to user/config/plugins/tecart-search.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true
quick_tray: true
quick_tray_permissions:
    - admin.login
    - admin
    - admin.super
includes_jquery: false
searchbox_placeholder: 'TecArt Website durchsuchen!'
index_storage: pages
searchresult_target: _blank
searchresult_path: relative
searchresult_headline: 'Treffer:'
searchresult_empty: 'Leider keine Ergebnisse.'

Plugin settings in Grav backend

Plugin Settings

Page option settings

Search option pages

Exclude pages from index

In options tab of page settings you can set option to ignore page from search.

Set higher priority in search result

In options tab of page settings you can set if page has a higher priority in search result list. List items are sorted by this field (true/false) descending.

Indexing

By click on the Create Search Index button in plugin settings an index file with all searchable pages is created. Only pages with $page->routable() and $page->published() are included.

[
  {
    "title": "Software f\u00fcr IT-Dienstleister",
    "metadata": {
      "description": "Optimieren Sie Ihre IT-Dienstleistungen mit unserem ma\u00dfgeschneiderten ERP f\u00fcr Dienstleister."
    },
    "content": "Kundenbeziehungen st\u00e4rken mit dem TecArt Dienstleister-ERP",
    "route": "\/loesungen\/branchen\/it-dienstleister-und-systemhaeuser",
    "location": "http:\/\/172.17.0.2\/loesungen\/branchen\/it-dienstleister-und-systemhaeuser",
    "has_higher_priority": false
  },
  {
    "title": "Software f\u00fcr die \u00f6ffentliche Verwaltung",
    "metadata": {
      "description": "Entdecken Sie unsere ma\u00dfgeschneiderte Software f\u00fcr die \u00f6ffentliche Verwaltung. Wir helfen Beh\u00f6rden, effizienter zu arbeiten."
    },
    "content": "Made & Hosted in Germany: maximale Datensicherheit und Transparenz",
    "route": "\/loesungen\/branchen\/egovernment",
    "location": "http:\/\/172.17.0.2\/loesungen\/branchen\/egovernment",
    "has_higher_priority": false
  },
  {
    "title": "Softwareeinf\u00fchrung",
    "metadata": {
      "description": "Optimieren Sie Gesch\u00e4ftsprozesse mit TecArt: CRM, Projektmanagement und mehr. Entdecken Sie unsere ma\u00dfgeschneiderten Softwarel\u00f6sungen auf www.tecart.de."
    },
    "content": "CRM Einf\u00fchrung, Projektplanung und Implementierung.",
    "route": "\/infos\/whitepaper-und-checklisten\/softwareeinfuehrung",
    "location": "http:\/\/172.17.0.2\/infos\/whitepaper-und-checklisten\/softwareeinfuehrung",
    "has_higher_priority": false
  }
]

Ability to create the search index externally via cURL.

curl yourdomain.de/admin/plugins/tecart-search?tecartsearchindexer=create-extern

Usage

Describe how to use the plugin.

To put a searchbar in your theme eg. into header or sidebar, you have to include the searchbox partial. You can copy the twig file into your theme folder.

Plugin Path:

/your/site/grav/user/plugins/tecart-search/templates/partials/tecart-search-searchbox.html.twig

Theme Path Example:

/your/site/grav/user/themes/tecart-website-front/templates/partials/tecart-search-searchbox.html.twig

Code:

{% if config.plugins["tecart-search"]["enabled"] %}
{% include 'partials/tecart-search-searchbox.html.twig' %}
{% endif %}

To Do

  • Multilanguage support

Known Issues

  • N/A