W3C home > Mailing lists > Public > public-dap-commits@w3.org > December 2009

2009/dap/ReSpec.js documentation.html,1.30,1.31

From: Frederick Hirsch via cvs-syncmail <cvsmail@w3.org>
Date: Wed, 23 Dec 2009 21:05:47 +0000
To: public-dap-commits@w3.org
Message-Id: <E1NNYOx-0000Y2-FJ@lionel-hutz.w3.org>
Update of /sources/public/2009/dap/ReSpec.js
In directory hutz:/tmp/cvs-serv2059

Modified Files:
	documentation.html 
Log Message:
added refNote to allow paragraph at start of references section, resolving issue-61

Index: documentation.html
===================================================================
RCS file: /sources/public/2009/dap/ReSpec.js/documentation.html,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -d -r1.30 -r1.31
--- documentation.html	4 Dec 2009 21:43:35 -0000	1.30
+++ documentation.html	23 Dec 2009 21:05:45 -0000	1.31
@@ -360,6 +360,26 @@
           Historically, IDL parameters have all started with "in", as inherited from OMG IDL. In WebIDL
           this is optional, and this option turns it off for the entire document.
         </dd>
+        <dt>refNote</dt>
+        <dd>
+          <p>If the <code>refNote</code> parameter is defined, the
+          text contained within it is 
+          provided as a paragraph in the References section, before
+          the normative and informative reference sub-sections. If
+          not defined then no paragraph is included.
+            </p><p>
+            This
+          may be used to provide a note regarding use of subsequent revisions
+          of references for example:
+      <pre class='example sh_html'>
+respecConfig.refNote = "Dated references below are to the latest known \
+or appropriate edition of the referenced work.  The referenced works \
+may be subject to revision, and conformant implementations may follow, \
+and are encouraged to investigate the appropriateness of following, \
+some or all more recent editions or replacements of the works \
+cited. It is in each case implementation-defined which  editions are \
+supported."; 
+</pre></dd>
         <dt>wg</dt>
         <dd>
           The full and official name of the group (WG, IG, CG, XG, TF, etc.) in charge of this document.
@@ -387,7 +407,7 @@
           </p>
         </dd>
       </dl>
-    </section>
+      </section>
     
     <section>
       <h2>Table of Contents &amp; Numbering</h2>
@@ -491,6 +511,9 @@
         same syntax but with a "!" in front of the code: <code>[<!---->[!CODE]]</code>. This will produce
         a result like the following: [[!ELEMENTTRAVERSAL]].
       </p>
+<p>If the <code>refNote</code> parameter is defined then a paragraph will be
+  created in the References section with the content of that
+  parameter, as noted in the Configuration section.
     </section>
     
     <section>
@@ -725,7 +748,7 @@
           added support for implements (NEEDS DOCUMENTING).
         </li>
         <li>
-          2009-11-30 - support for authors was added. maxTocLevel support added.
+          2009-11-30 - support for authors was added (fjh). maxTocLevel support added.
         </li>
         <li>
           2009-12-03 - support for optional, arrays, nullable, noIDLIn, and many bugfixes.
@@ -735,7 +758,11 @@
           documentation to avoid replication. Added support for
           optional email address, and optional note following person
           description. Added optional prevRecShortname to support for
-          &quot;Latest Recommendation:&quot; header.
+          &quot;Latest Recommendation:&quot; header. (fjh)
+        </li>
+        <li>
+          2009-12-23 - added refNote, to enable text in references
+          section. (fjh)
         </li>
       </ul>
     </section>
Received on Wednesday, 23 December 2009 21:05:49 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Wednesday, 23 December 2009 21:05:50 GMT