From 3ac41c06736b1b36aeff56f826759a9cde84b8e5 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Thu, 24 Nov 2011 11:45:54 -0500 Subject: [PATCH] reorganized content --- index.rst | 17 ++++++++--------- {catalog => patterns/catalog}/index.rst | 0 {cmf => patterns/cmf}/actions.rst | 0 {cmf => patterns/cmf}/catalog.rst | 0 {cmf => patterns/cmf}/content.rst | 0 {cmf => patterns/cmf}/index.rst | 0 {cmf => patterns/cmf}/missing.rst | 0 {cmf => patterns/cmf}/skins.rst | 0 {cmf => patterns/cmf}/workflow.rst | 0 patterns/index.rst | 15 +++++++++++++++ {wiki2_auth => patterns/wiki2_auth}/index.rst | 0 {zeo => patterns/zeo}/index.rst | 0 .../quick_tutorial.png | Bin .../quick_tutorial.rst | 16 ++++++++-------- .../src}/schema.sql | 0 .../src}/static/style.css | 0 .../src}/tasks.py | 0 .../src}/templates/layout.mako | 0 .../src}/templates/list.mako | 0 .../src}/templates/new.mako | 0 .../src}/templates/notfound.mako | 0 wiki_tutorials.rst | 9 +++++++++ 22 files changed, 40 insertions(+), 17 deletions(-) rename {catalog => patterns/catalog}/index.rst (100%) rename {cmf => patterns/cmf}/actions.rst (100%) rename {cmf => patterns/cmf}/catalog.rst (100%) rename {cmf => patterns/cmf}/content.rst (100%) rename {cmf => patterns/cmf}/index.rst (100%) rename {cmf => patterns/cmf}/missing.rst (100%) rename {cmf => patterns/cmf}/skins.rst (100%) rename {cmf => patterns/cmf}/workflow.rst (100%) create mode 100644 patterns/index.rst rename {wiki2_auth => patterns/wiki2_auth}/index.rst (100%) rename {zeo => patterns/zeo}/index.rst (100%) rename pyramid_quick_tutorial.png => quick_tutorial/quick_tutorial.png (100%) rename pyramid_quick_tutorial.rst => quick_tutorial/quick_tutorial.rst (96%) rename {pyramid_quick_tutorial => quick_tutorial/src}/schema.sql (100%) rename {pyramid_quick_tutorial => quick_tutorial/src}/static/style.css (100%) rename {pyramid_quick_tutorial => quick_tutorial/src}/tasks.py (100%) rename {pyramid_quick_tutorial => quick_tutorial/src}/templates/layout.mako (100%) rename {pyramid_quick_tutorial => quick_tutorial/src}/templates/list.mako (100%) rename {pyramid_quick_tutorial => quick_tutorial/src}/templates/new.mako (100%) rename {pyramid_quick_tutorial => quick_tutorial/src}/templates/notfound.mako (100%) create mode 100644 wiki_tutorials.rst diff --git a/index.rst b/index.rst index 28266e1..b009c23 100644 --- a/index.rst +++ b/index.rst @@ -1,19 +1,18 @@ Pyramid Tutorials ================= -This site contains tutorial-like content for the Pyramid web framework. +This is the home of tutorial and patterns content for the Pyramid web framework. -Contents: +Contents +--------- .. toctree:: - :maxdepth: 2 - - wiki2_auth/index - zeo/index - catalog/index - cmf/index - glossary + :maxdepth: 1 + quick_tutorial/quick_tutorial + wiki_tutorials + patterns/index + Indices and tables ================== diff --git a/catalog/index.rst b/patterns/catalog/index.rst similarity index 100% rename from catalog/index.rst rename to patterns/catalog/index.rst diff --git a/cmf/actions.rst b/patterns/cmf/actions.rst similarity index 100% rename from cmf/actions.rst rename to patterns/cmf/actions.rst diff --git a/cmf/catalog.rst b/patterns/cmf/catalog.rst similarity index 100% rename from cmf/catalog.rst rename to patterns/cmf/catalog.rst diff --git a/cmf/content.rst b/patterns/cmf/content.rst similarity index 100% rename from cmf/content.rst rename to patterns/cmf/content.rst diff --git a/cmf/index.rst b/patterns/cmf/index.rst similarity index 100% rename from cmf/index.rst rename to patterns/cmf/index.rst diff --git a/cmf/missing.rst b/patterns/cmf/missing.rst similarity index 100% rename from cmf/missing.rst rename to patterns/cmf/missing.rst diff --git a/cmf/skins.rst b/patterns/cmf/skins.rst similarity index 100% rename from cmf/skins.rst rename to patterns/cmf/skins.rst diff --git a/cmf/workflow.rst b/patterns/cmf/workflow.rst similarity index 100% rename from cmf/workflow.rst rename to patterns/cmf/workflow.rst diff --git a/patterns/index.rst b/patterns/index.rst new file mode 100644 index 0000000..fdb097a --- /dev/null +++ b/patterns/index.rst @@ -0,0 +1,15 @@ +Pyramid Tutorial-Like Patterns +============================== + +This section contains tutorial-like patterns for the Pyramid web framework. + +Contents: + +.. toctree:: + :maxdepth: 2 + + wiki2_auth/index + zeo/index + catalog/index + cmf/index + glossary diff --git a/wiki2_auth/index.rst b/patterns/wiki2_auth/index.rst similarity index 100% rename from wiki2_auth/index.rst rename to patterns/wiki2_auth/index.rst diff --git a/zeo/index.rst b/patterns/zeo/index.rst similarity index 100% rename from zeo/index.rst rename to patterns/zeo/index.rst diff --git a/pyramid_quick_tutorial.png b/quick_tutorial/quick_tutorial.png similarity index 100% rename from pyramid_quick_tutorial.png rename to quick_tutorial/quick_tutorial.png diff --git a/pyramid_quick_tutorial.rst b/quick_tutorial/quick_tutorial.rst similarity index 96% rename from pyramid_quick_tutorial.rst rename to quick_tutorial/quick_tutorial.rst index 0f12da1..f10055a 100644 --- a/pyramid_quick_tutorial.rst +++ b/quick_tutorial/quick_tutorial.rst @@ -20,7 +20,7 @@ At the end of the tutorial, you'll have a minimal application which: Here's a screenshot of the final application: -.. image:: pyramid_quick_tutorial.png +.. image:: quick_tutorial.png Step 1 - Organizing The Project ------------------------------- @@ -28,7 +28,7 @@ Step 1 - Organizing The Project .. note:: For help getting Pyramid set up, try the `install guide - `_. + `_. Before getting started, we will create the directory hierarchy needed for our application layout. Create the following directory layout on your @@ -327,7 +327,7 @@ messages sent by the application and another block to display the content of the page inheriting this master layout by using the mako directive ``${next.body()}``. -.. literalinclude:: pyramid_quick_tutorial/templates/layout.mako +.. literalinclude:: src/templates/layout.mako :language: html+mako list.mako @@ -340,7 +340,7 @@ tasks. The loop uses the passed ``tasks`` dictionary sent from the ``request.route_url`` function to generate a url based on a route name and its arguments instead of statically defining the url path. -.. literalinclude:: pyramid_quick_tutorial/templates/list.mako +.. literalinclude:: src/templates/list.mako :language: html+mako new.mako @@ -350,7 +350,7 @@ This template is used by the ``new_view`` view function. The template extends the master ``layout.mako`` template by providing a basic form to add new tasks. -.. literalinclude:: pyramid_quick_tutorial/templates/new.mako +.. literalinclude:: src/templates/new.mako :language: html+mako notfound.mako @@ -359,7 +359,7 @@ notfound.mako This template extends the master ``layout.mako`` template. We use it as the template for our custom ``NotFound`` view. -.. literalinclude:: pyramid_quick_tutorial/templates/notfound.mako +.. literalinclude:: src/templates/notfound.mako :language: html+mako Configuring Template Locations @@ -382,7 +382,7 @@ It's now time to add some styling to the application templates by adding a **CSS** file named ``style.css`` to the ``static`` directory with the following content: -.. literalinclude:: pyramid_quick_tutorial/static/style.css +.. literalinclude:: src/static/style.css :language: css To cause this static file to be served by the application, we must add a @@ -401,7 +401,7 @@ We have now completed all steps needed to run the application in its final version. Before running it, here's the complete main code for ``tasks.py`` for review: -.. literalinclude:: pyramid_quick_tutorial/tasks.py +.. literalinclude:: src/tasks.py :language: python And now let's run ``tasks.py``: diff --git a/pyramid_quick_tutorial/schema.sql b/quick_tutorial/src/schema.sql similarity index 100% rename from pyramid_quick_tutorial/schema.sql rename to quick_tutorial/src/schema.sql diff --git a/pyramid_quick_tutorial/static/style.css b/quick_tutorial/src/static/style.css similarity index 100% rename from pyramid_quick_tutorial/static/style.css rename to quick_tutorial/src/static/style.css diff --git a/pyramid_quick_tutorial/tasks.py b/quick_tutorial/src/tasks.py similarity index 100% rename from pyramid_quick_tutorial/tasks.py rename to quick_tutorial/src/tasks.py diff --git a/pyramid_quick_tutorial/templates/layout.mako b/quick_tutorial/src/templates/layout.mako similarity index 100% rename from pyramid_quick_tutorial/templates/layout.mako rename to quick_tutorial/src/templates/layout.mako diff --git a/pyramid_quick_tutorial/templates/list.mako b/quick_tutorial/src/templates/list.mako similarity index 100% rename from pyramid_quick_tutorial/templates/list.mako rename to quick_tutorial/src/templates/list.mako diff --git a/pyramid_quick_tutorial/templates/new.mako b/quick_tutorial/src/templates/new.mako similarity index 100% rename from pyramid_quick_tutorial/templates/new.mako rename to quick_tutorial/src/templates/new.mako diff --git a/pyramid_quick_tutorial/templates/notfound.mako b/quick_tutorial/src/templates/notfound.mako similarity index 100% rename from pyramid_quick_tutorial/templates/notfound.mako rename to quick_tutorial/src/templates/notfound.mako diff --git a/wiki_tutorials.rst b/wiki_tutorials.rst new file mode 100644 index 0000000..233647b --- /dev/null +++ b/wiki_tutorials.rst @@ -0,0 +1,9 @@ +Wiki Tutorials +============== + +Detailed tutorials explaining how to use Pyramid to build various types of +applications and how to deploy Pyramid applications to various platforms. + +* `SQLAlchemy + URL Dispatch Wiki Tutorial `_ + +* `ZODB + Traversal Wiki Tutorial `_