rfc-4735

Example Media Types for Use in Documentation

T. Taylor
date2006-10 streamIETF wgnon working group statusPROPOSED STANDARD pages6 canonicalhttps://www.rfc-editor.org/rfc/rfc4735 doi10.17487/RFC4735
This document is registration for the 'example' media type and 'example' subtypes within the standards tree. The 'example/*' and '*/example' media types are defined for documentation purposes only. [STANDARDS-TRACK]

Extracted elements (10)

design-rationale §1

The 'example' media types are defined to provide a clearly illustrative placeholder in documentation and examples, avoiding the worst-case scenario where implementors mistake an example media type for a real protocol requirement.

process

interoperability-note §3

Any attempt to negotiate or send the 'example' media type or any 'example' media subtype is bound to lead to interoperability problems.

normative-requirement §3 MUST NOT

IANA MUST NOT register any subtypes for the 'example' top-level media type.

registry

normative-requirement §4 MUST NOT

The 'example' media subtypes (application/example, audio/example, etc.) MUST NOT be implemented. Their appearance in real code could lead to unpredictable results and therefore open up security holes.

security

normative-requirement §3 MUST NOT

The 'example' media type MUST NOT be implemented. Its appearance in real code could lead to unpredictable results and therefore open up security holes.

security

protocol-element §4

Eight 'example' subtypes are registered under standard top-level types: application/example, audio/example, image/example, message/example, model/example, multipart/example, text/example, and video/example, all for documentation use only.

protocol-element §3

The 'example' top-level media type is registered for documentation purposes; any subtype name may be used with it, and required/optional parameters and encoding considerations are defined by the user as needed.

registry §4

IANA registers 'example' as a subtype within the 'application', 'audio', 'image', 'message', 'model', 'multipart', 'text', and 'video' media type trees, all intended for documentation use only.

registry

registry §3

IANA registers the 'example' top-level media type. IANA MUST NOT register any subtypes for the 'example' media type; subtypes may be freely invented by users for documentation purposes.

registry

security-consideration §5

The 'example' media type and subtypes are defined for documentation only and MUST NOT be implemented. Any attempt to implement them in real code could lead to unpredictable results and potentially open security holes.

security