<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>What to read next — Django v1.2 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Django v1.2 documentation" href="../index.html" />
<link rel="up" title="Getting started" href="index.html" />
<link rel="next" title="Using Django" href="../topics/index.html" />
<link rel="prev" title="Writing your first Django app, part 4" href="tutorial04.html" />
<script type="text/javascript" src="../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "../ref/templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body>
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../index.html">Django v1.2 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../index.html">Home</a> |
<a title="Table of contents" href="../contents.html">Table of contents</a> |
<a title="Global index" href="../genindex.html">Index</a> |
<a title="Module index" href="../py-modindex.html">Modules</a>
</div>
<div class="nav">
« <a href="tutorial04.html" title="Writing your first Django app, part 4">previous</a>
|
<a href="index.html" title="Getting started" accesskey="U">up</a>
|
<a href="../topics/index.html" title="Using Django">next</a> »</div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="intro-whatsnext">
<div class="section" id="s-what-to-read-next">
<span id="what-to-read-next"></span><h1>What to read next<a class="headerlink" href="#what-to-read-next" title="Permalink to this headline">¶</a></h1>
<p>So you’ve read all the <a class="reference internal" href="index.html"><em>introductory material</em></a> and have
decided you’d like to keep using Django. We’ve only just scratched the surface
with this intro (in fact, if you’ve read every single word you’ve still read
less than 10% of the overall documentation).</p>
<p>So what’s next?</p>
<p>Well, we’ve always been big fans of learning by doing. At this point you should
know enough to start a project of your own and start fooling around. As you need
to learn new tricks, come back to the documentation.</p>
<p>We’ve put a lot of effort into making Django’s documentation useful, easy to
read and as complete as possible. The rest of this document explains more about
how the documentation works so that you can get the most out of it.</p>
<p>(Yes, this is documentation about documentation. Rest assured we have no plans
to write a document about how to read the document about documentation.)</p>
<div class="section" id="s-finding-documentation">
<span id="finding-documentation"></span><h2>Finding documentation<a class="headerlink" href="#finding-documentation" title="Permalink to this headline">¶</a></h2>
<p>Django’s got a <em>lot</em> of documentation – almost 200,000 words – so finding what
you need can sometimes be tricky. A few good places to start are the <a class="reference internal" href="../search.html"><em>Search Page</em></a>
and the <a class="reference internal" href="../genindex.html"><em>Index</em></a>.</p>
<p>Or you can just browse around!</p>
</div>
<div class="section" id="s-how-the-documentation-is-organized">
<span id="how-the-documentation-is-organized"></span><h2>How the documentation is organized<a class="headerlink" href="#how-the-documentation-is-organized" title="Permalink to this headline">¶</a></h2>
<p>Django’s main documentation is broken up into “chunks” designed to fill
different needs:</p>
<ul>
<li><p class="first">The <a class="reference internal" href="index.html"><em>introductory material</em></a> is designed for people new
to Django – or to Web development in general. It doesn’t cover anything
in depth, but instead gives a high-level overview of how developing in
Django “feels”.</p>
</li>
<li><p class="first">The <a class="reference internal" href="../topics/index.html"><em>topic guides</em></a>, on the other hand, dive deep into
individual parts of Django. There are complete guides to Django’s
<a class="reference internal" href="../topics/db/index.html"><em>model system</em></a>, <a class="reference internal" href="../topics/templates.html"><em>template engine</em></a>, <a class="reference internal" href="../topics/forms/index.html"><em>forms framework</em></a>, and much
more.</p>
<p>This is probably where you’ll want to spend most of your time; if you work
your way through these guides you should come out knowing pretty much
everything there is to know about Django.</p>
</li>
<li><p class="first">Web development is often broad, not deep – problems span many domains.
We’ve written a set of <a class="reference internal" href="../howto/index.html"><em>how-to guides</em></a> that answer
common “How do I ...?” questions. Here you’ll find information about
<a class="reference internal" href="../howto/outputting-pdf.html"><em>generating PDFs with Django</em></a>, <a class="reference internal" href="../howto/custom-template-tags.html"><em>writing
custom template tags</em></a>, and more.</p>
<p>Answers to really common questions can also be found in the <a class="reference internal" href="../faq/index.html"><em>FAQ</em></a>.</p>
</li>
<li><p class="first">The guides and how-to’s don’t cover every single class, function, and
method available in Django – that would be overwhelming when you’re
trying to learn. Instead, details about individual classes, functions,
methods, and modules are kept in the <a class="reference internal" href="../ref/index.html"><em>reference</em></a>. This is
where you’ll turn to find the details of a particular function or
whathaveyou.</p>
</li>
<li><p class="first">Finally, there’s some “specialized” documentation not usually relevant to
most developers. This includes the <a class="reference internal" href="../releases/index.html"><em>release notes</em></a>,
<a class="reference internal" href="../obsolete/index.html"><em>documentation of obsolete features</em></a>,
<a class="reference internal" href="../internals/index.html"><em>internals documentation</em></a> for those who want to add
code to Django itself, and a <a class="reference internal" href="../misc/index.html"><em>few other things that simply don’t fit
elsewhere</em></a>.</p>
</li>
</ul>
</div>
<div class="section" id="s-how-documentation-is-updated">
<span id="how-documentation-is-updated"></span><h2>How documentation is updated<a class="headerlink" href="#how-documentation-is-updated" title="Permalink to this headline">¶</a></h2>
<p>Just as the Django code base is developed and improved on a daily basis, our
documentation is consistently improving. We improve documentation for several
reasons:</p>
<ul class="simple">
<li>To make content fixes, such as grammar/typo corrections.</li>
<li>To add information and/or examples to existing sections that need to be
expanded.</li>
<li>To document Django features that aren’t yet documented. (The list of
such features is shrinking but exists nonetheless.)</li>
<li>To add documentation for new features as new features get added, or as
Django APIs or behaviors change.</li>
</ul>
<p>Django’s documentation is kept in the same source control system as its code. It
lives in the <a class="reference external" href="http://code.djangoproject.com/browser/django/trunk/docs">django/trunk/docs</a> directory of our Subversion repository. Each
document online is a separate text file in the repository.</p>
</div>
<div class="section" id="s-where-to-get-it">
<span id="where-to-get-it"></span><h2>Where to get it<a class="headerlink" href="#where-to-get-it" title="Permalink to this headline">¶</a></h2>
<p>You can read Django documentation in several ways. They are, in order of
preference:</p>
<div class="section" id="s-on-the-web">
<span id="on-the-web"></span><h3>On the Web<a class="headerlink" href="#on-the-web" title="Permalink to this headline">¶</a></h3>
<p>The most recent version of the Django documentation lives at
<a class="reference external" href="http://docs.djangoproject.com/en/dev/">http://docs.djangoproject.com/en/dev/</a>. These HTML pages are generated
automatically from the text files in source control. That means they reflect the
“latest and greatest” in Django – they include the very latest corrections and
additions, and they discuss the latest Django features, which may only be
available to users of the Django development version. (See “Differences between
versions” below.)</p>
<p>We encourage you to help improve the docs by submitting changes, corrections and
suggestions in the <a class="reference external" href="http://code.djangoproject.com/simpleticket?component=Documentation">ticket system</a>. The Django developers actively monitor the
ticket system and use your feedback to improve the documentation for everybody.</p>
<p>Note, however, that tickets should explicitly relate to the documentation,
rather than asking broad tech-support questions. If you need help with your
particular Django setup, try the <a class="reference external" href="http://groups.google.com/group/django-users">django-users mailing list</a> or the <a class="reference external" href="irc://irc.freenode.net/django">#django
IRC channel</a> instead.</p>
</div>
<div class="section" id="s-in-plain-text">
<span id="in-plain-text"></span><h3>In plain text<a class="headerlink" href="#in-plain-text" title="Permalink to this headline">¶</a></h3>
<p>For offline reading, or just for convenience, you can read the Django
documentation in plain text.</p>
<p>If you’re using an official release of Django, note that the zipped package
(tarball) of the code includes a <tt class="docutils literal"><span class="pre">docs/</span></tt> directory, which contains all the
documentation for that release.</p>
<p>If you’re using the development version of Django (aka the Subversion “trunk”),
note that the <tt class="docutils literal"><span class="pre">docs/</span></tt> directory contains all of the documentation. You can
<tt class="docutils literal"><span class="pre">svn</span> <span class="pre">update</span></tt> it, just as you <tt class="docutils literal"><span class="pre">svn</span> <span class="pre">update</span></tt> the Python code, in order to get
the latest changes.</p>
<p>You can check out the latest Django documentation from Subversion using this
shell command:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>svn co http://code.djangoproject.com/svn/django/trunk/docs/ django_docs
</pre></div>
</div>
<p>One low-tech way of taking advantage of the text documentation is by using the
Unix <tt class="docutils literal"><span class="pre">grep</span></tt> utility to search for a phrase in all of the documentation. For
example, this will show you each mention of the phrase "max_length" in any
Django document:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>grep -r max_length /path/to/django/docs/
</pre></div>
</div>
</div>
<div class="section" id="s-as-html-locally">
<span id="as-html-locally"></span><h3>As HTML, locally<a class="headerlink" href="#as-html-locally" title="Permalink to this headline">¶</a></h3>
<p>You can get a local copy of the HTML documentation following a few easy steps:</p>
<ul>
<li><p class="first">Django's documentation uses a system called <a class="reference external" href="http://sphinx.pocoo.org/">Sphinx</a> to convert from
plain text to HTML. You'll need to install Sphinx by either downloading
and installing the package from the Sphinx Web site, or by Python's
<tt class="docutils literal"><span class="pre">easy_install</span></tt>:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>easy_install Sphinx
</pre></div>
</div>
</li>
<li><p class="first">Then, just use the included <tt class="docutils literal"><span class="pre">Makefile</span></tt> to turn the documentation into
HTML:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span><span class="nb">cd </span>path/to/django/docs
<span class="nv">$ </span>make html
</pre></div>
</div>
<p>You'll need <a class="reference external" href="http://www.gnu.org/software/make/">GNU Make</a> installed for this.</p>
</li>
<li><p class="first">The HTML documentation will be placed in <tt class="docutils literal"><span class="pre">docs/_build/html</span></tt>.</p>
</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Generation of the Django documentation will work with Sphinx version 0.6
or newer, but we recommend going straight to Sphinx 1.0.2 or newer.</p>
</div>
</div>
</div>
<div class="section" id="s-differences-between-versions">
<span id="differences-between-versions"></span><h2>Differences between versions<a class="headerlink" href="#differences-between-versions" title="Permalink to this headline">¶</a></h2>
<p>As previously mentioned, the text documentation in our Subversion repository
contains the "latest and greatest" changes and additions. These changes often
include documentation of new features added in the Django development version
-- the Subversion ("trunk") version of Django. For that reason, it's worth
pointing out our policy on keeping straight the documentation for various
versions of the framework.</p>
<p>We follow this policy:</p>
<ul class="simple">
<li>The primary documentation on djangoproject.com is an HTML version of the
latest docs in Subversion. These docs always correspond to the latest
official Django release, plus whatever features we've added/changed in
the framework <em>since</em> the latest release.</li>
<li>As we add features to Django's development version, we try to update the
documentation in the same Subversion commit transaction.</li>
<li>To distinguish feature changes/additions in the docs, we use the phrase:
"New in version X.Y", being X.Y the next release version (hence, the one
being developed).</li>
<li>Documentation for a particular Django release is frozen once the version
has been released officially. It remains a snapshot of the docs as of the
moment of the release. We will make exceptions to this rule in
the case of retroactive security updates or other such retroactive
changes. Once documentation is frozen, we add a note to the top of each
frozen document that says "These docs are frozen for Django version XXX"
and links to the current version of that document.</li>
<li>The <a class="reference external" href="http://docs.djangoproject.com/en/dev/">main documentation Web page</a> includes links to documentation for
all previous versions.</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">What to read next</a><ul>
<li><a class="reference internal" href="#finding-documentation">Finding documentation</a></li>
<li><a class="reference internal" href="#how-the-documentation-is-organized">How the documentation is organized</a></li>
<li><a class="reference internal" href="#how-documentation-is-updated">How documentation is updated</a></li>
<li><a class="reference internal" href="#where-to-get-it">Where to get it</a><ul>
<li><a class="reference internal" href="#on-the-web">On the Web</a></li>
<li><a class="reference internal" href="#in-plain-text">In plain text</a></li>
<li><a class="reference internal" href="#as-html-locally">As HTML, locally</a></li>
</ul>
</li>
<li><a class="reference internal" href="#differences-between-versions">Differences between versions</a></li>
</ul>
</li>
</ul>
<h3>Browse</h3>
<ul>
<li>Prev: <a href="tutorial04.html">Writing your first Django app, part 4</a></li>
<li>Next: <a href="../topics/index.html">Using Django</a></li>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../index.html">Django v1.2 documentation</a>
<ul><li><a href="index.html">Getting started</a>
<ul><li>What to read next</li></ul>
</li></ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/intro/whatsnext.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Jan 28, 2011</p>
</div>
</div>
<div id="ft">
<div class="nav">
« <a href="tutorial04.html" title="Writing your first Django app, part 4">previous</a>
|
<a href="index.html" title="Getting started" accesskey="U">up</a>
|
<a href="../topics/index.html" title="Using Django">next</a> »</div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-backports
>
by-pkgid
>
bc8a726fff5aedb19088c6244d3dd008
>
files
>
2783
