tweaking readmes

chaals · chaals · commit bd03d515ac5b · 2013-09-27T09:49:12.000+02:00
Added pointer to test results, tried to clarify the different kinds of
"other" tests.
diff --git a/README-offline.html b/README-offline.html
@@ -3,16 +3,29 @@
   <head>
     <meta charset="utf-8">
     <title>longdesc-tests</title>
+    <style>nav ul, nav li { display:inline} </style>
   </head>
   <body>
 <h1>Longdesc tests</h1>
     <p>Some tests proposed by Charles McCathie Nevile for the <a href="http://www.w3.org/TR/html-longdesc">HTML Image Description Extension</a> specification. All tests are ©chaals, and are made available under the terms of the <a href="http://www.w3.org/Consortium/Legal/copyright-software">W3C software license</a>.</p>
-
+<nav>
+  <ul>
+    <li><a href="#mult">Multifunction tests</a></li>
+    <li><a href="#auto">Automated browser tests</a></li>
+    <li><a href="#valid">Validation/Repair Tool tests</a></li>
+    <li><a href="#results">Test Results</a></li>
+    <li><a href="#support">About the supporting files</a></li>
+  </ul>
+</nav>
 <h2>Multifunction tests</h2>
 
 <p>There are tests for descriptions under different combinations of circumstances - images included "normally", as data: URIs, or missing, with the descriptions internal or external to the page, as a data: URI, or in a location only reachable by taking into account the base element</p>
 
-<p>The same tests can be used to determine whether in various scenarios the User Agent enables the user to access the description, and whether the description can be found through system accessibility APIs.</p>
+<p>The same tests can be used to determine whether </p>
+<ul>
+  <li>the User Agent informs the user that there is a description;</li>
+  <li>the User Agent enables the user to access the description; and</li>
+  <li>the description is communicated through system accessibility APIs.</li></ul>
 
 <h3>Longdesc value as data:URI</h3>
 
@@ -56,14 +69,20 @@ <h3>Longdesc value as external URI in presence of a <code>base</code> element</h
 <h3>longdesc inside an iframe</h3>
 <p>The test <a href="iframe-discoverability.html">Image in an iframe with External Description</a> loads an an image with a long description from a separate document using an <code>iframe</code>. To pass, the tester must be able to access the "Longdesc test Pass Page" which consists of the word "Pass" in a heading level 1 followed by a long description of the image.</p>
 
-<h2>Other tests</h2>
+<h2>Automated browser tests</h2>
 
 <p><a href="reflected-changing-longdesc.html">Longdesc value updated by javascript</a> tests whether the HTML attribute reflects changes made by javascript. To pass, the browser must be redirected to <a href="pass.html">pass.html</a> which has the word "Pass" as a heading followed by a description of the image.  Displaying the "Longdesc test Fail Page" would indicate a failure of this test. This test requires javascript to function.</p>
 
+<h2>Validation tool tests</h2>
+
 <p>The test <a href="invalid-longdescription.html">Invalid long description (plain text)</a> contains an invalid long description and can be used to test User Agent and validation tool handling. <strong>Note</strong> Handling of invalid longdescs by user agents is currently undefined.</p>
 <p>The test <a href="empty-longdesc.html">Invalid long description (empty attribute)</a> contains an invalid long description and can be used to test User Agent and validation tool handling. <strong>Note</strong> Handling of invalid longdescs by user agents is currently undefined.</p>
 <p>The test <a href="fail-fragment-pointer.html">Invalid long description fragment (the target is an empty element)</a> contains a pointer to <a href="fail-fragment-pointer.html">an invalidly marked long description as a fragment of a document</a> and can be used to test validation tool handling.</p>
 
+<h2>Results</h2>
+
+Preliminary <a href="test-results.html">test results</a> are available for a handful of platforms. Further results are very welcome!
+
 <h2>Supporting files</h2>
 
 <p>The following files are used to make one or more of the tests work:</p>
diff --git a/README.md b/README.md
@@ -49,14 +49,20 @@ The same tests are used to provide 3 results:
 
 * [Image in an `<iframe>` with External Description](https://rawgithub.com/chaals/longdesc-tests/master/iframe-discoverability.html) 
 
-## Other tests
+## Automated tests
 
 [Longdesc value updated by javascript](https://rawgithub.com/chaals/longdesc-tests/master/reflected-changing-longdesc.html) tests that the HTML attribute reflects changes made by javascript. To pass, the browser must redirect to the "Longdesc test Pass Page" which has the word "Pass" as a heading, followed by a description of the image.  Displaying the "Longdesc test Fail Page" would indicate a failure of this test. 
 
+## Validation / Repair tool tests
+
 [Invalid long description (plain text)](https://rawgithub.com/chaals/longdesc-tests/master/invalid-longdesc.html) contains an invalid long description (plain text) and can be used to test User Agent and validation tool handling. *NOTE: Handling of invalid longdescs by user agents is currently undefined.*
 [Invalid long description (empty attribute)](https://rawgithub.com/chaals/longdesc-tests/master/empty-longdesc.html) contains an invalid long description (plain text) and can be used to test User Agent and validation tool handling. *NOTE: Handling of invalid longdescs by user agents is currently undefined.*
 [Pointer to an invalid long description (not contained in a well-formed fragment)](https://rawgithub.com/chaals/longdesc-tests/master/fail-fragment-pointer.html) points to a long description in a [page fragment whose target is an empty element](https://rawgithub.com/chaals/longdesc-tests/master/fail-fragment-pointer.html). Validation tools should at least generate a warning, since an empty element is almost certainly not an adequate description, and is likely instead to reflect not passing the relevant authoring requirement.
 
+## Test results
+
+Preliminary [test results](https://rawgithub.com/chaals/longdesc-tests/master/test-results.html) are available for some platforms. More results are welcome.
+
 ## Supporting files
 
 The following files are required to make one or more of the tests work:
