Return-Path: 
 <commits-return-1372-apmail-creadur-commits-archive=creadur.apache.org@creadur.apache.org>
X-Original-To: apmail-creadur-commits-archive@www.apache.org
Delivered-To: apmail-creadur-commits-archive@www.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id 2D5F2D678
	for <apmail-creadur-commits-archive@www.apache.org>;
 Sun, 22 Jul 2012 17:00:19 +0000 (UTC)
Received: (qmail 37211 invoked by uid 500); 22 Jul 2012 17:00:19 -0000
Delivered-To: apmail-creadur-commits-archive@creadur.apache.org
Received: (qmail 37188 invoked by uid 500); 22 Jul 2012 17:00:19 -0000
Mailing-List: contact commits-help@creadur.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:commits-help@creadur.apache.org>
List-Unsubscribe: <mailto:commits-unsubscribe@creadur.apache.org>
List-Post: <mailto:commits@creadur.apache.org>
List-Id: <commits.creadur.apache.org>
Reply-To: dev@creadur.apache.org
Delivered-To: mailing list commits@creadur.apache.org
Received: (qmail 37178 invoked by uid 99); 22 Jul 2012 17:00:18 -0000
Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136)
    by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 22 Jul 2012 17:00:18 +0000
X-ASF-Spam-Status: No, hits=-2000.0 required=5.0
	tests=ALL_TRUSTED
X-Spam-Check-By: apache.org
Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4)
    by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 22 Jul 2012 17:00:16 +0000
Received: from eris.apache.org (localhost [127.0.0.1])
	by eris.apache.org (Postfix) with ESMTP id 8C7A1238897D
	for <commits@creadur.apache.org>; Sun, 22 Jul 2012 16:59:57 +0000 (UTC)
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1364360 - in /creadur/whisker/trunk/src/site/apt:
 examples/3rd-party-individual.apt index.apt
Date: Sun, 22 Jul 2012 16:59:57 -0000
To: commits@creadur.apache.org
From: rdonkin@apache.org
X-Mailer: svnmailer-1.0.8-patched
Message-Id: <20120722165957.8C7A1238897D@eris.apache.org>
X-Virus-Checked: Checked by ClamAV on apache.org

Author: rdonkin
Date: Sun Jul 22 16:59:57 2012
New Revision: 1364360

URL: http://svn.apache.org/viewvc?rev=1364360&view=rev
Log:
More content for the individual 3rd party example

Modified:
    creadur/whisker/trunk/src/site/apt/examples/3rd-party-individual.apt
    creadur/whisker/trunk/src/site/apt/index.apt

Modified: creadur/whisker/trunk/src/site/apt/examples/3rd-party-individual.apt
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/src/site/apt/examples/3rd-party-individual.apt?rev=1364360&r1=1364359&r2=1364360&view=diff
==============================================================================
--- creadur/whisker/trunk/src/site/apt/examples/3rd-party-individual.apt (original)
+++ creadur/whisker/trunk/src/site/apt/examples/3rd-party-individual.apt Sun Jul 22 16:59:57 2012
@@ -1,5 +1,5 @@
   ------
