[media-types] The styling of media types in IETF specifications

Sean Leonard <dev+ietf@seantek.com> Thu, 09 June 2016 15:31 UTC

Return-Path: <dev+ietf@seantek.com>
X-Original-To: media-types@ietfa.amsl.com
Delivered-To: media-types@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 3A6E112D11C for <media-types@ietfa.amsl.com>; Thu, 9 Jun 2016 08:31:37 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.901
X-Spam-Level:
X-Spam-Status: No, score=-1.901 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_PASS=-0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id kM3ZsN4XHEl1 for <media-types@ietfa.amsl.com>; Thu, 9 Jun 2016 08:31:36 -0700 (PDT)
Received: from pechora3.lax.icann.org (pechora3.icann.org [IPv6:2620:0:2d0:201::1:73]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 02B4B12B009 for <media-types@ietf.org>; Thu, 9 Jun 2016 08:31:34 -0700 (PDT)
Received: from fallback-in2.mxes.net (fallback-out2.mxes.net [216.86.168.191]) by pechora3.lax.icann.org (8.13.8/8.13.8) with ESMTP id u59FVEkd012566 (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NO) for <media-types@iana.org>; Thu, 9 Jun 2016 15:31:34 GMT
Received: from mxout-08.mxes.net (mxout-08.mxes.net [216.86.168.183]) by fallback-in2.mxes.net (Postfix) with ESMTP id 0A6172FDC2B for <media-types@iana.org>; Thu, 9 Jun 2016 11:31:13 -0400 (EDT)
Received: from [192.168.123.7] (unknown [75.83.2.34]) (using TLSv1.2 with cipher DHE-RSA-AES128-SHA (128/128 bits)) (No client certificate requested) by smtp.mxes.net (Postfix) with ESMTPSA id E0112509B6; Thu, 9 Jun 2016 11:30:31 -0400 (EDT)
To: "media-types@iana.org" <media-types@iana.org>
From: Sean Leonard <dev+ietf@seantek.com>
Message-ID: <46fc6302-ad89-a185-330d-d7ef8318740c@seantek.com>
Date: Thu, 09 Jun 2016 08:31:00 -0700
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Thunderbird/45.1.1
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Transfer-Encoding: quoted-printable
X-Greylist: IP, sender and recipient auto-whitelisted, not delayed by milter-greylist-4.0 (pechora3.lax.icann.org [192.0.33.73]); Thu, 09 Jun 2016 15:31:34 +0000 (UTC)
Archived-At: <https://mailarchive.ietf.org/arch/msg/media-types/Xz66pdGpwfyF7MxyfI9ASzqe1VI>
Cc: Julian Reschke <julian.reschke@greenbytes.de>, RFC Editor <rfc-editor@rfc-editor.org>
Subject: [media-types] The styling of media types in IETF specifications
X-BeenThere: media-types@ietf.org
X-Mailman-Version: 2.1.17
Precedence: list
List-Id: "IANA mailing list for reviewing Media Type \(MIME Type, Content Type\) registration requests." <media-types.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/media-types>, <mailto:media-types-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/media-types/>
List-Post: <mailto:media-types@ietf.org>
List-Help: <mailto:media-types-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/media-types>, <mailto:media-types-request@ietf.org?subject=subscribe>
X-List-Received-Date: Thu, 09 Jun 2016 15:31:37 -0000

  During the publication of draft-seantek-windows-image-03 (soon to be 
RFC 7903), the RFC Editor questioned:

> 2) We note that the names of the media types being registered
> sometimes appear without quotation marks (e.g., image/x-wmf) and a
> couple of times appear enclosed in double quotation marks (e.g.,
> "image/x-wmf"). Should the usage be consistent?

I checked RFC 6838, and RFC 6838 is itself inconsistent between quoting 
and unquoting media types.

How shall media types in IETF specifications be stylized in plain text, 
and in xml2rfc? Specifically: shall they be quoted "application/pdf", or 
unquoted application/pdf? In xml2rfc, shall they be quoted or unquoted, 
shall the quotes be curly quotes or straight quotes, and shall the text 
be in <tt> elements or plain?

My 2¢:

When referring to the media type as a string in a protocol element, in 
plain text "application/pdf" is correct (possibly with other elements, 
e.g., "text/plain; charset=ISO-8859-1". In xml2rfc, the same situations 
should be covered by <tt>application/pdf</tt> (no quotes).

When referring to the media type as a prose statement of the contents or 
using the media type for its semantics, do not use quotes and do not 
encase in <tt>. Examples:

   An application that renders application/pdf data needs to put it in a 
window with scroll bars.

   When a generator generates text/html, it SHOULD balance the tags.

Basically the use of the media type can be substituted by a prose and 
possibly more unwieldy description, such as:

   An application that renders PDFs needs to put it in a window with 
scroll bars.

   When a generator generates HTML documents, it SHOULD balance the tags.


Thank you,

Sean