/usr/share/perl5/Catalyst/Manual/Tutorial.pod is in libcatalyst-manual-perl 5.9007-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 | =head1 NAME
Catalyst::Manual::Tutorial - Catalyst Tutorial: Overview
=head1 DESCRIPTION
The Catalyst framework is a flexible and comprehensive environment for
quickly building high-functionality web applications. This tutorial is
designed to provide a rapid introduction to its basics and its most
commonly used features while focusing on real-world best practices.
We suggest that you read this introduction on the web. Make sure you are
reading the latest version of the tutorial by visiting
L<https://metacpan.org/module/Catalyst::Manual::Tutorial>. Alternatively
you can use CPAN modules like L<Pod::Webserver>, L<Pod::POM::Web>,
L<Pod::Browser> (Catalyst based), or L<CPAN::Mini::Webserver> to read a local
copy of the tutorial.
The tutorial is divided into the following sections:
B<NOTE: CLICK THESE LINKS TO JUMP TO CHAPTERS> (the index links above
only navigate inside this page).
=over 4
=item 1
L<Introduction|Catalyst::Manual::Tutorial::01_Intro>
=item 2
L<Catalyst Basics|Catalyst::Manual::Tutorial::02_CatalystBasics>
=item 3
L<More Catalyst Basics|Catalyst::Manual::Tutorial::03_MoreCatalystBasics>
=item 4
L<Basic CRUD|Catalyst::Manual::Tutorial::04_BasicCRUD>
=item 5
L<Authentication|Catalyst::Manual::Tutorial::05_Authentication>
=item 6
L<Authorization|Catalyst::Manual::Tutorial::06_Authorization>
=item 7
L<Debugging|Catalyst::Manual::Tutorial::07_Debugging>
=item 8
L<Testing|Catalyst::Manual::Tutorial::08_Testing>
=item 9
L<Advanced CRUD|Catalyst::Manual::Tutorial::09_AdvancedCRUD>
=item 10
L<Appendices|Catalyst::Manual::Tutorial::10_Appendices>
=back
Final code tarballs for each chapter of the tutorial are available at
L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/>.
=head1 Detailed Table of Contents
=head2 L<Chapter 1: Intro|Catalyst::Manual::Tutorial::01_Intro>
Note: Click on the heading in the previous line to jump to the actual
chapter. Below is a "table of contents" for this chapter.
=over 4
=item *
VERSIONS AND CONVENTIONS USED IN THIS TUTORIAL
=item *
CATALYST INSTALLATION
=item *
DATABASES
=item *
WHERE TO GET WORKING CODE
=back
=head2 L<Chapter 2: Catalyst Basics|Catalyst::Manual::Tutorial::02_CatalystBasics>
Note: Click on the heading in the previous line to jump to the actual
chapter. Below is a "table of contents" for this chapter.
=over 4
=item *
CREATE A CATALYST PROJECT
=item *
HELLO WORLD
=over 4
=item *
The Simplest Way
=item *
Hello, World! Using a View and a Template
=back
=item *
CREATE A SIMPLE CONTROLLER AND AN ACTION
=back
=head2 L<Chapter 3: More Catalyst Basics|Catalyst::Manual::Tutorial::03_MoreCatalystBasics>
Note: Click on the heading in the previous line to jump to the actual
chapter. Below is a "table of contents" for this chapter.
=over 4
=item *
CREATE A NEW APPLICATION
=item *
EDIT THE LIST OF CATALYST PLUGINS
=item *
CREATE A CATALYST CONTROLLER
=item *
CATALYST VIEWS
=over 4
=item *
Create a Catalyst View
=item *
Create a TT Template Page
=item *
Test Run The Application
=back
=item *
CREATE A SQLITE DATABASE
=item *
DATABASE ACCESS WITH DBIx::Class
=over 4
=item *
Create a Dynamic DBIC Model
=back
=item *
ENABLE THE MODEL IN THE CONTROLLER
=over 4
=item *
Test Run The Application
=back
=item *
CREATE A WRAPPER FOR THE VIEW
=over 4
=item *
Configure TT.pm For The Wrapper
=item *
Create the Wrapper Template File and Stylesheet
=item *
Test Run The Application
=back
=item *
A STATIC DATABASE MODEL WITH DBIx::Class
=over 4
=item *
Create Static DBIC Schema Files
=item *
Updating the Generated DBIC Schema Files
=item *
Run The Application
=back
=item *
UPDATING THE VIEW
=item *
RUNNING THE APPLICATION FROM THE COMMAND LINE
=item *
OPTIONAL INFORMATION
=over 4
=item *
Using RenderView for the Default View
=item *
Using The Default Template Name
=item *
Return To A Manually-Specified Template
=back
=back
=head2 L<Chapter 4: Basic CRUD|Catalyst::Manual::Tutorial::04_BasicCRUD>
Note: Click on the heading in the previous line to jump to the actual
chapter. Below is a "table of contents" for this chapter.
=over 4
=item *
FORMLESS SUBMISSION
=over 4
=item *
Include a Create Action in the Books Controller
=item *
Include a Template for the url_create Action:
=item *
Try the url_create Feature
=back
=item *
CONVERT TO A CHAINED ACTION
=over 4
=item *
Try the Chained Action
=item *
Refactor to Use a "Base" Method to Start the Chains
=back
=item *
MANUALLY BUILDING A CREATE FORM
=over 4
=item *
Add a Method to Display the Form
=item *
Add a Template for the Form
=item *
Add Method to Process Form Values and Update Database
=item *
Test Out the Form
=back
=item *
A SIMPLE DELETE FEATURE
=over 4
=item *
Include a Delete Link in the List
=item *
Add a Common Method to Retrieve a Book for the Chain
=item *
Add a Delete Action to the Controller
=item *
Try the Delete Feature
=item *
Fixing a Dangerous URL
=item *
Try the Delete and Redirect Logic
=item *
Using uri_for to Pass Query Parameters
=item *
Try the Delete and Redirect With Query Param Logic
=back
=item *
EXPLORING THE POWER OF DBIC
=over 4
=item *
Add Datetime Columns to Our Existing Books Table
=item *
Update DBIC to Automatically Handle the Datetime Columns
=item *
Create a ResultSet Class
=item *
Chaining ResultSets
=item *
Adding Methods to Result Classes
=back
=back
=head2 L<Chapter 5: Authentication|Catalyst::Manual::Tutorial::05_Authentication>
Note: Click on the heading in the previous line to jump to the actual
chapter. Below is a "table of contents" for this chapter.
=over 4
=item *
BASIC AUTHENTICATION
=over 4
=item *
Add Users and Roles to the Database
=item *
Add User and Role Information to DBIC Schema
=item *
Sanity-Check Reload of Development Server
=item *
Include Authentication and Session Plugins
=item *
Configure Authentication
=item *
Add Login and Logout Controllers
=item *
Add a Login Form TT Template Page
=item *
Add Valid User Check
=item *
Displaying Content Only to Authenticated Users
=item *
Try Out Authentication
=back
=item *
USING PASSWORD HASHES
=over 4
=item *
Get a SHA-1 Hash for the Password
=item *
Switch to SHA-1 Password Hashes in the Database
=item *
Enable SHA-1 Hash Passwords in Catalyst::Plugin::Authentication::Store::DBIC
=item *
Try Out the Hashed Passwords
=back
=item *
USING THE SESSION FOR FLASH
=over 4
=item *
Try Out Flash
=item *
Switch To Flash-To-Stash
=back
=back
=head2 L<Chapter 6: Authorization|Catalyst::Manual::Tutorial::06_Authorization>
Note: Click on the heading in the previous line to jump to the actual
chapter. Below is a "table of contents" for this chapter.
=over 4
=item *
BASIC AUTHORIZATION
=over 4
=item *
Update Plugins to Include Support for Authorization
=item *
Add Config Information for Authorization
=item *
Add Role-Specific Logic to the ``Book List'' Template
=item *
Limit Books::add to admin Users
=item *
Try Out Authentication And Authorization
=back
=item *
ENABLE MODEL-BASED AUTHORIZATION
=back
=head2 L<Chapter 7: Debugging|Catalyst::Manual::Tutorial::07_Debugging>
Note: Click on the heading in the previous line to jump to the actual
chapter. Below is a "table of contents" for this chapter.
=over 4
=item *
LOG STATEMENTS
=item *
RUNNING CATALYST UNDER THE PERL DEBUGGER
=item *
DEBUGGING MODULES FROM CPAN
=item *
TT DEBUGGING
=back
=head2 L<Chapter 8: Testing|Catalyst::Manual::Tutorial::08_Testing>
Note: Click on the heading in the previous line to jump to the actual
chapter. Below is a "table of contents" for this chapter.
=over 4
=item *
RUNNING THE "CANNED" CATALYST TESTS
=item *
RUNNING A SINGLE TEST
=item *
ADDING YOUR OWN TEST SCRIPT
=item *
SUPPORTING BOTH PRODUCTION AND TEST DATABASES
=back
=head2 L<Chapter 9: Advanced CRUD|Catalyst::Manual::Tutorial::09_AdvancedCRUD>
Note: Click on the heading in the previous line to jump to the actual
chapter. Below is a "table of contents" for this chapter.
=over 4
=item *
ADVANCED CRUD OPTIONS
=back
=head2 L<Chapter 10: Appendices|Catalyst::Manual::Tutorial::10_Appendices>
Note: Click on the heading in the previous line to jump to the actual
chapter. Below is a "table of contents" for this chapter.
=over 4
=item *
APPENDIX 1: CUT AND PASTE FOR POD-BASED EXAMPLES
=over 4
=item *
"Un-indenting" with Vi/Vim
=item *
"Un-indenting" with Emacs
=back
=item *
APPENDIX 2: USING MYSQL AND POSTGRESQL
=over 4
=item *
MySQL
=item *
PostgreSQL
=back
=item *
APPENDIX 3: IMPROVED HASHING SCRIPT
=back
=head1 THANKS
This tutorial would not have been possible without the input of many
different people in the Catalyst community. In particular, the
primary author would like to thank:
=over 4
=item *
Sebastian Riedel for founding the Catalyst project.
=item *
The members of the Catalyst Core Team for their tireless efforts to
advance the Catalyst project. Although all of the Core Team members
have played a key role in this tutorial, it would have never been
possible without the critical contributions of: Matt Trout, for his
unfathomable knowledge of all things Perl and Catalyst (and his
willingness to answer lots of my questions); Jesse Sheidlower, for his
incredible skill with the written word and dedication to improving the
Catalyst documentation; and Yuval Kogman, for his work on the Catalyst
"Auth & Authz" plugins (the original focus of the tutorial) and other
key Catalyst modules.
=item *
Other Catalyst documentation folks like Kieren Diment, Gavin Henry,
and Jess Robinson (including their work on the original Catalyst
tutorial).
=item *
Kieren Diment for his oversite of Catalyst-related documentation.
=item *
Everyone on #catalyst and #catalyst-dev.
=item *
Louis Moore (who thanks Marcello Romani and Tom Lanyon) for the
PostgreSQL content in the Appendix.
=item *
People who have emailed me with corrections and suggestions on the
tutorial. As of the most recent release, this include: Florian Ragwitz,
Mauro Andreolini, Jim Howard, Giovanni Gigante, William Moreno, Bryan
Roach, Ashley Berlin, David Kamholz, Kevin Old, Henning Sprang, Jeremy
Jones, David Kurtz, Ingo Wichmann, Shlomi Fish, Murray Walker, Adam
Witney and xenoterracide (Caleb Cushing). Thanks to Devin Austin for
coming up with an initial version of a non-TTSite wrapper page. Also, a
huge thank you to Kiffin Gish for all the hard work on the "database
depluralization" effort and Rafael Kitover for the work on updating the
tutorial to include foreign key support for SQLite. I'm sure I am
missing some names here... apologies for that (please let me know if you
name should be here).
=back
=head1 AUTHOR
Kennedy Clark, C<hkclark@gmail.com>
Feel free to contact the author for any errors or suggestions, but the
best way to report issues is via the CPAN RT Bug system at
<https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Manual>.
***TODO: Update
The most recent version of the Catalyst Tutorial can be found at
L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.80/trunk/lib/Catalyst/Manual/Tutorial/>.
Copyright 2006-2010, Kennedy Clark, under the
Creative Commons Attribution Share-Alike License Version 3.0
(L<http://creativecommons.org/licenses/by-sa/3.0/us/>).
|