diff --git a/docs/index.txt b/docs/index.txt index 096afc43942..dc060b7b618 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -33,151 +33,82 @@ Having trouble? We'd like to help! First steps =========== -:ref:`Overview ` - See what writing a database-driven application with Django looks like. + * **From scratch:** :ref:`Overview ` | :ref:`Installation ` + * **Tutorial:** :ref:`Part 1 ` | :ref:`Part 2 ` | :ref:`Part 3 ` | :ref:`Part 4 ` -:ref:`Installation ` - Get Django installed on your computer. +The model layer +=============== -Tutorial: Writing your first Django application -=============================================== + * **Models:** :ref:`Model syntax ` | :ref:`Field types ` | :ref:`Meta options ` + * **QuerySets:** :ref:`Executing queries ` | :ref:`QuerySet method reference ` + * **Model instances:** :ref:`Instance methods ` | :ref:`Accessing related objects ` + * **Advanced:** :ref:`Managers ` | :ref:`Raw SQL ` | :ref:`Transactions ` | :ref:`Custom fields ` + * **Other:** :ref:`Supported databases ` | :ref:`Legacy databases ` | :ref:`Providing initial data ` -:ref:`Part 1 ` - Start a project, create models and play with the database API. +The template layer +================== -:ref:`Part 2 ` - Explore the automatically-generated admin site. + * **For designers:** :ref:`Syntax overview ` | :ref:`Built-in tags and filters ` + * **For programmers:** :ref:`Template API ` | :ref:`Custom tags and filters ` -:ref:`Part 3 ` - Write the public interface views. +The view layer +============== -:ref:`Part 4 ` - Learn how to process forms. + * **The basics:** :ref:`URLconfs ` | :ref:`View functions ` | :ref:`Shortcuts ` + * **Reference:** :ref:`Request/response objects ` + * **File uploads:** :ref:`Overview ` | :ref:`File objects ` | :ref:`Storage API ` | :ref:`Managing files ` | :ref:`Custom storage ` + * **Advanced:** :ref:`Generic views ` | :ref:`Generating CSV ` | :ref:`Generating PDF ` + * **Middleware:** :ref:`Overview ` | :ref:`Built-in middleware classes ` -Using Django -============ +Forms +===== -:ref:`Models ` - Design a single, definitive source of data about your data. + * **The basics:** :ref:`Overview ` | :ref:`Form API ` | :ref:`Built-in fields ` | :ref:`Built-in widgets ` + * **Advanced:** :ref:`Forms for models ` | :ref:`Integrating media ` | :ref:`Formsets ` | :ref:`Customizing validation ` + * **Extras:** :ref:`Form preview ` | :ref:`Form wizard ` -:ref:`Handling web requests ` - Handle web requests, map them to views and return pages. +The development process +======================= -:ref:`Forms ` - Build and handle HTML forms. + * **Settings:** :ref:`Overview ` | :ref:`Full list of settings ` + * **django-admin.py and manage.py:** :ref:`Overview ` | :ref:`Adding custom commands ` + * **Testing:** :ref:`Overview ` + * **Deployment:** :ref:`Overview ` | :ref:`Apache/mod_python ` | :ref:`FastCGI/SCGI/AJP ` | :ref:`Apache authentication ` | :ref:`Serving static files ` | :ref:`Tracking code errors by e-mail ` -:ref:`Templates ` - Develop the visual design of your site. - -And more: ---------- +Other batteries included +======================== + * :ref:`Admin site ` * :ref:`Authentication ` - * :ref:`Caching ` - * :ref:`E-mail ` - * :ref:`File-access APIs ` - * :ref:`topics-i18n` - * :ref:`topics-pagination` - * :ref:`Serialization ` - * :ref:`Sessions ` - * :ref:`Settings/configuration ` - * :ref:`topics-signals` - * :ref:`Testing ` - -Add-on ("contrib") applications -=============================== - -:ref:`Django's automatic admin site ` - Get a clean Web interface to your data with little effort. - -:ref:`Form tools ` - Easily handle complex form workflows. - -:ref:`Syndication feeds ` - Generate RSS and Atom feeds of your data. - -:ref:`"Local flavor" ` - Give your site that special local touch. - -And more: ---------- - + * :ref:`Cache system ` * :ref:`Comments ` * :ref:`Content types ` * :ref:`Cross Site Request Forgery protection ` * :ref:`Databrowse ` + * :ref:`E-mail (sending) ` * :ref:`Flatpages ` * :ref:`Humanize ` + * :ref:`Internationalization ` + * :ref:`Jython support ` + * :ref:`"Local flavor" ` + * :ref:`Pagination ` * :ref:`Redirects ` + * :ref:`Serialization ` + * :ref:`Sessions ` + * :ref:`Signals ` * :ref:`Sitemaps ` * :ref:`Sites ` + * :ref:`Syndication feeds (RSS/Atom) ` + * :ref:`Unicode in Django ` * :ref:`Web design helpers ` - * :ref:`Markup ` -Solving specific problems -========================= +The Django open-source project +============================== -:ref:`Deployment ` - Release your project to the world. + * **Community:** :ref:`How to get involved ` | :ref:`The release process ` | :ref:`Team of committers ` + * **Design philosophies:** :ref:`Overview ` + * **Documentation:** :ref:`About this documentation ` + * **Third-party distributions:** :ref:`Overview ` + * **Django over time:** :ref:`API stability ` | :ref:`Archive of release notes ` | `Backwards-incompatible changes`_ -:ref:`Importing data from legacy databases ` - Use Django with an existing database or alongside other web development - toolkits. - -:ref:`Custom template tags ` - Add your own extensions to Django's template language. - -:ref:`Generating CSV ` & :ref:`PDF ` - Produce non-HTML content with Django. - -And more: ---------- - - * :ref:`Authenticating in Apache ` - * :ref:`howto-custom-file-storage` - * :ref:`howto-custom-management-commands` - * :ref:`howto-custom-model-fields` - * :ref:`Tracking code errors by e-mail ` - * :ref:`howto-initial-data` - * :ref:`howto-jython` - * :ref:`Serving static files ` - -Reference -========= - -:ref:`Settings ` - See all of Django's settings and what they do. - -:ref:`Request & response objects ` - Understand the classes Django uses to represent HTTP requests and responses. - -:ref:`Model API reference ` - Revel in the gory details of Django's model system. - -:ref:`Form API reference ` - Learn the details of forms, fields and widgets. - -And more: ---------- - - * :ref:`ref-databases` - * :ref:`ref-django-admin` - * :ref:`ref-files-index` - * :ref:`ref-generic-views` - * :ref:`ref-middleware` - * :ref:`ref-templates-index` - * :ref:`ref-unicode` - -And all the rest -================ - -:ref:`Internals ` - Learn how Django works under the hood and how you can contribute to the - project. - -:ref:`Release notes ` - See what is and was new in each release of Django. - -:ref:`Miscellany ` - Stuff we can't find a more organized place for. Like that drawer in your - kitchen with the scissors, batteries and duct tape. +.. _Backwards-incompatible changes: http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges