svn commit: r1368219 - in /creadur/whisker/trunk/src/site: apt/examples/license-family.apt fml/faq.fml

[rd...@apache.org]

Author: rdonkin
Date: Wed Aug  1 19:47:03 2012
New Revision: 1368219

URL: http://svn.apache.org/viewvc?rev=1368219&view=rev
Log:
Added FAQ about parameter names

Modified:
    creadur/whisker/trunk/src/site/apt/examples/license-family.apt
    creadur/whisker/trunk/src/site/fml/faq.fml

Modified: creadur/whisker/trunk/src/site/apt/examples/license-family.apt
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/src/site/apt/examples/license-family.apt?rev=1368219&r1=1368218&r2=1368219&view=diff
==============================================================================
--- creadur/whisker/trunk/src/site/apt/examples/license-family.apt (original)
+++ creadur/whisker/trunk/src/site/apt/examples/license-family.apt Wed Aug  1 19:47:03 2012
@@ -429,7 +429,8 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SU
 
   Yes, the license is indeed part of the BSD (2 Clause) license family.
   Checking <<<licenses>>> verifies that we need to add this as a new
-  template <<<license>>> with two parameters. We have a free choice 
+  template <<<license>>> with two parameters. We have a 
+  {{{../faq.html#parameter-name-freedom}free choice}} 
   of <<<parameter-name>>> but it's convention to reuse standard names
   (where possible).
 

Modified: creadur/whisker/trunk/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/src/site/fml/faq.fml?rev=1368219&r1=1368218&r2=1368219&view=diff
==============================================================================
--- creadur/whisker/trunk/src/site/fml/faq.fml (original)
+++ creadur/whisker/trunk/src/site/fml/faq.fml Wed Aug  1 19:47:03 2012
@@ -73,6 +73,18 @@ standard URL is given, where possible, f
        </p>
       </answer>
     </faq>
+    <faq id="parameter-name-freedom">
+      <question>Am I Free to Pick Any Name for a Parameter?</question>
+      <answer>
+      <p>
+      Yes
+      </p>
+      <p>
+Where possible, we recommend reusing the name adopted by a standards organisation, 
+for example  <a href='http://www.opensource.org'>The Open Source Initiative</a>.
+      </p>
+      </answer>
+    </faq>
     <faq id='where-is-reference'>
         <question>Is a reference available?</question>
         <answer>