svn commit: r667519 - in /ofbiz/site/dtds: entitymodel.xsd simple-methods.xsd widget-form.xsd widget-menu.xsd widget-screen.xsd

[lektran]

Author: lektran
Date: Fri Jun 13 06:18:01 2008
New Revision: 667519

URL: http://svn.apache.org/viewvc?rev=667519&view=rev
Log:
updated the website schemas

Modified:
    ofbiz/site/dtds/entitymodel.xsd
    ofbiz/site/dtds/simple-methods.xsd
    ofbiz/site/dtds/widget-form.xsd
    ofbiz/site/dtds/widget-menu.xsd
    ofbiz/site/dtds/widget-screen.xsd

Modified: ofbiz/site/dtds/entitymodel.xsd
URL: http://svn.apache.org/viewvc/ofbiz/site/dtds/entitymodel.xsd?rev=667519&r1=667518&r2=667519&view=diff
==============================================================================
--- ofbiz/site/dtds/entitymodel.xsd (original)
+++ ofbiz/site/dtds/entitymodel.xsd Fri Jun 13 06:18:01 2008
@@ -133,6 +133,15 @@
                 </xs:restriction>
             </xs:simpleType>
         </xs:attribute>
+        <xs:attribute name="enable-audit-log" default="false">
+            <xs:annotation><xs:documentation>If this is set to true then whenever the value for this field on a record changes the Entity Engine will record the change in the EntityAuditLog entity. Defaults to false.</xs:documentation></xs:annotation>
+            <xs:simpleType>
+                <xs:restriction base="xs:token">
+                    <xs:enumeration value="true"/>
+                    <xs:enumeration value="false"/>
+                </xs:restriction>
+            </xs:simpleType>
+        </xs:attribute>
     </xs:attributeGroup>
     <xs:element name="validate">
         <xs:complexType>

Modified: ofbiz/site/dtds/simple-methods.xsd
URL: http://svn.apache.org/viewvc/ofbiz/site/dtds/simple-methods.xsd?rev=667519&r1=667518&r2=667519&view=diff
==============================================================================
--- ofbiz/site/dtds/simple-methods.xsd (original)
+++ ofbiz/site/dtds/simple-methods.xsd Fri Jun 13 06:18:01 2008
@@ -39,7 +39,7 @@
     <xs:element name="IfBasicOperations" abstract="true"/>
     <xs:element name="IfOtherOperations" abstract="true"/>
     <xs:element name="OtherOperations" abstract="true"/>
-    <xs:group name="AllOperations">
+    <xs:group name="AllOperations"> <!-- Any simple-method operation can be nested under an if-* tag. -->
         <xs:choice>
             <xs:element ref="CallOperations"/>
             <xs:element ref="EventOperations"/>
@@ -131,7 +131,9 @@
         <xs:attribute type="xs:string" name="type">
             <xs:annotation>
                 <xs:documentation>
-                    Type of the value put in the field. If this is a method call or object creation and the type in the method signature being called is for a parent class or interface, then it should be the type in that parent class or interface and not the type of the object being passed in.
+                    Type of the value put in the field.
+                    If this is a method call or object creation and the type in the method signature being called is for a parent class or interface,
+                    then it should be the type in that parent class or interface and not the type of the object being passed in.
                 </xs:documentation>
             </xs:annotation>
         </xs:attribute>
@@ -139,7 +141,7 @@
     <xs:element name="string">
         <xs:annotation>
             <xs:documentation>
-                String of type java.lang.String
+                String of type java.lang.String. Inserts the value of the inline string where specified.
             </xs:documentation>
         </xs:annotation>
         <xs:complexType mixed="true">
@@ -779,7 +781,7 @@
         <xs:attribute type="xs:string" name="result-name" use="required">
             <xs:annotation>
                 <xs:documentation>
-                    Name of the result. May be used for the session attribute name. If you don't specify a session-name ,
+                    Name of the result. May be used for the session attribute name. If you don't specify a session-name,
                     that's the name of the session attribute that will be created for the value of that result.                                        
                 </xs:documentation>
             </xs:annotation>
@@ -1660,7 +1662,7 @@
                 <xs:documentation>
                     arg-list-name is used to insert values from a list into
                     the string using the object in the standard Java library
-                    that does this sort of string expresison with a { } brackets
+                    that does this sort of string expression with a { } brackets
                     and a number, no dollar sign.
                     
                     This pattern of the arg-list-name with the prefix and
@@ -1789,7 +1791,7 @@
     <xs:element name="clear-field" substitutionGroup="EnvOperations">
         <xs:annotation>
             <xs:documentation>
-                The clear-field tag clears/removes the specified field.
+                Sets the value of the specified field to null.
             </xs:documentation>
         </xs:annotation>        
         <xs:complexType>
@@ -2306,7 +2308,7 @@
     <xs:element name="entity-and" substitutionGroup="EntityFindOperations">
         <xs:annotation>
             <xs:documentation>
-                Does a find-by-and, returns a list of Generic values if any are found, otherwise returns null.
+                Does a find-by-and, returns a list of GenericValues if any are found, otherwise returns an empty list.
                 Uses name/value pairs, that will be used for the query and will all be "anded" together.
 
                 The result-set-type by default is scroll which is flexible so you can go forward.
@@ -2382,7 +2384,7 @@
     <xs:element name="entity-condition" substitutionGroup="EntityFindOperations">
         <xs:annotation>
             <xs:documentation>
-                Like entity-and returns a list of Generic values if any are found, otherwise returns null.
+                Like entity-and returns a list of Generic values if any are found, otherwise returns an empty list.
                 Uses any of condition-expression, condition-list and condition-object.                
             </xs:documentation>
         </xs:annotation>
@@ -3595,8 +3597,7 @@
             </xs:documentation>
         </xs:annotation>        
         <xs:complexType>
-            <xs:group minOccurs="0" maxOccurs="unbounded" ref="AllOperations">
-            </xs:group>
+            <xs:group minOccurs="0" maxOccurs="unbounded" ref="AllOperations"/>            
             <xs:attributeGroup ref="attlist.iterate"/>
         </xs:complexType>
     </xs:element>
@@ -4160,18 +4161,10 @@
         </xs:complexType>
     </xs:element>
     <xs:attributeGroup name="attlist.if-compare">
-        <xs:attribute type="xs:string" name="map-name">
-            <xs:annotation>
-                <xs:documentation>
-                    The name of the method environment field that contains the map that the field to be validated will come from.
-                    If not specified the field-name will be treated as a method environment field name (an env-name).
-                </xs:documentation>
-            </xs:annotation>            
-        </xs:attribute>
-        <xs:attribute type="xs:string" name="field-name" use="required">
+        <xs:attribute type="xs:string" name="field" use="required">
             <xs:annotation>
                 <xs:documentation>
-                    The name of the map field that will be compared.
+                    The name of the field in the context (environment) that will be compared.
                 </xs:documentation>
             </xs:annotation>            
         </xs:attribute>
@@ -4225,35 +4218,18 @@
         </xs:complexType>
     </xs:element>
     <xs:attributeGroup name="attlist.if-compare-field">
-        <xs:attribute type="xs:string" name="map-name">
-            <xs:annotation>
-                <xs:documentation>
-                    The name of the method environment field that contains the map that the field to be validated will come from.
-                    If not specified the field-name will be treated as a method environment field name (an env-name).                    
-                </xs:documentation>
-            </xs:annotation>
-        </xs:attribute>
-        <xs:attribute type="xs:string" name="field-name" use="required">
-            <xs:annotation>
-                <xs:documentation>
-                    The name of the map field that will be compared.
-                </xs:documentation>
-            </xs:annotation>
-        </xs:attribute>
-        <xs:attribute type="xs:string" name="to-map-name">
+        <xs:attribute type="xs:string" name="field" use="required">
             <xs:annotation>
                 <xs:documentation>
-                    The name of the method environment field that contains the map that the field to be compared will come from.
-                    If left empty will default to the method environment.
-                    It does not default to the map-name because that would make it impossible to compare a map field to an environment field.    
+                    The name of the context field that will be compared.
                 </xs:documentation>
             </xs:annotation>
         </xs:attribute>
-        <xs:attribute type="xs:string" name="to-field-name">
+        <xs:attribute type="xs:string" name="to-field">
             <xs:annotation>
                 <xs:documentation>
-                    The name of the to-map field that the main field will be compared to.
-                    If left empty will default to the field-name.                    
+                    The name of the context field that the main field will be compared to.
+                    If left empty will default to the field attribute's value.                    
                 </xs:documentation>
             </xs:annotation>
         </xs:attribute>
@@ -4352,18 +4328,10 @@
         </xs:complexType>
     </xs:element>
     <xs:attributeGroup name="attlist.if-empty">
