Representing phonetics for Japanese names in Atom feeds
draft-murata-atom-phonetics-03

Abstract

This specification introduces an attribute for representing Japanese phonetics within feeds of the Atom Syndication Format [RFC4287]. Such phonetics MAY be attached to author names and article titles. This attribute is applicable to OPDS(Open Publication Distribution System)[OPDS], which is based on Atom.

Status of This Memo

This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."

This Internet-Draft will expire on September 02, 2013.

Copyright Notice

Copyright (c) 2013 IETF Trust and the persons identified as the document authors. All rights reserved.

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.

1. Introduction

The Japanese language uses kanji (CJK ideographic characters) and kana(Japanese phonetic characters). A human name or article title is often represented by two strings: one with kanji and another without kanji. The latter is used to unambiguously specify the phonetics of the human name or article title. More about this issue, see [Miyazawa].

The Atom Syndication Format [RFC4287] does not provide mechanisms for representing a name in more than one language or script. As a solution specialized to Japanese phonetics, this specification introduces an attribute for representing the phonetics for a Japanese author name or article title. This attribute is applicable to OPDS(Open Publication Distribution System)[OPDS], which is based on Atom.

2. The phonetics attribute

• Namespace: http://www.jepa.or.jp/xmlns/atomPhonetics/1.0
• Local name: phonetics
• Parent element: atom:name, atom:title, and atom:subTitle
• Cardinality: 0 or 1
• Permissible values: Strings in the Japanese language without CJK ideographic characters. Such strings typically consists of Katakana or Hiragana characters but may include digits, symbols and Latin alphabets. [NDL] gives one way to create the phonetics of a given name and shows commonly used characters for phonetics.

2.1. Example

<feed 
     xmlns="http://www.w3.org/2005/Atom"
     xmlns:jepa="http://www.jepa.or.jp/xmlns/atomPhonetics/1.0">
  <title 
       jepa:phonetics="XML&#x30cb;&#x30e5;&#x30a6;&#x30e2;&#x30f3;"
                           >XML&#x5165;&#x9580;
  </title>
  <author>
      <name jepa:phonetics="&#x30e0;&#x30e9;&#x30bf;"
                      >&#x6751;&#x7530;</name>
  </author>
   ...
</feed>
                

"ニュウモン" and "ムラタ" are Katakana strings, while "入門" and "村田" are CJK ideographic character strings.

3. RELAX NG schema

The original schema (atom.rnc) allows any foreign attribute, and is thus usable for validating feeds containing the attribute for Japanese phonetics. However, the following schema is provided as an extension of the original schema for explicitly allowing the phonetics attribute for name, title, and subtitle elements and no other elements. Instead of the original schema, this schema MAY be used for validating atom feeds having phonetics.

namespace atom = "http://www.w3.org/2005/Atom"
namespace jepa = "http://www.jepa.or.jp/xmlns/atomPhonetics/1.0" 
namespace local = "" 
include "atom.rnc" { 
    undefinedAttribute = 
        attribute * - (xml:base | xml:lang | local:* | jepa:*) { text }
    atomPersonConstruct =
        atomCommonAttributes,
        (element atom:name {attribute jepa:phonetics {text }?, text }
          & element atom:uri { atomUri }?
          & element atom:email { atomEmailAddress }?
          & extensionElement*)
    atomTitle = 
        element atom:title
              {attribute jepa:phonetics { text }?, atomTextConstruct }
    atomSubtitle =
        element atom:subtitle
              {attribute jepa:phonetics {text }?, atomTextConstruct }
} 

4. Schematron schema

This additional schema is provided for explicitly allowing the phonetics attribute for name, title, and subtitle elements and no other elements. This schema MAY be used for validating atom feeds having phonetics. It MAY be used together with the original schema (atom.rnc) or schemas for OPDS.

<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://purl.oclc.org/dsdl/schematron"
    xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns:jepa="http://www.jepa.or.jp/xmlns/atomPhonetics/1.0">
    <ns prefix="atom" uri="http://www.w3.org/2005/Atom"/>
    <ns prefix="jepa" 
        uri="http://www.jepa.or.jp/xmlns/atomPhonetics/1.0"/>
    <pattern >
        <rule context="atom:*[@jepa:phonetics]">
            <let name="ln" value="local-name()"/>
            <assert test="($ln='name') 
                           or ($ln='title') 
                           or ($ln = 'subTitle') "
                >The jepa:phonetics attribute is allowed only   
                 for atom:name, atom:title, and atom:subTitle 
                 elements.</assert>
        </rule>
    </pattern>
</schema>
                    
                

5. Security Considerations

There are no new issues beyond those shown in [RFC4287].

6. References

6.1. Normative References

6.2. Informative References

Appendix A. Acknowldgements

The author is grateful to Hiroshi Hoshi, Ando Kazuhiro, Akira Miyazawa, Akimoto Ryoji, Masayoshi Takahashi, Hiroshi Takase, and Toshiyuki Takashima for their feedbacks.

Author's Address

Table of Contents

• 1. Introduction
• 2. The phonetics attribute
• 2.1. Example
• 3. RELAX NG schema
• 4. Schematron schema
• 5. Security Considerations
• 6. References
• 6.1. Normative References
• 6.2. Informative References
• Appendix A. Acknowldgements
• Author's Address