Re: [Cheetahtemplate-discuss] Documentation about the containment approach

[<ir...@ms...>]

On Fri, Aug 30, 2002 at 02:16:23AM -0400, Edmund Lian wrote:
> In reading section 12.2 of the docs, I see that there's not much discussion
> about the containment approach. I think a short code snippet would be
> helpful here (saying this as I sit here scratching my head over how to get
> things working).
> 
> In addition, I recall some discussion on the list about how Webware's
> Page.py and Cheetah's _SkeletonPage.py were not compatible. My assumption
> here is that this is irrelevant in the containment approach, but I could be
> wrong. What would be the appropriate servlet class to subclass if one was
> going to use templates for all output. Would it be Page, HTTPServlet, or
> something else?

I don't use Webware's Page, _SkeletonPage or the "containment approach",
so I don't have anything to write.  Perhaps you and Tavis can talk about
different containment strategies and then get back to me about what to
put in the Users' Guide.

The reason I don't use the containment approach is because every page on
my site needs the site framework and maybe a section framework, and it 
seems easier to do that by inheritance.  Every time I write an
application, I think, why not use the containment approach?  But every
page needs to produce *some* output, and it seems easiest to just use
the template-servlet you get for free with the inheritance approach,
rather than dealing with where to store this other template and what
advantage am I getting over not using a template-servlet anyway?

> Lastly, I think it might be good to document that incompatibility between
> Page.py and _SkeletonPage.py that was discussed on the list...

It's mentioned at the bottom of the next section, 12.3 ("Site
frameworks").

My intention with 12.2 ("Containment vs Inheritance") is to describe how
to get a working page with the two approaches while saying nothing about 
what the common portion (shared portion) might contain.  12.3 ("Site
Frameworks") is for discussing what you might put in the common portion,
and what prebuilt frameworks are available.

Is there a way the UG can be reorganized or more cross-references put in
to make it easier to find stuff?

BTW, I'm thinking about adding a "Troubleshooting" chapter for questions
like "Why am I getting a Not Found error?", "Why is my template output
empty?", etc.  If there are any FAQs you think should be there, let me
know.

-- 
-Mike (Iron) Orr, ir...@ms...  (if mail problems: ms...@oz...)
   http://iron.cx/     English * Esperanto * Russkiy * Deutsch * Espan~ol