-  Whisker In 5 Minutes
+  With An Individual Third Party Work  
   ------
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ~~
@@ -22,19 +22,15 @@
 ~~
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Whisker In 5 Minutes
+With An Individual Third Party Work
 
  {{{http://creadur.apache.org/whisker} Apache Whisker}} is based around
  {{{../meta-data.html}meta-data}} describing the licensing qualities
  of documents included within 
- {{{../faq.html#complex-software-applications}complex software distributions}}. 
- <Which> documents are distributed is separated 
- from <what> these documents are. 
+ {{{../faq.html#complex-software-applications}complex software distributions}}.
  
- For this example, we'll create meta-data for a simple 
- {{{http://opensource.org/licenses/mit-license.php/}MIT licensed}} 
- project. This illustrates any project where
- a NOTICE is not (necessarily) {{{../faq.html#when-notice-needed}required}}.
+ For this example, we'll add the meta-data for a third party work licensed from 
+ an individual.
  
  If you're using an IDE then see the 
   {{{../meta-data.html}meta data reference}} for a 
@@ -42,127 +38,332 @@ Whisker In 5 Minutes
   any questions, please try the {{{../faq.html}FAQ}} before asking on the 
   {{{../mail-lists.html}mail lists}}.
  
-* Basic Structure
+* The Story So Far
+
+  Let's assume <<<foo>>> is a simple project, 
+  with a single original source file: <<<HelloWorld.py>>>.  
+  The source for <<<foo>>> looks something like:
 
-  Each license, notice and organisation is described once 
-  above, and then
-  {{{../faq.html#why-ids}referenced by id}} below.
-  Begin with an outline.
- 
 +---------------------------------------+
-<manifest>
-    <!-- Definitions -->
-    <licenses/>
-    <notices/>
-    <organisations/>
-    <primary-license/>
-    <primary-notice/>
-    <primary-organisation/>
-    
-    <!-- Contents -->
-    <within dir='.'/>
-</manifest> 
+  foo--| 
+       | HelloWorld.py
+       | LICENSE
 +---------------------------------------+
 
-* Definitions
+** Definitions
 
-  Begin with the {{{../faq.html#what-is-primary}primary}} definitions.
+  Whisker describes each license, notice and {{{../faq.html#what-is-org}organisation}} once 
+  above, and then {{{../faq.html#why-ids}references by id}} below. So, the meta-data for
+  project <<<foo>>> is structured along these lines:
 
-** Add The Primary License
++---------------------------------------+
+<manifest>
+    <!-- Definitions -->
+    <licenses>...</licenses>
+    <notices>...</notices>
+    <organisations>...</organisations>
+    <primary-license>...</primary-license>
+    <primary-notice>...</primary-notice>
+    <primary-organisation>...</primary-organisation>
+    ...
++---------------------------------------+
+
+  Let's say that the 
+  {{{http://www.apache.org/licenses/LICENSE-2.0.html}Apache License, Version 2}}
+  is the primary license for the project, but <<<foo>>> opts not to include
+  a primary notice. The license text for this license is included in <<<licenses>>> above
+  and this data is referenced by <<<id>>> as <<<primary-license>>> below:
 
-  Licenses should be entered once into the <<<licenses>>> 
-  section (at the top), and then {{{../faq.html#why-ids}referenced 
-  by id}}. 
-  
-  This is an MIT license project, so add the MIT license.
-  
 +---------------------------------------+
 <manifest>
-    <licenses>
+    <!-- Definitions -->
         <license 
-            name='MIT License' 
-            id='osi: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>
+            name='Apache License, Version 2' 
+            id='osi:AL2' 
+            url='http://www.apache.org/licenses/LICENSE-2.0.txt'>
+<text>
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+</text>
         </license>
     </licenses>
-    ...  
+    <notices/>
+    <organisations>...</organisations>
+    <primary-license id='osi:AL2'/>
+    <primary-notice/>
+    <primary-organisation>...</primary-organisation>
+    ...
 +---------------------------------------+
-  
-  (Start here for more about the primary license.)
 
-* Summary
+  Let's assume that our project <<<foo>>> is here at Apache. So the 
+  {{{../faq.html#what-is-primary}primary organisation}} is the
+  Apache Software Foundation. The meta-data for <<<foo>>> describes
+  this in <<<organisations>>> above then references by id as the
+  <<<primary-organisation>>> below. 
 
 +---------------------------------------+
 <manifest>
-    <licenses>
-        <license name='MIT License' id='osi: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>
-    </licenses>
-    <notices/>
+    <!-- Definitions -->
+    <licenses>...</licenses>
+    <notices>...</notices>
     <organisations>
         <organisation 
-            id='example.org' 
-            name='An Example Software Vendor' 
-            url='http://example.org'/>
+            id='apache.org' 
+            name='The Apache Software Foundation' 
+            url='http://www.apache.org/'/>  
     </organisations>
-    <primary-license id='osi:mit'/>
-    <primary-notice/>
-    <primary-organisation id='example.org'/>
+    <primary-license>...</primary-license>
+    <primary-notice>...</primary-notice>
+    <primary-organisation id='apache.org'/>
+    ...
++---------------------------------------+
+
+* Contents
+  
+  Let's assume that the distribution for <<<foo>>> just contains the single
+  source file <<<HelloWorld.py>>> (plus legal documentation generated by Whisker), 
+  like this:
+
++---------------------------------------+
+  foo--| 
+       | HelloWorld.py
++---------------------------------------+
+
+  The contents section of the meta-data will look quite a lot like:
+
++---------------------------------------+
+<manifest>
+    <!-- Definitions -->
+    <licenses>...</licenses>
+    <notices>...</notices>
+    <organisations>...</organisations>
+    <primary-license>...</primary-license>
+    <primary-notice>...</primary-notice>
+    <primary-organisation>...</primary-organisation>
+    <!-- Contents -->
     <within dir='.'>
-        <with-license id='osi:mit'>
-            <by-organisation id='example.org'>
-                <resource name='LICENSE'/>
-                <resource name='README.txt'/>
+        <with-license id='osi:AL2'>
+            <by-organisation id='apache.org'>
+                <resource name='HelloWorld.py'/>
             </by-organisation>
         </with-license>
     </within>
-</manifest>
 +---------------------------------------+
 
-* Using Apache Whisker
 
-  * From the {{{/apache-whisker-cli/index.html}command line}}
+
   
-  * In a {{{/apache-whisker-plugin4maven/index.html}Maven build}}
- 
\ No newline at end of file
+* Adding A Third Party to the Distribution
+
+  For this example, we'll add a third party file <<<boo.png>>> to the distribution.
+  
+  Let's assume that this is licensed under the same Apache License 
+  by someone else: <Sam Smith> (of <<<example.org>>>). As far as Whisker is
+  concerned, an individual maintainer (like <Sam Smith>) is an 
+  {{{../faq.html#what-is-org}organisation}}. After finding that <Sam Smith>
+  isn't already described in the <<<organisations>>>, an <<<organisation>>>
+  needs to be added above.
+  
++---------------------------------------+
+<manifest>
+    <!-- Definitions -->
+    <licenses>...</licenses>
+    <notices>...</notices>
+    <organisations>
+    ...
+        <organisation
+           id='person:Sam.Smith'
+           name='Sam Smith'
+           url='http://example.org/~samsmith'
+        />
+    </organisations>
+    <primary-license>...</primary-license>
+    <primary-notice>...</primary-notice>
+    <primary-organisation>...</primary-organisation>
+    ...
++---------------------------------------+
+
+  The contents of the new distribution should be something like (plus the legal
+  documentation generated by Whisker).
+
++---------------------------------------+
+  foo--| 
+       | HelloWorld.py
+       | boo.png
++---------------------------------------+
+   
+   
\ No newline at end of file

Modified: creadur/whisker/trunk/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/src/site/apt/index.apt?rev=1364360&r1=1364359&r2=1364360&view=diff
==============================================================================
--- creadur/whisker/trunk/src/site/apt/index.apt (original)
+++ creadur/whisker/trunk/src/site/apt/index.apt Sun Jul 22 16:59:57 2012
@@ -65,3 +65,7 @@ What Is Apache Whisker?
  or take a look at some examples:
  
  * {{{./examples/in-5-mins.html}Whisker In 5 Minutes}}
+ 
+** Other Examples
+ 
+ * {{{./examples/3rd-party-individual.html}Including a 3rd Party work licensed by an individual}}