-
Notifications
You must be signed in to change notification settings - Fork 0
/
FormContent.htm
160 lines (155 loc) · 5.6 KB
/
FormContent.htm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>HAL - Hypertext Application Language</title>
<link type="text/css" rel="stylesheet" href="spec.css" />
</head>
<body>
<div id="wrapper">
<div id="heading">
<h1>Report Content </h1>
<h2>A media type for delivering content to a reporting engine</h2>
<dl>
<dt>Author:</dt>
<dd>Darrel Miller (<a href="mailto:[email protected]">[email protected]</a>)</dd>
<dt>Dates:</dt>
<dd>2013-01-23 (Created)</dd>
<dt>Version:</dt>
<dd>0.0.1</dd>
<dt>Status:</dt>
<dd class="stable">Initial Draft</dd>
</dl>
</div>
<div id="general">
<h2>General Description</h2>
<p>
TK. </p>
<h2>Motivation</h2>
<p>
TK </p>
<p>
TK</p>
<h2>
Non-Goals</h2>
<ul>
<li>It is not intended to be a general purpose data import/export format. </li>
<li>It does not constraint the allowed relationships between entities.</li>
<li>It does not constraint the allowed relationships between entities and contained properties.</li>
</ul>
</div>
<div id="examples">
<h2>Examples</h2>
<p>
Here is an example of a TID document:
</p>
<pre>
<tm version="1.0.0">
<assembly id="23">
<task code="3434"></task>
<quantity>2</quantity>
<ratio>.7</ratio>
</assembly>
<assembly id="23">
<quantity>1</quantity>
<ratio>.2</ratio>
</assembly>
</tm>
</pre>
</div>
<div id="compliance">
<h2>Compliance</h2>
<p>
An implementation is not compliant if it fails to satisfy one or more
of the MUST or REQUIRED level requirements. An implementation that satisfies all the MUST or REQUIRED
level and all the SHOULD level requirements is said
to be "unconditionally compliant"; one that satisfies all the MUST
level requirements but not all the SHOULD level requirements is said to be "conditionally compliant."
</p>
<blockquote>
<p>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
<a href="#refs-2119">RFC 2119</a>.
</p>
</blockquote>
</div>
<div id="media_type_identifiers">
<h2>Media Type Identifiers</h2>
<dl>
<dt>application/vnd.tavis.reportcontent+xml</dt>
<dd></dd>
</dl>
<h2>
Components</h2>
<p>
A TID document has a single root named tm. All elements and attributes
MUST be camelcased.</p>
<ol>
<li>
<h4>
Root Element</h4>
<p>
The root element can contain zero, one or multiple entity references. It can also contain link elements.
The root element MUST contain an attribute named version that conforms to
semantic versioning rules as defined by http://www.semver.org</p>
</li>
<li>
<h4>
Entity Reference</h4>
<p>
Entity reference elements MUST contain either an id or code attribute.
Entity references can contain zero, one or multiple property elements or entity
reference elements. Entity references MUST use one of the following
element names:
</p>
<ul>
<li>assembly</li>
<li>operation</li>
<li>task</li>
<li>part</li>
<li>job</li>
<li>ncr</li>
<li>lot</li>
<li>machine</li>
<li>location</li>
<li>externalIdentifier</li>
</ul>
</li>
<li>
<h4>
Property</h4>
<p>
Property elements MUST only contain a text node. Property elements can be
used within any entity reference element but MUST use one of the following
element names:</p>
<ul>
<li>quantity</li>
<li>ratio</li>
</ul>
</li>
<li><h4>Link</h4>
<p>Link elements MUST contain a rel attribute and an href attribute. Link elements can be used within entity references and the root node.</p>
</li>
</ol>
<h2>
Recommendations</h2>
<p>
Link relation values used to identify the links that retrieve TIDs can be used
to further define the significance of properties within entitiy references and
the relationships between those entities.</p>
</div>
<div id="extending">
<h2>Extending TID</h2>
<p>As new entity reference names and property names are added, the patch value on the version
number MUST be incremented. The minor version MUST be incremented if
existing vocabulary is removed or changed.</p>
<h2>
Notes</h2>
<p>
</p>
</div>
</body>
</html>