summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2008-07-25 00:39:59 +0000
committerChris McDonough <chrism@agendaless.com>2008-07-25 00:39:59 +0000
commitf7c48fe00eb624432f11142897e18dd78df9f642 (patch)
treeacdff927434f7a4dcd41dc509e17192e0ed8bb02 /docs
parent3c40c67500a765909d07c80339a76ede245a1d09 (diff)
downloadpyramid-f7c48fe00eb624432f11142897e18dd78df9f642.tar.gz
pyramid-f7c48fe00eb624432f11142897e18dd78df9f642.tar.bz2
pyramid-f7c48fe00eb624432f11142897e18dd78df9f642.zip
Work on Step 3.
Diffstat (limited to 'docs')
-rw-r--r--docs/tutorials/lxmlgraph/step03.rst98
-rw-r--r--docs/tutorials/lxmlgraph/step03/myapp/configure.zcml2
-rw-r--r--docs/tutorials/lxmlgraph/step03/myapp/models.py9
-rw-r--r--docs/tutorials/lxmlgraph/step03/myapp/templates/default.pt (renamed from docs/tutorials/lxmlgraph/step03/myapp/default.pt)0
-rw-r--r--docs/tutorials/lxmlgraph/step03/myapp/templates/xsltview.xsl (renamed from docs/tutorials/lxmlgraph/step03/myapp/xsltview.xsl)0
-rw-r--r--docs/tutorials/lxmlgraph/step03/myapp/views.py6
-rw-r--r--docs/tutorials/lxmlgraph/step03/run.py8
-rw-r--r--docs/tutorials/lxmlgraph/step05.rst1
8 files changed, 63 insertions, 61 deletions
diff --git a/docs/tutorials/lxmlgraph/step03.rst b/docs/tutorials/lxmlgraph/step03.rst
index 25d6ce638..af9766ff0 100644
--- a/docs/tutorials/lxmlgraph/step03.rst
+++ b/docs/tutorials/lxmlgraph/step03.rst
@@ -16,95 +16,100 @@ ZPT Templates
========================
Let's start with a ZPT-based default view for the nodes in the XML.
-The ZCML for this would look like this:
+Add this to your project's ``configure.zcml``:
.. code-block:: xml
<bfg:view
for=".models.IMyModel"
- view=".views.zpt_default_view"
+ view=".views.zpt_view"
/>
-Here we point to a function in ``views.py`` that looks like the
-following:
+This view stanza indicates that the *default view* for a model that
+implements ``myapp.models.IMyModel`` should be the
+``myapp.views.zpt_view`` function. It is the *default* view because
+this stanza does not have a ``name`` attribute.
+
+Additonally, add a template to your project's ``templates`` directory
+named ``default.pt`` with this content:
+
+.. literalinclude:: step03/myapp/templates/default.pt
+ :linenos:
+ :language: xml
+
+Also add a function in ``views.py`` that looks like the following:
.. code-block:: python
:linenos:
from repoze.bfg.template import render_template_to_response
- def zpt_default_view(context, request):
- fn = "default.pt"
- return render_template_to_response(fn, name=context.__name__, node=context)
+ def zpt_view(context, request):
+ return render_template_to_response('templates/default.pt',
+ name=context.__name__,
+ node=context)
This function is relatively simple:
-#. Line 1 imports a ``repoze.bfg`` function that renders ZPT
- templates. ``repoze.bfg`` uses the ``z3c.pt`` ZPT engine.
+#. Line 1 imports a ``repoze.bfg`` function that renders ZPT templates
+ to a response. ``repoze.bfg`` uses the ``z3c.pt`` ZPT engine.
#. Line 2, like our other view functions, gets passed a ``context``
(the current hop in the URL) and WebOb ``request`` object.
-#. Line 3 points at the filename of the ZPT.
-
-#. Line 4 calls the ``render_template_to_response`` function, passing in the
- filename for the ZPT and two top-level variables that can be used
- in the ZPT. The first is the name of the current URL hop
+#. Line 3 calls the ``render_template_to_response`` function, passing
+ in the filename for the ZPT and two top-level variables that can be
+ used in the ZPT. The first is the name of the current URL hop
(context). The second is the XML node object for that hop
(context).
-In Step 02, we returned a WebOb Response object that we created.
-``render_template_to_response`` makes a Response itself. The
-response's status is always ``200 OK`` if you use this shortcut
-function.
+In Step 02, we returned a :term:`WebOb` Response object that we
+created. ``render_template_to_response`` makes a Response itself.
+The response's status is always ``200 OK`` and the content-type is
+always ``text/html`` if you use this shortcut function.
-Here's what the ZPT looks like:
+Here's what the ZPT looks like again:
-.. literalinclude:: step03/myapp/default.pt
+.. literalinclude:: step03/myapp/templates/default.pt
:linenos:
:language: xml
-Look, a template! Life is better with templating:
+Life is better with templating:
#. Lines 1-2 make an ``<html>`` node with a namespace for TAL.
#. Line 5 inserts the value of the ``name`` that we passed into
``render_template_to_response``.
-#. Line 6 sure looks interesting. It uses the ``node`` that we passed
- in via ``render_template_to_response``. Since ``z3c.pt`` uses
- Python as its expession language, we can put anything Python-legal
- between the braces. And since ``node`` is an ``lxml`` ``Element``
- object, we just ask for its ``.tag``, like regular Python ``lxml``
- code.
+#. Line 6 looks interesting. It uses the ``node`` that we passed in
+ via ``render_template_to_response``. Since ``z3c.pt`` uses Python
+ as its expession language, we can put anything Python-legal between
+ the braces. And since ``node`` is an ``lxml`` ``Element`` object,
+ we just ask for its ``.tag``, like regular Python ``lxml`` code.
Viewing the ZPT
------------------
-With all of that in place, going to ``http://localhost:5432/a`` now
-generates, via the ZPT, the following::
+With all of that in place, restarting the application and visiting
+``http://localhost:5432/a`` now generates, via the ZPT, the
+following::
My template is viewing item: a
The node has a tag name of: document.
+We've successfully rendered a view that uses a template against a
+model using the ZPT templating language.
XSLT Templates
====================
-So that's the ZPT way of rendering HTML for an XML document. How
-might XSLT look?
-
-.. note::
-
- For the following, we'll switch back to showing the complete module
- code, rather than snippets. You can then follow along by looking at
- the files in ``docs/step03/myapp``.
+So that's the ZPT way of rendering HTML for an XML document. We can
+additonally use XSLT to do templating. How might XSLT look?
File ``configure.zcml``
----------------------------------
-The ZCML statement for the XSLT template looks almost exactly the same
-as the ZPT template:
+Make your ``configure.zcml`` look like so:
.. literalinclude:: step03/myapp/configure.zcml
:linenos:
@@ -113,18 +118,20 @@ as the ZPT template:
#. Lines 10-14 wire up a new view, in addition to the default view.
#. Line 13 provides the difference: ``name="xsltview.html"`` means
- that all our URLs now can have ``/xsltview.xml`` appended to them.
+ that URLs invoked against our model can have ``/xsltview.html``
+ appended to them, which will invoke our XSLT view.
In the ZCML, there is no distinction between a ZPT view and an XSLT
view. The difference is only in the function that is pointed to by
-the ``view=`` attribute.
-
+the ``view=`` attribute. The view itself controls which templating
+language is in use.
Module ``views.py``
--------------------------------
The ZCML says that our XSLT view (``xsltview.html`` on the URL) comes
-from the ``lxmlgraph.views.xslt_view`` function:
+from the ``lxmlgraph.views.xslt_view`` function, which you should add
+to your ``views.py`` file:
.. literalinclude:: step03/myapp/views.py
:linenos:
@@ -148,7 +155,7 @@ File ``xsltview.xsl``
How different does the XSLT itself look? At this stage, not too different:
-.. literalinclude:: step03/myapp/xsltview.xsl
+.. literalinclude:: step03/myapp/templates/xsltview.xsl
:linenos:
:language: xml
@@ -176,3 +183,6 @@ show::
My template is viewing item: a
The node has a name of: document.
+
+We've successfully run an XSL template against our model object.
+
diff --git a/docs/tutorials/lxmlgraph/step03/myapp/configure.zcml b/docs/tutorials/lxmlgraph/step03/myapp/configure.zcml
index ef340c283..83d83ab61 100644
--- a/docs/tutorials/lxmlgraph/step03/myapp/configure.zcml
+++ b/docs/tutorials/lxmlgraph/step03/myapp/configure.zcml
@@ -5,7 +5,7 @@
<bfg:view
for=".models.IMyModel"
- view=".views.zpt_default_view"
+ view=".views.zpt_view"
/>
<bfg:view
diff --git a/docs/tutorials/lxmlgraph/step03/myapp/models.py b/docs/tutorials/lxmlgraph/step03/myapp/models.py
index 3c03de1a9..1d93ccdd0 100644
--- a/docs/tutorials/lxmlgraph/step03/myapp/models.py
+++ b/docs/tutorials/lxmlgraph/step03/myapp/models.py
@@ -1,3 +1,5 @@
+import os
+
from zope.interface import implements
from zope.interface import Attribute
from zope.interface import Interface
@@ -32,10 +34,9 @@ def get_root(environ):
parser.set_element_class_lookup(parser_lookup)
# Now load the XML file
- xmlstring = open("myapp/samplemodel.xml").read()
+ here = os.path.join(os.path.dirname(__file__))
+ samplemodel = os.path.join(here, 'samplemodel.xml')
+ xmlstring = open(samplemodel).read()
root = etree.XML(xmlstring, parser)
return root
-
-
-
diff --git a/docs/tutorials/lxmlgraph/step03/myapp/default.pt b/docs/tutorials/lxmlgraph/step03/myapp/templates/default.pt
index 3cc98ef92..3cc98ef92 100644
--- a/docs/tutorials/lxmlgraph/step03/myapp/default.pt
+++ b/docs/tutorials/lxmlgraph/step03/myapp/templates/default.pt
diff --git a/docs/tutorials/lxmlgraph/step03/myapp/xsltview.xsl b/docs/tutorials/lxmlgraph/step03/myapp/templates/xsltview.xsl
index 4d759b15b..4d759b15b 100644
--- a/docs/tutorials/lxmlgraph/step03/myapp/xsltview.xsl
+++ b/docs/tutorials/lxmlgraph/step03/myapp/templates/xsltview.xsl
diff --git a/docs/tutorials/lxmlgraph/step03/myapp/views.py b/docs/tutorials/lxmlgraph/step03/myapp/views.py
index c77eca8fe..0ac33ba83 100644
--- a/docs/tutorials/lxmlgraph/step03/myapp/views.py
+++ b/docs/tutorials/lxmlgraph/step03/myapp/views.py
@@ -1,10 +1,10 @@
from repoze.bfg.template import render_template_to_response
from repoze.bfg.template import render_transform_to_response
-def zpt_default_view(context, request):
- return render_template_to_response("default.pt",
+def zpt_view(context, request):
+ return render_template_to_response("templates/default.pt",
name=context.__name__,
node=context)
def xslt_view(context, request):
- return render_transform_to_response("xsltview.xsl", context)
+ return render_transform_to_response('templates/xsltview.xsl', context)
diff --git a/docs/tutorials/lxmlgraph/step03/run.py b/docs/tutorials/lxmlgraph/step03/run.py
deleted file mode 100644
index 1eac209dc..000000000
--- a/docs/tutorials/lxmlgraph/step03/run.py
+++ /dev/null
@@ -1,8 +0,0 @@
-from paste import httpserver
-
-from repoze.bfg import make_app
-from myapp.models import get_root
-import myapp
-
-app = make_app(get_root, myapp)
-httpserver.serve(app, host='0.0.0.0', port='5432')
diff --git a/docs/tutorials/lxmlgraph/step05.rst b/docs/tutorials/lxmlgraph/step05.rst
index 74e59ead7..c3ba037d2 100644
--- a/docs/tutorials/lxmlgraph/step05.rst
+++ b/docs/tutorials/lxmlgraph/step05.rst
@@ -2,7 +2,6 @@
Step 5: Advanced Templating
================================================
-
- multiple "views" wired to the same function and template
- breadcrumbs, sidebars
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-11 18:39:34 +0000