blob: f3b71657e5ebc7c1381966667ea110ba360f5ca7 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<meta name="Author" content="Malcolm Edgar"/>
<meta name="description" lang="en" content="Click Java web application framework"/>
<meta name="keywords" lang="en" content="Click Framework, Java, JEEE, web application framework, open source"/>
<title>Click Framework</title>
<link rel="stylesheet" type="text/css" href="../help.css"/>
</head>
<body>
<h1>Click DTD</h1>
Click application XML descriptor Documentation Type Definition (DTD):
<pre class="codeDtd">
&lt;!-- The Click Application (click.xml) Document Type Definition. --&gt;
&lt;!ELEMENT <span class="red">click-app</span> (<span class="blue">pages</span>?, <span class="blue">headers</span>?, <span class="blue">format</span>?, <span class="blue">mode</span>?, <span class="blue">controls</span>?, <span class="blue">file-item-factory</span>?)&gt;
&lt;!ATTLIST <span class="red">click-app</span> <span class="blue">charset</span> CDATA #IMPLIED&gt;
&lt;!ATTLIST <span class="red">click-app</span> <span class="blue">locale</span> CDATA #IMPLIED&gt;
&lt;-- Application pages. --&gt;
&lt;!ELEMENT <span class="red">pages</span> (<span class="blue">page</span>*, <span class="blue">excludes</span>*)&gt;
&lt;!ATTLIST <span class="red">pages</span> <span class="blue">package</span> CDATA #IMPLIED&gt;
&lt;!ATTLIST <span class="red">pages</span> <span class="blue">automapping</span> (true|false) "<span class="green">true</span>"&gt;
&lt;!ATTLIST <span class="red">pages</span> <span class="blue">autobinding</span> (true|false) "<span class="green">true</span>"&gt;
&lt;!-- Page definition. --&gt;
&lt;!ELEMENT <span class="red">page</span> (<span class="blue">header</span>*)&gt;
&lt;!ATTLIST <span class="red">page</span> <span class="blue">path</span> CDATA #REQUIRED&gt;
&lt;!ATTLIST <span class="red">page</span> <span class="blue">classname</span> CDATA #REQUIRED&gt;
&lt;!-- Excludes definition. --&gt;
&lt;!ELEMENT <span class="red">excludes</span> (#PCDATA)&gt;
&lt;!ATTLIST <span class="red">excludes</span> <span class="blue">pattern</span> CDATA #REQUIRED&gt;
&lt;!-- Application default page headers. --&gt;
&lt;!ELEMENT <span class="red">headers</span> (<span class="blue">header</span>*)&gt;
&lt;!-- Header definition. --&gt;
&lt;!ELEMENT <span class="red">header</span> (#PCDATA)&gt;
&lt;!ATTLIST <span class="red">header</span> <span class="blue">name</span> CDATA #REQUIRED&gt;
&lt;!ATTLIST <span class="red">header</span> <span class="blue">value</span> CDATA #REQUIRED&gt;
&lt;!ATTLIST <span class="red">header</span> <span class="blue">type</span> (String|Integer|Date) "<span class="green">String</span>"&gt;
&lt;!-- Page template formatter class. An new format object added to
the Velocity context under the key: "format". --&gt;
&lt;!ELEMENT <span class="red">format</span> (#PCDATA)&gt;
&lt;!ATTLIST <span class="red">format</span> <span class="blue">classname</span> CDATA #FIXED "<span class="green">net.sf.click.util.Format</span>"&gt;
&lt;!-- Application mode, which configures logging and caching. --&gt;
&lt;!ELEMENT <span class="red">mode</span> (#PCDATA)&gt;
&lt;!ATTLIST <span class="red">mode</span> <span class="blue">value</span> (production|profile|development|debug|trace) "<span class="green">development</span>"&gt;
&lt;!-- Application deployable controls. --&gt;
&lt;!ELEMENT <span class="red">controls</span> (<span class="blue">control</span>*, <span class="blue">control-set</span>*)&gt;
&lt;-- Deployable control class. --&gt;
&lt;!ELEMENT <span class="red">control</span> (#PCDATA)&gt;
&lt;!ATTLIST <span class="red">control</span> <span class="blue">classname</span> CDATA #REQUIRED&gt;
&lt;-- Deployable Third Party Set of Controls. --&gt;
&lt;!ELEMENT <span class="red">control-set</span> (#PCDATA)&gt;
&lt;!ATTLIST <span class="red">control-set</span> <span class="blue">name</span> CDATA #REQUIRED&gt;
&lt;!-- Commons Upload FileItem Factory class. --&gt;
&lt;!ELEMENT <span class="red">file-item-factory</span> (property*)&gt;
&lt;!ATTLIST <span class="red">file-item-factory</span> <span class="blue">classname</span> CDATA #FIXED "<span class="green">org.apache.commons.fileupload.disk.DiskFileItemFactory</span>"&gt;
&lt;!-- FileItem Factory property set after factory creation. --&gt;
&lt;!ELEMENT <span class="red">property</span> (#PCDATA)&gt;
&lt;!ATTLIST <span class="red">property</span> <span class="blue">name</span> CDATA #REQUIRED&gt;
&lt;!ATTLIST <span class="red">property</span> <span class="blue">value</span> CDATA #REQUIRED&gt;
</pre>
</body>
</html>