-        <xs:attribute type="xs:string" name="map-name">
-            <xs:annotation>
-                <xs:documentation>
-                    The name of the method environment field that contains the map that the field to be validated will come from.
-                    If not specified the field-name will be treated as a method environment field name (an env-name).
-                </xs:documentation>
-            </xs:annotation>
-        </xs:attribute>
-        <xs:attribute type="xs:string" name="field-name" use="required">
+        <xs:attribute type="xs:string" name="field" use="required">
             <xs:annotation>
                 <xs:documentation>
-                    The name of the map field that will be compared.
+                    The name of the context field that will be compared.
                 </xs:documentation>
             </xs:annotation>
         </xs:attribute>
@@ -4400,18 +4368,10 @@
         </xs:complexType>
     </xs:element>
     <xs:attributeGroup name="attlist.if-not-empty">
-        <xs:attribute type="xs:string" name="map-name">
-            <xs:annotation>
-                <xs:documentation>
-                    The name of the method environment field that contains the map that the field to be validated will come from.
-                    If not specified the field-name will be treated as a method environment field name (an env-name).
-                </xs:documentation>
-            </xs:annotation>
-        </xs:attribute>
-        <xs:attribute type="xs:string" name="field-name" use="required">
+        <xs:attribute type="xs:string" name="field" use="required">
             <xs:annotation>
                 <xs:documentation>
-                    The name of the map field that will be compared.
+                    The name of the context field that will be compared.
                 </xs:documentation>
             </xs:annotation>
         </xs:attribute>
@@ -5137,7 +5097,8 @@
             <xs:documentation>
                 The Simple Map Processor Mini-Language performes two primary tasks: validation and conversion.  
                 It does this in a context of moving values from one Map to another.
-                The input map will commonly contain Strings, but can contain other object types like Integer, Long, Float, Double, java.sql.Date, Time, and Timestamp.
+                The input map will commonly contain Strings, but can contain other object types like
+                Integer, Long, Float, Double, java.sql.Date, Time, and Timestamp.
             </xs:documentation>
         </xs:annotation>
         <xs:complexType>

Modified: ofbiz/site/dtds/widget-form.xsd
URL: http://svn.apache.org/viewvc/ofbiz/site/dtds/widget-form.xsd?rev=667519&r1=667518&r2=667519&view=diff
==============================================================================
--- ofbiz/site/dtds/widget-form.xsd (original)
+++ ofbiz/site/dtds/widget-form.xsd Fri Jun 13 06:18:01 2008
@@ -36,6 +36,7 @@
                 <xs:element minOccurs="0" maxOccurs="unbounded" ref="auto-fields-service"/>
                 <xs:element minOccurs="0" maxOccurs="unbounded" ref="auto-fields-entity"/>
                 <xs:element minOccurs="0" maxOccurs="unbounded" ref="field"/>
+                <xs:element minOccurs="0" maxOccurs="unbounded" ref="on-event-update-area"/>
                 <xs:element minOccurs="0" ref="sort-order"/>
             </xs:sequence>
             <xs:attributeGroup ref="attlist.form"/>
@@ -149,7 +150,9 @@
                 </xs:restriction>
             </xs:simpleType>
         </xs:attribute>
-        <xs:attribute type="xs:string" name="view-size"/>
+        <xs:attribute type="xs:integer" name="view-size">
+            <xs:annotation><xs:documentation>The number of items to display per page</xs:documentation></xs:annotation>
+        </xs:attribute>
         <xs:attribute type="xs:string" name="row-count"/>
         <xs:attribute name="use-row-submit" default="false">
             <xs:simpleType>
@@ -315,6 +318,27 @@
     <xs:attributeGroup name="attlist.sort-field">
         <xs:attribute type="xs:string" name="name" use="required"/>
     </xs:attributeGroup>
+    <!-- ================== Form Events ==================== -->
+    <xs:attributeGroup name="attlist.on-form-event-update-area">
+        <xs:attribute name="event-type" use="required">
+            <xs:simpleType>
+                <xs:restriction base="xs:token">
+                    <xs:enumeration value="paginate"/>
+                    <xs:enumeration value="submit"/>
+                </xs:restriction>
+            </xs:simpleType>
+        </xs:attribute>
+        <xs:attribute type="xs:string" name="area-id" use="required"/>
+        <xs:attribute type="xs:string" name="area-target" use="required"/>
+    </xs:attributeGroup>
+    <xs:element name="on-event-update-area">
+        <xs:annotation>
+            <xs:documentation>Area to be updated when a form event occurs.</xs:documentation>
+        </xs:annotation>
+        <xs:complexType>
+            <xs:attributeGroup ref="attlist.on-form-event-update-area"/>
+        </xs:complexType>
+    </xs:element>
 
   <!-- ================== FIELDS ==================== -->
     <xs:element name="AllFields" abstract="true"/>
