From 868b96aef4d5f036e4e01d9e89b162ce0cb0ab49 Mon Sep 17 00:00:00 2001 From: Lou Quillio Date: Tue, 4 Oct 2011 15:11:43 -0700 Subject: [PATCH] More aggressive copy-edit; add TODO; validate HTML5 Change-Id: I45e7fde3eb33067274b5d454451f1bf8785511fd --- doc/README | 5 +- doc/TODO | 24 +++ doc/template.html | 4 +- doc/webp-container-spec.txt | 331 ++++++++++++++++++------------------ 4 files changed, 194 insertions(+), 170 deletions(-) create mode 100644 doc/TODO diff --git a/doc/README b/doc/README index 11a51c06..e6b14b08 100644 --- a/doc/README +++ b/doc/README @@ -9,6 +9,7 @@ automatically. [1]: http://kramdown.rubyforge.org/ [2]: http://rubygems.org/ -HTML generation can then be done from the project root, like so: +HTML generation can then be done from the project root: -$ kramdown doc/webp-container-spec.txt --template doc/template.html > doc/output/webp-container-spec.html +$ kramdown doc/webp-container-spec.txt --template doc/template.html > \ + doc/output/webp-container-spec.html diff --git a/doc/TODO b/doc/TODO new file mode 100644 index 00000000..f39df678 --- /dev/null +++ b/doc/TODO @@ -0,0 +1,24 @@ +, 20111004 + +* Determine that normative RFC 2119 terms (MUST, SHOULD, MAY, etc.) are + truly intended in all cases where capitalized. + +* Document hierarchy WRT headings has a flaw, in that topics related to + animated WebPs are discussed under subheads of "Single-image WebP + Files". + +* Several passages could be made clearer. + + * Overall edit for scope. Portions are phrased as an introduction to + the 0.1.3 RIFF container additions, rather than a holistic guide to + WebP. + + * To wit, suggest s/[spec|specification]/guide/g . "Spec" can imply a + standards track; in any case it's too formal for a work in progress. + + * Sections and passages re "multi-image" should likely be suppressed + until multi-image drops. + + * Improve the term "Mux-Container". + + diff --git a/doc/template.html b/doc/template.html index acc54469..e8753115 100644 --- a/doc/template.html +++ b/doc/template.html @@ -1,5 +1,7 @@ - + + + WebP Container Specification