PageTemplateHacking

Not logged in - Log In / Register

Revision 2 as of 2009-08-21 08:22:40

Clear message

Rationale

In HTML and CSS, just as in Python, consistent style makes code more maintainable and easier to develop.

Indentation

TAL precedence

When an element has multiple statements, they are executed in this order:

  1. define
  2. condition
  3. repeat
  4. content or replace
  5. attributes
  6. omit-tag

HTML guidelines

Comments

Don't give away implementation details in <!-- HTML comments -->. Instead, use code like this.

<tal:comment condition="nothing">
  Comment here.
</tal:comment>

Tables

Lists

Text and code to avoid

See UserInterfaceChecklist.

Defining a local macro that can be used in a page template

Use metal:define-macro like this:

<metal:define metal:define-macro="my-macro">
  <ul tal:condition="foobies">
    <li tal:repeat="foo foobies" tal:content="foo.name" />
  </ul>
</metal:define>

define-macro by itself defines the macro, but leaves the output untouched -- in other words, when processing the code snippet above the TAL engine generates an unordered list as output. You may also use names inside the macro as long as they are defined all in the contexts it is used, including its definition.

You can then access the macro from the template/macros namespace:

  <metal:use metal:use-macro="template/macros/my-macro" />

Reserved form parameter names

There are certain names for form controls that are reserved; for details see ReservedQueryParameters.

Unresolved issues