docs/README.txt
changeset 19 270c209df927
parent 0 31ded33115d7
--- a/docs/README.txt	Tue Nov 26 10:09:41 2019 +0100
+++ b/docs/README.txt	Tue Nov 26 10:10:17 2019 +0100
@@ -1,3 +1,38 @@
-===============
-PyAMS Templates
-===============
+======================
+PyAMS_template package
+======================
+
+.. contents::
+
+
+What is PyAMS
+=============
+
+PyAMS (Pyramid Application Management Suite) is a small suite of packages written for applications
+and content management with the Pyramid framework.
+
+**PyAMS** is actually mainly used to manage web sites through content management applications (CMS),
+see PyAMS_content package), but many features are generic and can be used inside any kind of web
+application.
+
+
+What is PyAMS_template ?
+========================
+
+PyAMS is using Chameleon internally as HTML templates engine.
+
+This package, which is essentially an adaptation of "z3c.template" package for Pyramid, allows to
+separate the definition of a view and of it's template; this template selection can actually be
+based on the view but also on the request layer (see "PyAMS_skin" package to get more information
+about layers).
+
+PyAMS_template package provides a "template_config" decorator, which allows you to define a template
+for a given view, and a "layout_config" decorator, which allows to define a "layout" template;
+layout templates are particularly useful when using "pagelets", which are defined into another
+package (see PyAMS_pagelet).
+
+You can also override a template definition for a given view, without creating a new view class,
+just by using the "override_template" or "override_layout" functions.
+
+View and layout templates can also be declared using ZCML instead of Python code, by using the
+<template /> and <layout /> directives.