diff options
Diffstat (limited to 'doc/web/quickstart.rst')
| -rw-r--r-- | doc/web/quickstart.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/web/quickstart.rst b/doc/web/quickstart.rst index 1bcd217e..996942db 100644 --- a/doc/web/quickstart.rst +++ b/doc/web/quickstart.rst @@ -45,7 +45,7 @@ by creating a :class:`~.WebSupport` object for your application:: search='xapian') You'll only need one of these for each set of documentation you will be working -with. You can then call it's :meth:`~.WebSupport.get_document` method to access +with. You can then call its :meth:`~.WebSupport.get_document` method to access individual documents:: contents = support.get_document('contents') @@ -56,8 +56,8 @@ This will return a dictionary containing the following items: * **sidebar**: The sidebar of the document as HTML * **relbar**: A div containing links to related documents * **title**: The title of the document -* **css**: Links to css files used by Sphinx -* **js**: Javascript containing comment options +* **css**: Links to CSS files used by Sphinx +* **script**: JavaScript containing comment options This dict can then be used as context for templates. The goal is to be easy to integrate with your existing templating system. An example using `Jinja2 @@ -77,9 +77,9 @@ integrate with your existing templating system. An example using `Jinja2 <link rel="stylesheet" href="/static/websupport-custom.css" type="text/css"> {% endblock %} - {%- block js %} + {%- block script %} {{ super() }} - {{ document.js|safe }} + {{ document.script|safe }} {%- endblock %} {%- block relbar %} @@ -109,8 +109,8 @@ must update the websupport package's data:: support.update_username(old_username, new_username) *username* should be a unique string which identifies a user, and *moderator* -should be a boolean representing whether the user has moderation privilieges. -The default value for *moderator* is *False*. +should be a boolean representing whether the user has moderation privileges. +The default value for *moderator* is ``False``. An example `Flask <http://flask.pocoo.org/>`_ function that checks whether a user is logged in and then retrieves a document is:: |