Permalink
Browse files

Merge pull request #919 from kezabelle/develop

Minor documentation improvements.
  • Loading branch information...
2 parents 0e6cc4b + 3fb9795 commit eeab29e56e7100c264de8b2fbc23c9318f6417e5 @ojii ojii committed Aug 4, 2011
View
@@ -1,8 +1,8 @@
##########################
-Contributing to Django-CMS
+Contributing to django CMS
##########################
-Like every open-source project, Django-CMS is always looking for motivated
+Like every open-source project, django CMS is always looking for motivated
individuals to contribute to it's 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 :) )
@@ -12,12 +12,12 @@ tidy, everybody has to follow a few rules (nothing major, I promise :) )
Community
*********
-People interested in developing for the django-cms should join the
+People interested in developing for the django CMS should join the
`django-cms-developers`_ mailing list as well as heading over to #django-cms on
-freenode for help and to discuss the development.
+the `freenode`_ IRC network for help and to discuss the development.
-You may also be interested in following @djangocmsstatus on twitter to get the
-github commits as well as the hudson build reports. There is also a @djangocms
+You may also be interested in following `@djangocmsstatus`_ on twitter to get the
+GitHub commits as well as the hudson build reports. There is also a `@djangocms`_
account for less technical announcements.
@@ -26,14 +26,14 @@ In a nutshell
*************
Here's what the contribution process looks like, in a bullet-points fashion, and
-only for the stuff we host on github:
+only for the stuff we host on GitHub:
-#. django-cms is hosted on `Github`_, at https://github.com/divio/django-cms
+#. django CMS is hosted on `GitHub`_, at https://github.com/divio/django-cms
#. The best method to contribute back is to create an account there, then fork
the project. You can use this fork as if it was your own project, and should
push your changes to it.
-#. When you feel your code is good enough for inclusion, "send us a pull
- request", by using the nice Github web interface.
+#. When you feel your code is good enough for inclusion, "send us a `pull
+ request`_", by using the nice GitHub web interface.
@@ -45,7 +45,7 @@ Contributing Code
Getting the source code
=======================
-If you're interested in developing a new feature for the cms, it is recommended
+If you're interested in developing a new feature for the CMS, it is recommended
that you first discuss it on the `django-cms-developers`_ mailing list so as
not to do any work that will not get merged in anyway.
@@ -58,10 +58,10 @@ not to do any work that will not get merged in anyway.
- Usually, if unit tests are written, pass, and your change is relevant, then
it'll be merged.
-Since we're hosted on github, django-cms uses git as a version control system.
+Since we're hosted on GitHub, django CMS uses `git`_ as a version control system.
-The `Github help`_ is very well written and will get you started on using git
-and github in a jiffy. It is an invaluable resource for newbies and old timers
+The `GitHub help`_ is very well written and will get you started on using git
+and GitHub in a jiffy. It is an invaluable resource for newbies and old timers
alike.
@@ -82,7 +82,7 @@ Process
This is how you fix a bug or add a feature:
-#. `fork`_ us on github.
+#. `fork`_ us on GitHub.
#. Checkout your fork.
#. Hack hack hack, test test test, commit commit commit, test again.
#. Push to your fork.
@@ -135,7 +135,7 @@ correctness.
Documentation should be:
-- We use `Sphinx`_/restructuredText. So obviously this is the format you should
+- 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
@@ -148,7 +148,7 @@ Documentation should be:
A brief description of what it does is also welcome.
Pulling of documentation is pretty fast and painless. Usually somebody goes over
-your text and merges it, since there are no "breaks" and that github parses rst
+your text and merges it, since there are no "breaks" and that GitHub parses rst
files automagically it's really convenient to work with.
Also, contributing to the documentation will earn you great respect from the
@@ -173,7 +173,7 @@ Translations
************
-For translators we have a `transifex account
+For translators we have a `Transifex account
<http://www.transifex.net/projects/p/django-cms/>`_ where you can translate
the .po files and don't need to install git or mercurial to be able to
contribute. All changes there will be automatically sent to the project.
@@ -182,5 +182,12 @@ contribute. All changes there will be automatically sent to the project.
.. _Sphinx: http://sphinx.pocoo.org/
.. _PEP8: http://www.python.org/dev/peps/pep-0008/
.. _django-cms-developers: http://groups.google.com/group/django-cms-developers
-.. _Github : http://www.github.com
-.. _Github help : http://help.github.com
+.. _GitHub : http://www.github.com
+.. _GitHub help : http://help.github.com
+.. _freenode : http://freenode.net/
+.. _@djangocmsstatus : https://twitter.com/djangocmsstatus
+.. _@djangocms : https://twitter.com/djangocms
+.. _pull request : http://help.github.com/send-pull-requests/
+.. _git : http://git-scm.com/
+.. _restructuredText: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
+
@@ -260,3 +260,23 @@ menus.base
this node.
:param bool visible: Optional, defaults to ``True``, whether this item is
visible or not.
+
+
+ .. method:: get_descendants
+
+ Returns a list of all children beneath the current menu item.
+
+ .. method:: get_ancestors
+
+ Returns a list of all parent items, excluding the current menu item.
+
+ .. method:: get_absolute_url
+
+ Utility method to return the URL associated with this menu item,
+ primarily to follow naming convention asserted by Django.
+
+ .. method:: get_menu_title
+
+ Utility method to return the associated title, using the same naming
+ convention used by :class:`cms.models.pagemodel.Page`.
+
@@ -313,7 +313,7 @@ An example use-case
-------------------
A simple example: you have a news application that publishes pages
-independently of Django CMS. However, you would like to integrate the
+independently of django CMS. However, you would like to integrate the
application into the menu structure of your site, so that at appropriate
places a *News* node appears in the navigation menu.
@@ -2,8 +2,8 @@
Custom Plugins
##############
-CMS Plugins are reusable content publishers, that can be inserted into Django
-CMS pages (or indeed into any content that uses Django CMS placeholders) in
+CMS Plugins are reusable content publishers, that can be inserted into django
+CMS pages (or indeed into any content that uses django CMS placeholders) in
order to publish information automatically, without further intervention.
This means that your published web content, whatever it is, can be kept
@@ -22,17 +22,17 @@ Why would you need to write a plugin?
*************************************
A plugin is the most convenient way to integrate content from another Django
-app into a Django CMS page.
+app into a django CMS page.
-For example, suppose you're developing a site for a record company in Django
+For example, suppose you're developing a site for a record company in django
CMS. You might like to have on your site's home page a "Latest releases" box.
Of course, you could every so often edit that page and update the information.
However, a sensible record company will manage its catalogue in Django too,
which means Django already knows what this week's new releases are.
This is an excellent opportunity to make use of that information to make your
-life easier - all you need to do is create a Django CMS plugin that you can
+life easier - all you need to do is create a django CMS plugin that you can
insert into your home page, and leave it to do the work of publishing information
about the latest releases for you.
@@ -45,7 +45,7 @@ publish information about recent new releases in that series.
Overview
********
-A Django CMS plugin is fundamentally composed of three things.
+A django CMS plugin is fundamentally composed of three things.
* a plugin **editor**, to configure a plugin each time it is deployed
* a plugin **publisher**, to do the automated work of deciding what to publish
@@ -2,7 +2,7 @@
Placeholders outside the CMS
############################
-Placeholders are special model fields that DjangoCMS uses to render
+Placeholders are special model fields that django CMS uses to render
user-editable content (plugins) in templates. That is, it's the place where a
user can add text, video or any other plugin to a webpage, using either the
normal Django admin interface or the so called `frontend editing`.
@@ -1,5 +1,5 @@
#########################
-Search and the Django-CMS
+Search and the django CMS
#########################
For powerful full-text search in with the django CMS, we suggest using
@@ -4,7 +4,7 @@
Configuration
#############
-The Django-CMS has a lot of settings you can use to customize your installation
+The django CMS has a lot of settings you can use to customize your installation
of the CMS to be exactly like you want it to be.
*****************
@@ -209,7 +209,7 @@ CMS_HIDE_UNTRANSLATED
Default: ``True``
-By default django-cms hides menu items that are not yet translated into the
+By default django CMS hides menu items that are not yet translated into the
current language. With this setting set to False they will show up anyway.
.. setting:: CMS_LANGUAGES
@@ -219,7 +219,7 @@ CMS_LANGUAGES
Default: Value of :setting:`django:LANGUAGES`
-Defines the languages available in the CMS.
+Defines the languages available in django CMS.
Example::
@@ -283,7 +283,7 @@ CMS_FRONTEND_LANGUAGES
Default: Value of :setting:`CMS_LANGUAGES`
-A list of languages Django CMS uses in the frontend. For example, if
+A list of languages django CMS uses in the frontend. For example, if
you decide you want to add a new language to your page but don't want to
show it to the world yet.
@@ -330,12 +330,12 @@ CMS_PAGE_MEDIA_PATH
Default: ``'cms_page_media/'``
-By default, Django CMS creates a folder called ``cms_page_media`` in your
+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 subfolders numbered with the id of the page.
You should take care that the directory to which it points is writable by the
-user under which django will be running.
+user under which Django will be running.
****
@@ -90,7 +90,7 @@ On Microsoft Windows
Databases
*********
-We recommend using `PostgreSQL`_ or `MySQL`_ with Django CMS. Installing and
+We recommend using `PostgreSQL`_ or `MySQL`_ with django CMS. Installing and
maintaining database systems is outside the scope of this documentation, but is
very well documented on the system's respective websites.
@@ -98,7 +98,7 @@ instead:
If you opt for core plugins you should take care that directory to which
: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 writable by the user under which Django
will be running. If you have opted for django-filer then similar requirement
exists based on its configuration.
@@ -137,7 +137,7 @@ default Django settings file will not have any)::
Almost there!
Point your :setting:`django:MEDIA_ROOT` to where the static media should live (that is,
-your images,CSS files, Javascript files...)::
+your images, CSS files, Javascript files...)::
MEDIA_ROOT = os.path.join(PROJECT_PATH, "media")
MEDIA_URL = "/media/"
@@ -219,7 +219,7 @@ and `django-appmedia`_ will do all the work for you.
Creating templates
******************
-Django CMS uses templates to define how a page should look and what parts of
+django CMS uses templates to define how a page should look and what parts of
it are editable. Editable areas are called *placeholders*. These templates are
standard Django templates and you may use them as described in the
`official documentation`_.
@@ -301,7 +301,7 @@ Initial database setup
This command depends on whether you **upgrade** your installation or do a
**fresh install**. We recommend that you get familiar with the way `South`_ works,
-as it is a very powerful, easy and convenient tool. Django CMS uses it extensively.
+as it is a very powerful, easy and convenient tool. django CMS uses it extensively.
Fresh install
-------------
@@ -337,7 +337,7 @@ Head over to the `admin panel <http://127.0.0.1:8000/admin/>` and log in with
the user you created during the database setup.
To deploy your django CMS project on a production webserver, please refer to the
-`Django Documentation <http://docs.djangoproject.com/en/1.2/howto/deployment/>`_.
+`Django documentation <http://docs.djangoproject.com/en/1.2/howto/deployment/>`_.
@@ -375,7 +375,7 @@ pages.
.. |my-first-page| image:: ../images/my-first-page.png
-Congratulations! You now have a fully functional Django CMS installation!
+Congratulations! You now have a fully functional django CMS installation!
Publishing a page
=================
@@ -455,7 +455,7 @@ Template errors
If your placeholder content isn't displayed when you view a CMS Page: change the
:setting:`CMS_MODERATOR` setting in your ``settings.py`` to ``False``. This bug
-has been recently fixed, so upgrade to the latest version of Django CMS. See:
+has been recently fixed, so upgrade to the latest version of django CMS. See:
https://github.com/divio/django-cms/issues/issue/430
@@ -1,5 +1,5 @@
###########################
-Using South with Django-CMS
+Using South with django CMS
###########################
South is an incredible piece of software that lets you handle database
View
@@ -4,7 +4,7 @@
contain the root `toctree` directive.
######################################
-Welcome to django cms's documentation!
+Welcome to django CMS's documentation!
######################################
This document refers to version |release|
@@ -57,9 +57,9 @@ Extending the CMS
extending_cms/fields
-***********************
-Contributing to the CMS
-***********************
+**************************
+Contributing to django CMS
+**************************
.. toctree::
:maxdepth: 2

0 comments on commit eeab29e

Please sign in to comment.