Web Templates¶
Contents:
Problem
The extention package(s) of a given web framework do not assume the existence of a common base template, that the authors(s) of a website using such packages should implement. If such a template inherited a skeleton template common to that framework then its extention packages could appear as the natural extention of the web author(s) site. It might even be possible to make the respective templates in such packages agnostic of the template engine used to render them.
Objective
This package hopes to provide such skeleton templates for each framework and its extention packages. Author(s) using these frameworks, and their extention packages, then implement a base template that extends the common skeleton template provided by this package.
Scope
Web-Templates provide a set of standardized HTML templates for use in Python’s Web Frameworks (Django/Tornado/Flask/etc.). Setting up the minimal scaffold necessary for a standard HTML document
<!DOCTYPE HTML>
<HTML>
<HEAD></HEAD>
<BODY></BODY>
</HTML>
Making the <HEAD> and <BODY> elements as extensible as possible. Minor assumptions are made about the structure within the <BODY> element as a convenience but thse are readily overridden.
Organization
The documentation is partitioned into sections that are pertinent to the package users or website authors, third parties providing framework extentions and package contributors.
Setup describes the installation and removal of Web-Templates. Then a section, each dedicated to each framework, details the configuration and usage of Web-Templates within ones project(s). Each section prescribes a standardized base template, where possible, and details the underlying skeleton that it extends.
Third parties incorporating Web-Templates into their projects should read the extentions section along with the section relevant to the framework(s) they support. The rational, nomenclature and structure of the skeleton is described in Template.
Finally the package design is described and how one might constribute.
Note
This package only supports Python 3.4 and onwards as it relies upon name-spaced packages (See PEP 420 and Name Spaced Packages).