lib/Maypole/Manual.pod

   1 =head1 The Maypole Manual
   2
   3 The Maypole documentation is arranged over several files; this is
   4 the right one to start with, as it provides an overview of the
   5 entire set of Maypole manuals, with a brief description of each.
   6 Some of these manuals are not yet finished, but they should still
   7 be useful.
   8
   9 =over 4
  10
  11 =item L<Maypole::Manual::About> - Overview of the Project
  12
  13 This document is a general introduction to Maypole: what it is, what it
  14 does and how it works.
  15
  16 Maypole is a framework for Web development. At the basic level, it
  17 converts a URL like C<http://www.mysite.com/product/display/12> into a
  18 method call such as "perform the C<display> method on item C<12> in the
  19 C<product> table" and then shows the result: here, presumably, a
  20 description of item C<12> in your product database,
  21
  22 It is based on Model-View-Controller (MVC), a design paradigm in
  23 which each major aspect of an application's operation is
  24 handled by a different and totally separate system).
  25
  26 Basic installation instructions are given. A sample Web
  27 application--the Beer database--is introduced, set up, and
  28 discussed. Finally, the path a Maypole request takes as it
  29 moves through the system is described.
  30
  31 =item L<Maypole::Manual::Model> - Model Classes *
  32
  33 This document introduces the I<model class>, which controls
  34 the interaction between Maypole and your database. The use of
  35 "actions"--method calls that operate on your database--is
  36 discussed. Maypole's default model class is L<Class::DBI>,
  37 which basically creates a class for each table in your
  38 database and provides a variety of convenient methods for
  39 manipulating each table and its relations. It integrates very
  40 smoothly with Maypole's default L<view class|Maypole::Manual::View>,
  41 the L<Template|Template> Toolkit.
  42
  43 =item L<Maypole::Manual::View> - View Classes *
  44
  45 This document is an extensive discussion of Maypole's I<view class>,
  46 which takes the data produced by the model (see
  47 above) and sends it through a templating
  48 system in order to produce output. It focusses chiefly on
  49 the L<Template> Toolkit, which is Maypole's default templating
  50 system, but discusses other possibilities.
  51
  52 =item L<Maypole::Manual::StandardTemplates> - Standard actions and templates *
  53
  54 This document discusses the standard actions and templates
  55 that Maypole uses. The standard actions (method calls that
  56 operate on your database) include C<list>, which generates a
  57 paged list of a table suitable for browsing, and C<search>, which
  58 handles a search query and generates search results.
  59
  60 The standard templates, which generate output for display on
  61 the Web, also include C<list>, which displays the entries in a
  62 table, and C<search>, which displays the result of a search.
  63
  64 You'll note that most actions are associated with templates.
  65
  66 This document also introduces the theory behind Maypole's
  67 actions and templates, showing you how to write your own
  68 so that you can have a highly customized application.
  69
  70 =item L<Maypole::Manual::Workflow> - Description of the Request Workflow
  71
  72 This is a technical document that describes the progress of a
  73 request through the entire Maypole system. It should be of
  74 interest chiefly to those people hacking on Maypole itself,
  75 and not to most of those who are using it.
  76
  77 =item L<Maypole::Manual::Beer> - The Beer Database Revisited *
  78
  79 This document gives a close look at the Beer database that
  80 was introduced in L<Maypole::Manual::About>.
  81
  82 =item L<Maypole::Manual::Request> - The Request Cookbook
  83
  84 This extensive document is Maypole's main "How do I do X?" FAQ.
  85 It provides a wide variety of cookbook-like techniques that
  86 are useful both for themselves, and as examples of what sort
  87 of things can be done with Maypole processes.
  88
  89 =item L<Maypole::Manual::Flox> - Case Study: Flox social network *
  90
  91 This is an example of how to construct a large Web application
  92 in Maypole: a "social network", similar to Friendster and
  93 Orkut. It shows, specifically, the database structure and the
  94 variety of customized techniques that make such a system
  95 work.
  96
  97 =item L<Maypole::Manual::IBuySpy> - Case Study: iBuySpy *
  98
  99 This is an example of the C<ASP.NET> sample portal application
 100 ported to Maypole. L<http://www.ibuyspy.com> is a fictional
 101 e-commerce site that is relatively sophisticated. It is much
 102 better as a Maypole application.
 103
 104 =back
 105
 106   * indicates incomplete chapters.
 107
 108 =head1 SEE ALSO
 109
 110 L<http://maypole.perl.org>
 111
 112 =head1 AUTHOR
 113
 114 The Maypole Manual was written by Simon Cozens. A generous grant from the Perl
 115 Foundation in the first quarter of 2004 funded some of the chapters of this
 116 manual.
 117
 118 This overview was rewritten by Jesse Sheidlower, C<jester#panix.com>,
 119 based on Simon Cozens' original I<Overview> document.
 120
 121 In December 2004, Dave Howorth, C<dave.howorth#acm.org> kindly donated some
 122 of his spare time to improve the structure of the manual and bring it up to
 123 date.
 124
 125 =head1 AUTHOR EMERITUS
 126
 127 Simon Cozens, C<simon#cpan.org>
 128
 129 =cut