{ "info": { "author": "Alexei Andrushievich", "author_email": "vint21h@vint21h.pp.ua", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Plugins", "Framework :: Django :: 2.2", "Framework :: Django :: 3.2", "Framework :: Django :: 4.0", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: Unix", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Topic :: Utilities" ], "description": ".. django-opensearch\n.. README.rst\n\n\nA django-opensearch documentation\n=================================\n\n|GitHub|_ |Coveralls|_ |pypi-license|_ |pypi-version|_ |pypi-python-version|_ |pypi-django-version|_ |pypi-format|_ |pypi-wheel|_ |pypi-status|_\n\n *django-opensearch is a Django reusable application to handle opensearch.xml*\n\n.. contents::\n\nInstallation\n------------\n* 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/.\n* Run ``$ python ./setup.py install`` from the repository source tree or unpacked archive. Or use pip: ``$ pip install django-opensearch``.\n\nConfiguration\n-------------\n* Add ``\"opensearch\"`` to ``settings.INSTALLED_APPS``.\n\n.. code-block:: python\n\n # settings.py\n\n INSTALLED_APPS += [\n \"opensearch\",\n ]\n\n* Add ``\"opensearch\"`` to your URLs definitions.\n\n.. code-block:: python\n\n # urls.py\n\n from django.urls import re_path\n\n\n urlpatterns += [\n re_path(r\"^opensearch/\", include(\"opensearch.urls\")),\n ]\n\nUsage\n-----\nLoad ``\"opensearch_tags\"`` to your base template and place opensearch rel meta tag to
HTML tag by calling ``{% opensearch_meta %}``.\n\n.. code-block:: django\n\n {# base.html #}\n\n {% load opensearch_tags %}\n\n \n {% opensearch_meta %}\n \n\nSettings\n--------\n``OPENSEARCH_CONTACT_EMAIL``\n Contains an email address at which the maintainer of the description document can be reached. Defaults to ``\"\"``.\n\n``OPENSEARCH_SHORT_NAME``\n Contains a brief human-readable title that identifies this search engine. Defaults to ``\"\"``.\n\n``OPENSEARCH_DESCRIPTION``\n Contains a human-readable text description of the search engine. Defaults to ``\"\"``.\n\n``OPENSEARCH_FAVICON_WIDTH``\n Contains width of an image that can be used in association with this search content. Defaults to ``16``.\n\n``OPENSEARCH_FAVICON_HEIGHT``\n Contains height of an image that can be used in association with this search content. Defaults to ``16``.\n\n``OPENSEARCH_FAVICON_TYPE``\n Contains mimetype of an image that can be used in association with this search content. Defaults to ``\"image/x-icon\"``.\n\n``OPENSEARCH_FAVICON_FILE``\n Contains a URL that identifies the location of an image that can be used in association with this search content. Defaults to ``\"favicon.ico\"``.\n\n``OPENSEARCH_SEARCH_URL``\n Contains a Django URL name to search content. Defaults to ``\"search\"``.\n\n``OPENSEARCH_SEARCH_QUERYSTRING``\n Contains the querystring to prepend to search parameter. Defaults to ``\"q=\"``.\n\n``OPENSEARCH_INPUT_ENCODING``\n Contains a string that indicates that the search engine supports search requests encoded with the specified character encoding. Defaults to ``\"UTF-8\"``.\n\nContributing\n------------\n1. `Fork it