読者です 読者をやめる 読者になる 読者になる

kagamihogeの日記

kagamihogeの日記です。

JEP 224: HTML5 Javadocをテキトーに訳した

http://openjdk.java.net/jeps/224 をテキトーに訳した。

JEP 224: HTML5 Javadoc

Owner    Bhavesh Patel
Created 2014/06/05 20:00
Updated 2014/11/14 15:34
Type    Feature
Status  Targeted
Component   tools / javadoc(tool)
Scope   JDK
Discussion  javadoc dash dev at openjdk dot java dot net
Effort  M
Duration    M
Priority    2
Reviewed by Jonathan Gibbons
Endorsed by Brian Goetz
Release 9
Issue   8046068
Depends 8064826: Phase 3: Update the generated markup to be HTML5 accessibility compliant
8064827: Phase 4: Update DocLint to validate HTML5
8055729: Phase 1: Update the current generated markup to be HTML5 compliant
8059892: Phase 2: Update the generated markup to use new HTML5 tags.

Summary

HTML5*1マークアップを生成出来るようにjavadocツールを機能拡張します。

Goals

出力をHTML 4かHTML5のどちらかを設定出来るようなjavadocのオプションを提供します。HTML5マークアップはセマンティックにすべきで、言い換えると、スタイルおよびコンテンツと意味を明確に分離するということです。HTML5マークアップを使用して生成されるページはアクセシビリティ要求を満たすべきです。

Non-Goals

現在のバージョンで生成される三フレームのHTMLページを置き換えることは目的ではありません。将来的に別のJEPで置き換えを行うかもしれません。

Motivation

現在javadocツールは古い標準であるHTML 4.01のページを生成します。HTML5はHTMLの最新版です。HTML5はwebページのセマンティックな値を増加させ*2、アクセスしやすいwebページの生成が容易になります。

Description

  • 出力するマークアップを指定するためのコマンドラインオプションをjavadocに追加します。現行のHTML 4がデフォルト出力です。将来のJDKリリース時にHTML5をデフォルトにします。
  • 生成されるHTMLのセマンティックな値はheader, footer, navなどのHTML5構造要素を使用することで改善を行います。
  • HTML5マークアップアクセシビリティを満たすためにWAI-ARIA standardを実装します。role属性を使用してHTMLドキュメントの要素に役割(role)を割り当てます。
  • 指定したマークアップに基づいて入力コメントを検証するように-Xdoclint機能を修正します。

Testing

テストは以下の事項を確認する必要があります。

自動化されたアクセシビリティテストツールの不足が包括的なテストのネックとなる可能性があります。

*1:原文の http://www.w3.org/TR/2014/html5/ はリンク切れしたいのでこちらにした。

*2:increases the semantic value of web pagesが原文。もうちょっと良い日本語はあるかと思うが……