lib/Catalyst/Manual/Tutorial/Appendices.pod

   1 =head1 NAME
   2
   3 Catalyst::Manual::Tutorial::Appendices - Catalyst Tutorial - Part 9: Appendices
   4
   5
   6 =head1 OVERVIEW
   7
   8 This is B<Part 9 of 9> of the Catalyst tutorial.
   9
  10 L<Tutorial Overview|Catalyst::Manual::Tutorial>
  11
  12 =over 4
  13
  14 =item 1
  15
  16 L<Introduction|Catalyst::Manual::Tutorial::Intro>
  17
  18 =item 2
  19
  20 L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics>
  21
  22 =item 3
  23
  24 L<Basic CRUD|Catalyst::Manual::Tutorial_BasicCRUD>
  25
  26 =item 4
  27
  28 L<Authentication|Catalyst::Manual::Tutorial::Authentication>
  29
  30 =item 5
  31
  32 L<Authorization|Catalyst::Manual::Tutorial::Authorization>
  33
  34 =item 6
  35
  36 L<Debugging|Catalyst::Manual::Tutorial::Debugging>
  37
  38 =item 7
  39
  40 L<Testing|Catalyst::Manual::Tutorial::Testing>
  41
  42 =item 8
  43
  44 L<AdvancedCRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>
  45
  46 =item 9
  47
  48 B<Appendicies>
  49
  50 =back
  51
  52
  53
  54 =head1 DESCRIPTION
  55
  56 This part of the tutorial provides supporting information relevant to
  57 the Catalyst tutorial.
  58
  59
  60
  61 =head1 APPENDIX 1: CUT AND PASTE FOR POD-BASED EXAMPLES
  62
  63 You may notice that Pod indents example code with four spaces.  This
  64 section provides some quick advice to "un-indent" this text in common
  65 editors.
  66
  67
  68 =head2 "Un-indenting" with Vi/Vim
  69
  70 When cutting and pasting multi-line text from Pod-based documents, the
  71 following vi/vim regexs can be helpful to "un-indent" the inserted text
  72 (do NOT type the quotes, they are only included to show spaces in the
  73 regex patterns).  I<Note that all 3 of the regexs end in 4 spaces>:
  74
  75 =over 4
  76
  77 =item *
  78
  79 ":0,$s/^    "
  80
  81 Removes four leading spaces from the entire file (from the first line,
  82 C<0>, to the last line, C<$>).
  83
  84 =item *
  85
  86 ":.,$s/^    "
  87
  88 Removes the first four spaces from the line the cursor is on at the time
  89 the regex command is executed (".") to the last line of the file.
  90
  91 =item *
  92
  93 ":.,44s/^    "
  94
  95 Removes four leading space from the current line through line 44
  96 (obviously adjust the C<44> to the appropriate value in your example).
  97
  98 =back
  99
 100
 101 =head2 "Un-indenting" with Emacs
 102
 103 B<TODO>
 104
 105
 106
 107 =head1 APPENDIX 2: USING MYSQL AND POSTGRESQL
 108
 109 The main database used in this tutorial is the very simple yet powerful
 110 SQLite.  This section provides information that can be used to "convert"
 111 the tutorial to use MySQL and PostgreSQL.  However, note that part of
 112 the beauty of the MVC architecture is that very little database-specific
 113 code is spread throughout the system (at least when MVC is "done
 114 right").  Consequently, converting from one database to another is
 115 relatively painless with most Catalyst applications.  In general, you
 116 just need to adapt the schema definition C<.sql> file you use to
 117 initialize your database and adjust a few configuration parameters.
 118
 119 Also note that the purpose of the data definition statements for this
 120 section are not designed to take maximum advantage of the various
 121 features in each database for issues such as referential integrity and
 122 field types/constraints.
 123
 124
 125 =head2 MySQL
 126
 127 B<TODO>
 128
 129 =head2 PostgreSQL
 130
 131 B<TODO>
 132