Django

Code

Changeset 9490

Show
Ignore:
Timestamp:
11/18/08 01:33:35 (2 months ago)
Author:
adrian
Message:

Greatly refactored the docs index to allow for more efficient use by power users, while staying clean for new users. It no longer takes four clicks to get to the list of default template filters.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • django/trunk/docs/index.txt

    r9139 r9490  
    3434=========== 
    3535 
    36 :ref:`Overview <intro-overview>` 
    37     See what writing a database-driven application with Django looks like. 
     36    * **From scratch:** :ref:`Overview <intro-overview>` | :ref:`Installation <intro-install>` 
     37    * **Tutorial:** :ref:`Part 1 <intro-tutorial01>` | :ref:`Part 2 <intro-tutorial02>` | :ref:`Part 3 <intro-tutorial03>` | :ref:`Part 4 <intro-tutorial04>` 
    3838 
    39 :ref:`Installation <intro-install>` 
    40     Get Django installed on your computer. 
     39The model layer 
     40=============== 
    4141 
    42 Tutorial: Writing your first Django application 
    43 =============================================== 
     42    * **Models:** :ref:`Model syntax <topics-db-models>` | :ref:`Field types <ref-models-fields>` | :ref:`Meta options <ref-models-options>` 
     43    * **QuerySets:** :ref:`Executing queries <topics-db-queries>` | :ref:`QuerySet method reference <ref-models-querysets>` 
     44    * **Model instances:** :ref:`Instance methods <ref-models-instances>` | :ref:`Accessing related objects <ref-models-relations>` 
     45    * **Advanced:** :ref:`Managers <topics-db-managers>` | :ref:`Raw SQL <topics-db-sql>` | :ref:`Transactions <topics-db-transactions>` | :ref:`Custom fields <howto-custom-model-fields>` 
     46    * **Other:** :ref:`Supported databases <ref-databases>` | :ref:`Legacy databases <howto-legacy-databases>` | :ref:`Providing initial data <howto-initial-data>` 
    4447 
    45 :ref:`Part 1 <intro-tutorial01>` 
    46     Start a project, create models and play with the database API. 
     48The template layer 
     49================== 
    4750 
    48 :ref:`Part 2 <intro-tutorial02>` 
    49     Explore the automatically-generated admin site. 
     51    * **For designers:** :ref:`Syntax overview <topics-templates>` | :ref:`Built-in tags and filters <ref-templates-builtins>` 
     52    * **For programmers:** :ref:`Template API <ref-templates-api>` | :ref:`Custom tags and filters <howto-custom-template-tags>` 
    5053 
    51 :ref:`Part 3 <intro-tutorial03>` 
    52     Write the public interface views. 
     54The view layer 
     55============== 
    5356 
    54 :ref:`Part 4 <intro-tutorial04>` 
    55     Learn how to process forms. 
     57    * **The basics:** :ref:`URLconfs <topics-http-urls>` | :ref:`View functions <topics-http-views>` | :ref:`Shortcuts <topics-http-shortcuts>` 
     58    * **Reference:** :ref:`Request/response objects <ref-request-response>` 
     59    * **File uploads:** :ref:`Overview <topics-http-file-uploads>` | :ref:`File objects <ref-files-file>` | :ref:`Storage API <ref-files-storage>` | :ref:`Managing files <topics-files>` | :ref:`Custom storage <howto-custom-file-storage>` 
     60    * **Advanced:** :ref:`Generic views <ref-generic-views>` | :ref:`Generating CSV <howto-outputting-csv>` | :ref:`Generating PDF <howto-outputting-pdf>` 
     61    * **Middleware:** :ref:`Overview <topics-http-middleware>` | :ref:`Built-in middleware classes <ref-middleware>` 
    5662 
    57 Using Django 
    58 ============ 
     63Forms 
     64===== 
    5965 
    60 :ref:`Models <topics-db-index>` 
    61     Design a single, definitive source of data about your data. 
     66    * **The basics:** :ref:`Overview <topics-forms-index>` | :ref:`Form API <ref-forms-api>` | :ref:`Built-in fields <ref-forms-fields>` | :ref:`Built-in widgets <ref-forms-widgets>` 
     67    * **Advanced:** :ref:`Forms for models <topics-forms-modelforms>` | :ref:`Integrating media <topics-forms-media>` | :ref:`Formsets <topics-forms-formsets>` | :ref:`Customizing validation <ref-forms-validation>` 
     68    * **Extras:** :ref:`Form preview <ref-contrib-formtools-form-preview>` | :ref:`Form wizard <ref-contrib-formtools-form-wizard>` 
    6269 
    63 :ref:`Handling web requests <topics-http-index>` 
    64     Handle web requests, map them to views and return pages. 
     70The development process 
     71======================= 
    6572 
    66 :ref:`Forms <topics-forms-index>` 
    67     Build and handle HTML forms. 
     73    * **Settings:** :ref:`Overview <topics-settings>` | :ref:`Full list of settings <ref-settings>` 
     74    * **django-admin.py and manage.py:** :ref:`Overview <ref-django-admin>` | :ref:`Adding custom commands <howto-custom-management-commands>` 
     75    * **Testing:** :ref:`Overview <topics-testing>` 
     76    * **Deployment:** :ref:`Overview <howto-deployment-index>` | :ref:`Apache/mod_python <howto-deployment-modpython>` | :ref:`FastCGI/SCGI/AJP <howto-deployment-fastcgi>` | :ref:`Apache authentication <howto-apache-auth>` | :ref:`Serving static files <howto-static-files>` | :ref:`Tracking code errors by e-mail <howto-error-reporting>` 
    6877 
    69 :ref:`Templates <topics-templates>` 
    70     Develop the visual design of your site. 
     78Other batteries included 
     79======================== 
    7180 
    72 And more: 
    73 --------- 
    74  
     81    * :ref:`Admin site <ref-contrib-admin>` 
    7582    * :ref:`Authentication <topics-auth>` 
    76     * :ref:`Caching <topics-cache>` 
    77     * :ref:`E-mail <topics-email>` 
    78     * :ref:`File-access APIs <topics-files>` 
    79     * :ref:`topics-i18n` 
    80     * :ref:`topics-pagination` 
    81     * :ref:`Serialization <topics-serialization>` 
    82     * :ref:`Sessions <topics-http-sessions>` 
    83     * :ref:`Settings/configuration <topics-settings>` 
    84     * :ref:`topics-signals` 
    85     * :ref:`Testing <topics-testing>` 
    86  
    87 Add-on ("contrib") applications 
    88 =============================== 
    89  
    90 :ref:`Django's automatic admin site <ref-contrib-admin>` 
    91     Get a clean Web interface to your data with little effort. 
    92  
    93 :ref:`Form tools <ref-contrib-formtools-index>` 
    94     Easily handle complex form workflows. 
    95  
    96 :ref:`Syndication feeds <ref-contrib-syndication>` 
    97     Generate RSS and Atom feeds of your data. 
    98  
    99 :ref:`"Local flavor" <ref-contrib-localflavor>` 
    100     Give your site that special local touch. 
    101  
    102 And more: 
    103 --------- 
    104  
     83    * :ref:`Cache system <topics-cache>` 
    10584    * :ref:`Comments <ref-contrib-comments-index>` 
    10685    * :ref:`Content types <ref-contrib-contenttypes>` 
    10786    * :ref:`Cross Site Request Forgery protection <ref-contrib-csrf>` 
    10887    * :ref:`Databrowse <ref-contrib-databrowse>` 
     88    * :ref:`E-mail (sending) <topics-email>` 
    10989    * :ref:`Flatpages <ref-contrib-flatpages>` 
    11090    * :ref:`Humanize <ref-contrib-humanize>` 
     91    * :ref:`Internationalization <topics-i18n>` 
     92    * :ref:`Jython support <howto-jython>` 
     93    * :ref:`"Local flavor" <ref-contrib-localflavor>` 
     94    * :ref:`Pagination <topics-pagination>` 
    11195    * :ref:`Redirects <ref-contrib-redirects>` 
     96    * :ref:`Serialization <topics-serialization>` 
     97    * :ref:`Sessions <topics-http-sessions>` 
     98    * :ref:`Signals <topics-signals>` 
    11299    * :ref:`Sitemaps <ref-contrib-sitemaps>` 
    113100    * :ref:`Sites <ref-contrib-sites>` 
     101    * :ref:`Syndication feeds (RSS/Atom) <ref-contrib-syndication>` 
     102    * :ref:`Unicode in Django <ref-unicode>` 
    114103    * :ref:`Web design helpers <ref-contrib-webdesign>` 
    115     * :ref:`Markup <ref-contrib-markup>` 
    116104 
    117 Solving specific problems 
    118 ========================= 
     105The Django open-source project 
     106============================== 
    119107 
    120 :ref:`Deployment <howto-deployment-index>` 
    121     Release your project to the world. 
     108    * **Community:** :ref:`How to get involved <internals-contributing>` | :ref:`The release process <internals-release-process>` | :ref:`Team of committers <internals-committers>` 
     109    * **Design philosophies:** :ref:`Overview <misc-design-philosophies>` 
     110    * **Documentation:** :ref:`About this documentation <internals-documentation>` 
     111    * **Third-party distributions:** :ref:`Overview <misc-distributions>` 
     112    * **Django over time:** :ref:`API stability <misc-api-stability>` | :ref:`Archive of release notes <releases-index>` | `Backwards-incompatible changes`_ 
    122113 
    123 :ref:`Importing data from legacy databases <howto-legacy-databases>` 
    124     Use Django with an existing database or alongside other web development 
    125     toolkits. 
    126  
    127 :ref:`Custom template tags <howto-custom-template-tags>` 
    128     Add your own extensions to Django's template language. 
    129  
    130 :ref:`Generating CSV <howto-outputting-csv>` & :ref:`PDF <howto-outputting-pdf>` 
    131     Produce non-HTML content with Django. 
    132  
    133 And more: 
    134 --------- 
    135  
    136     * :ref:`Authenticating in Apache <howto-apache-auth>` 
    137     * :ref:`howto-custom-file-storage` 
    138     * :ref:`howto-custom-management-commands` 
    139     * :ref:`howto-custom-model-fields` 
    140     * :ref:`Tracking code errors by e-mail <howto-error-reporting>` 
    141     * :ref:`howto-initial-data` 
    142     * :ref:`howto-jython` 
    143     * :ref:`Serving static files <howto-static-files>` 
    144  
    145 Reference 
    146 ========= 
    147  
    148 :ref:`Settings <ref-settings>` 
    149     See all of Django's settings and what they do. 
    150  
    151 :ref:`Request & response objects <ref-request-response>` 
    152     Understand the classes Django uses to represent HTTP requests and responses. 
    153  
    154 :ref:`Model API reference <ref-models-index>` 
    155     Revel in the gory details of Django's model system. 
    156  
    157 :ref:`Form API reference <ref-forms-index>` 
    158     Learn the details of forms, fields and widgets. 
    159  
    160 And more: 
    161 --------- 
    162  
    163     * :ref:`ref-databases` 
    164     * :ref:`ref-django-admin` 
    165     * :ref:`ref-files-index` 
    166     * :ref:`ref-generic-views` 
    167     * :ref:`ref-middleware` 
    168     * :ref:`ref-templates-index` 
    169     * :ref:`ref-unicode` 
    170  
    171 And all the rest 
    172 ================ 
    173  
    174 :ref:`Internals <internals-index>` 
    175     Learn how Django works under the hood and how you can contribute to the 
    176     project. 
    177  
    178 :ref:`Release notes <releases-index>` 
    179     See what is and was new in each release of Django. 
    180  
    181 :ref:`Miscellany <misc-index>` 
    182     Stuff we can't find a more organized place for. Like that drawer in your 
    183     kitchen with the scissors, batteries and duct tape. 
     114.. _Backwards-incompatible changes: http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges