You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by rd...@apache.org on 2011/11/01 18:40:27 UTC

svn commit: r1196155 - /incubator/rat/whisker/trunk/src/site/apt/meta-data.apt

Author: rdonkin
Date: Tue Nov  1 17:40:27 2011
New Revision: 1196155

URL: http://svn.apache.org/viewvc?rev=1196155&view=rev
Log:
Documented how to separate copyright notices from licenses to reduce duplication.

Modified:
    incubator/rat/whisker/trunk/src/site/apt/meta-data.apt

Modified: incubator/rat/whisker/trunk/src/site/apt/meta-data.apt
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/src/site/apt/meta-data.apt?rev=1196155&r1=1196154&r2=1196155&view=diff
==============================================================================
--- incubator/rat/whisker/trunk/src/site/apt/meta-data.apt (original)
+++ incubator/rat/whisker/trunk/src/site/apt/meta-data.apt Tue Nov  1 17:40:27 2011
@@ -197,6 +197,114 @@ Whisker Meta-Data Model
 
 +------------------------------------------------------------------------+
 
+** Variable Copyright Notices
+
+ A copyright notice is a simple claim of ownership, typically by an author of the work. For example
+
++------------------------------------------------------------------------+
+        Copyright (c) YEAR A.N.AUTHOR
++------------------------------------------------------------------------+
+
+ <<Do not>> confuse a <copyright notice> with the <<<NOTICE>>> that some licenses require to be
+ distributed. A typical <<<NOTICE>>> contains attribution information 
+ (for example <This products contains software developed by the Apache Software Foundation>)
+ as well as a copyright notice.
+ 
+ Many license definitions (for example, The {{{http://www.opensource.org/licenses/mit-license.php} MIT License}}) 
+ conventionally include a copyright notice. The contents of these copyright notices vary widely.
+ 
+ Whisker separates <<<copyright-notice>>> from <<<license>>> to reduce duplication. 
+ (Optionally) a <<<copyright-notice>>> begins a <<<with-license>>> block, 
+ before <<<resource>>> grouped <<<by-organisation>>> 
+ sharing this <<<copyright-notice>>> and <<<license>>>.
+ 
++------------------------------------------------------------------------+ 
+    <with-license id='MIT'>
+        <copyright-notice>
+Copyright (c) YEAR A.N.AUTHOR
+All rights reserved.
+        </copyright-notice>
+        <by-organisation id='example.org'>
+                <resource name='document.txt'/>
+                ...
+
++------------------------------------------------------------------------+
+
+*** An Example Separation Into License and Notice
+
+ Here is an example instance of the 
+ {{{http://www.opensource.org/licenses/mit-license.php} MIT License}} 
+
++------------------------------------------------------------------------+ 
+Copyright (c) YEAR-YEAR A.N.AUTHOR
+All rights reserved.
+
+Permission is hereby granted, free  of charge, to any person obtaining
+a  copy  of this  software  and  associated  documentation files  (the
+"Software"), to  deal in  the Software without  restriction, including
+without limitation  the rights to  use, copy, modify,  merge, publish,
+distribute,  sublicense, and/or sell  copies of  the Software,  and to
+permit persons to whom the Software  is furnished to do so, subject to
+the following conditions:
+
+The  above  copyright  notice  and  this permission  notice  shall  be
+included in all copies or substantial portions of the Software.
+
+THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
+EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
+MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
++------------------------------------------------------------------------+ 
+
+
+ To allow the <<<license>>> to be reused, add the <<<text>>> 
+ excluding the copyright notice.
+
++------------------------------------------------------------------------+ 
+        <license 
+            name='MIT License' 
+            id='MIT' 
+            url='http://www.opensource.org/licenses/mit-license.php'>
+            <text>
+Permission is hereby granted, free  of charge, to any person obtaining
+a  copy  of this  software  and  associated  documentation files  (the
+"Software"), to  deal in  the Software without  restriction, including
+without limitation  the rights to  use, copy, modify,  merge, publish,
+distribute,  sublicense, and/or sell  copies of  the Software,  and to
+permit persons to whom the Software  is furnished to do so, subject to
+the following conditions:
+
+The  above  copyright  notice  and  this permission  notice  shall  be
+included in all copies or substantial portions of the Software.
+
+THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
+EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
+MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+            </text>
+        </license>
++------------------------------------------------------------------------+ 
+
+ Add the appropriate <<<copyright-notice>>> applying to the <<<resource>>>.
+
++------------------------------------------------------------------------+ 
+
+        <with-license id='MIT'>
+        <copyright-notice>
+Copyright (c) YEAR-YEAR A.N.AUTHOR
+All rights reserved.
+        </copyright-notice>
+            <by-organisation id='example.org'>
+                <resource name='mit-licensed-document-by-A-N-Author.txt'/>
+                ...
++------------------------------------------------------------------------+ 
+
 
 ** Templates For License Families
 
@@ -230,6 +338,7 @@ Whisker Meta-Data Model
       ...
 +------------------------------------------------------------------------+
 
+
  
 *** A Template Example