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