Skip to content

Commit

Permalink
Fixed several broken and redirecting URLs in the documentation (fixes…
Browse files Browse the repository at this point in the history
… #12219, refs #12427).

git-svn-id: http://code.djangoproject.com/svn/django/trunk@11994 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information
gwilson committed Dec 26, 2009
1 parent ed67c63 commit 4c50c2b
Show file tree
Hide file tree
Showing 22 changed files with 59 additions and 63 deletions.
2 changes: 1 addition & 1 deletion docs/faq/install.txt
Expand Up @@ -35,7 +35,7 @@ also need a database engine. PostgreSQL_ is recommended, because we're
PostgreSQL fans, and MySQL_, `SQLite 3`_, and Oracle_ are also supported.

.. _Python: http://www.python.org/
.. _WSGI: http://www.python.org/peps/pep-0333.html
.. _WSGI: http://www.python.org/dev/peps/pep-0333/
.. _server arrangements wiki page: http://code.djangoproject.com/wiki/ServerArrangements
.. _PostgreSQL: http://www.postgresql.org/
.. _MySQL: http://www.mysql.com/
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/auth-remote-user.txt
Expand Up @@ -12,7 +12,7 @@ Windows Authentication or Apache and `mod_authnz_ldap`_, `CAS`_, `Cosign`_,
`WebAuth`_, `mod_auth_sspi`_, etc.

.. _mod_authnz_ldap: http://httpd.apache.org/docs/2.2/mod/mod_authnz_ldap.html
.. _CAS: http://www.ja-sig.org/products/cas/
.. _CAS: http://www.jasig.org/cas
.. _Cosign: http://weblogin.org
.. _WebAuth: http://www.stanford.edu/services/webauth/
.. _mod_auth_sspi: http://sourceforge.net/projects/mod-auth-sspi
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/deployment/modpython.txt
Expand Up @@ -375,9 +375,9 @@ set of imports until it stops crashing, so as to find the specific module that
causes the problem. Drop down further into modules and look into their imports,
as necessary.

.. _Expat Causing Apache Crash: http://www.dscpl.com.au/articles/modpython-006.html
.. _Expat Causing Apache Crash: http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash
.. _mod_python FAQ entry: http://modpython.org/FAQ/faqw.py?req=show&file=faq02.013.htp
.. _Getting mod_python Working: http://www.dscpl.com.au/articles/modpython-001.html
.. _Getting mod_python Working: http://www.dscpl.com.au/wiki/ModPython/Articles/GettingModPythonWorking

If you get a UnicodeEncodeError
===============================
Expand Down
10 changes: 4 additions & 6 deletions docs/howto/outputting-pdf.txt
Expand Up @@ -16,13 +16,13 @@ For example, Django was used at kusports.com_ to generate customized,
printer-friendly NCAA tournament brackets, as PDF files, for people
participating in a March Madness contest.

.. _ReportLab: http://www.reportlab.org/rl_toolkit.html
.. _ReportLab: http://www.reportlab.org/oss/rl-toolkit/
.. _kusports.com: http://www.kusports.com/

Install ReportLab
=================

Download and install the ReportLab library from http://www.reportlab.org/downloads.html.
Download and install the ReportLab library from http://www.reportlab.org/oss/rl-toolkit/download/.
The `user guide`_ (not coincidentally, a PDF file) explains how to install it.

Test your installation by importing it in the Python interactive interpreter::
Expand Down Expand Up @@ -138,17 +138,15 @@ Further resources

* PDFlib_ is another PDF-generation library that has Python bindings. To
use it with Django, just use the same concepts explained in this article.
* `Pisa HTML2PDF`_ is yet another PDF-generation library. Pisa ships with
* `Pisa XHTML2PDF`_ is yet another PDF-generation library. Pisa ships with
an example of how to integrate Pisa with Django.
* HTMLdoc_ is a command-line script that can convert HTML to PDF. It
doesn't have a Python interface, but you can escape out to the shell
using ``system`` or ``popen`` and retrieve the output in Python.
* `forge_fdf in Python`_ is a library that fills in PDF forms.

.. _PDFlib: http://www.pdflib.org/
.. _`Pisa HTML2PDF`: http://www.htmltopdf.org/
.. _`Pisa XHTML2PDF`: http://www.xhtml2pdf.com/
.. _HTMLdoc: http://www.htmldoc.org/
.. _forge_fdf in Python: http://www.accesspdf.com/article.php/20050421092951834

Other formats
=============
Expand Down
15 changes: 8 additions & 7 deletions docs/internals/contributing.txt
Expand Up @@ -849,7 +849,8 @@ dependencies:
* Textile_
* Docutils_
* setuptools_
* memcached_, plus the either the python-memcached_ or cmemcached_ Python binding
* memcached_, plus the either the python-memcached_ or cmemcached_
Python binding

If you want to test the memcached cache backend, you will also need to define
a :setting:`CACHE_BACKEND` setting that points at your memcached instance.
Expand All @@ -864,7 +865,7 @@ associated tests will be skipped.
.. _setuptools: http://pypi.python.org/pypi/setuptools/
.. _memcached: http://www.danga.com/memcached/
.. _python-memcached: http://pypi.python.org/pypi/python-memcached/
.. _cmemcached: http://pypi.python.org/pypi/cmemcache
.. _cmemcached: http://gijsbert.org/cmemcache/index.html

To run a subset of the unit tests, append the names of the test modules to the
``runtests.py`` command line. See the list of directories in
Expand Down Expand Up @@ -959,9 +960,9 @@ for feature branches:
If you want a feature branch in SVN, you'll need to ask in
`django-developers`_ for a mentor.

.. _git: http://git.or.cz/
.. _mercurial: http://www.selenic.com/mercurial/
.. _bazaar: http://bazaar-vcs.org/
.. _git: http://git-scm.com/
.. _mercurial: http://mercurial.selenic.com/
.. _bazaar: http://bazaar.canonical.com/
.. _django branches: http://code.djangoproject.com/wiki/DjangoBranches

Branch rules
Expand Down Expand Up @@ -1093,7 +1094,7 @@ If you're using Django 0.95 or earlier and installed it using
file. Then copy the branch's version of the ``django`` directory into
``site-packages``.

.. _path file: http://docs.python.org/lib/module-site.html
.. _path file: http://docs.python.org/library/site.html

Deciding on features
====================
Expand Down Expand Up @@ -1159,6 +1160,6 @@ requests for commit access are potential flame-war starters, and will be ignored
.. _django-users: http://groups.google.com/group/django-users
.. _`#django`: irc://irc.freenode.net/django
.. _list of tickets with patches: http://code.djangoproject.com/query?status=new&status=assigned&status=reopened&has_patch=1&order=priority
.. _pep8.py: http://svn.browsershots.org/trunk/devtools/pep8/pep8.py
.. _pep8.py: http://pypi.python.org/pypi/pep8/
.. _i18n branch: http://code.djangoproject.com/browser/django/branches/i18n
.. _`tags/releases`: http://code.djangoproject.com/browser/django/tags/releases
2 changes: 1 addition & 1 deletion docs/internals/documentation.txt
Expand Up @@ -10,7 +10,7 @@ based on docutils__. The basic idea is that lightly-formatted plain-text
documentation is transformed into HTML, PDF, and any other output format.

__ http://sphinx.pocoo.org/
__ http://docutils.sf.net/
__ http://docutils.sourceforge.net/

To actually build the documentation locally, you'll currently need to install
Sphinx -- ``easy_install Sphinx`` should do the trick.
Expand Down
4 changes: 2 additions & 2 deletions docs/intro/tutorial01.txt
Expand Up @@ -102,7 +102,7 @@ These files are:
contents" of your Django-powered site. You can read more about URLs in
:ref:`topics-http-urls`.

.. _more about packages: http://docs.python.org/tut/node8.html#packages
.. _more about packages: http://docs.python.org/tutorial/modules.html#packages

The development server
----------------------
Expand Down Expand Up @@ -367,7 +367,7 @@ Finally, note a relationship is defined, using
to a single Poll. Django supports all the common database relationships:
many-to-ones, many-to-manys and one-to-ones.

.. _`Python path`: http://docs.python.org/tut/node8.html#SECTION008110000000000000000
.. _`Python path`: http://docs.python.org/tutorial/modules.html#the-module-search-path

Activating models
=================
Expand Down
1 change: 0 additions & 1 deletion docs/ref/contrib/flatpages.txt
Expand Up @@ -26,7 +26,6 @@ content in a custom template.

Here are some examples of flatpages on Django-powered sites:

* http://www.chicagocrime.org/about/
* http://www.everyblock.com/about/
* http://www.lawrence.com/about/contact/

Expand Down
2 changes: 1 addition & 1 deletion docs/ref/contrib/index.txt
Expand Up @@ -19,7 +19,7 @@ those packages have.
``'django.contrib.admin'``) to your ``INSTALLED_APPS`` setting and re-run
``manage.py syncdb``.

