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/01 16:52:49 UTC

svn commit: r1196067 - in /incubator/rat/whisker/trunk/src/site: apt/meta-data.apt resources/examples/public-domain.xml

Author: rdonkin
Date: Tue Nov  1 15:52:49 2011
New Revision: 1196067

URL: http://svn.apache.org/viewvc?rev=1196067&view=rev
Log:
Document how public domain is handled.

Added:
    incubator/rat/whisker/trunk/src/site/resources/examples/public-domain.xml   (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=1196067&r1=1196066&r2=1196067&view=diff
==============================================================================
--- incubator/rat/whisker/trunk/src/site/apt/meta-data.apt (original)
+++ incubator/rat/whisker/trunk/src/site/apt/meta-data.apt Tue Nov  1 15:52:49 2011
@@ -125,6 +125,79 @@ Whisker Meta-Data Model
 
 * Some More Advanced Features Explained
 
+** Public Domain
+
+ Some contemporary laws make it surprisingly difficult for an author to place a work in the public domain. 
+ See <<<{{{http://creativecommons.org} creativecommons.org}}>>>
+ for {{{http://creativecommons.org/about/cc0} more}} 
+ {{{http://creativecommons.org/weblog/entry/23830} explanation}}.
+ 
+ Whisker supports works in the public domain through <<<public-domain>>> blocks <<<within>>> a directory. 
+ A <<<resource>>> in the public domain should be grouped <<<by-organisation>>> within the <<<public-domain>>>
+ block.
+ 
++------------------------------------------------------------------------+
+
+    <within dir='.'>
+        <public-domain>
+            <by-organisation id='An Author'>
+                <resource name='A Work In The Public Domain'/>
+            </by-organisation>
+        </public-domain>
+    </within>
+
++------------------------------------------------------------------------+
+
+*** A Public Domain Example
+
+ This simple example illustrates how <Guide to the Lakes> by William Wordsworth
+ (now in the public domain) may be indicated. 
+ Source is {{{./examples/public-domain.xml}here}}.
+
++------------------------------------------------------------------------+
+<manifest>
+    <licenses>
+        <license id='LICENSE' name='A License'>
+            <text>The words of the license</text>
+        </license>
+    </licenses>
+    <notices/>
+    <organisations>
+        <organisation id="ORG" name='An Organisation'/>
+        <!-- 
+        The original author must still be credited
+        even for works in the public domain.
+        Copyrights to the works of William Wordsworth 
+        (1770-1850)
+        have now expired. 
+                                              -->
+        <organisation id="WilliamWordsworth" name='William Wordsworth'/>
+    </organisations>
+    <primary-license id='LICENSE'/>
+    <primary-organisation id='ORG'/>
+    
+    <within dir='.'>
+        <!-- 
+            The public domain block should be included
+            when the directory contains a resources 
+            in the public domain. 
+                     -->
+        <public-domain>
+            <by-organisation id='WilliamWordsworth'>
+            <!-- 
+                Copyrights to 'Guide to the Lakes'
+                by William Wordsworth have now expired.
+                It is in the public domain.
+                         -->
+                <resource name='Guide to the Lakes'/>
+            </by-organisation>
+        </public-domain>
+    </within>
+</manifest>
+
++------------------------------------------------------------------------+
+
+
 ** Templates For License Families
 
  Some familiar open source licenses (for example, 

Added: incubator/rat/whisker/trunk/src/site/resources/examples/public-domain.xml
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/src/site/resources/examples/public-domain.xml?rev=1196067&view=auto
==============================================================================
--- incubator/rat/whisker/trunk/src/site/resources/examples/public-domain.xml (added)
+++ incubator/rat/whisker/trunk/src/site/resources/examples/public-domain.xml Tue Nov  1 15:52:49 2011
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.    
+-->
+<!DOCTYPE manifest [
+
+<!ELEMENT manifest (licenses, notices, organisations, 
+    primary-license, primary-notice?, primary-organisation?, within*)>
+<!-- Collects license descriptions -->    
+<!ELEMENT licenses (license*)>
+<!-- Describes a copyright license -->
+<!ELEMENT license (template?, text)>
+<!ATTLIST license name CDATA #REQUIRED>
+<!ATTLIST license url CDATA #IMPLIED>
+<!ATTLIST license id ID #REQUIRED>
+<!-- Some licenses require a link to source code -->
+<!ATTLIST license requires-source (yes|no) "no">
+<!-- The words expressing the license -->
+<!ELEMENT text (#PCDATA)>
+<!-- Template license families have parameterised license wording -->
+<!ELEMENT template (parameter-name+)>
+<!-- The name of a parameter to be substituted -->
+<!ELEMENT parameter-name (#PCDATA)>
+
+<!-- Collects notice descriptions -->
+<!ELEMENT notices (notice*)>
+<!-- Describes notice text to be preserved -->
+<!ELEMENT notice (#PCDATA)>
+<!ATTLIST notice id ID #REQUIRED>
+
+<!-- Collections organisation descriptions -->
+<!ELEMENT organisations (organisation*)>
+<!-- Descibres an upstream organisation -->
+<!ELEMENT organisation EMPTY>
+<!ATTLIST organisation id ID #REQUIRED>
+<!ATTLIST organisation name CDATA #REQUIRED>
+<!ATTLIST organisation url CDATA #IMPLIED>
+
+<!-- The primary license for the application -->
+<!ELEMENT primary-license EMPTY>
+<!-- References the license by id attribute -->
+<!ATTLIST primary-license id IDREF #REQUIRED>
+
+<!-- The text of the application's primary notice -->
+<!ELEMENT primary-notice (#PCDATA)>
+
+<!-- The organisation responsible for the application -->
+<!ELEMENT primary-organisation EMPTY>
+<!-- References the organisation by id attribute -->
+<!ATTLIST primary-organisation id IDREF #REQUIRED>
+
+<!-- Collects the resources within a directory-->
+<!ELEMENT within (public-domain?, with-license*)>
+<!ATTLIST within dir CDATA #REQUIRED>
+
+<!-- Collects resources sharing licensing qualities -->
+<!ELEMENT with-license (copyright-notice?, license-parameters?, by-organisation*)>
+<!-- Refers to a license defined above by ID -->
+<!ATTLIST with-license id IDREF #REQUIRED>
+<!-- A copyright claim -->
+<!ELEMENT copyright-notice (#PCDATA)>
+<!-- Values substituted into the text of template licenses -->
+<!ELEMENT license-parameters (parameter*)>
+<!ELEMENT parameter (name, value)>
+<!ELEMENT name (#PCDATA)>
+<!ELEMENT value (#PCDATA)>
+
+<!-- Collects resources in the public domain -->
+<!ELEMENT public-domain (by-organisation*)>
+
+<!-- Collects resources issued by an upstream organisation -->
+<!ELEMENT by-organisation (resource*)>
+<!ATTLIST by-organisation id IDREF #REQUIRED>
+
+<!-- Contained in the application release -->
+<!ELEMENT resource EMPTY>
+<!ATTLIST resource name CDATA #REQUIRED>
+<!ATTLIST resource sha1 CDATA #IMPLIED>
+<!ATTLIST resource notice IDREF #IMPLIED>
+<!ATTLIST resource source CDATA #IMPLIED>
+]>
+<manifest>
+    <licenses>
+        <license id='LICENSE' name='A License'>
+            <text>The words of the license</text>
+        </license>
+    </licenses>
+    <notices/>
+    <organisations>
+        <organisation id="ORG" name='An Organisation'/>
+        <!-- 
+        The original author must still be credited
+        even for works in the public domain.
+        Copyrights to the works of William Wordsworth 
+        (1770–1850)
+        have now expired. 
+                                              -->
+        <organisation id="WilliamWordsworth" name='William Wordsworth'/>
+    </organisations>
+    <primary-license id='LICENSE'/>
+    <primary-organisation id='ORG'/>
+    
+    <within dir='.'>
+        <!-- 
+            The public domain block should be included
+            when the directory contains a resources 
+            in the public domain. 
+                     -->
+        <public-domain>
+            <by-organisation id='WilliamWordsworth'>
+            <!-- 
+                Copyrights to 'Guide to the Lakes'
+                by William Wordsworth have now expired.
+                It is in the public domain.
+                         -->
+                <resource name='Guide to the Lakes'/>
+            </by-organisation>
+        </public-domain>
+    </within>
+</manifest>
\ No newline at end of file

Propchange: incubator/rat/whisker/trunk/src/site/resources/examples/public-domain.xml
------------------------------------------------------------------------------
    svn:eol-style = native