Document the section better

batiste · Jun 12, 2016 · 363e12d · 363e12d
1 parent 293d40a
commit 363e12d
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 8 deletions.
diff --git a/README.rst b/README.rst
@@ -30,5 +30,5 @@ dynamically appears in the page admin interface.
 
 Each page can have a different template with different placeholders.
 
-.. image:: https://github.com/batiste/django-page-cms/raw/master/doc/admin-screenshot1.png
+.. image:: https://github.com/batiste/django-page-cms/raw/master/doc/images/admin-screenshot1.png
 
diff --git a/doc/admin-screenshot1.png → doc/images/admin-screenshot1.png b/doc/admin-screenshot1.png → doc/images/admin-screenshot1.png
diff --git a/doc/images/section.png b/doc/images/section.png
diff --git a/doc/introduction.rst b/doc/introduction.rst
@@ -17,7 +17,7 @@ The project code repository is found at this address: http://github.com/batiste/
 Screenshot
 ============
 
-.. image:: admin-screenshot1.png
+.. image:: images/admin-screenshot1.png
 
 Features
 ============

diff --git a/doc/placeholders.rst b/doc/placeholders.rst
@@ -79,13 +79,19 @@ Template syntax example::
     <img src="{{ img_src }}" alt=""/>
 
 The **section** option
------------------
+-------------------------
 
-The **section** option is used to group a placeholder into a section in admin.
+The **section** option is used to group placeholders into a section in the admin interface.
+A section is collapsed by default and hides the fields.
 
 Template syntax example::
 
     <meta name="description" content="{% placeholder "meta_description" section "SEO" %}" />
+    <meta name="description" content="{% placeholder "meta_keywords" section "SEO" %}" />
+
+You will get
+
+.. image:: images/section.png
 
 The **parsed** keyword
 -----------------------

diff --git a/example/templates/index.html b/example/templates/index.html
@@ -8,6 +8,7 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta name="description" content="{% placeholder "meta_description" section "SEO Options" %}">
+    <meta name="description" content="{% placeholder "meta_keywords" section "SEO Options" %}" />
     <meta name="author" content="">
 
     <title>{% placeholder 'title' %}</title>

diff --git a/requirements/documentation.txt b/requirements/documentation.txt
@@ -1,5 +1,2 @@
-django>=1.8,<1.10
-django-mptt>=0.8.0
-six>=1.5.2
-Pillow>=3.2.0<3.3.0
+-r base.txt
 sphinx