| 1 |
<pre>Network Working Group E. Levinson |
| 2 |
Request for Comments: 1874 Accurate Information Systems, Inc. |
| 3 |
Category: Experimental December 1995 |
| 4 |
|
| 5 |
|
| 6 |
<span class="h1">SGML Media Types</span> |
| 7 |
|
| 8 |
Status of this Memo |
| 9 |
|
| 10 |
This memo defines an Experimental Protocol for the Internet |
| 11 |
community. This memo does not specify an Internet standard of any |
| 12 |
kind. Discussion and suggestions for improvement are requested. |
| 13 |
Distribution of this memo is unlimited. |
| 14 |
|
| 15 |
Abstract |
| 16 |
|
| 17 |
This document proposes new media sub-types of Text/SGML and |
| 18 |
Application/SGML. These media types can be used in the exchange of |
| 19 |
SGML documents and their entities. Specific details for the exchange |
| 20 |
or encapsulation of groups of related SGML entities using MIME are |
| 21 |
currently being considered by the mimesgml Working Group <sgml- |
| 22 |
[email protected]>. |
| 23 |
|
| 24 |
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span> |
| 25 |
|
| 26 |
A need exists for the transfer the elements of documents constructed |
| 27 |
using the Standard Generalized Markup Language (SGML) [<a href="#ref-ISO-8879">ISO-8879</a>]. |
| 28 |
While the specific details of such transfers are being considered |
| 29 |
general agreement exists on the need to register basic media types |
| 30 |
for the SGML entities not covered by existing types. |
| 31 |
|
| 32 |
The Standard Generalized Markup Language (SGML) is used to encode |
| 33 |
document structure and a rigorous description of it is left to [ISO- |
| 34 |
8879]. The terms used in the present document attempt to be |
| 35 |
consistent with SGML terminology and usage. |
| 36 |
|
| 37 |
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. The SGML Media-Types</span> |
| 38 |
|
| 39 |
There are two media-types for SGML parsable entities, Text/SGML and |
| 40 |
Application/SGML. Both have the same optional parameters. Text/SGML |
| 41 |
provides a fallback to Text/Plain for those without SGML capability. |
| 42 |
Senders should base the choice between text and application media- |
| 43 |
types on the entity's content. Text is suggested for entities that |
| 44 |
would be meaningful to a human being without SGML processing. |
| 45 |
Application/SGML is recommended for all others. |
| 46 |
|
| 47 |
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
<span class="grey">Levinson Experimental [Page 1]</span></pre> |
| 53 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span> |
| 54 |
<span class="grey"><a href="./rfc1874">RFC 1874</a> SGML Media Types December 1995</span> |
| 55 |
|
| 56 |
|
| 57 |
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Text/SGML</span> |
| 58 |
|
| 59 |
MIME type name: Text |
| 60 |
MIME subtype name: SGML |
| 61 |
Required parameters: none |
| 62 |
Optional parameters: charset, SGML-bctf, SGML-boot |
| 63 |
Encoding considerations: may be encoded |
| 64 |
Security considerations: see <a href="#section-4">section 4</a> below |
| 65 |
Published specification: ISO 8879:1986 |
| 66 |
Person and email address to contact for further information: |
| 67 |
E. Levinson <[email protected]> |
| 68 |
|
| 69 |
The Text/SGML media-type can be employed when the contents of the |
| 70 |
SGML entity is intended to be read by a human and is in a readily |
| 71 |
comprehensible form. That is the content can be easily discerned by |
| 72 |
someone without SGML display software. Each record in the SGML |
| 73 |
entity, delimited by record start (RS) and record end (RE) codes, |
| 74 |
must correspond to a line in the Text/SGML body part. |
| 75 |
|
| 76 |
SGML entities that do not meet the above requirements should use the |
| 77 |
Application/SGML media-type. |
| 78 |
|
| 79 |
See <a href="#section-2.3">section 2.3</a> for a description of the parameters. |
| 80 |
|
| 81 |
<span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. Application/SGML</span> |
| 82 |
|
| 83 |
MIME type name: Application |
| 84 |
MIME subtype name: SGML |
| 85 |
Required parameters: none |
| 86 |
Optional parameters: SGML-bctf, SGML-boot |
| 87 |
Encoding considerations: may be encoded |
| 88 |
Security considerations: see <a href="#section-4">section 4</a> below |
| 89 |
Published specification: ISO-8879 |
| 90 |
Person and email address to contact for further information: |
| 91 |
E. Levinson <[email protected]> |
| 92 |
|
| 93 |
Use the Application/SGML media-type for SGML text entities that are |
| 94 |
not appropriate for Text/SGML. When used, each record start (RS) and |
| 95 |
record end (RE) character shall be explicitly represented by the bit |
| 96 |
combination specified in the SGML declaration. |
| 97 |
|
| 98 |
The parameters are described in the next section. |
| 99 |
|
| 100 |
|
| 101 |
|
| 102 |
|
| 103 |
|
| 104 |
|
| 105 |
|
| 106 |
|
| 107 |
|
| 108 |
<span class="grey">Levinson Experimental [Page 2]</span></pre> |
| 109 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span> |
| 110 |
<span class="grey"><a href="./rfc1874">RFC 1874</a> SGML Media Types December 1995</span> |
| 111 |
|
| 112 |
|
| 113 |
<span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. SGML Sub-type Parameters</span> |
| 114 |
|
| 115 |
The parameters for the Text/ and Application/SGML subtypes are |
| 116 |
defined below. |
| 117 |
|
| 118 |
charset The charset parameter for Text/SGML is defined in |
| 119 |
[<a href="./rfc1521">RFC-1521</a>], the valid values and their meaning are |
| 120 |
registered by the Internet Assigned Numbers |
| 121 |
Authority (IANA) [<a href="./rfc1590">RFC-1590</a>]. The default charset |
| 122 |
value for all Text content-types is "us-ascii" |
| 123 |
[<a href="./rfc1521">RFC-1521</a>]. |
| 124 |
|
| 125 |
The charset parameter is provided to permit non- |
| 126 |
SGML capable systems to provide reasonable |
| 127 |
behavior when Text/SGML defaults to Text/Plain. |
| 128 |
SGML capable systems will use the SGML-bctf param- |
| 129 |
eter. |
| 130 |
|
| 131 |
SGML-bctf The SGML-bctf (SGML bit combination transformation |
| 132 |
format) parameter describes the method used to |
| 133 |
transform the entity's sequence of constant width |
| 134 |
binary numbers (called "bit combinations" in [ISO |
| 135 |
8879, 4.24]) into the octet stream contained in |
| 136 |
the MIME body part. |
| 137 |
|
| 138 |
Valid values for SGML-bctf are the BCTF notation |
| 139 |
names defined in Annex C of [<a href="#ref-ISO-10744">ISO-10744</a>] and are |
| 140 |
reproduced for convenience in the Appendix. The |
| 141 |
default value is "identity", i.e. perform no |
| 142 |
transformation. |
| 143 |
|
| 144 |
SGML-boot The SGML-boot parameter value is the content-ID of |
| 145 |
a MIME body part (Application/Octet-stream) that |
| 146 |
satisfies the requirements of the boot attribute |
| 147 |
in [<a href="#ref-ISO-10744">ISO-10744</a>]. The Appendix contains a summary |
| 148 |
of those requirements. The SGML-boot parameter is |
| 149 |
only applicable if the SGML entity is a document |
| 150 |
entity. |
| 151 |
|
| 152 |
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Security Considerations</span> |
| 153 |
|
| 154 |
SGML entities contain information to be parsed and processed by the |
| 155 |
recipient's SGML system. Those entities may contain and such systems |
| 156 |
may permit explicit system level commands to be execute while |
| 157 |
processing the data. To the extent that an SGML system will execute |
| 158 |
arbitrary command strings recipients of SGML entities may be at risk. |
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
<span class="grey">Levinson Experimental [Page 3]</span></pre> |
| 165 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span> |
| 166 |
<span class="grey"><a href="./rfc1874">RFC 1874</a> SGML Media Types December 1995</span> |
| 167 |
|
| 168 |
|
| 169 |
Parsable SGML entities may also contain explicit processing |
| 170 |
instructions for a presentation or composition system; use of such |
| 171 |
instructions present concerns similar to those of |
| 172 |
Application/PostScript. |
| 173 |
|
| 174 |
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. References</span> |
| 175 |
|
| 176 |
[<a id="ref-ISO-8879">ISO-8879</a>] |
| 177 |
Information processing -- 8-bit Single-Byte Coded Graphic |
| 178 |
Character Sets -- Part 1: Latin Alphabet No. 1, ISO |
| 179 |
8859-1:1987. |
| 180 |
|
| 181 |
[<a id="ref-ISO-8879">ISO-8879</a>] |
| 182 |
ISO 8879:1986, Information processing -- Text and office |
| 183 |
systems -- Standard Generalized Markup Language (SGML). |
| 184 |
|
| 185 |
[<a id="ref-ISO-10744">ISO-10744</a>] |
| 186 |
ISO/IEC 10744:1992, Information technology -- |
| 187 |
Hypermedia/Time-based Structuring Language (HyTime) (as |
| 188 |
modified by First Proposed Technical Corrigendum, ISO/IEC |
| 189 |
JTC1/SC18 N5027) |
| 190 |
|
| 191 |
[<a id="ref-RFC-1521">RFC-1521</a>] |
| 192 |
Borenstein, N., and N. Freed, "MIME (Multipurpose Internet |
| 193 |
Mail Extensions) Part One: Mechanisms for Specifying and |
| 194 |
Describing the Format of Internet Message Bodies", <a href="./rfc1521">RFC</a> |
| 195 |
<a href="./rfc1521">1521</a>, Bellcore, Innosoft, September 1993. |
| 196 |
|
| 197 |
[<a id="ref-RFC-1590">RFC-1590</a>] |
| 198 |
Postel, J., "Media Type Registration Procedure", <a href="./rfc1590">RFC 1590</a>, |
| 199 |
USC/Information Sciences Institute, March 1994. |
| 200 |
|
| 201 |
[<a id="ref-RFC-1642">RFC-1642</a>] |
| 202 |
Goldsmith, D., and M. Davis, "UTF-7, A Mail-Safe |
| 203 |
Transformation Format of UNICODE", <a href="./rfc1642">RFC 1642</a>, Taligent, |
| 204 |
Inc., July 1994. |
| 205 |
|
| 206 |
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Author's Address</span> |
| 207 |
|
| 208 |
Ed Levinson |
| 209 |
Accurate Information Systems, Inc. |
| 210 |
2 Industrial Way |
| 211 |
Eatontown, NJ 07724 |
| 212 |
|
| 213 |
EMail: [email protected] |
| 214 |
|
| 215 |
|
| 216 |
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
<span class="grey">Levinson Experimental [Page 4]</span></pre> |
| 221 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span> |
| 222 |
<span class="grey"><a href="./rfc1874">RFC 1874</a> SGML Media Types December 1995</span> |
| 223 |
|
| 224 |
|
| 225 |
APPENDIX |
| 226 |
|
| 227 |
ISO-10744 BCTF Values and Boot Attribute |
| 228 |
|
| 229 |
<span class="h3"><a class="selflink" id="appendix-A.1" href="#appendix-A.1">A.1</a>. Bit Combination Transformation Format (BCTF) Values</span> |
| 230 |
|
| 231 |
The following list of Bit Combination Transformation Format (BCTF) |
| 232 |
values is provided as a convenience. The authoritative source is |
| 233 |
[<a href="#ref-ISO-10744">ISO-10744</a>]. |
| 234 |
|
| 235 |
identity Each bit combination is represented by a single |
| 236 |
octet; this BCTF can be used only for entities all |
| 237 |
of whose bit combinations have a value not exceeding |
| 238 |
255. |
| 239 |
|
| 240 |
fixed-2 Each bit combination is represented by exactly 2 |
| 241 |
octets, with the more significant octet first; this |
| 242 |
BCTF can be used only for entities all of whose bit |
| 243 |
combinations have a value not exceeding 65535. |
| 244 |
|
| 245 |
fixed-3 Each bit combination is represented by exactly 3 |
| 246 |
octets, with a more significant octet preceding any |
| 247 |
less significant octets; this BCTF can be used only |
| 248 |
for entities all of whose bit combinations have a |
| 249 |
value not exceeding 16777215. |
| 250 |
|
| 251 |
fixed-4 Each bit combination is represented by exactly 4 |
| 252 |
octets, with a more significant octet preceding any |
| 253 |
less significant octets. |
| 254 |
|
| 255 |
utf-8 Each bit combination is represented by a variable |
| 256 |
number of octets according to UCS Transformation |
| 257 |
Format 8 defined in Annex P to be added by the first |
| 258 |
proposed drafted amendment (PDAM 1) to ISO/IEC |
| 259 |
10646-1:1993. |
| 260 |
|
| 261 |
utf-7 Each bit combination is represented by a variable |
| 262 |
number of octets in the range 0 through 127 as |
| 263 |
described in [<a href="./rfc1642">RFC-1642</a>]; this BCTF can be used only |
| 264 |
for entities all of whose bit combinations have a |
| 265 |
value not exceeding 65535. |
| 266 |
|
| 267 |
euc-jp Each bit combination is treated as a pair of octets, |
| 268 |
most significant octet first, encoding a character |
| 269 |
using the |
| 270 |
Extended_UNIX_Code_Fixed_Width_for_Japanese charset, |
| 271 |
and is transformed into the variable length sequence |
| 272 |
of octets that would encode that character using the |
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
<span class="grey">Levinson Experimental [Page 5]</span></pre> |
| 277 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span> |
| 278 |
<span class="grey"><a href="./rfc1874">RFC 1874</a> SGML Media Types December 1995</span> |
| 279 |
|
| 280 |
|
| 281 |
Extended_UNIX_Code_Packed_Format_for_Japanese char- |
| 282 |
set. |
| 283 |
|
| 284 |
sjis Each bit combination is treated as a pair of octets, |
| 285 |
most significant octet first, encoding a character |
| 286 |
using the |
| 287 |
Extended_UNIX_Code_Fixed_Width_for_Japanese charset, |
| 288 |
and is transformed into the variable length sequence |
| 289 |
of octets that would encode that character using the |
| 290 |
Shift_JIS charset. |
| 291 |
|
| 292 |
<span class="h3"><a class="selflink" id="appendix-A.2" href="#appendix-A.2">A.2</a>. The Boot Attribute</span> |
| 293 |
|
| 294 |
The body part specified by the SGML-boot parameter contains a |
| 295 |
sequence of triplets of positive integers separated by white space. |
| 296 |
The triplets correspond to the described character set portion [IS0- |
| 297 |
8879, 13.1.1.2] of the SGML declaration. SGML-boot provides the |
| 298 |
capability to identify the character set of the document's SGML |
| 299 |
declaration when it uses significant SGML characters [ibid., 4.298] |
| 300 |
in the SGML reference concrete syntax [ibid., 13.4] that have a |
| 301 |
character number [ibid., 4.44] in the document's character set that |
| 302 |
differs from us-ascii. The default value is "0 128 0", all |
| 303 |
characters are us-ascii. |
| 304 |
|
| 305 |
Notes: (1) The triplet, <dscn noc bscn> has the following meaning. |
| 306 |
Starting with character number dscn in the us-ascii character set, |
| 307 |
renumber noc characters starting at bscn and incrementing by one. |
| 308 |
Thus, 0 128 0, represents the identity mapping. (2) The document's |
| 309 |
declaration itself may also redefine the significant SGML characters; |
| 310 |
the boot attribute is intended to bootstrap the SGML system's parse |
| 311 |
of the declaration. |
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 |
|
| 319 |
|
| 320 |
|
| 321 |
|
| 322 |
|
| 323 |
|
| 324 |
|
| 325 |
|
| 326 |
|
| 327 |
|
| 328 |
|
| 329 |
|
| 330 |
|
| 331 |
|
| 332 |
Levinson Experimental [Page 6] |
| 333 |
</pre> |