Author: rdonkin
Date: Thu Aug 9 20:12:02 2012
New Revision: 1371428
URL: http://svn.apache.org/viewvc?rev=1371428&view=rev
Log:
Starting to describe how to add contents
Modified:
creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt
Modified: creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt
URL:
http://svn.apache.org/viewvc/creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt?rev=1371428&r1=1371427&r2=1371428&view=diff
==============================================================================
--- creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt (original)
+++ creadur/whisker/trunk/src/site/apt/examples/in-5-mins.apt Thu Aug 9
20:12:02 2012
@@ -234,6 +234,37 @@ WITH THE SOFTWARE OR THE USE OR OTHER DE
...
+---------------------------------------+
+* Contents
+
+ Meta-data links the contents of a software distribution with
+ its licensing definitions. This allows Whisker to, for example,
+ generate licensing document and check that every document
+ included is expected.
+
+ Contents are described by directory. The resources <<<within>>>
+ each directory are grouped <<<with-license>>> then
+ <<<by-organisation>>> but the tree structure of directories
+ in a file system is not replicated in the element structure.
+ In short, directories are modeled by a flat list.
+
+ Work through the distribution, one directory at a time.
+ Let's say our distribution is something similar to this.
+
++---------------------------------------+
+ --|- one.txt
+ |- two.html
+ |- three.py
+ |
+ |-alpha-|- five.js
+ | |- six.rb
+ | |- seven.coffee
+ |
+ |-beta--|- eight.java
+ | |...
+ ...
++---------------------------------------+
+
+
* Summary