summaryrefslogtreecommitdiff
path: root/docs/quick_tutorial/traversal_addcontent.rst
blob: 499e08fbb057e4f0dbbb5a8e46fbcbd047b98439 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
===================================
25: Adding Resources To Hierarchies
===================================

Multiple views per type allowing addition of content anywhere in a
resource tree.

Background
==========

We now have multiple kinds-of-things, but only one view per resource
type. We need the ability to add things to containers,
then view/edit resources.

This introduces the concept of named views. A name is a part of the URL
that appears after the resource identifier. For example::

  @view_config(context=Folder, name='add_document')

...means that this URL::

  http://localhost:6543/some_folder/add_document

...will match the view being configured. It's as if you have an
object-oriented web, with operations on resources represented by a URL.

When you omit the ``name=`` (as we did in the previous examples,
you are establishing a "default view" for the context. That is,
a view to be used when no view name is found during traversal.

Goals
=====

- Adding and editing content in a resource tree

- Simple form which POSTs data

- A view which takes the POST data, creates a resource, and redirects
  to the newly-added resource

- Named views

Steps
=====

#. We are going to use the previous step as our starting point:

   .. code-block:: bash

    (env27)$ cd ..; cp -r traversal_typeviews traversal_addcontent; cd traversal_addcontent
    (env27)$ python setup.py develop


#. Our views in ``traversal_addcontent/tutorial/views.py`` need
   type-specific registrations:

   .. literalinclude:: traversal_addcontent/tutorial/views.py
      :linenos:

#. One small change in
   ``traversal_addcontent/tutorial/templates/document.pt``:

   .. literalinclude:: traversal_addcontent/tutorial/templates/document.pt
      :language: html
      :linenos:

#. Need forms added to
   ``traversal_addcontent/tutorial/templates/folder.pt``:

   .. literalinclude:: traversal_addcontent/tutorial/templates/folder.pt
      :language: html
      :linenos:

#. Forms also needed for
   ``traversal_addcontent/tutorial/templates/site.pt``:

   .. literalinclude:: traversal_addcontent/tutorial/templates/site.pt
      :language: html
      :linenos:

#. ``$ nosetests`` should report running 4 tests.

#. Run your Pyramid application with:

   .. code-block:: bash

    (env27)$ pserve development.ini --reload

#. Open ``http://localhost:6543/`` in your browser.

Analysis
========

Our views now represent a richer system, where form data can be
processed to modify content in the tree. We do this by attaching named
views to resource types, giving them a natural system for
object-oriented operations.

To enforce uniqueness, we randomly choose a satisfactorily large number.

Extra Credit
============

#. Can ``document_view`` simply return nothing instead of an empty
   dictionary?