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<Appendices>
  49
  50 =back
  51
  52 =head1 DESCRIPTION
  53
  54 This part of the tutorial provides supporting information relevant to
  55 the Catalyst tutorial.
  56
  57 =head1 APPENDIX 1: CUT AND PASTE FOR POD-BASED EXAMPLES
  58
  59 You may notice that Pod indents example code with four spaces.  This
  60 section provides some quick advice to "un-indent" this text in common
  61 editors.
  62
  63 =head2 "Un-indenting" with Vi/Vim
  64
  65 When cutting and pasting multi-line text from Pod-based documents, the
  66 following vi/vim regexs can be helpful to "un-indent" the inserted text
  67 (do NOT type the quotes, they are only included to show spaces in the
  68 regex patterns).  I<Note that all 3 of the regexs end in 4 spaces>:
  69
  70 =over 4
  71
  72 =item *
  73
  74 ":0,$s/^    "
  75
  76 Removes four leading spaces from the entire file (from the first line,
  77 C<0>, to the last line, C<$>).
  78
  79 =item *
  80
  81 ":.,$s/^    "
  82
  83 Removes the first four spaces from the line the cursor is on at the time
  84 the regex command is executed (".") to the last line of the file.
  85
  86 =item *
  87
  88 ":.,44s/^    "
  89
  90 Removes four leading space from the current line through line 44
  91 (obviously adjust the C<44> to the appropriate value in your example).
  92
  93 =back
  94
  95 =head2 "Un-indenting" with Emacs
  96
  97 B<TODO>
  98
  99 =head1 APPENDIX 2: USING MYSQL AND POSTGRESQL
 100
 101 The main database used in this tutorial is the very simple yet powerful
 102 SQLite.  This section provides information that can be used to "convert"
 103 the tutorial to use MySQL and PostgreSQL.  However, note that part of
 104 the beauty of the MVC architecture is that very little database-specific
 105 code is spread throughout the system (at least when MVC is "done
 106 right").  Consequently, converting from one database to another is
 107 relatively painless with most Catalyst applications.  In general, you
 108 just need to adapt the schema definition C<.sql> file you use to
 109 initialize your database and adjust a few configuration parameters.
 110
 111 Also note that the purpose of the data definition statements for this
 112 section are not designed to take maximum advantage of the various
 113 features in each database for issues such as referential integrity and
 114 field types/constraints.
 115
 116 =head2 MySQL
 117
 118 B<TODO>
 119
 120 =head2 PostgreSQL
 121
 122 B<TODO>
 123