2009/dap/ReSpec.js documentation.html,1.56,1.57

Update of /sources/public/2009/dap/ReSpec.js
In directory hutz:/tmp/cvs-serv11823/ReSpec.js

Modified Files:
	documentation.html 
Log Message:
scaring people away from v3

Index: documentation.html
===================================================================
RCS file: /sources/public/2009/dap/ReSpec.js/documentation.html,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -d -r1.56 -r1.57
--- documentation.html	22 May 2012 15:36:13 -0000	1.56
+++ documentation.html	7 Aug 2012 14:19:43 -0000	1.57
@@ -46,6 +46,31 @@
       </p>
     </section>
     
+    <section>
+      <h2>A Word of Warning</h2>
+      <p>
+        The documentation you are reading here is the documentation that was written for ReSpec v1. The
+        current release of ReSpec as of this writing is v3.1. That may sound worrying, but it really isn't,
+        for the following reasons:
+      </p>
+      <ul>
+        <li>
+          If you're still on v1, unless you've done something weird or bad, you should have 
+          completely smooth compatibility when upgrading. You really should upgrade though as v1 is no longer
+          supported at all and v3 is a lot better.
+        </li>
+        <li>
+          This means that the documentation here is still accurate. It's just incomplete. But given that I
+          haven't released new documentation yet (though I will) you can stick to reading this guide.
+        </li>
+      </ul>
+      <p>
+        You can upgrade <em>now</em> by replacing whichever way you're referencing ReSpec with:
+        <code>&lt;script src='http://www.w3.org/Tools/respec/respec-w3c-common' class='remove' async>&lt;/script></code>.
+        If in doing so you bump into problems, I really need to look at your spec. So please email me!
+      </p>
+    </section>
+    
     <section class='informative'>
       <h2>Introduction</h2>
       <p>
@@ -325,6 +350,8 @@
         <dd>Specifies the optional URI to the implementation report for the specification.  This is normally only used during the Proposed Recommendation phase of publication.</dd>
         <dt>extraCSS</dt>
         <dd>
+          <strong>This configuration parameter is now deprecated and you should avoid using it. In ReSpec v3 it's
+          a noop.</strong>
           This is an array that contains URI references (that may be absolute or relative) to additional
           CSS style sheets that you may wish to be loaded into the document. It is RECOMMENDED that you
           include <code>http://dev.w3.org/2009/dap/ReSpec.js/css/respec.css</code> as one of those, though

Received on Tuesday, 7 August 2012 14:19:49 UTC