[apps-discuss] apps-review comments for draft-lundberg-app-tei-xml-03

Eran Hammer-Lahav <eran@hueniverse.com> Tue, 28 September 2010 20:45 UTC

From: Eran Hammer-Lahav <eran@hueniverse.com>
To: "apps-discuss@ietf.org" <apps-discuss@ietf.org>, "iesg@ietf.org" <iesg@ietf.org>
Date: Tue, 28 Sep 2010 13:45:38 -0700
Thread-Topic: apps-review comments for draft-lundberg-app-tei-xml-03
Thread-Index: ActfR78A919if47BTaiNVGH8hZ1m3Q==
Message-ID: <90C41DD21FB7C64BB94121FBBC2E72343D460DB7CB@P3PW5EX1MB01.EX1.SECURESERVER.NET>
Accept-Language: en-US
Content-Language: en-US
acceptlanguage: en-US
Content-Type: multipart/alternative; boundary="_000_90C41DD21FB7C64BB94121FBBC2E72343D460DB7CBP3PW5EX1MB01E_"
MIME-Version: 1.0
Cc: "laurent.romary@inria.fr" <laurent.romary@inria.fr>, "slu@kb.dk" <slu@kb.dk>
Subject: [apps-discuss] apps-review comments for draft-lundberg-app-tei-xml-03
Precedence: list

I have been selected as the Applications Area Review Team reviewer for this draft (for background on apps-review, please see http://www.apps.ietf.org/content/applications-area-review-team).

Please resolve these comments along with any other Last Call comments you may receive. Please wait for direction from your document shepherd or AD before posting a new version of the draft.

Document: draft-lundberg-app-tei-xml-03

Reviewer: Eran Hammer-Lahav

Review Date: September 28, 2010

IETF Last Call Date: September 2-30, 2010

IESG Telechat Date: Unknown

Summary: This draft is almost ready for publication as a Standards Track RFC. The technical material is straight forward, but has a few minor document-level issues and numerous grammatical/editorial nits that should be reviewed before publication.

MAJOR ISSUES: None.

MINOR ISSUES:

- Section 2

* 'Published specification' should point to this draft, not the [TEI] specification.

* Interoperability considerations should be none, and the '.xml' comment moved to 'file extensions'.

* 'Security considerations' should refer to [[this specification]], and the comment about 'the security issues of [RFC3986], section 7' moved to the Security Consideration section. Also add "In addition, as this media type uses the "+xml" convention, it shares the same security considerations as described in RFC 3023 [RFC3023], section 10.".

- Section 3

* The examples should be XML snippets of actual TEI documents, not just rephrasing of the previous paragraph.

- Section 5.2

* I don't understand why this text is needed or why it is part of the security consideration section. If the authors insist on including it, I suggest moving it to an appendix and changing the title to something like 'TEI Document Content Intellectual Property Rights' to make it clear this is not about this specification or TEI, but the actual documents.

NITS:

- Section 1

* "The TEI is" reads funny. Should be "TEI is".

* "This document defines the 'application/tei+xml' media type in accordance with [RFC3023], in order to enable generic XML processing of TEI documents on the Internet."

- Section 2

* Move this section into a subsection of 'IANA Considerations' titled "application/tei+xml media type registration".

* Optional parameters: "charset": This parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in RFC 3023 [RFC3023]. [RFC3023].

* Encoding considerations: Identical to those of "application/xml" as described in RFC 3023 [RFC3023], section 3.2.

* Applications which use this media type: There are currently no applications using the media type 'application/tei+xml'.

- Section 3

* TEI files are XML documents or fragments with a root element in a TEI namespace. TEI namespace URIs start with 'http://www.tei-c.org/ns/', followed by the version number of the namespace. The current namespace is 'http://www.tei-c.org/ns/1.0'.

- Section 4

* "Documents having the media type 'application/tei+xml', use the fragment identifier notation as specified in [RFC3023] for the 'application/xml' media type.

Thanks,

EHL

[apps-discuss] apps-review comments for draft-lun… Eran Hammer-Lahav
[apps-discuss] Title of docs in apps-review comme… Manger, James H
Re: [apps-discuss] Title of docs in apps-review c… S Moonesamy
Re: [apps-discuss] Title of docs in apps-review c… David Harrington