summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2009-12-30 00:51:00 +0000
committerChris McDonough <chrism@agendaless.com>2009-12-30 00:51:00 +0000
commitbf76adfca191a3ece130c53c3ee8a300428a8302 (patch)
tree6ac03f3804962e8e3ed999162dc405378dcb4c8f /docs
parentd22e8dc6772b15de7ed1372e1eb2dcd01311591e (diff)
downloadpyramid-bf76adfca191a3ece130c53c3ee8a300428a8302.tar.gz
pyramid-bf76adfca191a3ece130c53c3ee8a300428a8302.tar.bz2
pyramid-bf76adfca191a3ece130c53c3ee8a300428a8302.zip
Less restrictive license; add Ian attribution.
Diffstat (limited to 'docs')
-rw-r--r--docs/copyright.rst38
-rw-r--r--docs/narr/webob.rst22
2 files changed, 50 insertions, 10 deletions
diff --git a/docs/copyright.rst b/docs/copyright.rst
index 0cdaab061..4ab7e97cd 100644
--- a/docs/copyright.rst
+++ b/docs/copyright.rst
@@ -7,20 +7,23 @@ by Chris McDonough
Copyright © 2008-2010, Agendaless Consulting.
+ISBN-13: 978-0-615-34537-6
+
All rights reserved. This material may be copied or distributed only
subject to the terms and conditions set forth in the `Creative Commons
-Attribution-Noncommercial-No Derivative Works 3.0 United States
-License <http://creativecommons.org/licenses/by-nc-nd/3.0/us/>`_. You
-must give the original author credit. You may not use this work for
-commercial purposes. You may not alter, transform, or build upon this
-work.
+Attribution-Noncommercial-Share Alike 3.0 United States License
+<http://creativecommons.org/licenses/by-nc-sa/3.0/us/>`_. You must
+give the original author credit. You may not use this work for
+commercial purposes. If you alter, transform, or build upon this
+work, you may distribute the resulting work only under the same or
+similar license to this one.
.. note::
While the :mod:`repoze.bfg` documentation is offered under the
- Creative Commons Attribution-Nonconmmercial-No Derivative Works 3.0
- United States License, the :mod:`repoze.bfg` *software* is offered
- under a `less restrictive (BSD-like) license
+ Creative Commons Attribution-Nonconmmercial-Share Alike 3.0 United
+ States License, the :mod:`repoze.bfg` *software* is offered under a
+ `less restrictive (BSD-like) license
<http://repoze.org/license.html>`_ .
**Trademarks**
@@ -30,6 +33,15 @@ service marks have been appropriately capitalized. However, use of a
term in this book should not be regarded as affecting the validity of
any trademark or service mark.
+**Attributions**
+
+Cover Designer:
+ `Electrosoup <http://www.electrosoup.co.uk>`_.
+
+Used with permission:
+ The :ref:`webob_chapter` chapter is adapted, with permission, from
+ documentation originally written by Ian Bicking.
+
**Warning and Disclaimer**
Every effort has been made to make this book as complete and as
@@ -42,8 +54,14 @@ with respect to the use of the information contained herein.
**Contacting The Publisher**
-Please send documentation licensing inquiries and other business
-communications to `Agendaless Consulting
+Please send documentation licensing inquiries, translation inquiries,
+and other business communications to `Agendaless Consulting
<mailto:webmaster@agendaless.com>`_. Please send software and other
technical queries to the `repoze-dev maillist
<http://lists.repoze.org/listinfo/repoze-dev>`_.
+
+**Source Code**
+
+The source code for this book is available within the
+:mod:`repoze.bfg` software distribution, always available via
+http://bfg.repoze.org.
diff --git a/docs/narr/webob.rst b/docs/narr/webob.rst
index 6f2b9ff21..4284c4110 100644
--- a/docs/narr/webob.rst
+++ b/docs/narr/webob.rst
@@ -1,8 +1,14 @@
+.. index::
+ pair: ian; bicking
+
.. _webob_chapter:
Request and Response Objects
============================
+.. note:: This chapter is adapted from a portion of the :term:`WebOb`
+ documentation, originally written by Ian Bicking.
+
:mod:`repoze.bfg` uses the :term:`WebOb` package to supply
:term:`request` and :term:`response` object implementations. The
:term:`request` object that is passed to a :mod:`repoze.bfg`
@@ -98,6 +104,9 @@ instance, ``req.if_modified_since`` returns a `datetime
`Request reference
<http://pythonpaste.org/webob/class-webob.Request.html>`_.
+.. index::
+ pair: request; URL
+
URLs
++++
@@ -121,6 +130,10 @@ of the request. I'll show various values for an example URL
Gives a URL, relative to the current URL. If ``to_application``
is True, then resolves it relative to ``req.application_url``.
+
+.. index::
+ pair: request; methods
+
Methods
+++++++
@@ -141,6 +154,9 @@ only a few you'll use often:
and returns a `Response`_ object. You can also use this for
subrequests or testing.
+.. index::
+ pair: request; unicode
+
Unicode
+++++++
@@ -242,6 +258,9 @@ properties. These are parsed, so you can do things like
The details are available in the `extracted Response documentation
<http://pythonpaste.org/webob/class-webob.Response.html>`_.
+.. index::
+ pair: response; creating
+
Instantiating the Response
++++++++++++++++++++++++++
@@ -329,6 +348,9 @@ key/value pairs will show up. Similarly ``request.GET.keys()``
returns ``['pref', 'pref']``. Multidict is a view on a list of
tuples; all the keys are ordered, and all the values are ordered.
+.. index::
+ triple: response; attributes; special
+
Special :mod:`repoze.bfg` Attributes Added to the Request
---------------------------------------------------------