From 197863523a7631ae1d11d4fdf49b747a96e011a3 Mon Sep 17 00:00:00 2001 From: Julien Phalip Date: Sat, 4 Aug 2012 16:05:12 -0700 Subject: [PATCH] Restructured the documentation's index page and added some introductory sentences to each section. --- docs/index.txt | 140 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 104 insertions(+), 36 deletions(-) diff --git a/docs/index.txt b/docs/index.txt index 50e8471b14..b01116124f 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -34,6 +34,8 @@ Having trouble? We'd like to help! First steps =========== +Are you new to Django or to programming? This is the place to start! + * **From scratch:** :doc:`Overview ` | :doc:`Installation ` @@ -47,6 +49,9 @@ First steps The model layer =============== +Django provides an abstration layer (the "models") for structuring and +manipulating the data of your Web application. Learn more about it below: + * **Models:** :doc:`Model syntax ` | :doc:`Field types ` | @@ -74,20 +79,13 @@ The model layer :doc:`Providing initial data ` | :doc:`Optimize database access ` -The template layer -================== - -* **For designers:** - :doc:`Syntax overview ` | - :doc:`Built-in tags and filters ` - -* **For programmers:** - :doc:`Template API ` | - :doc:`Custom tags and filters ` - The view layer ============== +Django offers the concept of "views" to encapsulate the logic reponsible for +processing a user's request and for returning the response. Find all you need +to know about views via the links below: + * **The basics:** :doc:`URLconfs ` | :doc:`View functions ` | @@ -118,9 +116,29 @@ The view layer :doc:`Overview ` | :doc:`Built-in middleware classes ` +The template layer +================== + +The template layer provides a designer-friendly syntax for rendering the +information to be presented to the user. Learn how this syntax can be used by +designers and how it can be extended by programmers: + +* **For designers:** + :doc:`Syntax overview ` | + :doc:`Built-in tags and filters ` | + :doc:`Web design helpers ` | + :doc:`Humanization ` + +* **For programmers:** + :doc:`Template API ` | + :doc:`Custom tags and filters ` + Forms ===== +Django provides a rich framework to facilitate the creation of forms and the +manipulation of form data. + * **The basics:** :doc:`Overview ` | :doc:`Form API ` | @@ -140,6 +158,9 @@ Forms The development process ======================= +Learn about the various components and tools to help you in the development and +testing of Django applications: + * **Settings:** :doc:`Overview ` | :doc:`Full list of settings ` @@ -161,46 +182,93 @@ The development process :doc:`Handling static files ` | :doc:`Tracking code errors by email ` -Other batteries included -======================== +The admin +========= -* :doc:`Admin site ` | :doc:`Admin actions ` | :doc:`Admin documentation generator` -* :doc:`Authentication ` -* :doc:`Cache system ` +Find all you need to know about the automated admin interface, one of Django's +most popular features: + +* :doc:`Admin site ` +* :doc:`Admin actions ` +* :doc:`Admin documentation generator` + +Security +======== + +Security is a topic of paramount importance in the development of Web +applications and Django provides multiple protection tools and mechanisms: + +* :doc:`Security overview ` * :doc:`Clickjacking protection ` -* :doc:`Comments ` | :doc:`Moderation ` | :doc:`Custom comments ` -* :doc:`Conditional content processing ` -* :doc:`Content types and generic relations ` * :doc:`Cross Site Request Forgery protection ` * :doc:`Cryptographic signing ` -* :doc:`Databrowse ` -* :doc:`E-mail (sending) ` -* :doc:`Flatpages ` -* :doc:`GeoDjango ` -* :doc:`Humanize ` + +Internationalization and localization +===================================== + +Django offers a robust internationalization and localization framework to +assist you in the development of applications for multiple languages and world +regions: + * :doc:`Internationalization ` -* :doc:`Jython support ` * :doc:`"Local flavor" ` -* :doc:`Logging ` -* :doc:`Messages ` -* :doc:`Pagination ` + +Python compatibility +==================== + +Django aims to be compatible with multiple different flavors and versions of +Python: + +* :doc:`Jython support ` * :doc:`Python 3 compatibility ` -* :doc:`Redirects ` -* :doc:`Security ` + +Geographic framework +==================== + +:doc:`GeoDjango ` intends to be a world-class geographic +Web framework. Its goal is to make it as easy as possible to build GIS Web +applications and harness the power of spatially enabled data. + +Common Web application tools +============================ + +Django offers multiple tools commonly needed in the development of Web +applications: + +* :doc:`Authentication ` +* :doc:`Caching ` +* :doc:`Logging ` +* :doc:`Sending e-mails ` +* :doc:`Syndication feeds (RSS/Atom) ` +* :doc:`Comments `, :doc:`comment moderation ` and :doc:`custom comments ` +* :doc:`Pagination ` +* :doc:`Messages framework ` * :doc:`Serialization ` * :doc:`Sessions ` -* :doc:`Signals ` * :doc:`Sitemaps ` -* :doc:`Sites ` -* :doc:`Static Files ` -* :doc:`Syndication feeds (RSS/Atom) ` +* :doc:`Static files management ` +* :doc:`Data validation ` + +Other core functionalities +========================== + +Learn about some other core functionalities of the Django framework: + +* :doc:`Conditional content processing ` +* :doc:`Content types and generic relations ` +* :doc:`Databrowse ` +* :doc:`Flatpages ` +* :doc:`Redirects ` +* :doc:`Signals ` +* :doc:`The sites framework ` * :doc:`Unicode in Django ` -* :doc:`Web design helpers ` -* :doc:`Validators ` The Django open-source project ============================== +Learn about the development process for the Django project itself and about how +you can contribute: + * **Community:** :doc:`How to get involved ` | :doc:`The release process ` |