creadur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r1363083 - in /creadur/whisker/trunk/src/site: apt/examples/in-5-mins.apt apt/index.apt fml/faq.fml site.xml
Date Wed, 18 Jul 2012 20:05:46 GMT
Author: rdonkin
Date: Wed Jul 18 20:05:46 2012
New Revision: 1363083

URL: http://svn.apache.org/viewvc?rev=1363083&view=rev
Log:
Started work on MIT license example

Added:
    creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt
      - copied, changed from r1361679, creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/examples/generation-in-5-mins.apt.vm
Modified:
    creadur/whisker/trunk/src/site/apt/index.apt
    creadur/whisker/trunk/src/site/fml/faq.fml
    creadur/whisker/trunk/src/site/site.xml

Copied: creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt (from r1361679, creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/examples/generation-in-5-mins.apt.vm)
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt?p2=creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt&p1=creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/examples/generation-in-5-mins.apt.vm&r1=1361679&r2=1363083&rev=1363083&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/examples/generation-in-5-mins.apt.vm
(original)
+++ creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt Wed Jul 18 20:05:46 2012
@@ -1,3 +1,6 @@
+  ------
+  Whisker In 5 Minutes
+  ------
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ~~
 ~~  Licensed to the Apache Software Foundation (ASF) under one
@@ -19,50 +22,133 @@
 ~~
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Generation In 5 Minutes
+Whisker In 5 Minutes
 
- {{{http://creadur.apache.org/whisker} Apache Whisker}} generates licensing
- documentation (for example, <<<LICENSE>>> and <<<NOTICE>>>
documents) from
- meta-data.
+ {{{http://creadur.apache.org/whisker} Apache Whisker}} is based around
+ {{{../meta-data.html}meta-data}} describing the licensing qualities
+ of documents included within complex software distributions. This
+ separates information about <which> documents are distributed 
+ from <what> these documents are. 
+ 
+ For this example, we'll create meta-data for a simple 
+ {{{http://opensource.org/licenses/mit-license.php/}MIT licensed}} 
+ project.  
  
-* Describe Your Project
-
- Describe your project in a meta-data document, and save as 
- <<<descriptor.xml>>> in the project directory.
  
+* Basic Structure
+    
 +---------------------------------------+
-TODO 
+<manifest>
+    <licenses/>
+    <notices/>
+    <organisations/>
+    <primary-license/>
+    <primary-notice/>
+    <primary-organisation/>
+    <within dir='.'/>
+</manifest> 
 +---------------------------------------+
 
-* Configure Apache Whisker Plugin4Maven
- 
+  Each license, notice and organisation is described once above, and then
+  {{{../faq.html#why-ids}referenced by id}} below.
+  If you're using an IDE then see 
+  {{{../meta-data.html}meta data reference}} for a DTD.
+
+** Add The Primary License
+
+  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.
+  
 +---------------------------------------+
-  ...
-  <build>
-    <plugins>
-        ...
-        <plugin>
-          <groupId>org.apache.creadur.whisker</groupId>
-            <artifactId>apache-whisker-plugin4maven</artifactId>
-            <version>${project.version}</version>
-            <executions>
-                <execution>
-                    <id>generate-licensing-docs</id>
-                    <phase>package</phase>
-                    <goals>
-                        <goal>generate</goal>
-                    </goals>
-                </execution>
-            </executions>
-            <configuration>
-                <descriptor>descriptor.xml</descriptor>
-            </configuration>
-        </plugin>
-        ...
-    </plugins>
-  </build>
-  ...
- 
+<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>
+    ...  
 +---------------------------------------+
+  
+  (Start here for more about the primary license.)
+
+* Summary
+
++---------------------------------------+
+<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/>
+    <organisations>
+        <organisation 
+            id='example.org' 
+            name='An Example Software Vendor' 
+            url='http://example.org'/>
+    </organisations>
+    <primary-license id='osi:mit'/>
+    <primary-notice/>
+    <primary-organisation id='example.org'/>
+    <within dir='.'>
+        <with-license id='osi:mit'>
+            <by-organisation id='example.org'>
+                <resource name='LICENSE'/>
+                <resource name='README.txt'/>
+            </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

Modified: creadur/whisker/trunk/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/src/site/apt/index.apt?rev=1363083&r1=1363082&r2=1363083&view=diff
==============================================================================
--- creadur/whisker/trunk/src/site/apt/index.apt (original)
+++ creadur/whisker/trunk/src/site/apt/index.apt Wed Jul 18 20:05:46 2012
@@ -53,4 +53,12 @@ What Is Apache Whisker?
 
  * From the {{{./apache-whisker-cli/index.html} command line}} 
  
- * As a {{{./apache-whisker-plugin4maven/index.html} plugin for Maven}}
\ No newline at end of file
+ * As a {{{./apache-whisker-plugin4maven/index.html} plugin for Maven}}
+
+* Getting Started
+
+ Browse the {{{./xref/index.html}source}}, 
+ read the {{{./apidocs/index.html}javadocs}}
+ or take a look at some examples:
+ 
+ * {{{./examples/in-5-mins.html}Whisker In 5 Minutes}}

Modified: creadur/whisker/trunk/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/src/site/fml/faq.fml?rev=1363083&r1=1363082&r2=1363083&view=diff
==============================================================================
--- creadur/whisker/trunk/src/site/fml/faq.fml (original)
+++ creadur/whisker/trunk/src/site/fml/faq.fml Wed Jul 18 20:05:46 2012
@@ -18,6 +18,22 @@
   under the License.    
 -->
 <faqs id="FAQ" title="Frequently Asked Questions">
+  <part id="meta-data"> 
+    <title>Meta Data</title>
+    <faq id="why-ids">
+      <question>Why Reference Licenses, Notices and Organisations by ID?</question>
+      <answer>
+      <p>
+      <a href="http://dbpedia.org/resource/Don't_repeat_yourself">DRY</a> rules.
+      </p>
+      <p>
+      Each license, notice and organisation should be described once, and then
+      referenced by <code>id</code>. For complex projects, this reduces duplication
+      and eases maintenance.   
+      </p>
+      </answer>
+    </faq>
+  </part>
   <part id="generation"> 
     <title>Generating Licensing Documents</title>
     <faq id="when-notice">

Modified: creadur/whisker/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/src/site/site.xml?rev=1363083&r1=1363082&r2=1363083&view=diff
==============================================================================
--- creadur/whisker/trunk/src/site/site.xml (original)
+++ creadur/whisker/trunk/src/site/site.xml Wed Jul 18 20:05:46 2012
@@ -39,6 +39,10 @@
        <item name="FAQ" href="faq.html"/>
     </menu>
     
+    <menu name='Examples'>
+        <item name="In 5 Minutes" href="examples/in-5-mins.html"/>
+    </menu>
+    
     <menu name="Apache Creadur &trade;" inherit="bottom">
 		<item name='Creadur Project Home' href="http://creadur.apache.org"/>
 		<item name='Apache Rat' href="http://creadur.apache.org/rat"/>  



Mime
View raw message