You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by jl...@apache.org on 2020/03/09 13:32:28 UTC
[ofbiz-site] branch master updated: Updates XSDs
This is an automated email from the ASF dual-hosted git repository.
jleroux pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ofbiz-site.git
The following commit(s) were added to refs/heads/master by this push:
new fcf91be Updates XSDs
fcf91be is described below
commit fcf91be2c86de2d9aa6d5c54ed775a4d02b43ccf
Author: Jacques Le Roux <ja...@les7arts.com>
AuthorDate: Mon Mar 9 14:32:39 2020 +0100
Updates XSDs
---
dtds/widget-form.xsd | 42 +++++++++++++++++++++++++++++++++++-------
dtds/widget-theme.xsd | 18 +++++++++---------
2 files changed, 44 insertions(+), 16 deletions(-)
diff --git a/dtds/widget-form.xsd b/dtds/widget-form.xsd
index 868cd87..d452ef9 100644
--- a/dtds/widget-form.xsd
+++ b/dtds/widget-form.xsd
@@ -647,7 +647,13 @@ under the License.
</xs:attribute>
<xs:attribute type="xs:string" name="parameter-name">
<xs:annotation>
- <xs:documentation>Defaults to the value of the name attribute; is the name of the parameter to use for this field (the request parameter in a web application).</xs:documentation>
+ <xs:documentation>Specifies the parameter name to use for this field - i.e. the name attribute of an
+ HTML input field in a web application.
+
+ Accepts Unified Expression Language (JSR 245) notation, i.e. ${}, to allow use of expressions.
+
+ Defaults to the value of the name attribute.
+ </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:string" name="title">
@@ -656,7 +662,7 @@ under the License.
The name of this field that will be shown to the user.
It can use the ${} and foo.bar (dot) syntax to insert values from the context for parameterization or internationalization.
- Be sure a "FormFieldTitle_" labels does not already exist, else it will be overriden.
+ Be sure a "FormFieldTitle_" labels does not already exist, else it will be overridden.
</xs:documentation>
</xs:annotation>
</xs:attribute>
@@ -755,7 +761,18 @@ under the License.
<xs:documentation>Used to specify a javascript action that should be run based on an existing specified event.</xs:documentation>
</xs:annotation>
</xs:attribute>
- <xs:attribute type="xs:string" name="id-name" />
+ <xs:attribute type="xs:string" name="id-name">
+ <xs:annotation>
+ <xs:documentation>Define the string to be used as the identifier (like a DOM id attribute) for this
+ field.
+
+ Accepts ${} notation to allow use of expressions.
+
+ If undefined then defaults to [form-name]_[name] where form-name is set using the form-name
+ attribute or taken from the containing form element's name attribute.
+ </xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
<xs:attribute name="separate-column" type="xs:boolean" default="false"/>
<xs:attribute name="required-field" type="xs:boolean"/>
<xs:attribute type="xs:string" name="required-field-style">
@@ -1199,10 +1216,21 @@ under the License.
</xs:attribute>
<xs:attribute type="xs:string" name="target-parameter">
<xs:annotation>
- <xs:documentation>The name of a field whose value is passed in as a parameter to the lookup target form.
- Can be a comma separated list. You need to affect it the value using parameters.parmI
- (where I is the position number in the list, I must begin at 0) in the related lookup screen.
- See LookupPreferredContactMech as example
+ <xs:documentation>Comma separated list of the parameter-names of the fields whose values are passed
+ as parameters to the lookup target form.
+
+ Accepts Unified Expression Language (JSR 245) notation, i.e. ${}, to allow use of expressions.
+ Expressions are evaluated before splitting at any commas. After splitting, whitespace is trimmed
+ from the beginning and end of the resulting elements.
+
+ The position of a field name in the list corresponds to the parameter name that will be passed
+ to the lookup form. Parameter names follow the naming convention parmN where N is the list
+ position of the field name, starting with 0.
+
+ Example: A form has a text input field with parameter-name alpha and value 42; and text input
+ field with parameter-name bravo and value 107. A lookup field has been created for that form
+ with target-parameter="bravo,alpha". When the lookup is performed the resulting request will
+ include parm0=107 and parm1=42.
</xs:documentation>
</xs:annotation>
</xs:attribute>
diff --git a/dtds/widget-theme.xsd b/dtds/widget-theme.xsd
index 1efe3cf..3362cef 100644
--- a/dtds/widget-theme.xsd
+++ b/dtds/widget-theme.xsd
@@ -34,7 +34,7 @@ under the License.
</xs:complexType>
</xs:element>
<xs:element name="visual-themes">
- <xs:annotation><xs:documentation>List all visual themes embedded by this theme</xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>List all visual themes embded by this theme</xs:documentation></xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="visual-theme" />
@@ -54,20 +54,20 @@ under the License.
</xs:element>
<xs:element name="description"/>
<xs:element name="screenshot">
- <xs:annotation><xs:documentation>List all screenshot images with the path to use from web site (ex '/mytheme/screenshot1.jpg' for an image in ofbiz/themes/mytheme/webapp/screenshot1.jpg)</xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>List all screenshots image with the path to use from web site (ex '/mytheme/screenshot1.jpg' for an image in ofbiz/themes/mytheme/webapp/screenshot1.jpg)</xs:documentation></xs:annotation>
<xs:complexType>
<xs:attribute type="xs:string" name="location" use="required" />
</xs:complexType>
</xs:element>
<xs:element name="extends">
- <xs:annotation><xs:documentation>Indicate the theme to extend if you when improve an existing theme like common-theme. You need to define the path to the theme definition to surcharge (ex: component://common-theme/widget/Theme.xml)</xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Indicate the theme to extend if you when improve an existent theme like common-theme. You need to define the path to the theme definition to surcharge (ex: component://common-theme/widget/Theme.xml)</xs:documentation></xs:annotation>
<xs:complexType>
<xs:attribute type="xs:string" name="location" use="required" />
</xs:complexType>
</xs:element>
<xs:element name="widget-properties">
<xs:annotation><xs:documentation>
- This element contains all properties used by the screen engine that the theme can be dedicating some values to
+ This element contains all properties use by the screen engine that the theme can be dedicate some values
</xs:documentation></xs:annotation>
<xs:complexType>
<xs:sequence>
@@ -127,7 +127,7 @@ under the License.
</xs:complexType>
</xs:element>
<xs:annotation><xs:documentation>
- This element contains all properties associated with the theme technology
+ This element contains all properties dedicate with the theme technology
</xs:documentation></xs:annotation>
<xs:element name="property">
<xs:complexType>
@@ -148,7 +148,7 @@ under the License.
</xs:complexType>
</xs:element>
<xs:annotation><xs:documentation>
- This element contains all Freemarker macro templates supported by this theme
+ This element contains all ftl macro template supported by this theme
</xs:documentation></xs:annotation>
<xs:element name="template">
<xs:complexType>
@@ -181,7 +181,7 @@ under the License.
</xs:element>
<xs:element name="common-screens">
<xs:annotation><xs:documentation>
- List the location of each common screen that the theme implements
+ List the location of each common screens that the theme implement
</xs:documentation></xs:annotation>
<xs:complexType>
<xs:sequence>
@@ -193,7 +193,7 @@ under the License.
</xs:element>
<xs:element name="common-forms">
<xs:annotation><xs:documentation>
- List the location of each common form that the theme implements
+ List the location of each common forms that the theme implement
</xs:documentation></xs:annotation>
<xs:complexType>
<xs:sequence>
@@ -203,7 +203,7 @@ under the License.
</xs:element>
<xs:element name="common-menus">
<xs:annotation><xs:documentation>
- List the location of each common menu that the theme implements
+ List the location of each common menus that the theme implement
</xs:documentation></xs:annotation>
<xs:complexType>
<xs:sequence>