Code

Changes between Version 25 and Version 26 of DocSprint12Apr


Ignore:
Timestamp:
04/14/08 08:33:23 (6 years ago)
Author:
jacob
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DocSprint12Apr

    v25 v26  
    1515 * Add [http://sphinx.pocoo.org/markup/para.html#glossary glossary] directives for "important" terms. A very small starting list can be found [http://www.djangoproject.com/documentation/contributing/#commonly-used-terms in the contributing documentation], but there's many more candidates for glossary. 
    1616 * Start looking at the generated index (look in {{{_build/html/genindex.html}}} after running a build) and improving it by adding [http://sphinx.pocoo.org/markup/para.html#index-generating-markup index directives] where appropriate. 
    17  * Fill in empty documents with content (most will just be moved from other places). Currently empty files: 
    18 {{{ 
    19     ./howto/newforms-migration.txt 
    20     ./howto/split-models.txt 
    21     ./howto/standalone-templates.txt 
    22     ./howto/url-best-practices.txt 
    23     ./obsolete/pagination.txt 
    24     ./topics/db/managers.txt 
    25     ./topics/db/queries.txt 
    26     ./topics/db/sql.txt 
    27     ./topics/http/auth.txt 
    28     ./topics/http/generic-views.txt 
    29 }}} 
     17 * Fill in documents missing content (see below). 
    3018 * Find code blocks and make sure they're [http://sphinx.pocoo.org/markup/code.html syntax highlighted] correctly. 
    3119 
     
    5240 * ~~knmurphy -- moving ref/django-admin.txt to ./howto/custom-management-commands.txt  
    5341 * yml -- Replace all images ({{{.. image::}}} and {{{.. figure::}}} directives) with local image files -- right now they use absolute URLs to Django's media server. Images should be put in in {{{_static}}} directory next to the document they're used in. For an example, see {{{internals/contributing.txt}}} and the associated {{{internals/_static}}} directory. 
     42 
     43== Status == 
     44 
     45Here's where every file stands. Before we can push this into trunk all the files 
     46have to have content and have to have all the Sphinx markup applied. Stuff like 
     47index entries and code highlighting can come later if needed; when this 
     48checklist is full we can push upstream. 
     49 
     50|| '''File'''                             || '''Content''' || '''Markup''' || 
     51|| faq/admin.txt                          || Y             || Y            || 
     52|| faq/contributing.txt                   || Y             || Y            || 
     53|| faq/general.txt                        || Y             || Y            || 
     54|| faq/index.txt                          || Y             || Y            || 
     55|| faq/install.txt                        || Y             || Y            || 
     56|| faq/models.txt                         || Y             || Y            || 
     57|| faq/usage.txt                          || Y             || Y            || 
     58 
     59|| howto/apache-auth.txt                  || Y             || Y            || 
     60|| howto/custom-management-commands.txt   || Y             || Y            || 
     61|| howto/custom-model-fields.txt          || Y             || Y            || 
     62|| howto/custom-template-tags.txt         || Y             || Y            || 
     63|| howto/deployment/fastcgi.txt           || Y             ||              || 
     64|| howto/deployment/index.txt             ||               ||              || 
     65|| howto/deployment/modpython.txt         || Y             ||              || 
     66|| howto/error-reporting.txt              || Y             ||              || 
     67|| howto/index.txt                        ||               ||              || 
     68|| howto/initial-data.txt                 ||               ||              || 
     69|| howto/legacy-databases.txt             || Y             ||              || 
     70|| howto/newforms-migration.txt           ||               ||              || 
     71|| howto/outputting-csv.txt               || Y             ||              || 
     72|| howto/outputting-pdf.txt               || Y             ||              || 
     73|| howto/split-models.txt                 ||               ||              || 
     74|| howto/standalone-templates.txt         ||               ||              || 
     75|| howto/static-files.txt                 || Y             ||              || 
     76|| howto/url-best-practices.txt           ||               ||              || 
     77 
     78|| index.txt                              ||               ||              || 
     79 
     80|| internals/contributing.txt             || Y             || Y            || 
     81|| internals/documentation.txt            ||               ||              || 
     82|| internals/index.txt                    ||               ||              || 
     83 
     84|| intro/index.txt                        ||               ||              || 
     85|| intro/install.txt                      ||               ||              || 
     86|| intro/overview.txt                     || Y             ||              || 
     87|| intro/tutorial01.txt                   || Y             ||              || 
     88|| intro/tutorial02.txt                   || Y             ||              || 
     89|| intro/tutorial03.txt                   || Y             ||              || 
     90|| intro/tutorial04.txt                   || Y             ||              || 
     91|| intro/whatsnext.txt                    ||               ||              || 
     92 
     93|| misc/api-stability.txt                 || Y             ||              || 
     94|| misc/design-philosophies.txt           || Y             ||              || 
     95|| misc/distributions.txt                 || Y             ||              || 
     96|| misc/index.txt                         ||               ||              || 
     97 
     98|| obsolete/admin-css.txt                 || Y             ||              || 
     99|| obsolete/form-for-model.txt            || Y             ||              || 
     100|| obsolete/forms.txt                     || Y             ||              || 
     101|| obsolete/index.txt                     ||               ||              || 
     102|| obsolete/pagination.txt                ||               ||              || 
     103 
     104|| ref/contrib/admin.txt                  ||               ||              || 
     105|| ref/contrib/auth.txt                   ||               ||              || 
     106|| ref/contrib/contenttypes.txt           || Y             || Y            || 
     107|| ref/contrib/csrf.txt                   ||               ||              || 
     108|| ref/contrib/databrowse.txt             ||               ||              || 
     109|| ref/contrib/flatpages.txt              ||               ||              || 
     110|| ref/contrib/formtools/form-preview.txt ||               ||              || 
     111|| ref/contrib/formtools/form-wizard.txt  ||               ||              || 
     112|| ref/contrib/formtools/index.txt        ||               ||              || 
     113|| ref/contrib/index.txt                  ||               ||              || 
     114|| ref/contrib/localflavor.txt            ||               ||              || 
     115|| ref/contrib/redirects.txt              ||               ||              || 
     116|| ref/contrib/sitemaps.txt               ||               ||              || 
     117|| ref/contrib/sites.txt                  ||               ||              || 
     118|| ref/contrib/syndication.txt            ||               ||              || 
     119|| ref/contrib/webdesign.txt              ||               ||              || 
     120|| ref/databases.txt                      ||               ||              || 
     121|| ref/django-admin.txt                   ||               ||              || 
     122|| ref/forms/api.txt                      ||               ||              || 
     123|| ref/forms/fields.txt                   ||               ||              || 
     124|| ref/forms/index.txt                    ||               ||              || 
     125|| ref/forms/widgets.txt                  ||               ||              || 
     126|| ref/generic-views.txt                  ||               ||              || 
     127|| ref/index.txt                          ||               ||              || 
     128|| ref/middleware.txt                     ||               ||              || 
     129|| ref/models/fields.txt                  ||               ||              || 
     130|| ref/models/index.txt                   ||               ||              || 
     131|| ref/models/instances.txt               ||               ||              || 
     132|| ref/models/options.txt                 ||               ||              || 
     133|| ref/models/querysets.txt               ||               ||              || 
     134|| ref/models/relations.txt               ||               ||              || 
     135|| ref/request-response.txt               ||               ||              || 
     136|| ref/settings.txt                       ||               ||              || 
     137|| ref/templates/api.txt                  ||               ||              || 
     138|| ref/templates/authors.txt              ||               ||              || 
     139|| ref/templates/builtins.txt             ||               ||              || 
     140|| ref/templates/index.txt                ||               ||              || 
     141|| ref/unicode.txt                        ||               ||              || 
     142 
     143|| releases/0.95.txt                      ||               ||              || 
     144|| releases/0.96.txt                      ||               ||              || 
     145|| releases/index.txt                     ||               ||              || 
     146 
     147|| topics/auth.txt                        ||               ||              || 
     148|| topics/cache.txt                       ||               ||              || 
     149|| topics/db/index.txt                    ||               ||              || 
     150|| topics/db/managers.txt                 ||               ||              || 
     151|| topics/db/models.txt                   ||               ||              || 
     152|| topics/db/queries.txt                  ||               ||              || 
     153|| topics/db/sql.txt                      ||               ||              || 
     154|| topics/db/transactions.txt             ||               ||              || 
     155|| topics/email.txt                       ||               ||              || 
     156|| topics/forms/index.txt                 ||               ||              || 
     157|| topics/forms/modelforms.txt            ||               ||              || 
     158|| topics/http/auth.txt                   ||               ||              || 
     159|| topics/http/generic-views.txt          ||               ||              || 
     160|| topics/http/index.txt                  ||               ||              || 
     161|| topics/http/middleware.txt             ||               ||              || 
     162|| topics/http/sessions.txt               ||               ||              || 
     163|| topics/http/shortcuts.txt              ||               ||              || 
     164|| topics/http/urls.txt                   ||               ||              || 
     165|| topics/http/views.txt                  ||               ||              || 
     166|| topics/i18n.txt                        ||               ||              || 
     167|| topics/index.txt                       ||               ||              || 
     168|| topics/install.txt                     ||               ||              || 
     169|| topics/pagination.txt                  ||               ||              || 
     170|| topics/serialization.txt               ||               ||              || 
     171|| topics/settings.txt                    ||               ||              || 
     172|| topics/templates.txt                   ||               ||              || 
     173|| topics/testing.txt                     ||               ||              || 
     174