Remove TTSite in favor of manually created wrapper template and css
[catagits/Catalyst-Manual.git] / lib / Catalyst / Manual / Tutorial / Debugging.pod
index 125bc3d..5cf5b6a 100644 (file)
@@ -76,19 +76,20 @@ Fans of interactive debuggers.
 
 Catalyst is able to easily accommodate both styles of debugging.
 
+
 =head1 LOG STATEMENTS
 
-Folks in the former group can use Catalyst's C<$c-E<gt>log> facility.
-(See L<Catalyst::Log> for more detail.) For example, if you add the
-following code to a controller action method:
+Folks in the former group can use Catalyst's C<$c-E<gt>log> facility. 
+(See L<Catalyst::Log|Catalyst::Log> for more detail.) For example, if 
+you add the following code to a controller action method:
 
     $c->log->info("Starting the foreach loop here");
 
     $c->log->debug("Value of \$id is: ".$id);
 
 Then the Catalyst development server will display your message along
-with the other debug output. To accomplish the same thing in a TTSite
-view use:
+with the other debug output. To accomplish the same thing in a TT
+template view use:
 
     [% c.log.debug("This is a test log message") %]
 
@@ -96,6 +97,7 @@ You can also use L<Data::Dumper|Data::Dumper> in both Catalyst code
 (C<use Data::Dumper; $c-E<gt>log-E<gt>debug("\$var is: ".Dumper($var));)>) 
 and TT templates (C<[% Dumper.dump(book) %]>.
 
+
 =head1 RUNNING CATALYST UNDER THE PERL DEBUGGER
 
 Members of the interactive-debugger fan club will also be at home with
@@ -279,7 +281,7 @@ debugging:
 
 Check the version of an installed module:
 
-    perl -MModule::Name -e 'print $Module::Name::VERSION;'
+    perl -ME<lt>mod_nameE<gt> -e '"print $E<lt>mod_nameE<gt>::VERSION\n"'
 
 For example:
 
@@ -305,6 +307,30 @@ Otherwise, it returns undef and nothing will be printed.
 =back
 
 
+=head1 TT DEBUGGING
+
+If you run into issues during the rendering of your template, it might 
+be helpful to enable TT C<DEBUG> options.  You can do this in a Catalyst 
+environment by adding a C<DEBUG> line to the C<__PACKAGE__->config> 
+declaration in C<lib/MyApp/View/TT.pm>:
+
+    __PACKAGE__->config({
+        TEMPLATE_EXTENSION => '.tt2',
+        DEBUG              => 'undef',
+    });
+
+There are a variety of options you can use, such as 'undef', 'all', 
+'service', 'context', 'parser' and 'provider'.  See 
+L<Template::Constants|Template::Constants> for more information 
+(remove the C<DEBUG_> portion of the name shown in the TT docs and 
+convert to lower case for use inside Catalyst).
+
+B<NOTE:> B<Please be sure to disable TT debug options before continuing 
+with the tutorial> (especially the 'undef' option -- leaving this 
+enabled will conflict with several of the conventions used by this 
+tutorial to leave some variables undefined on purpose).
+
+
 =head1 AUTHOR
 
 Kennedy Clark, C<hkclark@gmail.com>
@@ -314,4 +340,4 @@ most recent version of the Catalyst Tutorial can be found at
 L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Manual/lib/Catalyst/Manual/Tutorial/>.
 
 Copyright 2006-2008, Kennedy Clark, under Creative Commons License
-(L<http://creativecommons.org/licenses/by-nc-sa/2.5/>).
+(L<http://creativecommons.org/licenses/by-sa/3.0/us/>).