creadur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r1364379 - /creadur/whisker/trunk/src/site/apt/examples/3rd-party-individual.apt
Date Sun, 22 Jul 2012 17:44:13 GMT
Author: rdonkin
Date: Sun Jul 22 17:44:13 2012
New Revision: 1364379

URL: http://svn.apache.org/viewvc?rev=1364379&view=rev
Log:
Added more content to example.

Modified:
    creadur/whisker/trunk/src/site/apt/examples/3rd-party-individual.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=1364379&r1=1364378&r2=1364379&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 17:44:13
2012
@@ -50,7 +50,7 @@ With An Individual Third Party Work
        | LICENSE
 +---------------------------------------+
 
-** Definitions
+** Starting 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
@@ -292,7 +292,7 @@ With An Individual Third Party Work
     ...
 +---------------------------------------+
 
-* Contents
+** Starting Contents
   
   Let's assume that the distribution for <<<foo>>> just contains the single
   source file <<<HelloWorld.py>>> (plus legal documentation generated by
Whisker), 
@@ -306,14 +306,7 @@ With An Individual Third Party Work
   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:AL2'>
@@ -322,6 +315,7 @@ With An Individual Third Party Work
             </by-organisation>
         </with-license>
     </within>
+</manifest>
 +---------------------------------------+
 
 
@@ -329,14 +323,22 @@ With An Individual Third Party Work
   
 * Adding A Third Party to the Distribution
 
-  For this example, we'll add a third party file <<<boo.png>>> to the distribution.
+  Let's add <<<boo.png>>> to the distribution,
+  licensed under the same Apache License 
+  by, let's say, <Sam Smith> (of <<<example.org>>>). If this had
had 
+  a different license, then this license might have to be added but 
+  otherwise the process would be analogous.
   
-  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.
+** Add Organisation  
+
+  As far as Whisker is
+  concerned, data about an individual maintainer (like <Sam Smith>) is
+  entered as an {{{../faq.html#what-is-org}organisation}}. 
+  After checking that <Sam Smith> isn't already described in the 
+  <<<organisations>>>, we find that an <<<organisation>>>
+  needs to be added. Pay particular attention to the <<<id>>> -
+  we'll need to refer to this later when the content are added.
+  For this example, we'll pick <<<person:Sam.Smith>>>
   
 +---------------------------------------+
 <manifest>
@@ -357,13 +359,31 @@ With An Individual Third Party Work
     ...
 +---------------------------------------+
 
-  The contents of the new distribution should be something like (plus the legal
-  documentation generated by Whisker).
+** Add Contents
+
+  Excluding the legal documentation to be generated by Whisker,
+  the contents of the new distribution should be something like:
 
 +---------------------------------------+
   foo--| 
        | HelloWorld.py
        | boo.png
 +---------------------------------------+
+
+  We need to add <<<boo.png>>> to the contents, to a new group of resources
+  within the root directory. 
    
++---------------------------------------+
+    ...
+    <!-- Contents -->
+    <within dir='.'>
+        <with-license id='osi:AL2'>
+            ...
+            <by-organisation id='person:Sam.Smith'>
+                <resource name='boo.png'/>
+            </by-organisation>
+        </with-license>
+    </within>
+</manifest>
++---------------------------------------+
    
\ No newline at end of file



Mime
View raw message