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

2009/dap/ReSpec.js documentation.html,1.28,1.29

From: Frederick Hirsch via cvs-syncmail <cvsmail@w3.org>
Date: Fri, 04 Dec 2009 20:18:19 +0000
To: public-dap-commits@w3.org
Message-Id: <E1NGebb-0003d4-NJ@lionel-hutz.w3.org>
Update of /sources/public/2009/dap/ReSpec.js
In directory hutz:/tmp/cvs-serv13903

Modified Files:
	documentation.html 
Log Message:
Unified author and editor code and combined documentation to avoid replication. Added support for optional email address, and optional note following person description. 

Index: documentation.html
===================================================================
RCS file: /sources/public/2009/dap/ReSpec.js/documentation.html,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -d -r1.28 -r1.29
--- documentation.html	4 Dec 2009 18:01:58 -0000	1.28
+++ documentation.html	4 Dec 2009 20:18:17 -0000	1.29
@@ -291,65 +291,51 @@
                   The URL to the editor's affiliation's website.
                 </td>
               </tr>
-            </tbody>
-          </table>
-          <p>
-            At least one editor is required, and you can have as many as you want. They will be displayed
-            in the provided order. There are two conventions usually applied within W3C: by alphabetical
-            order of last name, or of first name — choose whichever applies to your WG. Sometimes one
-            editor who stands out as having contributed far more than most is placed first.
-          </p>
-        </dd>
-        <dt>authors</dt>
-        <dd>
-          <p>
-            An array describing authors that contains objects with the following fields:
-          </p>
-          <table class='simple'>
-            <thead>
-              <tr><th>key</th><th>optional</th><th>description</th></tr>
-            </thead>
-            <tbody>
               <tr>
-                <td>name</td>
-                <td>No</td>
-                <td>
-                  The name of the author.
-                </td>
-              </tr>
-              <tr>
-                <td>url</td>
-                <td>Yes</td>
-                <td>
-                  The URL to the author's website.
-                </td>
-              </tr>
-              <tr>
-                <td>company</td>
+                <td>mailto</td>
                 <td>Yes</td>
                 <td>
-                  The author's affiliation.
+                  The email address for the editor.
                 </td>
               </tr>
               <tr>
-                <td>companyURL</td>
+                <td>note</td>
                 <td>Yes</td>
-                <td>
-                  The URL to the author's affiliation's website.
+                <td>Additional note related to this editor, displayed
+                  as parenthetical after other 
+                  information.
                 </td>
               </tr>
             </tbody>
           </table>
           <p>
-            Use of authors is entirely optional,none are required. You
-            can have as many authors as you want. They will be displayed 
+            At least one editor is required, and you can have as many as you want. They will be displayed
             in the provided order. There are two conventions usually
             applied within W3C: by alphabetical 
             order of last name, or of first name — choose whichever
             applies to your WG. Sometimes one 
-            author who stands out as having contributed far more than
+            editor who stands out as having contributed far more than
             most is placed first. 
           </p>
+          <p>
+            A note may be used to display additional relevant
+            information, such as the specific release the editor
+            worked on, for example. This could be done by  setting
+            note to &quot;2nd Edition&quot;, for example: 
+                  <dl><dt>Mr Example, Foo Company ( 2nd Edition )</dt></dl>
+          </p>
+        </dd>
+        <dt>authors</dt>
+        <dd>
+          <p>
+            An array describing authors that contains objects with
+            fields for each author. The format and definitions of the
+            fields are the same as for editors.
+          <p>
+            Use of authors is entirely optional,none are required. You
+            can have as many authors as you want. Display is the same
+            as described for editors.
+          </p>
         </dd>
         <dt>maxTocLevel</dt>
         <dd>
@@ -742,6 +728,12 @@
         <li>
           2009-12-04 -  modified to be less verbose on bibl errors, listing each only once with count.
         </li>
+        <li>
+          2009-12-04 -  Unified author and editor code and combined
+          documentation to avoid replication. Added support for
+          optional email address, and optional note following person
+          description. 
+        </li>
       </ul>
     </section>
     
Received on Friday, 4 December 2009 20:18:28 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Friday, 4 December 2009 20:18:28 GMT