creadur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1364118 - in /creadur/whisker/trunk/src/site: apt/examples/in-5-mins.apt fml/faq.fml
Date Sat, 21 Jul 2012 16:26:44 GMT
Author: rdonkin
Date: Sat Jul 21 16:26:44 2012
New Revision: 1364118

A couple of new FAQs, linked from example.


Modified: creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt
--- creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt (original)
+++ creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt Sat Jul 21 16:26:44 2012
@@ -33,7 +33,7 @@ Whisker In 5 Minutes
  For this example, we'll create meta-data for a simple 
  {{{}MIT licensed}} 
  project. This illustrates any project where
- a NOTICE is not (necessarily) required.
+ a NOTICE is not (necessarily) {{{../faq.html#when-notice-needed}required}}.
 * Basic Structure

Modified: creadur/whisker/trunk/src/site/fml/faq.fml
--- creadur/whisker/trunk/src/site/fml/faq.fml (original)
+++ creadur/whisker/trunk/src/site/fml/faq.fml Sat Jul 21 16:26:44 2012
@@ -39,19 +39,50 @@
     <faq id="when-notice">
       <question>When will a NOTICE be generated?</question>
-      <p>Whisker should generate a NOTICE document only when needed. 
+      <p>Whisker should generate a <code>NOTICE</code> document only when

+      <a href='#when-notice-needed'>needed</a>. 
       Examples include:</p>
         <li>when the primary notice is not empty; and</li>
         <li>when at least one distributed artifact requires an attribution.</li>
-      <p>If you have a use case where an unnecessary NOTICE is generated,
-      or when a NOTICE isn't generated when it is needed please open an 
+      <p>If you have a use case where an unnecessary <code>NOTICE</code>
is generated,
+      or when a <code>NOTICE</code> isn't generated when it is needed please
open an 
       <a href='./issue-tracking.html'>issue</a> or let us know 
       <a href='./mail-lists.html'>on list</a>.</p>
+  <part id="licensing"> 
+    <title>Licensing Documentation</title>
+     <faq id="notice-vs-license">
+        <question>What is the difference between a <code>NOTICE</code>
and a <code>LICENSE</code>?</question>
+        <answer>
+            <p>
+A <code>NOTICE</code> is informational documentation, whereas a <code>LICENSE</code>

+is legal documentation. 
+A <code>NOTICE</code> may be subject to a <a href='#when-notice-needed'>retention
+            </p>
+        </answer>
+    </faq>
+    <faq id="when-notice-needed">
+        <question>When is a <code>NOTICE</code> needed?</question>
+        <answer>
+            <p>
+            It depends :-)
+            </p>
+            <p>
+Some licenses require <code>NOTICE</code> documents to be retained.
+For example, clause 4.4 in the
+<a href=''>Apache License, Version 2</a>
+is a retention clause covering any <code>NOTICE</code> distributed with the original.

+When creating or distributing a modified version of a project licensed with a retention clause,
+you need to ensure that the <code>NOTICE</code> is distributed. 
+            </p>
+        </answer>
+    </faq>
+  </part>
   <part id="learning"> 
     <title>Is there an Example...</title>
     <faq id="mit-example">

View raw message