[catagits/Catalyst-Runtime.git] / lib / Catalyst / Manual / Tutorial / Appendices.pod

=head1 NAME

Catalyst::Manual::Tutorial::Appendices - Catalyst Tutorial - Part 9: Appendices


=head1 OVERVIEW

This is B<Part 9 of 9> of the Catalyst tutorial.

L<Tutorial Overview|Catalyst::Manual::Tutorial>

=over 4

=item 1

L<Introduction|Catalyst::Manual::Tutorial::Intro>

=item 2

L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics>

=item 3

L<Basic CRUD|Catalyst::Manual::Tutorial_BasicCRUD>

=item 4

L<Authentication|Catalyst::Manual::Tutorial::Authentication>

=item 5

L<Authorization|Catalyst::Manual::Tutorial::Authorization>

=item 6

L<Debugging|Catalyst::Manual::Tutorial::Debugging>

=item 7

L<Testing|Catalyst::Manual::Tutorial::Testing>

=item 8

L<AdvancedCRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>

=item 9

B<Appendicies>

=back


=head1 DESCRIPTION

This part of the tutorial provides supporting information relevant to
the Catalyst tutorial.


=head1 APPENDIX 1: CUT AND PASTE FOR POD-BASED EXAMPLES

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.


=head2 "Un-indenting" with Vi/Vim

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>:

=over 4

=item * 

":0,$s/^    "

Removes four leading spaces from the entire file (from the first line,
C<0>, to the last line, C<$>).

=item * 

":.,$s/^    "

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.

=item * 

":.,44s/^    "

Removes four leading space from the current line through line 44
(obviously adjust the C<44> to the appropriate value in your example).

=back


=head2 "Un-indenting" with Emacs

B<TODO>


=head1 APPENDIX 2: USING MYSQL AND POSTGRESQL

The main database used in this tutorial is the very simple yet 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.

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.


=head2 MySQL

B<TODO>

=head2 PostgreSQL

B<TODO>
Commit	Line	Data
4d583dd8	1	=head1 NAME
4d583dd8	2
64ccd8a8	3	Catalyst::Manual::Tutorial::Appendices - Catalyst Tutorial - Part 9: Appendices
4d583dd8	4
	5
	6	=head1 OVERVIEW
	7
64ccd8a8	8	This is B<Part 9 of 9> of the Catalyst tutorial.
4d583dd8	9
64ccd8a8	10	L<Tutorial Overview\|Catalyst::Manual::Tutorial>
4d583dd8	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
64ccd8a8	24	L<Basic CRUD\|Catalyst::Manual::Tutorial_BasicCRUD>
4d583dd8	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
64ccd8a8	56	This part of the tutorial provides supporting information relevant to
64ccd8a8	57	the Catalyst tutorial.
4d583dd8	58
	59
	60
	61	=head1 APPENDIX 1: CUT AND PASTE FOR POD-BASED EXAMPLES
	62
64ccd8a8	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.
4d583dd8	66
	67
	68	=head2 "Un-indenting" with Vi/Vim
	69
64ccd8a8	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>:
4d583dd8	74
	75	=over 4
	76
	77	=item *
	78
	79	":0,$s/^ "
	80
64ccd8a8	81	Removes four leading spaces from the entire file (from the first line,
64ccd8a8	82	C<0>, to the last line, C<$>).
4d583dd8	83
	84	=item *
	85
	86	":.,$s/^ "
	87
64ccd8a8	88	Removes the first four spaces from the line the cursor is on at the time
64ccd8a8	89	the regex command is executed (".") to the last line of the file.
4d583dd8	90
	91	=item *
	92
	93	":.,44s/^ "
	94
64ccd8a8	95	Removes four leading space from the current line through line 44
64ccd8a8	96	(obviously adjust the C<44> to the appropriate value in your example).
4d583dd8	97
	98	=back
	99
	100
	101	=head2 "Un-indenting" with Emacs
	102
64ccd8a8	103	B<TODO>
4d583dd8	104
	105
	106
	107	=head1 APPENDIX 2: USING MYSQL AND POSTGRESQL
	108
64ccd8a8	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.
4d583dd8	118
64ccd8a8	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.
4d583dd8	123
	124
	125	=head2 MySQL
	126
64ccd8a8	127	B<TODO>
4d583dd8	128
	129	=head2 PostgreSQL
	130
64ccd8a8	131	B<TODO>
4d583dd8	132