Permalink
Browse files

Documentation cleanup: fixed typos, grammar, etc.

  • Loading branch information...
1 parent 56afb01 commit b17d2357ed478c6413457a906c72450650e8cc01 @stephenmuss stephenmuss committed Jun 26, 2012
View
@@ -33,21 +33,21 @@ Plugin and apphook management commands
``cms uninstall``
=================
-The ``uninstall`` subcommand can be used to make an uninstallation of a CMS
+The ``uninstall`` subcommand can be used to make uninstalling a CMS
Plugin or an apphook easier.
It has two subcommands:
* ``cms uninstall plugins <plugin name> [<plugin name 2> [...]]`` uninstalls
one or several plugins by **removing** them from all pages where they are
used. Note that the plugin name should be the name of the class that is
- registered to the django CMS. If you are unsure about the plugin name, use
+ registered in the django CMS. If you are unsure about the plugin name, use
the :ref:`cms-list-command` to see a list of installed plugins.
* ``cms uninstall apphooks <apphook name> [<apphook name 2> [...]]`` uninstalls
one or several apphooks by **removing** them from all pages where they are
used. Note that the apphook name should be the name of the class that is
- registered to the django CMS. If you are unsure about the apphook name, use
- the :ref:`cms-list-command` to see a list of installed apphook.
+ registered in the django CMS. If you are unsure about the apphook name, use
+ the :ref:`cms-list-command` to see a list of installed apphooks.
.. warning::
View
@@ -74,7 +74,7 @@ In the view pass the :meth:`get_absolute_url` method to the
set_language_changer(request, item.get_absolute_url)
# ...
-This allows the language chooser to have another URL then the current one.
+This allows the language chooser to have another URL than the current one.
If the current URL is not handled by the CMS and no ``set_language_changer``
function is provided it will take the exact same URL as the current one and
will only change the language prefix.
@@ -131,7 +131,7 @@ If you put :setting:`CMS_HIDE_UNTRANSLATED` to ``False`` in your
``settings.py`` all pages will be displayed in all languages even if they are
not translated yet.
-If :setting:`CMS_HIDE_UNTRANSLATED` is ``True`` is in your ``settings.py``
-and you are on a page that hasn't got a english translation yet and you view the
-german version then the language chooser will redirect to ``/``. The same goes
-for urls that are not handled by the cms and display a language chooser.
+If :setting:`CMS_HIDE_UNTRANSLATED` is ``True`` in your ``settings.py``
+and you are on a page that doesn't yet have an English translatio and you view the
+Ferman version then the language chooser will redirect to ``/``. The same goes
+for urls that are not handled by the cms and display a language chooser.
@@ -4,7 +4,7 @@ Template Tags
.. highlightlang:: html+django
-To use any of the following templatetags you need to load them first at the
+To use any of the following templatetags you first need to load them at the
top of your template::
{% load cms_tags menu_tags %}
@@ -29,7 +29,7 @@ Example::
If you want additional content to be displayed in case the placeholder is
empty, use the ``or`` argument and an additional ``{% endplaceholder %}``
closing tag. Everything between ``{% placeholder "..." or %}`` and ``{%
-endplaceholder %}`` is rendered instead if the placeholder has no plugins or
+endplaceholder %}`` is rendered in the event that the placeholder has no plugins or
the plugins do not generate any output.
Example::
@@ -48,7 +48,7 @@ same name on parent pages, simply pass the ``inherit`` argument::
{% placeholder "content" inherit %}
-This will walk the page tree up till the root page and will show the first
+This will walk up the page tree up until the root page and will show the first
placeholder it can find with content.
It's also possible to combine this with the ``or`` argument to show an
@@ -111,7 +111,7 @@ that ``reverse_id`` with the appropriate templatetags::
If you are referring to a page `relative` to the current page, you'll probably
have to use a numeric page ID or a page object. For instance, if you want the
-content of the parent page display on the current page, you can use::
+content of the parent page to display on the current page, you can use::
{% show_placeholder "content" request.current_page.parent_id %}
@@ -208,9 +208,9 @@ four optional parameters: ``start_level``, ``end_level``, ``extra_inactive``,
and ``extra_active``.
The first two parameters, ``start_level`` (default=0) and ``end_level``
-(default=100) specify from what level to which level should the navigation be
-rendered. If you have a home as a root node and don't want to display home you
-can render the navigation only after level 1.
+(default=100) specify from which level the navigation shoud be rendered
+and at which level it should stop. If you have home as a root node and don't
+want to display home you can render the navigation only after level 1.
The third parameter, ``extra_inactive`` (default=0), specifies how many levels
of navigation should be displayed if a node is not a direct ancestor or
@@ -278,7 +278,7 @@ show_sub_menu
*************
Displays the sub menu of the current page (as a nested list).
-Takes one argument that specifies how many levels deep should the submenu be
+Takes one argument that specifies how many levels deep the submenu should be
displayed. The template can be found at ``cms/sub_menu.html``::
<ul>
@@ -345,7 +345,7 @@ Returns the url of the current page in an other language::
{% page_language_url en %}
If the current url has no cms-page and is handled by a navigation extender and
-the url changes based on the language: You will need to set a language_changer
+the url changes based on the language, you will need to set a language_changer
function with the set_language_changer function in cms.utils.
For more information, see :doc:`i18n`.
@@ -370,16 +370,16 @@ or with custom template::
The language_chooser has three different modes in which it will display the
languages you can choose from: "raw" (default), "native", "current" and "short".
-It can be passed as last argument to the ``language_chooser tag`` as a string.
-In "raw" mode, the language will be displayed like it's verbose name in the
+It can be passed as the last argument to the ``language_chooser tag`` as a string.
+In "raw" mode, the language will be displayed like its verbose name in the
settings. In "native" mode the languages are displayed in their actual language
(eg. German will be displayed "Deutsch", Japanese as "日本語" etc). In "current"
mode the languages are translated into the current language the user is seeing
the site in (eg. if the site is displayed in German, Japanese will be displayed
as "Japanisch"). "Short" mode takes the language code (eg. "en") to display.
If the current url has no cms-page and is handled by a navigation extender and
-the url changes based on the language: You will need to set a language_changer
+the url changes based on the language, you will need to set a language_changer
function with the set_language_changer function in menus.utils.
For more information, see :doc:`i18n`.
@@ -390,7 +390,7 @@ For more information, see :doc:`i18n`.
cms_toolbar
***********
-The ``cms_toolbar`` templatetag will add the needed css and javascript to the
+The ``cms_toolbar`` templatetag will add the required css and javascript to the
sekizai blocks in the base template. The templatetag has to be placed after the
``<body>`` tag and before any ``{% cms_placeholder %}`` occurrences within your HTML.
@@ -15,9 +15,9 @@ What they operate on is a list of menu nodes, that gets passed around the menu s
The main active parts of the menu system are menu *generators* and *modifiers*.
-Some of these parts are supplied with the menus application. Some come from from other applications (from the cms application in django CMS, for example, or some other application entirely).
+Some of these parts are supplied with the menus application. Some come from other applications (from the cms application in django CMS, for example, or some other application entirely).
-All these active parts need to be registered with the menu system.
+All these active parts need to be registered within the menu system.
Then, when the time comes to build a menu, the system will ask all the registered menu generators and modifiers to get to work on it.
@@ -42,13 +42,13 @@ Modifiers
A modifier examines the nodes that have been assembled, and modifies them according to its requirements (adding or removing them, or manipulating their attributes, as it sees fit).
-One important one in cms (:py:class:`cms.menu.SoftRootCutter`) removes the nodes that are no longer required when a soft root is encountered.
+An important one in cms (:py:class:`cms.menu.SoftRootCutter`) removes the nodes that are no longer required when a soft root is encountered.
These classes are subclasses of :py:class:`menus.base.Modifier`. Examples are :py:class:`cms.menu.NavExtender` and :py:class:`cms.menu.SoftRootCutter`.
In order to use a modifier, its :py:meth:`modify()` method must be called.
-
-Note that each Modifer's :py:meth:`modify()` method can be called *twice*, before and after the menu has been trimmed.
+
+Note that each Modifier's :py:meth:`modify()` method can be called *twice*, before and after the menu has been trimmed.
For example when using the {% show_menu %} templatetag, it's called:
@@ -101,7 +101,7 @@ Don't forget that show_menu recurses - so it will do *all* of the below for *eac
* :py:meth:`menus.menu_pool.MenuPool.apply_modifiers()`
* :py:meth:`menus.menu_pool.MenuPool._mark_selected()`
* loops over each node, comparing its URL with the request.path, and marks the best match as ``selected``
- * loops over the Modifiers in self.modifiers calling each one's :py:meth:`modify(post_cut = False)`. The default Modifiers are:
+ * loops over the Modifiers in self.modifiers calling each one's :py:meth:`modify(post_cut=False)`. The default Modifiers are:
* :py:class:`cms.menu.NavExtender`
* :py:class:`cms.menu.SoftRootCutter` removes all nodes below the appropriate soft root
* :py:class:`menus.modifiers.Marker` loops over all nodes; finds selected, marks its ancestors, siblings and children
@@ -118,4 +118,4 @@ Don't forget that show_menu recurses - so it will do *all* of the below for *eac
* :py:class:`menus.modifiers.AuthVisibility`
* :py:class:`menus.modifiers.Level`:
* :py:meth:`menus.modifiers.Level.mark_levels()`
- * return the nodes to the context in the variable ``children``
+ * return the nodes to the context in the variable ``children``
@@ -6,9 +6,9 @@ Serving content in multiple languages
Basic concepts
**************
-django CMS has a sophisticated multilingual capability; it's able to serve
+django CMS has a sophisticated multilingual capability. It is able to serve
content in multiple languages, with fallbacks into other languages where
-translations have not been provided, the facility for the user to set the
+translations have not been provided. It also has the facility for the user to set the
preferred language and so on.
How django CMS determines the user's preferred language
@@ -47,14 +47,17 @@ examples.
* the CMS is set up to provide content in English and Italian
* :setting:`CMS_HIDE_UNTRANSLATED` is False
* the page ``/some/page``
-1. you visit ``/some/page``
+
+2. you visit ``/some/page``
* the content is served in Italian
* all link URLs (menus etc.) on that page will be prepended with /it
* the page is served at ``/some/page`` (i.e. no redirection has taken place)
-1. now you select one of those links ``/it/some/other/page`` that is available in Italian
+
+3. now you select one of those links ``/it/some/other/page`` that is available in Italian
* Italian content is served
* the page is served at ``/it/some/other/page``
-1. now you select a link to a page **not** available in Italian
+
+4. now you select a link to a page **not** available in Italian
* the link is still ``/it/some/other/page``
* you'll get the English version, because Italian's not available
* the path of the new page is ``/en/some/other/page`` (i.e. it has redirected)
@@ -96,9 +99,11 @@ Your language cookie should only ever get set or changed if:
* your browser has asked for a language (but this can't override your choice above)
If your cookie contains a particualar language (say, "it"):
+
* the content should be served in Italian wherever available
* links on a page should be to ``/it`` content where available, and fallback where not
When visiting a page only available in English:
+
* content will have to be in English
-* links should be to Italian content where possible
+* links should be to Italian content where possible
View
@@ -3,7 +3,7 @@ Contributing to django CMS
##########################
Like every open-source project, django CMS is always looking for motivated
-individuals to contribute to it's source code.
+individuals to contribute to its source code.
However, to ensure the highest code quality and keep the repository nice and
tidy, everybody has to follow a few rules (nothing major, I promise :) )
@@ -126,17 +126,17 @@ Contributing Documentation
Perhaps considered "boring" by hard-core coders, documentation is sometimes even
more important than code! This is what brings fresh blood to a project, and
serves as a reference for old timers. On top of this, documentation is the one
-area where less technical people can help most - you just need to write a
+area where less technical people can help most - you just need to write
semi-decent English. People need to understand you. We don't care about style or
correctness.
Documentation should be:
- We use `Sphinx`_/`restructuredText`_. So obviously this is the format you should
use :) File extensions should be .rst.
-- Written in English. We can discuss how it would bring more people to the
- project to have a Klingon translation or anything, but that's a problem we
- will ask ourselves when we already have a good documentation in English.
+- Written in English. We could discuss how it would bring more people to the
+ project by having a Klingon or some other translation, but that's a problem we
+ will confront once we already have good documentation in English.
- Accessible. You should assume the reader to be moderately familiar with
Python and Django, but not anything else. Link to documentation of libraries
you use, for example, even if they are "obvious" to you (South is the first
@@ -155,7 +155,7 @@ double cookie points. Seriously. You rock.
Section style
=============
-We use Python documentation conventions fo section marking:
+We use Python documentation conventions for section marking:
* ``#`` with overline, for parts
* ``*`` with overline, for chapters
@@ -11,7 +11,7 @@ on the models and managers, because the direct API via models and managers is
slightly counterintuitive for developers. Also the functions defined in this
module do sanity checks on arguments.
-.. warning:: None of the functions in this modules do any security or permission
+.. warning:: None of the functions in this module does any security or permission
checks. They verify their input values to be sane wherever
possible, however permission checks should be implemented manually
before calling any of these functions.
@@ -56,7 +56,7 @@ Functions and constants
:param string redirect: URL redirect (only applicable if :setting:`CMS_REDIRECTS` is ``True``)
:param string meta_description: Description of this page for SEO
:param string meta_keywords: Keywords for this page for SEO
- :param created_by: User that creates this page
+ :param created_by: User that is creating this page
:type created_by: string of :class:`django.contrib.auth.models.User` instance
:param parent: Parent page of this page
:type parent: :class:`cms.models.pagemodel.Page` instance
@@ -65,7 +65,7 @@ Functions and constants
:param boolean in_navigation: Whether this page should be in the navigation or not
:param boolean soft_root: Whether this page is a softroot or not
:param string reverse_id: Reverse ID of this page (for template tags)
- :param string navigation_extenders: Menu to attach to this page, must be a valid menu
+ :param string navigation_extenders: Menu to attach to this page. Must be a valid menu
:param boolean published: Whether this page should be published or not
:param site: Site to put this page on
:type site: :class:`django.contrib.sites.models.Site` instance
@@ -201,7 +201,7 @@ cms.plugin_base
.. attribute:: module
- Will be group the plugin in the plugin editor. If module is ``None``,
+ Will group the plugin in the plugin editor. If module is ``None``,
plugin is grouped "Generic" group.
.. attribute:: name
Oops, something went wrong.

0 comments on commit b17d235

Please sign in to comment.