| 1 |
<pre>Network Working Group A. Miller |
| 2 |
Request for Comment: 4708 The University of Auckland |
| 3 |
Category: Informational October 2006 |
| 4 |
|
| 5 |
|
| 6 |
<span class="h1">CellML Media Type</span> |
| 7 |
|
| 8 |
Status of This Memo |
| 9 |
|
| 10 |
This memo provides information for the Internet community. It does |
| 11 |
not specify an Internet standard of any kind. Distribution of this |
| 12 |
memo is unlimited. |
| 13 |
|
| 14 |
Copyright Notice |
| 15 |
|
| 16 |
Copyright (C) The Internet Society (2006). |
| 17 |
|
| 18 |
Abstract |
| 19 |
|
| 20 |
This document standardises a new media type -- application/cellml+xml |
| 21 |
-- for use in exchanging mathematical models represented in a CellML |
| 22 |
Umbrella 1.0 compliant markup language. |
| 23 |
|
| 24 |
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span> |
| 25 |
|
| 26 |
The CellML Umbrella format is a standardised markup meta-language for |
| 27 |
the interchange of mathematical models. The CellML Umbrella format |
| 28 |
provides a common base that is supported by a number of specific |
| 29 |
formats used in the interchange of mathematical models. The CellML |
| 30 |
Umbrella format provides enough information to determine which |
| 31 |
specific language is used to express the model. The syntax and |
| 32 |
semantics of the CellML Umbrella format are defined by |
| 33 |
[<a href="#ref-CELLML-UMBRELLA" title=""CellML Umbrella Specification 1.0"">CELLML-UMBRELLA</a>]. |
| 34 |
|
| 35 |
The CellML Umbrella format is an actual media format. Although |
| 36 |
CellML Umbrella documents contain elements in namespaces defined by |
| 37 |
other specifications such as [<a href="#ref-RDF" title=""RDF/XML Syntax Specification (Revised)"">RDF</a>] and [<a href="#ref-MATHML" title=""Mathematical Markup Language (MathML) 1.01 Specification"">MATHML</a>], the elements in |
| 38 |
these namespaces do not contain sufficient information to define a |
| 39 |
mathematical model, and so CellML provides the information required |
| 40 |
to interconnect the different CellML components, as well as the |
| 41 |
information required to link CellML components to their metadata. As |
| 42 |
such, CellML Umbrella documents are more than just a collection of |
| 43 |
entities defined elsewhere, and so a new media type is required to |
| 44 |
identify CellML. |
| 45 |
|
| 46 |
As all well-formed CellML Umbrella documents are also well-formed XML |
| 47 |
documents, the convention described in <a href="./rfc3023#section-7">Section 7 of [RFC3023]</a> has |
| 48 |
been observed by use of the +xml suffix. |
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
<span class="grey">Miller Informational [Page 1]</span></pre> |
| 53 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span> |
| 54 |
<span class="grey"><a href="./rfc4708">RFC 4708</a> CellML Media Type October 2006</span> |
| 55 |
|
| 56 |
|
| 57 |
The information in CellML Umbrella documents cannot be interpreted |
| 58 |
without understanding the semantics of the XML elements used to mark |
| 59 |
up the model structure. Therefore, the application top-level type is |
| 60 |
used instead of the text top-level type. |
| 61 |
|
| 62 |
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Notational Conventions</span> |
| 63 |
|
| 64 |
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", |
| 65 |
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this |
| 66 |
document are to be interpreted as described in [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>]. |
| 67 |
|
| 68 |
The terms "element" and "document element" in this document are to be |
| 69 |
interpreted as in [<a href="#ref-XML" title=""Extensible Markup Language (XML) 1.0 (Fourth Edition)"">XML</a>]. |
| 70 |
|
| 71 |
The term "XML namespace" is to be interpreted as in [<a href="#ref-NAMESPACES" title=""Namespaces in XML 1.1"">NAMESPACES</a>]. |
| 72 |
|
| 73 |
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Media Type Registration for CellML Umbrella</span> |
| 74 |
|
| 75 |
MIME media type name: application |
| 76 |
|
| 77 |
MIME subtype name: cellml+xml |
| 78 |
|
| 79 |
Mandatory parameters: none |
| 80 |
|
| 81 |
Optional parameters: charset |
| 82 |
|
| 83 |
The charset parameter of application/cellml+xml is handled in the |
| 84 |
same fashion as for application/xml, as specified in <a href="./rfc3023#section-3.2">Section 3.2 |
| 85 |
of [RFC3023]</a>. However, per conformance rule 4 of |
| 86 |
[<a href="#ref-CELLML-UMBRELLA" title=""CellML Umbrella Specification 1.0"">CELLML-UMBRELLA</a>], valid CellML Umbrella documents MUST be in the |
| 87 |
UTF-8 character set. If the charset parameter is present, it MUST |
| 88 |
take the value "utf-8". CellML processing software SHOULD check |
| 89 |
the charset field, and if it is present but not equal to "utf-8", |
| 90 |
MAY attempt to recover from the error by processing the document |
| 91 |
in the specified character set. |
| 92 |
|
| 93 |
Encoding considerations: As per <a href="./rfc3023#section-3.2">Section 3.2 of [RFC3023]</a>. |
| 94 |
|
| 95 |
Security considerations: As per <a href="#section-5">Section 5</a> of this document. |
| 96 |
|
| 97 |
Interoperability considerations: As per <a href="#section-4.1">Section 4.1</a> of this document. |
| 98 |
|
| 99 |
Published specification: |
| 100 |
|
| 101 |
CellML Umbrella Specification [<a href="#ref-CELLML-UMBRELLA" title=""CellML Umbrella Specification 1.0"">CELLML-UMBRELLA</a>]. |
| 102 |
|
| 103 |
Applications that use this media type: As per <a href="#section-4.2">Section 4.2</a> of this |
| 104 |
document. |
| 105 |
|
| 106 |
|
| 107 |
|
| 108 |
<span class="grey">Miller Informational [Page 2]</span></pre> |
| 109 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span> |
| 110 |
<span class="grey"><a href="./rfc4708">RFC 4708</a> CellML Media Type October 2006</span> |
| 111 |
|
| 112 |
|
| 113 |
Additional information: |
| 114 |
|
| 115 |
Magic number(s): None. |
| 116 |
XML processing software can identify CellML Umbrella documents |
| 117 |
as XML documents that contain a document element with the local |
| 118 |
name "model". |
| 119 |
|
| 120 |
File extension(s): |
| 121 |
The RECOMMENDED file extension for CellML Umbrella documents is |
| 122 |
.cellml |
| 123 |
|
| 124 |
Some older software uses the file extension .xml. Software |
| 125 |
vendors have also used the non-standard extension .cml. In |
| 126 |
contexts where the MIME type is available, or where the type |
| 127 |
has already been determined as CellML, implementations SHOULD |
| 128 |
allow files to be opened regardless of the extension. |
| 129 |
Implementations transferring models to an environment that uses |
| 130 |
file extensions SHOULD use the .cellml extension. |
| 131 |
|
| 132 |
Macintosh File Type Code(s): "TEXT" |
| 133 |
|
| 134 |
Person & email address to contact for further information: |
| 135 |
See the Author's Address section of this document. |
| 136 |
|
| 137 |
Intended usage: COMMON |
| 138 |
|
| 139 |
Author/Change controller: The CellML Umbrella 1.0 specification |
| 140 |
was authored by Andrew Miller. |
| 141 |
|
| 142 |
The CellML Umbrella 1.0 specification itself will not change. |
| 143 |
However, the umbrella specification defines the process for new |
| 144 |
specific formats to be registered. The Bioengineering |
| 145 |
Institute at The University of Auckland, with input from the |
| 146 |
CellML Community via the [email protected] mailing |
| 147 |
list, has control over the CellML Umbrella Format Registry. |
| 148 |
|
| 149 |
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Interoperability and Usage</span> |
| 150 |
|
| 151 |
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Interoperability Considerations</span> |
| 152 |
|
| 153 |
The interoperability considerations in <a href="./rfc3023#section-3.1">Section 3.1 of [RFC3023]</a> also |
| 154 |
apply to CellML Umbrella documents. CellML Umbrella documents |
| 155 |
contain XML elements defined by each specific format, all of which |
| 156 |
are published specifications. In addition to the ability to parse |
| 157 |
XML, user agents require software support for the semantics of [<a href="#ref-RDF" title=""RDF/XML Syntax Specification (Revised)"">RDF</a>] |
| 158 |
and/or part or all of a specific format. As efforts are made to keep |
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
<span class="grey">Miller Informational [Page 3]</span></pre> |
| 165 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span> |
| 166 |
<span class="grey"><a href="./rfc4708">RFC 4708</a> CellML Media Type October 2006</span> |
| 167 |
|
| 168 |
|
| 169 |
the number of specific formats small, user agents SHOULD implement |
| 170 |
all specific formats listed in the CellML Umbrella Format Registry at |
| 171 |
the time they were developed. |
| 172 |
|
| 173 |
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Applications that Use CellML Umbrella Format</span> |
| 174 |
|
| 175 |
CellML Umbrella is device-, platform-, and vendor-neutral and is |
| 176 |
supported by a wide range of CellML processing tools, including those |
| 177 |
designed to validate, edit, and/or visualise CellML models, extract |
| 178 |
MathML or RDF, translate to or from other related specifications, |
| 179 |
evaluate mathematics and ordinary differential equations, fit |
| 180 |
parameters to models, and serve, archive, and annotate models. |
| 181 |
|
| 182 |
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Security Considerations</span> |
| 183 |
|
| 184 |
As CellML Umbrella is an XML-based markup language, all the security |
| 185 |
considerations presented in <a href="./rfc3023#section-10">Section 10 of [RFC3023]</a> also apply to |
| 186 |
CellML Umbrella. |
| 187 |
|
| 188 |
Some types of CellML Umbrella documents can refer to other Uniform |
| 189 |
Resource Locators (URLs) in a number of places: |
| 190 |
|
| 191 |
i) References to XML document type definitions or schemas. |
| 192 |
|
| 193 |
ii) References to other models using the import features of some |
| 194 |
specific formats. |
| 195 |
|
| 196 |
iii) References to other documents embedded in user-defined data. |
| 197 |
|
| 198 |
Some types of CellML processing software may then automatically |
| 199 |
attempt to access the URL and retrieve the document. This retrieval |
| 200 |
could have several consequences, specifically, |
| 201 |
|
| 202 |
i) if a CellML document is transferred via e-mail, the fact that |
| 203 |
the recipient has opened the CellML document could be |
| 204 |
disclosed to the sender without the recipient's knowledge or |
| 205 |
consent. |
| 206 |
|
| 207 |
ii) where the recipient of a document transfers the document to |
| 208 |
another location using the MIME type defined in this |
| 209 |
document, the original author of the document may be notified |
| 210 |
of the second address by the attempted retrieval of further |
| 211 |
documents. |
| 212 |
|
| 213 |
iii) by performing requests on the recipient's behalf, the CellML |
| 214 |
processing software may cause actions to be performed with |
| 215 |
privileges granted to the recipient, without the recipient's |
| 216 |
knowledge or consent. |
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
<span class="grey">Miller Informational [Page 4]</span></pre> |
| 221 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span> |
| 222 |
<span class="grey"><a href="./rfc4708">RFC 4708</a> CellML Media Type October 2006</span> |
| 223 |
|
| 224 |
|
| 225 |
CellML processing software can mitigate this threat when running in |
| 226 |
an environment where it is a concern by requiring explicit |
| 227 |
confirmation from the user before attempting to load any external |
| 228 |
documents. |
| 229 |
|
| 230 |
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. IANA Considerations</span> |
| 231 |
|
| 232 |
This document specifies a new media type. IANA has added this media |
| 233 |
type to their media types registry as specified in [<a href="./rfc4288" title=""Media Type Specifications and Registration Procedures"">RFC4288</a>]. |
| 234 |
|
| 235 |
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. References</span> |
| 236 |
|
| 237 |
<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Normative References</span> |
| 238 |
|
| 239 |
[<a id="ref-CELLML-UMBRELLA">CELLML-UMBRELLA</a>] Miller, A.K., "CellML Umbrella Specification 1.0", |
| 240 |
20 April 2006, <<a href="http://www.cellml.org/specifications/cellml_umbrella_1.0">http://www.cellml.org/</a> |
| 241 |
<a href="http://www.cellml.org/specifications/cellml_umbrella_1.0">specifications/cellml_umbrella_1.0</a>> |
| 242 |
|
| 243 |
[<a id="ref-NAMESPACES">NAMESPACES</a>] Bray, T., et. al., "Namespaces in XML 1.1", 4 |
| 244 |
February 2004, <<a href="http://www.w3.org/TR/xml-names11">http://www.w3.org/TR/xml-names11</a>> |
| 245 |
|
| 246 |
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate |
| 247 |
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997. |
| 248 |
|
| 249 |
[<a id="ref-RFC3023">RFC3023</a>] Murata, M., St. Laurent, S., and D. Kohn, "XML |
| 250 |
Media Types", <a href="./rfc3023">RFC 3023</a>, January 2001. |
| 251 |
|
| 252 |
[<a id="ref-XML">XML</a>] Bray, T., et. al., "Extensible Markup Language |
| 253 |
(XML) 1.0 (Fourth Edition)", 29 September 2006, |
| 254 |
<<a href="http://www.w3.org/TR/REC-xml/">http://www.w3.org/TR/REC-xml/</a>> |
| 255 |
|
| 256 |
<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Informative References</span> |
| 257 |
|
| 258 |
[<a id="ref-MATHML">MATHML</a>] Ion, P. and Miner, R.(editors) "Mathematical Markup |
| 259 |
Language (MathML) 1.01 Specification", 7 July 1999, |
| 260 |
<<a href="http://www.w3.org/TR/REC-MathML/">http://www.w3.org/TR/REC-MathML/</a>> |
| 261 |
|
| 262 |
[<a id="ref-RDF">RDF</a>] Beckett, D.(editor) "RDF/XML Syntax Specification |
| 263 |
(Revised)", 10 February 2004, |
| 264 |
<<a href="http://www.w3.org/TR/rdf-syntax-grammar/">http://www.w3.org/TR/rdf-syntax-grammar/</a>> |
| 265 |
|
| 266 |
[<a id="ref-RFC4288">RFC4288</a>] Freed, N. and J. Klensin, "Media Type |
| 267 |
Specifications and Registration Procedures", <a href="https://www.rfc-editor.org/bcp/bcp13">BCP</a> |
| 268 |
<a href="https://www.rfc-editor.org/bcp/bcp13">13</a>, <a href="./rfc4288">RFC 4288</a>, December 2005. |
| 269 |
|
| 270 |
|
| 271 |
|
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
<span class="grey">Miller Informational [Page 5]</span></pre> |
| 277 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span> |
| 278 |
<span class="grey"><a href="./rfc4708">RFC 4708</a> CellML Media Type October 2006</span> |
| 279 |
|
| 280 |
|
| 281 |
Author's Address |
| 282 |
|
| 283 |
Andrew Miller |
| 284 |
The Bioengineering Institute at The University of Auckland |
| 285 |
Level 6, 70 Symonds St |
| 286 |
Auckland Central |
| 287 |
Auckland |
| 288 |
|
| 289 |
EMail: [email protected] |
| 290 |
|
| 291 |
|
| 292 |
|
| 293 |
|
| 294 |
|
| 295 |
|
| 296 |
|
| 297 |
|
| 298 |
|
| 299 |
|
| 300 |
|
| 301 |
|
| 302 |
|
| 303 |
|
| 304 |
|
| 305 |
|
| 306 |
|
| 307 |
|
| 308 |
|
| 309 |
|
| 310 |
|
| 311 |
|
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 |
|
| 319 |
|
| 320 |
|
| 321 |
|
| 322 |
|
| 323 |
|
| 324 |
|
| 325 |
|
| 326 |
|
| 327 |
|
| 328 |
|
| 329 |
|
| 330 |
|
| 331 |
|
| 332 |
<span class="grey">Miller Informational [Page 6]</span></pre> |
| 333 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span> |
| 334 |
<span class="grey"><a href="./rfc4708">RFC 4708</a> CellML Media Type October 2006</span> |
| 335 |
|
| 336 |
|
| 337 |
Full Copyright Statement |
| 338 |
|
| 339 |
Copyright (C) The Internet Society (2006). |
| 340 |
|
| 341 |
This document is subject to the rights, licenses and restrictions |
| 342 |
contained in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a>, and except as set forth therein, the authors |
| 343 |
retain all their rights. |
| 344 |
|
| 345 |
This document and the information contained herein are provided on an |
| 346 |
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS |
| 347 |
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET |
| 348 |
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, |
| 349 |
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE |
| 350 |
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED |
| 351 |
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. |
| 352 |
|
| 353 |
Intellectual Property |
| 354 |
|
| 355 |
The IETF takes no position regarding the validity or scope of any |
| 356 |
Intellectual Property Rights or other rights that might be claimed to |
| 357 |
pertain to the implementation or use of the technology described in |
| 358 |
this document or the extent to which any license under such rights |
| 359 |
might or might not be available; nor does it represent that it has |
| 360 |
made any independent effort to identify any such rights. Information |
| 361 |
on the procedures with respect to rights in RFC documents can be |
| 362 |
found in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and <a href="https://www.rfc-editor.org/bcp/bcp79">BCP 79</a>. |
| 363 |
|
| 364 |
Copies of IPR disclosures made to the IETF Secretariat and any |
| 365 |
assurances of licenses to be made available, or the result of an |
| 366 |
attempt made to obtain a general license or permission for the use of |
| 367 |
such proprietary rights by implementers or users of this |
| 368 |
specification can be obtained from the IETF on-line IPR repository at |
| 369 |
<a href="http://www.ietf.org/ipr">http://www.ietf.org/ipr</a>. |
| 370 |
|
| 371 |
The IETF invites any interested party to bring to its attention any |
| 372 |
copyrights, patents or patent applications, or other proprietary |
| 373 |
rights that may cover technology that may be required to implement |
| 374 |
this standard. Please address the information to the IETF at |
| 375 |
[email protected]. |
| 376 |
|
| 377 |
Acknowledgement |
| 378 |
|
| 379 |
Funding for the RFC Editor function is provided by the IETF |
| 380 |
Administrative Support Activity (IASA). |
| 381 |
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 |
|
| 386 |
|
| 387 |
|
| 388 |
Miller Informational [Page 7] |
| 389 |
</pre> |