@@ -322,6 +346,7 @@
         <xs:complexType>
             <xs:sequence>
                 <xs:element minOccurs="0" ref="AllFields"/>
+                <xs:element minOccurs="0" maxOccurs="unbounded" ref="on-field-event-update-area"/>
             </xs:sequence>
             <xs:attributeGroup ref="attlist.field"/>
         </xs:complexType>
@@ -422,6 +447,7 @@
             <xs:annotation><xs:documentation>The name of a style (like a CSS class) to apply to the title of this field if required. Will default to form's default-required-field-style. If field is required, but required-field-style is empty, an '*' will be placed to the right of text, textarea and password fields.</xs:documentation></xs:annotation>
         </xs:attribute>
     </xs:attributeGroup>
+
   <!-- ================== FIELD TYPES ==================== -->
     <xs:element name="check" substitutionGroup="AllFields">
         <xs:complexType>
@@ -577,6 +603,15 @@
         </xs:complexType>
     </xs:element>
     <xs:attributeGroup name="attlist.drop-down">
+        <xs:attribute name="type" default="traditional">
+            <xs:simpleType>
+                <xs:restriction base="xs:token">
+                    <xs:enumeration value="traditional"/>
+                    <xs:enumeration value="auto-complete-server"/>
+                    <!-- <xs:enumeration value="auto-complete-client"/> something to consider for the future -->
+                </xs:restriction>
+            </xs:simpleType>
+        </xs:attribute>
         <xs:attribute name="allow-empty" default="false">
             <xs:simpleType>
                 <xs:restriction base="xs:token">
@@ -798,7 +833,8 @@
         </xs:attribute>
         <xs:attribute type="xs:string" name="image-location"/>
         <xs:attribute type="xs:string" name="background-submit-refresh-target">
-            <xs:annotation><xs:documentation>This will submit the form in the background and refresh just this form and not the rest of the page. Note that the button-type must be button.</xs:documentation></xs:annotation>
+            <xs:annotation><xs:documentation>Deprecated. Use the on-event-update-area element
+                instead.</xs:documentation></xs:annotation>
         </xs:attribute>
     </xs:attributeGroup>
     <xs:element name="text" substitutionGroup="AllFields">
@@ -912,7 +948,29 @@
         </xs:attribute>
     </xs:attributeGroup>
 
-  <!-- ================== FIELD SUB-ELEMENTS ==================== -->
+    <!-- ================== Field Events ==================== -->
+    <xs:element name="on-field-event-update-area">
+        <xs:annotation>
+            <xs:documentation>Area to be updated when a field event occurs.</xs:documentation>
+        </xs:annotation>
+        <xs:complexType>
+            <xs:attributeGroup ref="attlist.on-field-event-update-area"/>
+        </xs:complexType>
+    </xs:element>
+    <xs:attributeGroup name="attlist.on-field-event-update-area">
+        <xs:attribute name="event-type" use="required">
+            <xs:simpleType>
+                <xs:restriction base="xs:token">
+                    <xs:enumeration value="change"/>
+                    <xs:enumeration value="click"/>
+                </xs:restriction>
+            </xs:simpleType>
+        </xs:attribute>
+        <xs:attribute type="xs:string" name="area-id" use="required"/>
+        <xs:attribute type="xs:string" name="area-target" use="required"/>
+    </xs:attributeGroup>
+
+    <!-- ================== FIELD SUB-ELEMENTS ==================== -->
     <xs:element name="entity-constraint">
         <xs:complexType>
             <xs:attributeGroup ref="attlist.entity-constraint"/>

Modified: ofbiz/site/dtds/widget-menu.xsd
URL: http://svn.apache.org/viewvc/ofbiz/site/dtds/widget-menu.xsd?rev=667519&r1=667518&r2=667519&view=diff
==============================================================================
--- ofbiz/site/dtds/widget-menu.xsd (original)
+++ ofbiz/site/dtds/widget-menu.xsd Fri Jun 13 06:18:01 2008
@@ -48,10 +48,10 @@
         <xs:attribute type="xs:string" name="title"/>
         <xs:attribute type="xs:string" name="tooltip"/>
         <xs:attribute type="xs:string" name="default-entity-name"/>
-        <xs:attribute type="xs:string" name="default-title-style" default="tabButton"/>
+        <xs:attribute type="xs:string" name="default-title-style"/>
         <xs:attribute type="xs:string" name="default-widget-style"/>
         <xs:attribute type="xs:string" name="default-tooltip-style"/>
