Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "STP/Policy Component/XEF Reference"

(Tool Tips)
(Tool Tips)
Line 98: Line 98:
 
! After
 
! After
 
| [[Image:XEFToolTipAfter.jpg]]  
 
| [[Image:XEFToolTipAfter.jpg]]  
 +
|- valign="top"
 +
! Example
 +
|
 +
<pre><xs:attribute name="sample_interval" type="xs:positiveInteger">
 +
  <xs:annotation>
 +
    <xs:appinfo>
 +
      <xef:docShort>Defines how often the log is sampled for auditing</xef:docShort>
 +
    </xs:appinfo>
 +
  </xs:annotation>
 +
</xs:attribute></pre>
 +
|}
 +
 +
== Units ==
 +
{| border="1" cellspacing="0" cellpadding="4"
 +
|- valign="top"
 +
! Annotation
 +
| <xef:units> - String
 +
|- valign="top"
 +
! Description
 +
| Places an extra label to describe the units of measurement for the attribute in the editor.
 +
|- valign="top"
 +
! Applies to
 +
| <xs:attribute>
 +
|- valign="top"
 +
! Before
 +
| [[Image:XEFUnitsBefore.jpg]]
 +
|- valign="top"
 +
! After
 +
| [[Image:XEFUnitsAfter.jpg]]
 
|- valign="top"
 
|- valign="top"
 
! Example
 
! Example

Revision as of 13:51, 11 December 2007

XEF Reference

Category

Annotation <xef:category> - String
Description Provides categorization for the element or attribute. For elements the category is used in the Schema Selection Dialog, for attributes the category is used to put the attribute in a collapsible section in the editor.
Applies to <xs:element> and <xs:attribute>
Before

attributes: XEFCategoryBefore.jpg


elements: XEFCategoryElementBefore.jpg

After

attributes: XEFCategoryAfter1.jpg and XEFCategoryAfter2.jpg


elements: XEFCategoryElementAfter.jpg

Example
<xs:element name="audit">
  <xs:annotation>
    <xs:appinfo>
      <xef:category>Logging</xef:category>
    </xs:appinfo>
  </xs:annotation>
</xs:element>

Display Name

Annotation <xef:displayName> - String
Description Provides a human readable name for the attribute or element.
Applies to <xs:element> and <xs:attribute>
Before

attributes: DisplayNameBefore.jpg


elements: DisplayNameElementBefore.jpg

After

attributes: DisplayNameAfter.jpg


elements: DisplayNameElementAfter.jpg

Example
<xs:attribute name="every_client" type="xs:boolean">
  <xs:annotation>
    <xs:appinfo>
      <xef:displayName>Every Client</xef:displayName>
    </xs:appinfo>
  </xs:annotation>
</xs:attribute>

Tool Tips

Annotation <xef:docShort> - String
Description Provides tooltips on the controls that display the elements and attributes.
Applies to <xs:element> and <xs:attribute>
Before XEFToolTipBefore.jpg
After XEFToolTipAfter.jpg
Example
<xs:attribute name="sample_interval" type="xs:positiveInteger">
  <xs:annotation>
    <xs:appinfo>
      <xef:docShort>Defines how often the log is sampled for auditing</xef:docShort>
    </xs:appinfo>
  </xs:annotation>
</xs:attribute>

Units

Annotation <xef:units> - String
Description Places an extra label to describe the units of measurement for the attribute in the editor.
Applies to <xs:attribute>
Before XEFUnitsBefore.jpg
After XEFUnitsAfter.jpg
Example
<xs:attribute name="sample_interval" type="xs:positiveInteger">
  <xs:annotation>
    <xs:appinfo>
      <xef:docShort>Defines how often the log is sampled for auditing</xef:docShort>
    </xs:appinfo>
  </xs:annotation>
</xs:attribute>

Back to the top