Changes between Version 6 and Version 7 of ApplicationObject

Timestamp:

Jul 15, 2008, 7:45:54 PM (16 years ago)

Author:

cmlenz

Comment:

Document package data conventions

ApplicationObject

@@ -51 +51 @@
 See ConfigOptions for information on the configuration options that are available by default, although you can of course always add your own.
 
+== Package Data Conventions ==
+
+An application can easily avoid explicit configuration of things like the template and locale directories or URL routing by sticking to a directory layout convention that puts these resources in standard paths inside the application package.
+
+The prerequisite for this to work is to specify a class variable called `package` on the `Application` subclass, which must be the package name as string. For example:
+
+{{{
+#!pycon
+>>> from diva.core import Application
+>>> 
+>>> class MyApp(Application):
+...    package = 'mypkg'
+}}}
+
+With that class variable set, templates, PO/MO translation catalogs, and the routing configuration file are expected in the following directories:
+
+ * `mypkg/conf/routing.cfg`
+ * `mypkg/locale` (with subdirectories of the form `[locale]/LC_MESSAGES`)
+ * `mypkg/templates`
+
+Of course these defaults can be overridden by setting the equivalent attributes on the `Application` class, or by specifying them via the constructor.
+
 == Application Context Variables ==