remove some empty doc files and add documentation about pluggable app…

…lications
TurboGears · Mar 27, 2012 · 94305d8 · 94305d8
1 parent ebd4f01
commit 94305d8
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 40 deletions.
diff --git a/docs/extensions.rst b/docs/extensions.rst
@@ -17,9 +17,10 @@ This is a list of core TurboGears extensions and tutorials that involve optional
 
       main/Extensions/Crud/index
       main/Extensions/Admin/index
-      main/Extensions/Geo/index
+      main/Extensions/Pluggable/index
       main/Extensions/Command/index
       main/Extensions/Scheduling
+      main/Extensions/Geo/index
 
       main/AuthorizeTutorial
 
diff --git a/docs/main/Extensions/Pluggable/index.rst b/docs/main/Extensions/Pluggable/index.rst
@@ -0,0 +1,51 @@
+=========================================
+Pluggable Applications with TurboGears
+=========================================
+
+TurboGears 2.1.4 introduced support for pluggable applications using tgext.pluggable.
+``tgext.pluggable`` is now the official supported way in TurboGears to create pluggable
+reusable applications.
+Currently only SQLAlchemy based applications are supported as pluggable applications.
+
+Official documentation for ``tgext.pluggable`` can be found at: http://pypi.python.org/pypi/tgext.pluggable
+
+Supported Features
+==================================
+
+Pluggable applications can define their own:
+
+    * **controllers**, which will be automatically mounted when the application is purged.
+    * **models**, which will be available inside and outside of the plugged application.
+    * **helpers**, which can be automatically exposed in ``h`` object in application template.
+    * **bootstrap**, which will be executed when `setup-app` is called.
+    * **statics**, which will be available at their own private path.
+
+Mounting a pluggable application
+==================================
+
+In your application config/app_cfg.py import plug from ``tgext.pluggable`` and
+call it for each pluggable application you want to enable.
+
+The plugged package must be installed in your environment.
+
+.. code-block:: python
+
+    from tgext.pluggable import plug
+    plug(base_config, 'package_name')
+
+Creating Pluggable Applications
+===================================
+
+``tgext.pluggable`` provides a **quickstart-pluggable** command
+to create a new pluggable applications:
+
+.. code-block:: bash
+
+    $ paster quickstart-pluggable plugtest
+    Enter package name [plugtest]:
+    ...
+
+The quickstarted application will provide an example on how to use
+models, helpers, bootstrap, controllers and statics.
+
+
diff --git a/docs/testimonials.rst b/docs/testimonials.rst
diff --git a/docs/toc.rst b/docs/toc.rst
@@ -51,14 +51,6 @@ Useful Utilities and Tools
 
        utilities
 
-Testimonials, White Papers, and Case Studies
-============================================
-
-.. toctree::
-   :maxdepth: 3
-
-   testimonials
-
 
 Indices and tables
 ==================

diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -49,14 +49,6 @@ Moving From Other Frameworks
 
    main/CakePHPIntro
 
-Extended Tutorials / White Papers
-=================================
-
-.. toctree::
-   :maxdepth: 1
-
-   whitepapers/cardlist
-
 Sometimes, you don't need a tutorial. Sometimes, you just need to see
 some sample code, or get a specific answer to a specific question, and
 tutorials are just too much for you. If that's you, might we suggest

diff --git a/docs/whitepapers/cardlist.rst b/docs/whitepapers/cardlist.rst