Merge pull request django-cms#4722 from divio/touch-docs

Touch docs

Author: mkoistinen

docs/how_to/apphooks.rst

@@ -176,7 +176,7 @@ For example::
 
     {% url 'my_view' %}
 
-Will not work anymore when you namespace an app. You will need to do something like::
+Will not work any more when you namespace an app. You will need to do something like::
 
     {% url 'my_namespace:my_view' %}
 

docs/how_to/caching.rst

@@ -3,9 +3,9 @@ Caching
 #######
 
 
-*****
-Setup
-*****
+******
+Set-up
+******
 
 To setup caching configure a caching backend in django.
 

docs/how_to/frontend_models.rst

@@ -15,7 +15,7 @@ hint on hover. Double-clicking opens a pop-up window containing the change form
 
 .. note::
 
-    This interface is not currently available for touchscreen users, but will be improved in
+    This interface is not currently available for touch-screen users, but will be improved in
     future releases.
 
 .. warning::

docs/how_to/install.rst

@@ -382,7 +382,7 @@ for detailed installation information, and then return to this tutorial.
 
 If you opt for the core plugins you should take care that directory to which
 the :setting:`CMS_PAGE_MEDIA_PATH` setting points (by default ``cms_page_media/``
-relative to :setting:`django:MEDIA_ROOT`) is writable by the user under which Django
+relative to :setting:`django:MEDIA_ROOT`) is writeable by the user under which Django
 will be running. If you have opted for django-filer there is a similar requirement
 for its configuration.
 
@@ -468,7 +468,7 @@ setting::
 .. note::
 
     Please make sure both the ``static`` and ``media`` sub-folders exist in your
-    project and are writable.
+    project and are writeable.
 
 Now add a little magic to the :setting:`django:TEMPLATE_DIRS` section of the file::
 

docs/how_to/toolbar.rst

@@ -9,6 +9,13 @@ mode into your application, and provide your users with a streamlined editing ex
 
 For the toolbar API reference, please refer to :ref:`toolbar-api-reference`.
 
+.. important:: **Overlay** and **sideframe**
+
+    Then django CMS *sideframe* has been replaced with an *overlay* mechanism. The API still refers
+    to the ``sideframe``, because it is invoked in the same way, and what has changed is merely the
+    behaviour in the user's browser.
+
+    In other words, *sideframe* and the *overlay* refer to different versions of the same thing.
 
 ***********
 Registering

docs/introduction/install.rst

@@ -97,7 +97,7 @@ indicated with an asterisk *****).
 * Languages to enable. Option can be provided multiple times, or as a comma separated list: ``en,
   de`` *****
 * Optional default time zone: ``America/Chicago``
-* Activate Django timezone support: ``yes``
+* Activate Django time zone support: ``yes``
 * Activate CMS permission management: ``yes``
 * Use Twitter Bootstrap Theme: ``yes`` *****
 * Use custom template set: ``no``

docs/reference/api_references.rst

@@ -418,6 +418,14 @@ cms.toolbar.toolbar
 cms.toolbar.items
 =================
 
+.. important:: **Overlay** and **sideframe**
+
+    Then django CMS *sideframe* has been replaced with an *overlay* mechanism. The API still refers
+    to the ``sideframe``, because it is invoked in the same way, and what has changed is merely the
+    behaviour in the user's browser.
+
+    In other words, *sideframe* and the *overlay* refer to different versions of the same thing.
+
 .. module:: cms.toolbar.items
 
 
@@ -489,16 +497,16 @@ cms.toolbar.items
 
     .. method:: add_sideframe_item(name, url, active=False, disabled=False, extra_classes=None, on_close=None, side=LEFT, position=None)
 
-        Adds an item which opens ``url`` in the side frame and returns it.
+        Adds an item which opens ``url`` in the sideframe and returns it.
 
-        ``on_close`` can be set to ``None`` to do nothing when the side frame
+        ``on_close`` can be set to ``None`` to do nothing when the sideframe
         closes, :attr:`REFRESH_PAGE` to refresh the page when it
         closes or a URL to open once it closes.
 
     .. method:: add_modal_item(name, url, active=False, disabled=False, extra_classes=None, on_close=REFRESH_PAGE, side=LEFT, position=None)
 
         The same as :meth:`add_sideframe_item`, but opens the ``url`` in a
-        modal dialog instead of the side frame.
+        modal dialog instead of the sideframe.
 
         ``on_close`` can be set to ``None`` to do nothing when the side modal
         closes, :attr:`REFRESH_PAGE` to refresh the page when it
@@ -575,7 +583,7 @@ cms.toolbar.items
 
 .. class:: SideframeItem(name, url, active=False, disabled=False, extra_classes=None, on_close=None, side=LEFT)
 
-    Item that opens ``url`` in side frame.
+    Item that opens ``url`` in sideframe.
 
 
 .. class:: AjaxItem(name, action, csrf_token, data=None, active=False, disabled=False, extra_classes=None, question=None, side=LEFT)

docs/reference/configuration.rst

@@ -709,7 +709,7 @@ By default, django CMS creates a folder called ``cms_page_media`` in your
 static files folder where all uploaded media files are stored. The media files
 are stored in sub-folders numbered with the id of the page.
 
-You need to ensure that the directory to which it points is writable by the
+You need to ensure that the directory to which it points is writeable by the
 user under which Django will be running.
 
 
@@ -860,7 +860,7 @@ default
     ``True``
 
 Should the output of pages be cached?
-Takes the language, and timezone into account. Pages for logged in users are not cached.
+Takes the language, and time zone into account. Pages for logged in users are not cached.
 If the toolbar is visible the page is not cached as well.
 
 
