View · Index

ADP Files

Avoid putting in Tcl code on ADP pages if possible
Although AOLserver/NaviServer ADP supports placing Tcl codes directing into ADP pages, one should used the ADP system wherever possible (see e.g. Using Templates in OpenACS or OpenACS Templating System).
Quote in the master, pass "properties" literally from slave adp files

when variables are used in templates without modifiers (marked with a ";") then the values of the variables are internationalized and html-quoted. The substitutions should be done at the place, where the variables are actually used, which is for "properties" in the master templates. That the places, where the variable values are just passed on, the modifier ";literal" should be used to prevent quoting and internationalization.

Master:
```
   <head> 
   <title>@doc.title@</title>
   </head> 
   <body bgcolor="#ffffff"> 
   <h1>@heading@</h1> 
   <slave> 
   </body>
```
Slave:
```
   <master> 
   <property name="doc(title)">@title;literal@</property> 
   <property name="heading">@title;literal@</property> 
   ...
```
Passing arguments to ADP includes:
```
   <include src="name-of-included-adp" ... var="@value;literal@" ...>
```
or one can pass variables via reference to the include
```
   <include src="name-of-included-adp" ... &="varName" ...> 
```

Pass always the "context" and "doc(title)" properties to the site master template
Example:

   <property name="doc(title)">@title;literal@</property>
   <property name="context">@context;literal@</property>

Quote HTML attributes
Quoting HTML attribute values improves the safety against XSS attacks, especially when the attribute values are variables. Double quotes are preferred over single quotes, both are fine.
Common doc properties
The following doc properties are used in the blank-master template:
- doc(title): Title of the document
- doc(lang): Language of the document
- doc(type): HTML doc type declaration
- doc(base_href): The base URL to be used throughout the document for relative URLs (see base element)
- doc(base_target): A keyword or author-defined name of the default browsing context to display the result when links or forms cause navigation, for <a> or <form> elements without an explicit target attribute. (see base element)

Popular tags

17 (1), 5.10 (1), 5.10.0 (2), 5.10.1 (1), 5.9.0 (3), 5.9.1 (4), ad_form (1), ADP (1), ajax (1), aolserver (1), asynchronous (2), bgdelivery (3), bootstrap (1), bugtracker (1), CentOS (1), COMET (1), compatibility (1), CSP (1), CSRF (1), cvs (3), debian (7), docker (2), docker-compose (1), emacs (2), engineering-standards (1), exec (1), fedora (1), FreeBSD (1), guidelines (1), host-node-map (1)

No registered users in community xowiki
in last 30 minutes

Contributors

OpenACS.org

References to this Page: en:coding-standards-index, en:docs-eng-toc Categories: Coding Standards (OpenACS.org)