Skip to content

Commit

Permalink
Merge pull request django-cms#868 from evildmp/patch-2
Browse files Browse the repository at this point in the history
Added an example of how soft roots work
  • Loading branch information
fivethreeo committed Jun 15, 2011
2 parents a090c06 + 118d97b commit 1fdedd2
Showing 1 changed file with 53 additions and 1 deletion.
54 changes: 53 additions & 1 deletion docs/getting_started/navigation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,9 @@ If true this node is a "soft root".
Soft Roots
**********

What Soft Roots do
==================

A *soft root* is a page that acts as the root for a menu
navigation tree.

Expand All @@ -208,9 +211,58 @@ at the real root of the site's page hierarchy.

This feature is useful when your site has deep page hierarchies
(and therefore multiple levels in its navigation trees). In such
a case, you usually don’t want to present site visitors with deep
a case, you usually don’t want to present site visitors with deep
menus of nested items.

For example, you're on the page "Introduction to Bleeding", so the menu might look like this:

* School of Medicine
* Medical Education
* Departments
* Department of Lorem Ipsum
* Department of Donec Imperdiet
* Department of Cras Eros
* Department of Mediaeval Surgery
* Theory
* Cures
* Bleeding
* Introduction to Bleeding <this is the current page>
* Bleeding - the scientific evidence
* Cleaning up the mess
* Cupping
* Leaches
* Maggots
* Techniques
* Instruments
* Department of Curabitur a Purus
* Department of Sed Accumsan
* Department of Etiam
* Research
* Administration
* Contact us
* Impressum

which is frankly overwhelming.

By making "Department of Mediaeval Surgery" a *soft root*, the
menu becomes much more manageable:

* Department of Mediaeval Surgery
* Theory
* Cures
* Bleeding
* Introduction to Bleeding <current page>
* Bleeding - the scientific evidence
* Cleaning up the mess
* Cupping
* Leaches
* Maggots
* Techniques
* Instruments

Using Soft Roots
================

To enable the feature, ``settings.py`` requires:

CMS_SOFTROOT = True
Expand Down

0 comments on commit 1fdedd2

Please sign in to comment.