.. _"batteries included" philosophy: http://docs.python.org/tut/node12.html#batteries-included
.. _"batteries included" philosophy: http://docs.python.org/tutorial/stdlib.html#batteries-included

.. toctree::
:maxdepth: 1
Expand Down
10 changes: 5 additions & 5 deletions docs/ref/contrib/localflavor.txt
Expand Up @@ -168,7 +168,7 @@ Austria (``at``)

.. class:: at.forms.ATStateSelect

A ``Select`` widget that uses a list of Austrian states as its choices.
A ``Select`` widget that uses a list of Austrian states as its choices.

.. class:: at.forms.ATSocialSecurityNumberField

Expand Down Expand Up @@ -518,7 +518,7 @@ Romania (``ro``)

.. class:: ro.forms.ROIBANField

A form field that validates its input as a Romanian International Bank
A form field that validates its input as a Romanian International Bank
Account Number (IBAN). The valid format is ROXX-XXXX-XXXX-XXXX-XXXX-XXXX,
with or without hyphens.

Expand Down Expand Up @@ -634,7 +634,7 @@ Sweden (``se``)

A \+ indicates that the person is older than 100 years, which will be taken
into consideration when the date is validated.

The checksum will be calculated and checked. The birth date is checked
to be a valid date.

Expand All @@ -650,7 +650,7 @@ Sweden (``se``)
Valid codes consist of five digits (XXXXX). The number can optionally be
formatted with a space after the third digit (XXX XX).

