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/10/30 22:41:40 UTC
svn commit: r1195254 - in /incubator/rat/whisker/trunk:
legacy/src/main/resources/org/apache/rat/whisker/samples/james/james.xml
src/site/apt/index.apt src/site/apt/meta-data.apt src/site/resources/
src/site/site.xml
Author: rdonkin
Date: Sun Oct 30 21:41:39 2011
New Revision: 1195254
URL: http://svn.apache.org/viewvc?rev=1195254&view=rev
Log:
Started documenting the meta-data format.
Added:
incubator/rat/whisker/trunk/src/site/apt/meta-data.apt
- copied, changed from r1195198, incubator/rat/whisker/trunk/legacy/src/main/resources/org/apache/rat/whisker/samples/james/james.xml
incubator/rat/whisker/trunk/src/site/resources/
incubator/rat/whisker/trunk/src/site/site.xml (with props)
Modified:
incubator/rat/whisker/trunk/legacy/src/main/resources/org/apache/rat/whisker/samples/james/james.xml
incubator/rat/whisker/trunk/src/site/apt/index.apt
Modified: incubator/rat/whisker/trunk/legacy/src/main/resources/org/apache/rat/whisker/samples/james/james.xml
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/legacy/src/main/resources/org/apache/rat/whisker/samples/james/james.xml?rev=1195254&r1=1195253&r2=1195254&view=diff
==============================================================================
--- incubator/rat/whisker/trunk/legacy/src/main/resources/org/apache/rat/whisker/samples/james/james.xml (original)
+++ incubator/rat/whisker/trunk/legacy/src/main/resources/org/apache/rat/whisker/samples/james/james.xml Sun Oct 30 21:41:39 2011
@@ -18,42 +18,76 @@
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>
Modified: incubator/rat/whisker/trunk/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/src/site/apt/index.apt?rev=1195254&r1=1195253&r2=1195254&view=diff
==============================================================================
--- incubator/rat/whisker/trunk/src/site/apt/index.apt (original)
+++ incubator/rat/whisker/trunk/src/site/apt/index.apt Sun Oct 30 21:41:39 2011
@@ -34,7 +34,7 @@ documentation.
* How Does Whisker Work?
- Licensing meta-data describe the legal qualities of the components
+ Licensing {{{./meta-data.html} meta-data}} describe the legal qualities of the components
assembled.
* What Does Whisker Do?
Copied: incubator/rat/whisker/trunk/src/site/apt/meta-data.apt (from r1195198, incubator/rat/whisker/trunk/legacy/src/main/resources/org/apache/rat/whisker/samples/james/james.xml)
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/src/site/apt/meta-data.apt?p2=incubator/rat/whisker/trunk/src/site/apt/meta-data.apt&p1=incubator/rat/whisker/trunk/legacy/src/main/resources/org/apache/rat/whisker/samples/james/james.xml&r1=1195198&r2=1195254&rev=1195254&view=diff
==============================================================================
--- incubator/rat/whisker/trunk/legacy/src/main/resources/org/apache/rat/whisker/samples/james/james.xml (original)
+++ incubator/rat/whisker/trunk/src/site/apt/meta-data.apt Sun Oct 30 21:41:39 2011
@@ -1,65 +1,112 @@
-<?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.
--->
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~
+~~ 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.
+~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Described By DTD
+
+ Useful for visual editors.
+
+----------------------------------------
<!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>
]>
+----------------------------------------
+
+Example
+
+----------------------------------------
+<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<licenses>
<license
Added: incubator/rat/whisker/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/rat/whisker/trunk/src/site/site.xml?rev=1195254&view=auto
==============================================================================
--- incubator/rat/whisker/trunk/src/site/site.xml (added)
+++ incubator/rat/whisker/trunk/src/site/site.xml Sun Oct 30 21:41:39 2011
@@ -0,0 +1,29 @@
+<?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.
+-->
+<project name="Apache Rat::Whisker">
+ <body>
+ <menu name='Whisker'>
+ <item name='Introduction' href='index.html'/>
+ <item name='Meta Data' href='meta-data.html'/>
+ </menu>
+
+ <menu ref='reports'/>
+ </body>
+</project>
\ No newline at end of file
Propchange: incubator/rat/whisker/trunk/src/site/site.xml
------------------------------------------------------------------------------
svn:eol-style = native