perltidy

[catagits/Catalyst-Plugin-ConfigLoader.git] / lib / Catalyst / Plugin / ConfigLoader / Manual.pod

diff --git a/lib/Catalyst/Plugin/ConfigLoader/Manual.pod b/lib/Catalyst/Plugin/ConfigLoader/Manual.pod
index 3558e69..7464128 100644 (file)
--- a/lib/Catalyst/Plugin/ConfigLoader/Manual.pod
+++ b/lib/Catalyst/Plugin/ConfigLoader/Manual.pod
@@ -1,3 +1,4 @@
+
 =head1 NAME 
 
 Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
@@ -8,10 +9,34 @@ Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
     
     use Catalyst qw( ConfigLoader ... );
 
+=head1 ENVIRONMENT VARIABLES
+
+=over 4
+
+=item * C<MYAPP_CONFIG> - specific config file to load for "MyApp"
+
+=item * C<CATALYST_CONFIG_LOCAL_SUFFIX> - global suffix for extra config files
+
+=item * C<MYAPP_CONFIG_LOCAL_SUFFIX> - suffix specifically for "MyApp"
+
+=back
+
 =head1 CONFIG FORMATS
 
 =head2 Config::General
 
+=head3 Extensions
+
+=over 4
+
+=item * cnf
+
+=item * conf
+
+=back
+
+=head3 Example Config
+
     name = TestApp
     <Component Controller::Foo>
         foo bar
@@ -22,6 +47,16 @@ Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
 
 =head2 INI
 
+=head3 Extensions
+
+=over 4
+
+=item * ini
+
+=back
+
+=head3 Example Config
+
     name=TestApp
     
     [Controller::Foo]
@@ -32,6 +67,18 @@ Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
 
 =head2 JSON
 
+=head3 Extensions
+
+=over 4
+
+=item * jsn
+
+=item * json
+
+=back
+
+=head3 Example Config
+
     {
         "name": "TestApp",
         "Controller::Foo": {
@@ -44,6 +91,18 @@ Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
 
 =head2 Perl
 
+=head3 Extensions
+
+=over 4
+
+=item * pl
+
+=item * perl
+
+=back
+
+=head3 Example Config
+
     {
         name => 'TestApp',
         'Controller::Foo' => {
@@ -56,6 +115,16 @@ Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
 
 =head2 XML
 
+=head3 Extensions
+
+=over 4
+
+=item * xml
+
+=back
+
+=head3 Example Config
+
     <config>
         <name>TestApp</name>
         <component name="Controller::Foo">
@@ -68,6 +137,18 @@ Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
 
 =head2 YAML
 
+=head3 Extensions
+
+=over 4
+
+=item * yml
+
+=item * yaml
+
+=back
+
+=head3 Example Config
+
     ---
     name: TestApp
     Controller::Foo:
@@ -75,4 +156,17 @@ Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
     Model::Baz:
         qux: xyzzy
 
+=head1 COOKBOOK
+
+=head2 Configuring a Catalyst::Model::DBIC::Schema model from a YAML config
+
+    Model::MyModel:
+      schema_class: MyApp::MySchema
+      connect_info:
+        - dbi:SQLite:myapp.db
+        - ''
+        - ''
+        - AutoCommit: 1 
+
 =cut
+