The cleaned value will never contain the space.
The cleaned value will never contain the space.

Switzerland (``ch``)
====================
Expand Down Expand Up @@ -683,7 +683,7 @@ United Kingdom (``uk``)

A form field that validates input as a UK postcode. The regular
expression used is sourced from the schema for British Standard BS7666
address types at http://www.govtalk.gov.uk/gdsc/schemas/bs7666-v2-0.xsd.
address types at http://www.cabinetoffice.gov.uk/media/291293/bs7666-v2-0.xml.

.. class:: uk.forms.UKCountySelect

Expand Down
2 changes: 1 addition & 1 deletion docs/ref/contrib/syndication.txt
Expand Up @@ -940,7 +940,7 @@ attributes. Thus, you can subclass the appropriate feed generator class
(``Atom1Feed`` or ``Rss201rev2Feed``) and extend these callbacks. They are:

.. _georss: http://georss.org/
.. _itunes podcast format: http://www.apple.com/itunes/store/podcaststechspecs.html
.. _itunes podcast format: http://www.apple.com/itunes/podcasts/specs.html

``SyndicationFeed.root_attributes(self, )``
Return a ``dict`` of attributes to add to the root feed element
Expand Down
2 changes: 1 addition & 1 deletion docs/ref/models/fields.txt
Expand Up @@ -555,7 +555,7 @@ By default, :class:`FileField` instances are
created as ``varchar(100)`` columns in your database. As with other fields, you
can change the maximum length using the :attr:`~CharField.max_length` argument.

.. _`strftime formatting`: http://docs.python.org/lib/module-time.html#l2h-1941
.. _`strftime formatting`: http://docs.python.org/library/time.html#time.strftime

``FilePathField``
-----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/ref/models/querysets.txt
Expand Up @@ -94,7 +94,7 @@ the query construction and is not part of the public API. However, it is safe
(and fully supported) to pickle and unpickle the attribute's contents as
described here.

.. _pickle: http://docs.python.org/lib/module-pickle.html
.. _pickle: http://docs.python.org/library/pickle.html

.. _queryset-api:

