summaryrefslogtreecommitdiff
path: root/docs/tutorials
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2008-07-24 19:55:33 +0000
committerChris McDonough <chrism@agendaless.com>2008-07-24 19:55:33 +0000
commit932675884332070229ee5ada2c163f5e218fdb72 (patch)
treeed065f36062d8591a8dbdfb2083f6686c47a93ed /docs/tutorials
parentc4d7f0b657c8863f34f3c9ea0bccb96aa7763877 (diff)
downloadpyramid-932675884332070229ee5ada2c163f5e218fdb72.tar.gz
pyramid-932675884332070229ee5ada2c163f5e218fdb72.tar.bz2
pyramid-932675884332070229ee5ada2c163f5e218fdb72.zip
Filename cleanups.
Diffstat (limited to 'docs/tutorials')
-rw-r--r--docs/tutorials/lxmlgraph/step01.rst3
-rw-r--r--docs/tutorials/lxmlgraph/step02.rst22
-rw-r--r--docs/tutorials/lxmlgraph/step03.rst14
-rw-r--r--docs/tutorials/lxmlgraph/step04.rst8
-rw-r--r--docs/tutorials/lxmlgraph/step05.rst4
5 files changed, 29 insertions, 22 deletions
diff --git a/docs/tutorials/lxmlgraph/step01.rst b/docs/tutorials/lxmlgraph/step01.rst
index d86c5bc8f..bf0f29085 100644
--- a/docs/tutorials/lxmlgraph/step01.rst
+++ b/docs/tutorials/lxmlgraph/step01.rst
@@ -14,4 +14,7 @@ To get started, run ``paster create -t bfg`` as described in
...
$
+You now have a project named ``lxmlgraph`` in your current directory.
+We'll add to this project in subsequent steps.
+
diff --git a/docs/tutorials/lxmlgraph/step02.rst b/docs/tutorials/lxmlgraph/step02.rst
index b4987df28..ab2faf572 100644
--- a/docs/tutorials/lxmlgraph/step02.rst
+++ b/docs/tutorials/lxmlgraph/step02.rst
@@ -1,11 +1,12 @@
================================================
-Step 02: Hello World as XML
+Step 2: Hello World as XML
================================================
-We now have a default project.
+We now have a default project named ``lxmlgraph``. It contains a
+*package* (also) named ``lxmlgraph``.
-In this step we will add an XML document as our model data. We will
-leverage the following ``repoze.bfg`` machinery:
+In this step we will add an XML document to the *package* as our model
+data. We will leverage the following ``repoze.bfg`` machinery:
- Model data with interfaces that define "types"
@@ -18,8 +19,11 @@ Our application will need to do these things:
- That model class needs to implement the "handshake"
-File ``myapp/samplemodel.xml``
---------------------------------
+All of the below filenames are relative to the ``lxmlgraph`` *package*
+rather than the project.
+
+File ``samplemodel.xml``
+-----------------------------------
We're going to add an XML document that will serve as a source for
model data named ``samplemodel.xml``.
@@ -45,7 +49,7 @@ with an attribute matching the next hop. Also, the value of the
``@name`` should be unique in its containing node.
-Module ``myapp/models.py``
+Module ``models.py``
------------------------------
At a high level, we make write a class that "extends" lxml Element
@@ -80,8 +84,8 @@ parser.
the custom Python class registered. We then load some XML and
return the top of the tree.
-Module `myapp/views.py``
---------------------------
+Module ``views.py``
+-----------------------------
Our ``views.py`` module does the following:
diff --git a/docs/tutorials/lxmlgraph/step03.rst b/docs/tutorials/lxmlgraph/step03.rst
index 6a585e37d..ca8e6837b 100644
--- a/docs/tutorials/lxmlgraph/step03.rst
+++ b/docs/tutorials/lxmlgraph/step03.rst
@@ -1,5 +1,5 @@
================================================
-Step 03: Basic Rendering With ZPT and XSLT
+Step 3: Basic Rendering With ZPT and XSLT
================================================
Our XML-based model is now usable. However, we're using Python to
@@ -25,7 +25,7 @@ The ZCML for this would look like this:
view=".views.zpt_default_view"
/>
-Here we point to a function in ``myapp/views.py`` that looks like the
+Here we point to a function in ``views.py`` that looks like the
following:
.. code-block:: python
@@ -99,8 +99,8 @@ might XSLT look?
code, rather than snippets. You can then follow along by looking at
the files in ``docs/step03/myapp``.
-File ``myapp/configure.zcml``
---------------------------------
+File ``configure.zcml``
+----------------------------------
The ZCML statement for the XSLT template looks almost exactly the same
as the ZPT template:
@@ -119,11 +119,11 @@ view. The difference is only in the function that is pointed to by
the ``view=`` attribute.
-Module ``myapp/views.py``
+Module ``views.py``
--------------------------------
The ZCML says that our XSLT view (``xsltview.html`` on the URL) comes
-from the ``myapp.views.xslt_view`` function:
+from the ``lxmlgraph.views.xslt_view`` function:
.. literalinclude:: step03/myapp/views.py
:linenos:
@@ -142,7 +142,7 @@ from the ``myapp.views.xslt_view`` function:
document that corresponds to the current hop in the URL.
-File ``myapp/xsltview.xsl``
+File ``xsltview.xsl``
--------------------------------
How different does the XSLT itself look? At this stage, not too different:
diff --git a/docs/tutorials/lxmlgraph/step04.rst b/docs/tutorials/lxmlgraph/step04.rst
index 8112610a2..966406319 100644
--- a/docs/tutorials/lxmlgraph/step04.rst
+++ b/docs/tutorials/lxmlgraph/step04.rst
@@ -1,5 +1,5 @@
================================================
-Step 04: Hierarchical Rendering With XSLT
+Step 4: Hierarchical Rendering With XSLT
================================================
Now that we have basic templating for our XML graph in place, let's
@@ -23,7 +23,7 @@ Pre-Flight Cleanup
In the last example, we had a default template that used ZPT. We're
shifting the rest of the steps over to XSLT. Thus, our
-``myapp/configure.zcml`` is now simpler:
+``configure.zcml`` is now simpler:
.. literalinclude:: step04/myapp/configure.zcml
:linenos:
@@ -76,8 +76,8 @@ That's the big picture. Each of these changes will be explained in
detail below.
-File ``myapp/samplemodel.xml``
-================================
+File ``samplemodel.xml``
+===================================
The XML document with the information for our website has quite a
number of changes:
diff --git a/docs/tutorials/lxmlgraph/step05.rst b/docs/tutorials/lxmlgraph/step05.rst
index 83474adfd..74e59ead7 100644
--- a/docs/tutorials/lxmlgraph/step05.rst
+++ b/docs/tutorials/lxmlgraph/step05.rst
@@ -1,5 +1,5 @@
================================================
-Step 05: Advanced Templating
+Step 5: Advanced Templating
================================================
@@ -9,4 +9,4 @@ Step 05: Advanced Templating
- <query> support
-- type-based support for <document>, <folder>, <query>, <site> \ No newline at end of file
+- type-based support for <document>, <folder>, <query>, <site>