@@ -873,7 +873,7 @@ default
     ``True``
 
 Should the output of the various placeholder template tags be cached?
-Takes the current language and timezone into account. If the toolbar is in edit mode or a plugin with ``cache=False`` is
+Takes the current language and time zone into account. If the toolbar is in edit mode or a plugin with ``cache=False`` is
 present the placeholders will not be cached.
 
 

docs/spelling_wordlist

@@ -10,27 +10,37 @@
 #
 # Please keep the two sections below separate.
 
-#### entries that need to be checked ####
+#### entries that need to be checked for various different reasons ####
 
 api
+fallback
 fallbacks
 js
+practices
 rc
+regexps
 src
 url
 
 #### accepted entries ####
 
+
 addons
+Admin
+admin
 Aldryn
+Alvarado
+app
 apphook
 apphooked
 apphooks
+apps
 astagi
 backport
 backported
 backticks
 basilelegal
+blog
 boilerplates
 cacheable
 callables
@@ -45,6 +55,7 @@ counterintuitive
 CSS
 customisable
 Daniele
+Debian
 deprecations
 Deutsch
 dialogs
@@ -58,8 +69,10 @@ django-cms
 docstrings
 doctormo
 douwevandermeij
+draggable
 driesdesmet
 elpaso
+etc
 Fankhauser
 fieldset
 filenames
@@ -82,6 +95,8 @@ iframe
 ikudryavtsev
 Indices
 inline
+introspected
+iPad
 ipsum
 Japanisch
 JavaScript
@@ -96,7 +111,9 @@ Larghi
 Lauber
 ldgarcia
 lin
+linted
 linters
+linting
 localhost
 login
 logout
@@ -105,6 +122,7 @@ Lorem
 lowercased
 maqnouch
 Matteo
+max
 Mediaeval
 middleware
 minified
@@ -124,6 +142,9 @@ olarcheveque
 online
 Paulo
 peterfarrell
+Placeholder
+placeholder
+placeholders
 plugin
 plugins
 pre
@@ -137,6 +158,8 @@ runserver
 runtime
 Saltvik
 sam
+Samsung
+Sass
 Schoen
 searchable
 Sekizai
@@ -154,13 +177,16 @@ templating
 timgraham
 Todo
 tomwardill
+Toolbar
+toolbar
 toolbars
 tooltip
 transactional
 treavis
 treebeard
 tuple
 tuples
+Ubuntu
 uncached
 unclosed
 uncomment
@@ -185,9 +211,14 @@ vstoykov
 whitespace
 Wohlwend
 workflows
+writeable
 xframe
 YouTube
 Zürich
 Øyvind
 日本語
+iOS
+Asus
+Xperia
+
 

docs/topics/commonly_used_plugins.rst

@@ -37,7 +37,7 @@ setting in your project's ``settings.py`` file::
 
 You should take care that the directory defined by the configuration setting
 :setting:`CMS_PAGE_MEDIA_PATH` (by default ``cms_page_media/`` relative to
-:setting:`django:MEDIA_ROOT`) is writable by the user under which django will be
+:setting:`django:MEDIA_ROOT`) is writeable by the user under which django will be
 running.
 
 You might consider using `django-filer`_ with `django filer CMS plugin`_ and its
@@ -161,7 +161,7 @@ it was placed in.
 
 You should take care that the directory defined by the configuration setting
 :setting:`CMS_PAGE_MEDIA_PATH` (by default ``cms_page_media/`` relative to
-:setting:`django:MEDIA_ROOT`) is writable by the user under which django will be
+:setting:`django:MEDIA_ROOT`) is writeable by the user under which django will be
 running.
 
 .. note:: In order to improve clarity, some Picture fields have been omitted in
@@ -196,7 +196,7 @@ settings in your project's ``settings.py`` file::
 
 You should take care that the directory defined by the configuration setting
 :setting:`CMS_PAGE_MEDIA_PATH` (by default ``cms_page_media/`` relative to
-:setting:`django:MEDIA_ROOT`) is writable by the user under which django will be
+:setting:`django:MEDIA_ROOT`) is writeable by the user under which django will be
 running.
 
 .. note:: For more advanced use cases where you would like to upload your media
@@ -258,7 +258,7 @@ default behaviour:
 
 You should take care that the directory defined by the configuration setting
 :setting:`CMS_PAGE_MEDIA_PATH` (by default ``cms_page_media/`` relative to
-:setting:`django:MEDIA_ROOT`) is writable by the user under which django will be
+:setting:`django:MEDIA_ROOT`) is writeable by the user under which django will be
 running.
 
 .. note:: For more advanced use cases where you would like to upload your media

docs/topics/i18n.rst

@@ -58,7 +58,7 @@ https://docs.djangoproject.com/en/dev/topics/i18n/translation/#how-django-discov
 When visiting a page that is only English and French with a German browser, the language from LANGUAGE_CODE will be used.
 If this is English, but the visitor only speaks French, the visitor will have to switch the language.
 Visiting the same page now again after some time, will show it in English again, because the browser session which was
-used to store the language selection doesn't exist anymore. To prevent this issue, a middleware exists which stores the
+used to store the language selection doesn't exist any more. To prevent this issue, a middleware exists which stores the
 language selection in a cookie. Add the following middleware to `MIDDLEWARE_CLASSES`:
 
     `cms.middleware.language.LanguageCookieMiddleware`

docs/topics/index.rst

@@ -9,6 +9,7 @@ concerned with explaining *how to do things* than with helping you understand
 .. toctree::
     :maxdepth: 2
 
+    touch
     menu_system
     publishing
     multiple_languages