summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJacob Rief <jacob.rief@gmail.com>2018-08-03 21:19:15 +0200
committerJohannes Linke <karyon@users.noreply.github.com>2018-08-03 21:19:15 +0200
commit5300605acc875ef0def87cfb859b3423f2fda644 (patch)
treece802e0c639c8b3e88c97a2332262bb7c282b42e /docs
parent43ce59666c3af04df4414c51191646bd6f0e34f9 (diff)
downloaddjango-compressor-5300605acc875ef0def87cfb859b3423f2fda644.tar.gz
add support to include external and deferred files (#891)
* add support to include external and deferred files * add documentation for enhanced Sekizai compressor * add dummy testing file * add unit test to check Sekizai processor * changes for next version * rebased to current version * Update django-sekizai.txt
Diffstat (limited to 'docs')
-rw-r--r--docs/changelog.txt1
-rw-r--r--docs/django-sekizai.txt38
2 files changed, 38 insertions, 1 deletions
diff --git a/docs/changelog.txt b/docs/changelog.txt
index 21d7492..702e8b9 100644
--- a/docs/changelog.txt
+++ b/docs/changelog.txt
@@ -5,6 +5,7 @@ Unreleased
-------------------
- Add Django 2.0 compatibility
+- Allow the mixed use of JS/CSS in Sekizai's templatetags `{% addtoblock "js" %}` and `{% addtoblock "css" %}`.
v2.2 (2017-08-16)
-------------------
diff --git a/docs/django-sekizai.txt b/docs/django-sekizai.txt
index 69f5228..bb56c1b 100644
--- a/docs/django-sekizai.txt
+++ b/docs/django-sekizai.txt
@@ -18,11 +18,47 @@ See `this issue`_ for details.
Usage
-----
+In templates which either extend base templates or are included by other templates,
+use any of these directives to import Stylesheets and JavaScript files:
+
+
+.. code-block:: django
+
+ {% load static sekizai_tags %}
+
+ {% addtoblock "css" %}<link href="https://cdnjs.cloudflare.com/ajax/libs/select2/4.0.5/css/select2.min.css" rel="stylesheet" />{% endaddtoblock %}
+ {% addtoblock "css" %}<link href="{% static 'app/css/mystyle.css' %}" rel="stylesheet" type="text/css" />{% endaddtoblock %}
+
+ {% addtoblock "js" %}<script src="https://cdnjs.cloudflare.com/ajax/libs/select2/4.0.5/js/select2.min.js"></script>{% endaddtoblock %}
+ {% addtoblock "js" %}<script src="{% static 'js/js/myapp.js' %}" type="text/javascript"></script>{% endaddtoblock %}
+ {% addtoblock "js" %}<script async="async" defer="defer" src="https://maps.googleapis.com/maps/api/js?key={{ config.apiKey }}&callback=initMap"></script>{% endaddtoblock %}
+
+Note that some files are loaded by the browser directly from a CDN and thus can not be compressed
+by django-compressor. Therefore the Sekizai compressor checks whether a file is compressable, and
+only if so, concatenates its payload.
+
.. code-block:: django
{% load sekizai_tags %}
- {% render_block "<js/css>" postprocessor "compressor.contrib.sekizai.compress" %}
+ <html>
+ <head>
+ ...
+ {% render_block "css" postprocessor "compressor.contrib.sekizai.compress" %}
+ </head>
+
+ <body>
+ ...
+ {% render_block "js" postprocessor "compressor.contrib.sekizai.compress" %}
+ </body>
+ </html>
+
+In the above example, we render StyleSheets inside the ``<head>`` element and JavaScript files
+just before closing the ``</body>`` tag.
+
+Here, we first render some references to CSS and JavaScript files, served from external
+sources. Afterwards all local files are concatenated and optionally minified. In the last
+step all references to deferred files are rendered.
.. _django-sekizai: https://github.com/ojii/django-sekizai
.. _django-sekizai docs: https://django-sekizai.readthedocs.io/en/latest/