You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by rd...@apache.org on 2011/11/02 10:25:28 UTC
svn commit: r1196515 - in /incubator/rat/whisker/trunk/src/site:
apt/meta-data.apt resources/meta-data-section1.dia
resources/meta-data-section1.png resources/meta-data-section3.dia
resources/meta-data-section3.png
Author: rdonkin
Date: Wed Nov 2 09:25:27 2011
New Revision: 1196515
URL: http://svn.apache.org/viewvc?rev=1196515&view=rev
Log:
Described the object model used by Whisker meta-data.
Added:
incubator/rat/whisker/trunk/src/site/resources/meta-data-section1.dia (with props)
incubator/rat/whisker/trunk/src/site/resources/meta-data-section1.png (with props)
incubator/rat/whisker/trunk/src/site/resources/meta-data-section3.dia (with props)
incubator/rat/whisker/trunk/src/site/resources/meta-data-section3.png (with props)
Modified:
incubator/rat/whisker/trunk/src/site/apt/meta-data.apt
Modified: incubator/rat/whisker/trunk/src/site/apt/meta-data.apt
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/src/site/apt/meta-data.apt?rev=1196515&r1=1196514&r2=1196515&view=diff
==============================================================================
--- incubator/rat/whisker/trunk/src/site/apt/meta-data.apt (original)
+++ incubator/rat/whisker/trunk/src/site/apt/meta-data.apt Wed Nov 2 09:25:27 2011
@@ -38,6 +38,70 @@ Whisker Meta-Data Model
[[I]] Contents of each directory, grouped by organisation and license.
+* Some Objects Modeled
+
+** {Section I} - Licenses, Notices and Organisations
+
+[meta-data-section1.png] Section I
+
+ License, notice and organisations are define independently. Each can then be efficiently
+ referenced in many places by simple <<<id>>>. Each <<<id>>> must be a unique <<<ID>>> (in xml terms). Adopting
+ a regular naming convention is recommended. Some typical conventions:
+
+ * use the domain name as the <<<id>>> for an organisation;
+
+ * use the {{{http://www.opensource.org} Open Source Initiative}} code as the <<<id>>>
+ for an open source license
+
+ Note that <<<organisation>>> includes any entity attributed as creator. Including (for example)
+
+ * the name of an author;
+
+ * a pseudonym;
+
+ * a corporation;
+
+ * a development community;
+
+ * the Apache Software Foundation.
+
+** {Section II} - Primary Details
+
+ The primary license, notice and organisation associated with the work reference data in {{{Section I}Section I}} by <<<id>>>.
+ This is the collective copyright for the act of composition. The components aggregated in the distribution
+ are detailed in {{{Section III}Section III}}.
+
+** {Section III} - Contents
+
+ This final section groups resources contained in each directory by organisation and license.
+
+[meta-data-section3.png] Section III
+
+ The deep nesting groups the resources contained in each directory by license and organisation
+ to reduce duplication. Licenses, notices and organisations are linked by <<<id>>> to the definitions
+ in {{{Section I} Section I}}.
+
+ Directories are modeled using a flat structure without nesting. Paths are relative to the
+ root directory of the distribution (indicated by '.') and separated by <<<//>>>.
+
++------------------------------------------------------------------------+
+
+ <within dir='.'>
+ <with-license ...
+ </within>
+ <within dir='WEB-INF'>
+ <with-license ...
+ </within>
+ <within dir='WEB-INF/conf'>
+ <with-license ...
+ </within>
+ <within dir='WEB-INF/lib'>
+ <with-license ...
+ </within>
+
++------------------------------------------------------------------------+
+
+
* Described By DTD
Useful for visual editors.
Added: incubator/rat/whisker/trunk/src/site/resources/meta-data-section1.dia
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/src/site/resources/meta-data-section1.dia?rev=1196515&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/rat/whisker/trunk/src/site/resources/meta-data-section1.dia
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/rat/whisker/trunk/src/site/resources/meta-data-section1.png
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/src/site/resources/meta-data-section1.png?rev=1196515&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/rat/whisker/trunk/src/site/resources/meta-data-section1.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: incubator/rat/whisker/trunk/src/site/resources/meta-data-section3.dia
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/src/site/resources/meta-data-section3.dia?rev=1196515&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/rat/whisker/trunk/src/site/resources/meta-data-section3.dia
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/rat/whisker/trunk/src/site/resources/meta-data-section3.png
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/src/site/resources/meta-data-section3.png?rev=1196515&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/rat/whisker/trunk/src/site/resources/meta-data-section3.png
------------------------------------------------------------------------------
svn:mime-type = image/png