-        <xs:attribute type="xs:string" name="default-selected-style" default="tabButtonSelected"/>
+        <xs:attribute type="xs:string" name="default-selected-style"/>
         <xs:attribute type="xs:string" name="default-align-style"/>
         <xs:attribute name="orientation" default="horizontal">
             <xs:simpleType>
@@ -76,8 +76,8 @@
         <xs:attribute type="xs:string" name="menu-width"/>
         <xs:attribute type="xs:string" name="default-cell-width"/>
         <xs:attribute type="xs:string" name="default-disabled-title-style"/>
-        <xs:attribute type="xs:string" name="selected-menuitem-context-field-name" default="tabButtonItem"/>
-        <xs:attribute type="xs:string" name="menu-container-style" default="tabContainer"/>
+        <xs:attribute type="xs:string" name="selected-menuitem-context-field-name"/>
+        <xs:attribute type="xs:string" name="menu-container-style"/>
         <xs:attribute name="default-align" default="left">
             <xs:simpleType>
                 <xs:restriction base="xs:token">

Modified: ofbiz/site/dtds/widget-screen.xsd
URL: http://svn.apache.org/viewvc/ofbiz/site/dtds/widget-screen.xsd?rev=667519&r1=667518&r2=667519&view=diff
==============================================================================
--- ofbiz/site/dtds/widget-screen.xsd (original)
+++ ofbiz/site/dtds/widget-screen.xsd Fri Jun 13 06:18:01 2008
@@ -754,7 +754,17 @@
     <xs:attributeGroup name="attlist.container">
         <xs:attribute type="xs:string" name="id"/>
         <xs:attribute type="xs:string" name="style"/>
-        <xs:attribute type="xs:string" name="auto-update-target"/>
+        <xs:attribute type="xs:string" name="auto-update-target">
+            <xs:annotation>
+                <xs:documentation>The URL to be called for periodic asynchronous area updates.
+                Some widget rendering environments support asynchronous updates.</xs:documentation>
+            </xs:annotation>
+        </xs:attribute>
+        <xs:attribute type="xs:integer" name="auto-update-interval">
+            <xs:annotation>
+                <xs:documentation>The auto-update interval, in seconds.</xs:documentation>
+            </xs:annotation>
+        </xs:attribute>
     </xs:attributeGroup>
     <xs:element name="image" substitutionGroup="AllWidgets">
         <xs:complexType mixed="true">
@@ -865,6 +875,15 @@
                 </xs:restriction>
             </xs:simpleType>
         </xs:attribute>
+        <xs:attribute name="initially-collapsed" default="false">
+            <xs:annotation><xs:documentation>When set to true, screenlet will be collapsed initially. Defaults to false.</xs:documentation></xs:annotation>
+            <xs:simpleType>
+                <xs:restriction base="xs:token">
+                    <xs:enumeration value="true"/>
+                    <xs:enumeration value="false"/>
+                </xs:restriction>
+            </xs:simpleType>
+        </xs:attribute>
         <xs:attribute name="padded" default="true">
             <xs:annotation><xs:documentation>When set to true, screenlet content will be padded. Defaults to true.</xs:documentation></xs:annotation>
             <xs:simpleType>
@@ -1065,10 +1084,12 @@
     <!-- ============== Platform Specific Elements =============== -->
     <xs:element name="platform-specific" substitutionGroup="AllWidgets">
         <xs:complexType>
-            <xs:choice>
+            <xs:sequence>
                 <xs:element minOccurs="0" ref="html"/>
                 <xs:element minOccurs="0" ref="swing"/>
-            </xs:choice>
+                <xs:element minOccurs="0" ref="xsl-fo"/>
+                <xs:element minOccurs="0" ref="xml"/>
+            </xs:sequence>
         </xs:complexType>
     </xs:element>
     <!-- ============== HTML Specific Elements =============== -->
@@ -1080,6 +1101,20 @@
             </xs:sequence>
         </xs:complexType>
     </xs:element>
+    <xs:element name="xsl-fo">
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element minOccurs="0" maxOccurs="unbounded" ref="HtmlWidgets"/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+    <xs:element name="xml">
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element minOccurs="0" maxOccurs="unbounded" ref="HtmlWidgets"/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
     <xs:element name="html-template" substitutionGroup="HtmlWidgets">
         <xs:complexType>
             <xs:attributeGroup ref="attlist.html-template"/>