W3C home > Mailing lists > Public > public-dap-commits@w3.org > July 2011

2009/dap/ReSpec.js documentation.html,1.52,1.53

From: Frederick Hirsch via cvs-syncmail <cvsmail@w3.org>
Date: Thu, 14 Jul 2011 15:56:43 +0000
To: public-dap-commits@w3.org
Message-Id: <E1QhOHL-00079e-EB@lionel-hutz.w3.org>
Update of /sources/public/2009/dap/ReSpec.js
In directory hutz:/tmp/cvs-serv27453

Modified Files:
	documentation.html 
Log Message:
revision of best practices processing to (1) autodetect likely need for best practices processing, (2) generate summary of best practices if section with class id bp-summary is present

Index: documentation.html
===================================================================
RCS file: /sources/public/2009/dap/ReSpec.js/documentation.html,v
retrieving revision 1.52
retrieving revision 1.53
diff -u -d -r1.52 -r1.53
--- documentation.html	15 Feb 2011 19:48:01 -0000	1.52
+++ documentation.html	14 Jul 2011 15:56:41 -0000	1.53
@@ -189,28 +189,7 @@
 The class signals that this will be replaced with a link containing
   the section number and title as follows:
 <pre>&lt;a href="#general-structure" class="sectionRef"&gt;section Section-Number Section-Title&lt;/a&gt;</pre>
-This results in a link such as the following <a href="#general-structure"
-  class="sectionRef" /> for this document, in this example.
 </p>
-<p>Best practices may be shown, numbered and formatted using the
-  following formatting:
-  <pre>
-  &lt;pre class='example'&gt;
-    &lt;div class="practice"&gt;
-      &lt;p&gt;&lt;a name="sample-practice" id="sample-practice"&gt;&lt;/a&gt;
-        &lt;span class="practicelab"&gt;Summary of the practice &lt;/span&gt;&lt;/p&gt;
-      &lt;p class="practicedesc"&gt;
-        More detailed decription of the practice.          
-      &lt;/p&gt;
-    &lt;/div&gt;
-  </pre>
-    <div class="practice">
-      <p><a id="sample-practice"></a>
-        <span class="practicelab">Summary of the practice </span></p>
-      <p class="practicedesc">
-        More detailed decription of the practice.          
-      </p>
-    </div>
     </section>
     <section>
       <h2>Configuration</h2>
@@ -602,7 +581,7 @@
         <code>href</code> is still to be used, but with a <code>class</code> set to "externalDFN".
       </p>
     </section>
-    
+
     <section>
       <h2>References</h2>
       <p>
@@ -657,6 +636,36 @@
     </section>
 
     <section>
+      <h2>Best Practice Documents</h2>
+      <p>
+<p>Best practices may be shown, numbered and formatted using the
+  following formatting:
+  <pre class='example'>
+    &lt;div class="practice"&gt;
+      &lt;p&gt;
+        &lt;span id="sample-practice" class="practicelab"&gt;Title of the practice&lt;/span&gt;&lt;/p&gt;
+      &lt;p class="practicedesc"&gt;
+        More detailed decription of the practice.          
+      &lt;/p&gt;
+    &lt;/div&gt;
+  </pre>
+    <div class="practice">
+      <p>
+        <span id="sample-practice" class="practicelab">Title of the practice</span></p>
+      <p class="practicedesc">
+        More detailed decription of the practice.          
+      </p>
+    </div>
+<p>If a <code>section</code> element with <code>id</code> "bp-summary" is
+  present, then a summary 
+  list of best practices will be placed in it, linked to the best
+  practices that have an id on the <code>span</code> element.</p>
+<pre class="example">
+  &lt;section id='bp-summary'&gt;&lt;/section&gt;
+</pre>
+</section>
+
+    <section>
       <h2>Including other data</h2>
       <p>
         Sometimes a specification will need to incorporate data that is best kept in
@@ -983,6 +992,11 @@
           <li>2011-01-07 - added same document references (fjh)</li>
           <li>2011-02-15 - added addPatentNote, update sotd language
           for CR to state exit not earlier than (fjh)</li>
+          <li>2011-07-14 - revised and moved best practice material to
+          new section. Updated code to auto check for best
+          practices processing and to generate best practice summary
+          if section with class id bp-summary present. Clean up
+          section ref documentation.  (fjh).</li>
       </ul>
     </section>
     
Received on Thursday, 14 July 2011 15:56:44 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Thursday, 14 July 2011 15:56:52 GMT