Django

Code

Changeset 8043

Show
Ignore:
Timestamp:
07/21/08 22:01:21 (2 months ago)
Author:
adrian
Message:

Fixed #7814 -- Fixed a number of style inconsistencies in the docs. Thanks, uzi and programmerq

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • django/trunk/docs/api_stability.txt

    r8020 r8043  
    6060   - `Request/response objects`_. 
    6161    
    62    - `Sending email`_. 
     62   - `Sending e-mail`_. 
    6363    
    6464   - `Sessions`_. 
     
    109109.. _redirects: ../redirects/ 
    110110.. _request/response objects: ../request_response/ 
    111 .. _sending email: ../email/ 
     111.. _sending e-mail: ../email/ 
    112112.. _sessions: ../sessions/ 
    113113.. _settings: ../settings/ 
  • django/trunk/docs/authentication.txt

    r8020 r8043  
    632632 
    633633Allows a user to reset their password, and sends them the new password 
    634 in an email. 
     634in an e-mail. 
    635635 
    636636**Optional arguments:** 
     
    641641 
    642642    * ``email_template_name``: The full name of a template to use for 
    643       generating the email with the new password. This will default to 
     643      generating the e-mail with the new password. This will default to 
    644644      ``registration/password_reset_email.html`` if not supplied. 
    645645 
     
    697697 
    698698    * ``django.contrib.auth.forms.PasswordResetForm``: A form for resetting a 
    699       user's password and emailing the new password to them. 
     699      user's password and e-mailing the new password to them. 
    700700 
    701701    * ``django.contrib.auth.forms.UserCreationForm``: A form for creating a 
  • django/trunk/docs/csrf.txt

    r7294 r8043  
    55The CsrfMiddleware class provides easy-to-use protection against 
    66`Cross Site Request Forgeries`_.  This type of attack occurs when a malicious 
    7 web site creates a link or form button that is intended to perform some action 
    8 on your web site, using the credentials of a logged-in user who is tricked 
     7Web site creates a link or form button that is intended to perform some action 
     8on your Web site, using the credentials of a logged-in user who is tricked 
    99into clicking on the link in their browser. 
    1010 
     
    3939   isn't, the user will get a 403 error. 
    4040 
    41 This ensures that only forms that have originated from your web site 
     41This ensures that only forms that have originated from your Web site 
    4242can be used to POST data back. 
    4343 
     
    4848 
    4949POST requests that are not accompanied by a session cookie are not protected, 
    50 but they do not need to be protected, since the 'attacking' web site 
     50but they do not need to be protected, since the 'attacking' Web site 
    5151could make these kind of requests anyway. 
    5252 
  • django/trunk/docs/db-api.txt

    r8001 r8043  
    464464``extra()`` calls, Django will not inspect these fragments to see if they need 
    465465to be rewritten because of changes in the merged query. So test the effects 
    466 carefully. Also realise that if you are combining two ``QuerySets`` with 
     466carefully. Also realize that if you are combining two ``QuerySets`` with 
    467467``|``, you cannot use ``extra(select=...)`` or ``extra(where=...)`` on *both* 
    468468``QuerySets``. You can only use those calls on one or the other (Django will 
  • django/trunk/docs/django-admin.txt

    r7844 r8043  
    396396Runs over the entire source tree of the current directory and pulls out all 
    397397strings marked for translation. It creates (or updates) a message file in the 
    398 conf/locale (in the django tree) or locale (for project and application) 
     398conf/locale (in the Django tree) or locale (for project and application) 
    399399directory. After making changes to the messages files you need to compile them 
    400400with ``compilemessages`` for use with the builtin gettext support. See the 
  • django/trunk/docs/forms.txt

    r8029 r8043  
    15581558--------------------------------- 
    15591559 
    1560 Form validation happens when the data is cleaned. If you want to customis
     1560Form validation happens when the data is cleaned. If you want to customiz
    15611561this process, there are various places you can change, each one serving a 
    15621562different purpose. Three types of cleaning methods are run during form 
     
    15691569problem with the data it is processing, passing the relevant error message to 
    15701570the ``ValidationError`` constructor. If no ``ValidationError`` is raised, the 
    1571 method should return the cleaned (normalised) data as a Python object. 
     1571method should return the cleaned (normalized) data as a Python object. 
    15721572 
    15731573If you detect multiple errors during a cleaning method and wish to signal all 
     
    16021602      any validation that requires access to multiple fields from the form at 
    16031603      once. This is where you might put in things to check that if field ``A`` 
    1604       is supplied, field ``B`` must contain a valid email address and the 
     1604      is supplied, field ``B`` must contain a valid e-mail address and the 
    16051605      like. The data that this method returns is the final ``cleaned_data`` 
    16061606      attribute for the form, so don't forget to return the full list of 
     
    17241724HTML - Django doesn't add a class definition, or any other widget-specific 
    17251725attributes. This means that all 'TextInput' widgets will appear the same 
    1726 on your web page. 
     1726on your Web page. 
    17271727 
    17281728If you want to make one widget look different to another, you need to 
     
    17481748    <tr><th>Comment:</th><td><input type="text" name="comment" /></td></tr> 
    17491749 
    1750 On a real web page, you probably don't want every widget to look the same. You 
     1750On a real Web page, you probably don't want every widget to look the same. You 
    17511751might want a larger input element for the comment, and you might want the 
    17521752'name' widget to have some special CSS class. To do this, you specify a 
  • django/trunk/docs/i18n.txt

    r7844 r8043  
    889889      used to differentiate between different programs that store their data 
    890890      in a common message-file library (usually ``/usr/share/locale/``). The 
    891       ``django`` domain is used for python and template translation strings 
     891      ``django`` domain is used for Python and template translation strings 
    892892      and is loaded into the global translation catalogs. The ``djangojs`` 
    893893      domain is only used for JavaScript translation catalogs to make sure 
  • django/trunk/docs/install.txt

    r7361 r8043  
    1919 
    2020If you just want to experiment with Django, skip ahead to the next 
    21 section; Django includes a lightweight web server you can use for 
     21section; Django includes a lightweight Web server you can use for 
    2222testing, so you won't need to set up Apache until you're ready to 
    2323deploy Django in production. 
     
    6565 
    6666* If you're using SQLite and either Python 2.3 or Python 2.4, you'll need 
    67   pysqlite_. Use version 2.0.3 or higher. Python 2.5 ships with an sqlite 
     67  pysqlite_. Use version 2.0.3 or higher. Python 2.5 ships with an SQLite 
    6868  wrapper in the standard library, so you don't need to install anything extra 
    6969  in that case. 
  • django/trunk/docs/release_notes_0.95.txt

    r7294 r8043  
    100100 
    101101Need help resolving a problem with Django? The documentation in the 
    102 distribution is also available online_ at the `Django website`_. The FAQ_ 
     102distribution is also available online_ at the `Django Web site`_. The FAQ_ 
    103103document is especially recommended, as it contains a number of issues that 
    104104come up time and again. 
     
    116116 
    117117.. _online: http://www.djangoproject.com/documentation/0.95/ 
    118 .. _Django website: http://www.djangoproject.com/ 
     118.. _Django Web site: http://www.djangoproject.com/ 
    119119.. _FAQ: http://www.djangoproject.com/documentation/faq/ 
    120120.. _django-users: http://groups.google.com/group/django-users 
  • django/trunk/docs/templates.txt

    r7811 r8043  
    19461946------------------------ 
    19471947 
    1948 A collection of template tags that can be useful while designing a website, 
     1948A collection of template tags that can be useful while designing a Web site, 
    19491949such as a generator of Lorem Ipsum text. See the `webdesign documentation`_. 
    19501950 
  • django/trunk/docs/tutorial03.txt

    r7294 r8043  
    442442* Django will find the match at ``'^polls/'`` 
    443443* It will strip off the matching text (``"polls/"``) and send the remaining 
    444   text -- ``"34/"`` -- to the 'mysite.polls.urls' urlconf for 
     444  text -- ``"34/"`` -- to the 'mysite.polls.urls' URLconf for 
    445445  further processing. 
    446446 
    447447Now that we've decoupled that, we need to decouple the 
    448 'mysite.polls.urls' urlconf by removing the leading "polls/" from each 
     448'mysite.polls.urls' URLconf by removing the leading "polls/" from each 
    449449line:: 
    450450 
  • django/trunk/docs/url_dispatch.txt

    r7560 r8043  
    374374essentially "roots" a set of URLs below other ones. 
    375375 
    376 For example, here's the URLconf for the `Django website`_ itself. It includes a 
     376For example, here's the URLconf for the `Django Web site`_ itself. It includes a 
    377377number of other URLconfs:: 
    378378 
     
    391391further processing. 
    392392 
    393 .. _`Django website`: http://www.djangoproject.com/ 
     393.. _`Django Web site`: http://www.djangoproject.com/ 
    394394 
    395395Captured parameters