Code Monkey home page Code Monkey logo

django-opensearch's Introduction

A django-opensearch documentation

Travis_ Coverage_ Codacy_ Requires_ pypi-license_ pypi-version_ pypi-python-version_ pypi-django-version_ pypi-format_ pypi-wheel_ pypi-status_

django-opensearch is a django reusable application to handle opensearch.xml

Installation

  • Obtain your copy of source code from the git repository: git clone https://github.com/vint21h/django-opensearch.git. Or download the latest release from https://github.com/vint21h/django-opensearch/tags/.
  • Run python ./setup.py install from repository source tree or unpacked archive. Or use pip: pip install django-opensearch.

Configuration

  • Add "opensearch" to settings.INSTALLED_APPS.
# settings.py

INSTALLED_APPS += (
    "opensearch",
)
  • Add "opensearch" to your URLs definitions.
# urls.py

urlpatterns += [
    url(r"^opensearch/", include("opensearch.urls")),
]

Usage

Load "opensearch_tags" to your base template and place opensearch rel meta tag to <head> HTML tag by calling {% opensearch_meta %}.

{# base.html #}

{% load opensearch_tags %}

<head>
    {% opensearch_meta %}
</head>

django-opensearch settings

OPENSEARCH_CONTACT_EMAIL

Contains an email address at which the maintainer of the description document can be reached. Defaults to "".

OPENSEARCH_SHORT_NAME

Contains a brief human-readable title that identifies this search engine. Defaults to "".

OPENSEARCH_DESCRIPTION

Contains a human-readable text description of the search engine. Defaults to "".

OPENSEARCH_FAVICON_WIDTH

Contains width of an image that can be used in association with this search content. Defaults to 16.

OPENSEARCH_FAVICON_HEIGHT

Contains height of an image that can be used in association with this search content. Defaults to 16.

OPENSEARCH_FAVICON_TYPE

Contains mimetype of an image that can be used in association with this search content. Defaults to "image/x-icon".

OPENSEARCH_FAVICON_FILE

Contains a URL that identifies the location of an image that can be used in association with this search content. Defaults to "favicon.ico".

OPENSEARCH_SEARCH_URL

Contains a django URL name to search content. Defaults to "search".

OPENSEARCH_SEARCH_QUERYSTRING

Contains the querystring to prepend to search parameter. Defaults to "q=".

OPENSEARCH_INPUT_ENCODING

Contains a string that indicates that the search engine supports search requests encoded with the specified character encoding. Defaults to "UTF-8".

Licensing

django-opensearch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. For complete license text see COPYING file.

Contacts

Project Website: https://github.com/vint21h/django-opensearch/

Author: Alexei Andrushievich <[email protected]>

For other authors list see AUTHORS file.

django-opensearch's People

Contributors

vint21h avatar ercpe avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.