Expand Down
9 changes: 4 additions & 5 deletions docs/ref/settings.txt
Expand Up @@ -341,7 +341,7 @@ Supported for the PostgreSQL_ (``postgresql``, ``postgresql_psycopg2``) and
MySQL_ (``mysql``) backends.

.. _PostgreSQL: http://www.postgresql.org/docs/8.2/static/multibyte.html
.. _MySQL: http://www.mysql.org/doc/refman/5.0/en/charset-database.html
.. _MySQL: http://dev.mysql.com/doc/refman/5.0/en/charset-database.html

.. setting:: TEST_COLLATION

Expand All @@ -353,10 +353,9 @@ Default: ``None``
The collation order to use when creating the test database. This value is
passed directly to the backend, so its format is backend-specific.

Only supported for the ``mysql`` backend (see `section 10.3.2`_ of the MySQL
manual for details).
Only supported for the ``mysql`` backend (see the `MySQL manual`_ for details).

.. _section 10.3.2: http://www.mysql.org/doc/refman/5.0/en/charset-database.html
.. _MySQL manual: MySQL_

.. setting:: TEST_NAME

Expand Down Expand Up @@ -734,7 +733,7 @@ system's standard umask.
get totally incorrect behavior.


.. _documentation for os.chmod: http://docs.python.org/lib/os-file-dir.html
.. _documentation for os.chmod: http://docs.python.org/library/os.html#os.chmod

.. setting:: FIRST_DAY_OF_WEEK

Expand Down
6 changes: 3 additions & 3 deletions docs/ref/unicode.txt
Expand Up @@ -21,16 +21,16 @@ data. Normally, this means giving it an encoding of UTF-8 or UTF-16. If you use
a more restrictive encoding -- for example, latin1 (iso8859-1) -- you won't be
able to store certain characters in the database, and information will be lost.

* MySQL users, refer to the `MySQL manual`_ (section 10.3.2 for MySQL 5.1) for
details on how to set or alter the database character set encoding.
* MySQL users, refer to the `MySQL manual`_ (section 9.1.3.2 for MySQL 5.1)
for details on how to set or alter the database character set encoding.

* PostgreSQL users, refer to the `PostgreSQL manual`_ (section 21.2.2 in
PostgreSQL 8) for details on creating databases with the correct encoding.

* SQLite users, there is nothing you need to do. SQLite always uses UTF-8
for internal encoding.

.. _MySQL manual: http://www.mysql.org/doc/refman/5.1/en/charset-database.html
.. _MySQL manual: http://dev.mysql.com/doc/refman/5.1/en/charset-database.html
.. _PostgreSQL manual: http://www.postgresql.org/docs/8.2/static/multibyte.html#AEN24104

All of Django's database backends automatically convert Unicode strings into
Expand Down
4 changes: 2 additions & 2 deletions docs/releases/0.96.txt
Expand Up @@ -227,8 +227,8 @@ start of your tests. This makes testing with real data much easier.

See `the testing documentation`_ for the full details.

.. _doctest: http://docs.python.org/lib/module-doctest.html
.. _unittest: http://docs.python.org/lib/module-unittest.html
.. _doctest: http://docs.python.org/library/doctest.html
.. _unittest: http://docs.python.org/library/unittest.html
.. _the testing documentation: http://www.djangoproject.com/documentation/0.96/testing/
.. _serialization formats: http://www.djangoproject.com/documentation/0.96/serialization/

Expand Down
2 changes: 1 addition & 1 deletion docs/topics/db/queries.txt
Expand Up @@ -327,7 +327,7 @@ translates (roughly) into the following SQL::
arguments whose names and values are evaluated at runtime. For more
information, see `Keyword Arguments`_ in the official Python tutorial.

.. _`Keyword Arguments`: http://docs.python.org/tut/node6.html#SECTION006720000000000000000
.. _`Keyword Arguments`: http://docs.python.org/tutorial/controlflow.html#keyword-arguments

If you pass an invalid keyword argument, a lookup function will raise
``TypeError``.
Expand Down
3 changes: 1 addition & 2 deletions docs/topics/db/sql.txt
Expand Up @@ -251,5 +251,4 @@ necessary. (Also note that Django expects the ``"%s"`` placeholder, *not* the
``"?"`` placeholder, which is used by the SQLite Python bindings. This is for
the sake of consistency and sanity.)

