Skip to main content

django CMS page extension to handle sitemap customization

Project description

======================
djangocms-page-sitemap
======================

.. image:: https://img.shields.io/pypi/v/djangocms-page-sitemap.svg?style=flat-square
:target: https://pypi.python.org/pypi/djangocms-page-sitemap
:alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/dm/djangocms-page-sitemap.svg?style=flat-square
:target: https://pypi.python.org/pypi/djangocms-page-sitemap
:alt: Monthly downloads

.. image:: https://img.shields.io/pypi/pyversions/djangocms-page-sitemap.svg?style=flat-square
:target: https://pypi.python.org/pypi/djangocms-page-sitemap
:alt: Python versions

.. image:: https://img.shields.io/travis/nephila/djangocms-page-sitemap.svg?style=flat-square
:target: https://travis-ci.org/nephila/djangocms-page-sitemap
:alt: Latest Travis CI build status

.. image:: https://img.shields.io/coveralls/nephila/djangocms-page-sitemap/master.svg?style=flat-square
:target: https://coveralls.io/r/nephila/djangocms-page-sitemap?branch=master
:alt: Test coverage

.. image:: https://img.shields.io/codecov/c/github/nephila/djangocms-page-sitemap/develop.svg?style=flat-square
:target: https://codecov.io/github/nephila/djangocms-page-sitemap
:alt: Test coverage

.. image:: https://codeclimate.com/github/nephila/djangocms-page-sitemap/badges/gpa.svg?style=flat-square
:target: https://codeclimate.com/github/nephila/djangocms-page-sitemap
:alt: Code Climate

django CMS page extension to handle sitemap customization

Support Python version:

* Python 2.7, 3.3, 3.4, 3.5

Supported Django versions:

* Django 1.8 to 1.10

Supported django CMS versions:

* django CMS 3.2+


Features
--------

* Support for changefreq and priority customisation per-page
* Option to exclude a page from the Sitemap
* Values are cached
* django CMS toolbar integration


Quickstart
----------

* Install djangocms-page-sitemap::

pip install djangocms-page-sitemap

* Add to ``INSTALLED_APPS`` with ``django.contrib.sitemaps``::

INSTALLED_APPS = [
...
'django.contrib.sitemaps',
'djangocms_page_sitemap',
]

* Add to the urlconf, eventually removing django CMS sitemap::

from djangocms_page_sitemap.sitemap import ExtendedSitemap

urlpatterns = patterns('',
...
url(r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': {'cmspages': ExtendedSitemap}}),
)

* Add the following snippets to the django CMS templates::

{% load robots_index %}

...
<head>
<!-- somewhere in the head tag -->
{% page_robots %}
</head>
...

Usage
-----

After installing as above, you will be able to tune the sitemap setting for each page.

A new menu item ``Sitemap properties`` will be available in the page toolbar.

For each page you will be able to set the following flags / values:

* Sitemap changefreq (default: the django CMS default)
* Sitemap priority (default: 0.5)
* Include page in sitemap (default: `True`)
* Set `noindex` value to page robots meta tag
* Set `noarchite` value to page robots meta tag
* Provide any additional robots meta tag values

page_robots options
###################

`page_robots` meta tag accepts the following parameters:

* `page`: the page to render robots meta tag (default: current page). Can be
any valid `page lookup`_
* `site`: the current site id (default: current site).

Settings
--------

* PAGE_SITEMAP_CHANGEFREQ_LIST: List of frequency changes
* PAGE_SITEMAP_DEFAULT_CHANGEFREQ: Default changefrequency (default: django CMS value -monthly-)
* PAGE_SITEMAP_CACHE_DURATION: Cache duration: same as django CMS menu cache)


.. _page lookup: https://docs.django-cms.org/en/reference/templatetags.html#page_lookup




History
-------

0.4.2 (2019-04-08)
++++++++++++++++++

* Add support for noindex, noarchive robots meta tag

0.4.1 (2016-12-02)
++++++++++++++++++

* Add Django 1.10 support

0.4.0 (2016-10-26)
++++++++++++++++++

* Drop compatibility with django CMS 3.1 and below, Django 1.7 and below

0.3.1 (2015-10-18)
++++++++++++++++++

* Improve defaults

0.3.0 (2015-10-18)
++++++++++++++++++

* Add Python 3.5
* Add option to exclude page from sitemap

0.2.0 (2015-08-15)
++++++++++++++++++

* Update to support django CMS 3.1
* Drop support for Django 1.4, 1.5
* Add support for Django 1.8

0.1.0 (2014-08-26)
++++++++++++++++++

* Initial version.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djangocms-page-sitemap-0.4.2.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

djangocms_page_sitemap-0.4.2-py2.py3-none-any.whl (19.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file djangocms-page-sitemap-0.4.2.tar.gz.

File metadata

  • Download URL: djangocms-page-sitemap-0.4.2.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.14

File hashes

Hashes for djangocms-page-sitemap-0.4.2.tar.gz
Algorithm Hash digest
SHA256 bf477d9b4a0f66d4bd941b0c0f12dc11290a12b1292c74a89945ffbf2b5e0874
MD5 9acde079bf8009fc8e73086ffa4a9f06
BLAKE2b-256 1bfd4a7c0fa10b7337b3e391e55f336b10f65dafaeeb6582bb8e2d451b821520

See more details on using hashes here.

File details

Details for the file djangocms_page_sitemap-0.4.2-py2.py3-none-any.whl.

File metadata

  • Download URL: djangocms_page_sitemap-0.4.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.14

File hashes

Hashes for djangocms_page_sitemap-0.4.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 311a5e5e5e279eecb7e479d5e43d178bef16ad3f6582ac34b3bff84254bc4800
MD5 1132ace13fa75b237ef5c7638c2e3601
BLAKE2b-256 f9b5c6bc769008113360cb62ef493d1a103e014379ace2df13ff4aec9c6d6c13

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page