[refactor][m]: rename extension from exampletheme to example as per new repository name.
[ckanext-datagovau.git] / README.rst
blob:a/README.rst -> blob:b/README.rst
--- a/README.rst
+++ b/README.rst
@@ -2,19 +2,25 @@
 
 It comprises:
 
-   * A CKAN Extension "plugin" at ``ckanext/example/plugin.py``
-     which, when loaded, overrides various settings in the core
-     ``ini``-file to provide:
+* A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when
+  loaded, overrides various settings in the core ``ini``-file to provide:
 
-     * A path to local customisations of the core templates and stylesheets
-     * A "stream filter" that replaces arbitrary strings in rendered templates
-     * A "route" to override and extend the default behaviour of a core CKAN page
+  * A path to local customisations of the core templates and stylesheets
+  * A "stream filter" that replaces arbitrary strings in rendered templates
+  * A "route" to override and extend the default behaviour of a core CKAN page
 
-   * A custom Pylons controller for overriding some core CKAN behaviour
+* A custom Pylons controller for overriding some core CKAN behaviour
 
-   * A custom Package edit form
+* A custom Package edit form
 
-   * Some simple template customisations
+* A custom Group edit form
+
+* A plugin that allows for custom forms to be used for datasets based on 
+  their "type".
+
+* A custom User registration and edition form
+
+* Some simple template customisations
 
 Installation
 ============
@@ -25,7 +31,6 @@
 
 Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file.
 
-
 Orientation
 ===========
 
@@ -33,17 +38,18 @@
 
 * To understand the nuts and bolts of this file, which is a CKAN
   *Extension*, read in conjunction with the "Extension
-  documentation":http://packages.python.org/ckan/plugins.html
+  documentation": http://docs.ckan.org/en/latest/plugins.html
 
 * One thing the extension does is set the values of
   ``extra_public_paths`` and ``extra_template_paths`` in the CKAN
   config, which are "documented
-  here":http://packages.python.org/ckan/configuration.html#extra-template-paths
+  here": http://docs.ckan.org/en/latest/configuration.html#extra-template-paths
 
 * These are set to point at directories within
-  `ckanext/example/theme/`` (in this package).  Here, we override
-  the home page, provide some extra style with an ``extra.css``, and
-  customise the navigation and header of the main template in the file ``layout.html``.
+  ``ckanext/example/theme/`` (in this package).  Here we:
+   * override the home page HTML ``ckanext/example/theme/templates/home/index.html``
+   * provide some extra style by serving ``extra.css`` (which is loaded using the ``ckan.template_head_end`` option
+   * customise the navigation and header of the main template in the file ``layout.html``.
 
   The latter file is a great place to make global theme alterations.
   It uses the _layout template_ pattern "described in the Genshi
@@ -51,7 +57,24 @@
   This allows you to use Xpath selectors to override snippets of HTML
   globally.
 
-* The custom package edit form at ``package_form.py`` follows the
-  conventions in the "main CKAN
-  documentation":http://packages.python.org/ckan/forms.html
+* The custom package edit form at ``package_form.py`` follows a deprecated
+  way to make a form (using FormAlchemy). This part of the Example Theme needs
+  updating. In the meantime, follow the instructions at: 
+  http://readthedocs.org/docs/ckan/en/latest/forms.html
 
+Example Tags With Vocabularies
+==============================
+
+To add example tag vocabulary data to the database, from the ckanext-example directory run:
+
+::
+
+    paster example create-example-vocabs -c <path to your ckan config file>
+
+This data can be removed with
+
+::
+
+    paster example clean -c <path to your ckan config file>
+
+