Skip to content

Commit

Permalink
Add documentation purposes with definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
kleihan committed Sep 12, 2024
1 parent a0f3c86 commit b9bf6b6
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions repository/src/main/resources/xsd/repositorytypes.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -826,14 +826,41 @@
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="SYNOPSIS"/>
<xs:annotation>
<xs:documentation>
Brief summary of the element, typically highlighting its key function or purpose, restricted to one paragraph for conciseness.</xs:documentation>
</xs:annotation>
<xs:enumeration value="ELABORATION"/>
<xs:annotation>
<xs:documentation>
Detailed explanation of the element, clarifying its usage, functionality, or background.</xs:documentation>
</xs:annotation>
<xs:enumeration value="EXAMPLE"/>
<xs:annotation>
<xs:documentation>
Sample or illustration demonstrating how the element is used in practice.</xs:documentation>
</xs:annotation>
<xs:enumeration value="DISPLAY">
<xs:annotation>
<xs:documentation>For UI when different from canonical name; may
have multi-language displays
<xs:documentation>
For UI when different from canonical name; may have multi-language displays.</xs:documentation>
</xs:annotation>
<xs:enumeration value="CAPTION">
<xs:annotation>
<xs:documentation>
Descriptive label or title for the element, may be used for tables, figures, headings or brief annotations.</xs:documentation>
</xs:annotation>
<xs:enumeration value="TOOLTIP">
<xs:annotation>
<xs:documentation>
Short message or hint that appears when hovering over the element, usually explaining its function or use.</xs:documentation>
</xs:documentation>
</xs:annotation>
<xs:enumeration value="DEFINITION">
<xs:annotation>
<xs:documentation>
Precise and formal explanation of the element, restricted to one sentence in length to ensure brevity.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
Expand Down

0 comments on commit b9bf6b6

Please sign in to comment.