Permalink
Browse files

updated docs for upcoming release

  • Loading branch information...
arthurk committed Mar 21, 2011
1 parent 9ca11ba commit 9bde96234c471a828b02f09b30620db79a7dbf2c
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
View
@@ -38,16 +38,16 @@
# General information about the project.
project = u'django-disqus'
-copyright = u'2010, Arthur Koziel'
+copyright = u'2011, Arthur Koziel'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '0.3.4'
+version = '0.4'
# The full version, including alpha/beta/rc tags.
-release = '0.3.4'
+release = '0.4'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
View
@@ -10,6 +10,7 @@ Export existing comments to and integrate DISQUS_ into your Django_ website.
- Export ``django.contrib.comments`` to DISQUS
- Dump comments from DISQUS into a local JSON file
- Templatetags
+- Exporting Comments as WXR
django-disqus is available open-source under the BSD license. If you'd like
to help out, you can fork the project at http://github.com/arthurk/django-disqus
@@ -27,5 +28,6 @@ Contents
installation
templatetags
commands
+ exporting_wxr
releasenotes/index
View
@@ -0,0 +1,16 @@
+django-disqus 0.4
+=================
+
+**Release Date**: 21-MAR-2011
+
+- Fix for unicode titles in urlencode (http://bugs.python.org/issue1349732).
+ Thanks `Adriano Petrich <https://github.com/frac>`_.
+- New templatetags to set context variables:
+ - set_disqus_developer
+ - set_disqus_identifier
+ - set_disqus_url
+ - set_disqus_title
+- Export comments as WXR feed
+
+A huge thanks to `Corey Oordt <https://github.com/coordt>`_, who
+implemented the new templatetags and the WXR feed.
@@ -9,3 +9,4 @@ Release Notes
0.3.2
0.3.3
0.3.4
+ 0.4
View
@@ -6,56 +6,7 @@ Templatetags
Before you can use the template tags, you need to load them with
``{% load disqus_tags %}``.
-set_disqus_developer
---------------------
-
-Adds ``disqus_deveoper`` variable to the context for the current block. The context variable is used in the :ref:`disqus_show_comments` and :ref:`disqus_num_replies` templatetags for signaling Disqus you are in testing mode. See
-`JavaScript configuration vairables documentation <http://docs.disqus.com/help/2/>`_ for more information.
-
-Example::
-
- {% load disqus_tags %}
- {% set_disqus_developer 1 %}
-
-set_disqus_identifier
----------------------
-
-Adds ``disqus_identifier`` variable to the context for the current block. The context variable is used in the :ref:`disqus_show_comments` and :ref:`disqus_num_replies` templatetags to assign a unique value for this page. The value can be a static value or a variable. See
-`JavaScript configuration vairables documentation <http://docs.disqus.com/help/2/>`_ for more information.
-
-Example::
-
- {% load disqus_tags %}
- {% set_disqus_identifier object.id %}
-
-You may also pass in multiple arguments, which will then be concatenated::
-
- {% load disqus_tags %}
- {% set_disqus_identifier "blogentry_" object.id %}
-
-This results in ``disqus_identifier`` set to ``blogentry_25``\ , if the object's id is 25.
-
-set_disqus_url
---------------
-
-Adds ``disqus_url`` variable to the context for the current block. The context variable is used in the :ref:`disqus_show_comments` and :ref:`disqus_num_replies` templatetags to assign a the URL for this page. This is very important if there are several ways to reach this page (mobile and desktop versions, for example). The value can be a static value or a variable. See
-`JavaScript configuration vairables documentation <http://docs.disqus.com/help/2/>`_ for more information.
-
-Example::
-
- {% load disqus_tags %}
- {% set_disqus_url object.get_absolute_url %}
-
-set_disqus_title
-----------------
-
-Adds ``disqus_title`` variable to the context for the current block. The context variable is used in the :ref:`disqus_show_comments` and :ref:`disqus_num_replies` templatetags to assign a title for this page. If your ``<title>`` tag contains extra cruft, this is useful for setting a easier to read title. The value can be a static value or a variable. See
-`JavaScript configuration vairables documentation <http://docs.disqus.com/help/2/>`_ for more information.
-
-Example::
-
- {% load disqus_tags %}
- {% set_disqus_title object.headline %}
+.. _disqus_dev:
disqus_dev
----------
@@ -77,11 +28,16 @@ Result::
var disqus_url = 'http://arthurkoziel.com/';
</script>
+.. _disqus_show_comments:
+
disqus_show_comments
--------------------
-Renders the ``disqus/show_comments.html`` template to display DISQUS comments, including any configuration variables set in this template block. The comments for the current Thread and the comment form are displayed to the user. See the
-`embed code <http://docs.disqus.com/developers/universal/>`_ for more information.
+Renders the ``disqus/show_comments.html`` template to display DISQUS comments,
+including any configuration variables set in this template block. The comments
+for the current Thread and the comment form are displayed to the user. See the
+`embed code <http://docs.disqus.com/developers/universal/>`_ for
+more information.
Example::
@@ -101,12 +57,18 @@ Result::
``settings.DISQUS_WEBSITE_SHORTNAME`` setting takes precedence
over this parameter. Example: ``{% disqus_show_comments "foobar" %}``
+.. _disqus_num_replies:
+
disqus_num_replies
------------------
-Renders the ``disqus/num_replies.html`` template, including any configuration variables set in this template block. This code that transforms links which end with a ``#disqus_thread`` anchor into the thread's comment count.
+Renders the ``disqus/num_replies.html`` template, including any configuration
+variables set in this template block. This code that transforms links which
+end with a ``#disqus_thread`` anchor into the thread's comment count.
-Disqus recommends including a ``data-disqus-identifier`` parameter to the ``<a>`` tag for consistent lookup. Make sure you also use :ref:`set_disqus_identifier` on the page it links to, as well.
+Disqus recommends including a ``data-disqus-identifier`` parameter to the
+``<a>`` tag for consistent lookup. Make sure you also use
+:ref:`set_disqus_identifier` on the page it links to, as well.
Example::
@@ -129,3 +91,80 @@ The javascript will then transform the link to::
- ``shortname``: DISQUS website shortname that should be used. The
``settings.DISQUS_WEBSITE_SHORTNAME`` setting takes precedence over this
parameter. Example: ``{% disqus_num_replies "foobar" %}``
+
+.. _set_disqus_developer:
+
+set_disqus_developer
+--------------------
+
+Adds ``disqus_developer`` variable to the context for the current block. The
+context variable is used in the :ref:`disqus_show_comments` and
+:ref:`disqus_num_replies` templatetags for signaling Disqus you are in
+testing mode. See `JavaScript configuration vairables documentation <http://docs.disqus.com/help/2/>`_
+for more information.
+
+Example::
+
+ {% load disqus_tags %}
+ {% set_disqus_developer 1 %}
+
+.. _set_disqus_identifier:
+
+set_disqus_identifier
+---------------------
+
+Adds ``disqus_identifier`` variable to the context for the current block.
+The context variable is used in the :ref:`disqus_show_comments` and
+:ref:`disqus_num_replies` templatetags to assign a unique value for this
+page. The value can be a static value or a variable. See
+`JavaScript configuration vairables documentation <http://docs.disqus.com/help/2/>`_
+for more information.
+
+Example::
+
+ {% load disqus_tags %}
+ {% set_disqus_identifier object.id %}
+
+You may also pass in multiple arguments, which will then be concatenated::
+
+ {% load disqus_tags %}
+ {% set_disqus_identifier "blogentry_" object.id %}
+
+This results in ``disqus_identifier`` set to ``blogentry_25``\ , if the
+object's id is 25.
+
+.. _set_disqus_url:
+
+set_disqus_url
+--------------
+
+Adds ``disqus_url`` variable to the context for the current block. The context
+variable is used in the :ref:`disqus_show_comments` and :ref:`disqus_num_replies`
+templatetags to assign a the URL for this page. This is very important if
+there are several ways to reach this page (mobile and desktop versions, for
+example). The value can be a static value or a variable. See
+`JavaScript configuration vairables documentation <http://docs.disqus.com/help/2/>`_
+for more information.
+
+Example::
+
+ {% load disqus_tags %}
+ {% set_disqus_url object.get_absolute_url %}
+
+.. _set_disqus_title:
+
+set_disqus_title
+----------------
+
+Adds ``disqus_title`` variable to the context for the current block. The
+context variable is used in the :ref:`disqus_show_comments` and
+:ref:`disqus_num_replies` templatetags to assign a title for this page. If
+your ``<title>`` tag contains extra cruft, this is useful for setting a
+easier to read title. The value can be a static value or a variable. See
+`JavaScript configuration vairables documentation <http://docs.disqus.com/help/2/>`_
+for more information.
+
+Example::
+
+ {% load disqus_tags %}
+ {% set_disqus_title object.headline %}

0 comments on commit 9bde962

Please sign in to comment.