.. _Python DB-API: http://www.python.org/peps/pep-0249.html

.. _Python DB-API: http://www.python.org/dev/peps/pep-0249/
2 changes: 1 addition & 1 deletion docs/topics/files.txt
Expand Up @@ -55,7 +55,7 @@ Internally, Django uses a ``django.core.files.File`` any time it needs to
represent a file. This object is a thin wrapper around Python's `built-in file
object`_ with some Django-specific additions.

.. _built-in file object: http://docs.python.org/lib/bltin-file-objects.html
.. _built-in file object: http://docs.python.org/library/stdtypes.html#bltin-file-objects

Most of the time you'll simply use a ``File`` that Django's given you (i.e. a
file attached to a model as above, or perhaps an uploaded file).
Expand Down
20 changes: 10 additions & 10 deletions docs/topics/http/file-uploads.txt
Expand Up @@ -30,7 +30,7 @@ is a dictionary containing a key for each ``FileField`` (or ``ImageField``, or
other ``FileField`` subclass) in the form. So the data from the above form would
be accessible as ``request.FILES['file']``.

Note that ``request.FILES`` will only contain data if the request method was
Note that ``request.FILES`` will only contain data if the request method was
``POST`` and the ``<form>`` that posted the request has the attribute
``enctype="multipart/form-data"``. Otherwise, ``request.FILES`` will be empty.

Expand Down Expand Up @@ -140,19 +140,19 @@ Three settings control Django's file upload behavior:

Defaults to your system's standard temporary directory (i.e. ``/tmp`` on
most Unix-like systems).

:setting:`FILE_UPLOAD_PERMISSIONS`
The numeric mode (i.e. ``0644``) to set newly uploaded files to. For
more information about what these modes mean, see the `documentation for
os.chmod`_

If this isn't given or is ``None``, you'll get operating-system
dependent behavior. On most platforms, temporary files will have a mode
of ``0600``, and files saved from memory will be saved using the
system's standard umask.

.. warning::

If you're not familiar with file modes, please note that the leading
``0`` is very important: it indicates an octal number, which is the
way that modes must be specified. If you try to use ``644``, you'll
Expand All @@ -173,7 +173,7 @@ Three settings control Django's file upload behavior:
Which means "try to upload to memory first, then fall back to temporary
files."

.. _documentation for os.chmod: http://docs.python.org/lib/os-file-dir.html
.. _documentation for os.chmod: http://docs.python.org/library/os.html#os.chmod

``UploadedFile`` objects
========================
Expand All @@ -197,17 +197,17 @@ define the following methods/attributes:
``UploadedFile.temporary_file_path()``
Only files uploaded onto disk will have this method; it returns the full
path to the temporary uploaded file.

.. note::

Like regular Python files, you can read the file line-by-line simply by
iterating over the uploaded file:

.. code-block:: python

for line in uploadedfile:
do_something_with(line)

However, *unlike* standard Python files, :class:`UploadedFile` only
understands ``\n`` (also known as "Unix-style") line endings. If you know
that you need to handle uploaded files with different line endings, you'll
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/install.txt
Expand Up @@ -53,7 +53,7 @@ for each platform.

.. _Apache: http://httpd.apache.org/
.. _mod_wsgi: http://code.google.com/p/modwsgi/
.. _WSGI: http://www.python.org/peps/pep-0333.html
.. _WSGI: http://www.python.org/dev/peps/pep-0333/
.. _server-arrangements wiki page: http://code.djangoproject.com/wiki/ServerArrangements

.. _database-installation:
Expand Down Expand Up @@ -125,7 +125,7 @@ Django will need permission to create a test database.
.. _compiled Windows version: http://stickpeople.com/projects/python/win-psycopg/
.. _MySQLdb: http://sourceforge.net/projects/mysql-python
.. _SQLite: http://www.sqlite.org/
.. _pysqlite: http://pysqlite.org/
.. _pysqlite: http://trac.edgewall.org/wiki/PySqlite
.. _cx_Oracle: http://cx-oracle.sourceforge.net/
.. _Oracle: http://www.oracle.com/
.. _Sybase SQL Anywhere: http://code.google.com/p/sqlany-django/
Expand Down

0 comments on commit 4c50c2b

Please sign in to comment.