doc/Overview.pod

   1 =head1 Overview of Maypole Documentation
   2
   3 The Maypole documentation is arranged over several files; this is a good
   4 one to start with.
   5
   6 Once you've read this, you should probably look at L<About.pod>, the
   7 guide to what Maypole is and how the Maypole request works. It also
   8 describes how to set up a simple CRUD web application in Maypole.
   9
  10 The next two chapters are quite thorough, and you might want to skip
  11 over them if you already know how L<Class::DBI> and the L<Template>
  12 toolkit work. L<Model.pod> and L<View.pod> describe these technologies
  13 and their relationship to Maypole.
  14
  15 Now we present the default actions and templates - the F<factory>
  16 templates - in L<StandardTemplates.pod>. When you have read these
  17 chapters, you are ready to start building more complex applications in
  18 Maypole than just a simple CRUD interface. L<Beer.pod> reintroduces the
  19 beer database application and shows how to move from the "magic" of the
  20 automatically supplied templates and actions to a customized application
  21 with user-specified actions.
  22
  23 L<Request.pod> contains more information about the Maypole request
  24 object and provides some cookbook-style techniques: how to provide
  25 authentication, how to provide a REST interface, how to override various
  26 stages of the content generation process, and so on.
  27
  28 The final chapters are examples of how to construct large web
  29 applications in Maypole: L<Flox.pod> describes a "social network" site
  30 similar to Friendster and Orkut; L<PetStore.pod> implements the Java/C#
  31 benchmark Pet Store application; and L<BuySpy.pod> implements the
  32 ASP.NET sample portal application.