| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/fml/faq.fml at 2021-05-18 |
| |
| | Rendered using Apache Maven Default Skin |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" /> |
| <title>Apache Whisker™ – Frequently Asked Questions</title> |
| <link rel="stylesheet" href="./css/maven-base.css" /> |
| <link rel="stylesheet" href="./css/maven-theme.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <link href="https://fonts.googleapis.com/css?family=Mate+SC" type="text/css" rel="stylesheet" /> |
| </head> |
| <body class="composite"> |
| <div id="banner"> |
| <div id="bannerLeft">Apache Whisker |
| </div> |
| <a href="https://www.apache.org/" id="bannerRight"><img src="https://www.apache.org/images/asf_logo_wide.jpg" alt="The Apache Software Foundation" title="The Apache Software Foundation"/></a> <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="breadcrumbs"> |
| <div class="xleft"> |
| <span id="publishDate">Last Published: 2021-05-18</span> |
|  | <span id="projectVersion">Version: 0.2-SNAPSHOT</span> |
| | <a href="http://www.apache.org/" class="externalLink" title="Apache">Apache</a> > |
| <a href="http://creadur.apache.org/" class="externalLink" title="Creadur">Creadur</a> > |
| <a href="http://creadur.apache.org/whisker/" class="externalLink" title="Whisker">Whisker</a> > |
| Frequently Asked Questions |
| </div> |
| <div class="xright"> </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="leftColumn"> |
| <div id="navcolumn"> |
| <h5>Apache Whisker™</h5> |
| <ul> |
| <li class="none"><a href="index.html" title="Introducing Whisker">Introducing Whisker</a></li> |
| <li class="none"><a href="meta-data.html" title="Meta Data">Meta Data</a></li> |
| <li class="none"><a href="apache-whisker-maven-plugin/index.html" title="Maven Plugin">Maven Plugin</a></li> |
| <li class="none"><a href="apache-whisker-cli/index.html" title="Command Line">Command Line</a></li> |
| <li class="none"><a href="apidocs/index.html" title="Javadocs">Javadocs</a></li> |
| <li class="none"><a href="xref/index.html" title="Source Cross-ref">Source Cross-ref</a></li> |
| <li class="none"><strong>FAQ</strong></li> |
| </ul> |
| <h5>Examples</h5> |
| <ul> |
| <li class="none"><a href="examples/in-5-mins.html" title="In 5 Minutes">In 5 Minutes</a></li> |
| <li class="none"><a href="examples/3rd-party-individual.html" title="3rd Party (Individual)">3rd Party (Individual)</a></li> |
| <li class="none"><a href="examples/3rd-party-corporate.html" title="3rd Party (Corporate)">3rd Party (Corporate)</a></li> |
| <li class="none"><a href="examples/3rd-party-group.html" title="3rd Party (Group)">3rd Party (Group)</a></li> |
| <li class="none"><a href="examples/license-family.html" title="License Family">License Family</a></li> |
| <li class="none"><a href="examples/copyright-notices.html" title="Copyright Notices">Copyright Notices</a></li> |
| </ul> |
| <h5>Sample Meta Data</h5> |
| <ul> |
| <li class="none"><a href="examples/james.xml" title="Apache James">Apache James</a></li> |
| <li class="none"><a href="examples/public-domain.xml" title="Public Domain">Public Domain</a></li> |
| <li class="none"><a href="examples/template-license.xml" title="Template License">Template License</a></li> |
| <li class="none"><a href="examples/license-family-sample.xml" title="License Family">License Family</a></li> |
| <li class="none"><a href="examples/3rd-party-individual-sample.xml" title="3rd Party (Individual)">3rd Party (Individual)</a></li> |
| <li class="none"><a href="examples/3rd-party-corporate-sample.xml" title="3rd Party (Corporate)">3rd Party (Corporate)</a></li> |
| <li class="none"><a href="examples/3rd-party-group-sample.xml" title="3rd Party (Group)">3rd Party (Group)</a></li> |
| <li class="none"><a href="examples/in-5-mins-sample.xml" title="MIT License">MIT License</a></li> |
| <li class="none"><a href="examples/copyright-notices-sample.xml" title="Copyright Notices">Copyright Notices</a></li> |
| </ul> |
| <h5>Apache Creadur ™</h5> |
| <ul> |
| <li class="none"><a href="http://creadur.apache.org" class="externalLink" title="Creadur Project Home">Creadur Project Home</a></li> |
| <li class="none"><a href="http://creadur.apache.org/rat" class="externalLink" title="Apache Rat">Apache Rat</a></li> |
| <li class="none"><a href="http://creadur.apache.org/tentacles" class="externalLink" title="Apache Tentacles">Apache Tentacles</a></li> |
| <li class="none"><a href="http://www.apache.org/security/" class="externalLink" title="Security">Security</a></li> |
| <li class="none"><a href="http://www.apache.org/licenses/" class="externalLink" title="License">License</a></li> |
| <li class="none"><a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">Sponsorship</a></li> |
| <li class="none"><a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a></li> |
| </ul> |
| <h5>The Apache Software Foundation</h5> |
| <ul> |
| <li class="none"><a href="http://www.apache.org/foundation" class="externalLink" title="About the Foundation">About the Foundation</a></li> |
| <li class="none"><a href="http://projects.apache.org" class="externalLink" title="The projects">The projects</a></li> |
| <li class="none"><a href="http://people.apache.org" class="externalLink" title="The people">The people</a></li> |
| <li class="none"><a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How we work">How we work</a></li> |
| <li class="none"><a href="http://www.apache.org/foundation/how-it-works.html#history" class="externalLink" title="Our history">Our history</a></li> |
| <li class="none"><a href="http://blogs.apache.org/foundation/" class="externalLink" title="News">News</a></li> |
| </ul> |
| <h5>Contribute</h5> |
| <ul> |
| <li class="none"><a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">Get Involved</a></li> |
| </ul> |
| <h5>Committer Info</h5> |
| <ul> |
| <li class="none"><a href="http://www.apache.org/dev/committers.html" class="externalLink" title="Committers' FAQ">Committers' FAQ</a></li> |
| <li class="none"><a href="http://www.apache.org/dev/new-committers-guide.html" class="externalLink" title="New Committers Guide">New Committers Guide</a></li> |
| <li class="none"><a href="http://planet.apache.org/committers/" class="externalLink" title="Plant Apache">Plant Apache</a></li> |
| <li class="none"><a href="http://community.apache.org/" class="externalLink" title="Community">Community</a></li> |
| <li class="none"><a href="http://www.apache.org/legal/" class="externalLink" title="Legal">Legal</a></li> |
| <li class="none"><a href="http://www.apache.org/foundation/marks/" class="externalLink" title="Branding">Branding</a></li> |
| <li class="none"><a href="http://www.apache.org/press/" class="externalLink" title="Media Relations">Media Relations</a></li> |
| </ul> |
| <h5>Project Documentation</h5> |
| <ul> |
| <li class="collapsed"><a href="project-info.html" title="Project Information">Project Information</a></li> |
| </ul> |
| <a href="https://maven.apache.org/" title="Maven" class="poweredBy"> |
| <img class="poweredBy" alt="Maven" src="https://maven.apache.org/images/logos/maven-feather.png" /> |
| </a> |
| </div> |
| </div> |
| <div id="bodyColumn"> |
| <div id="contentBox"> |
| <section> |
| <h2><a name="Frequently_Asked_Questions"></a><a name="top">Frequently Asked Questions</a></h2> |
| <p><b>Meta Data</b></p> |
| <ol style="list-style-type: decimal"> |
| <li><a href="#why-ids">Why Reference Licenses, Notices and Organisations by ID?</a></li> |
| <li><a href="#id-freedom">Am I Free to Pick Any ID?</a></li> |
| <li><a href="#name-freedom">Am I Free to Pick Any Name?</a></li> |
| <li><a href="#url-freedom">Am I Free to Pick Any URL?</a></li> |
| <li><a href="#parameter-name-freedom">Am I Free to Pick Any Name for a Parameter?</a></li> |
| <li><a href="#where-is-reference">Is a reference available?</a></li> |
| <li><a href="#what-is-primary">What do you mean by 'primary'?</a></li> |
| <li><a href="#primary-license-organisation-relationship">What is the relationship between the Primary License and the Primary Organsation?</a></li> |
| <li><a href="#what-is-org">What do you mean by an 'organisation'?</a></li> |
| <li><a href="#where-is-dtd">Does an organisation have to be a formal corporation or company?</a></li> |
| <li><a href="#third-party-individual">What about third party software licensed from an individual?</a></li> |
| <li><a href="#third-party-corporation">What about third party software licensed from a corporation?</a></li> |
| <li><a href="#third-party-ad-hoc">What about third party software licensed by an informal group?</a></li> |
| <li><a href="#organisation-verses-organization">Why organisation, not organization?</a></li> |
| <li><a href="#where-is-dtd">Is a DTD available?</a></li> |
| <li><a href="#why-dtd">Why only a DTD?</a></li> |
| <li><a href="#ide">I prefer to use an IDE. Can it help me write the meta-data?</a></li> |
| <li><a href="#how-root-dir">What represents the root directory?</a></li> |
| <li><a href="#how-dir-model">How are directories modeled?</a></li> |
| <li><a href="#why-dir-model">Why are directories modeled as a flat list?</a></li> |
| <li><a href="#how-contents">How are the contents of a distribution represented?</a></li> |
| <li><a href="#how-license-family">Are license families supported?</a></li> |
| <li><a href="#why-license-family">Why use templates for license families?</a></li> |
| <li><a href="#what-primary-copyright-notice">What do you mean by a primary copyright notice?</a></li> |
| <li><a href="#how-primary-copyright-notice">How do I add a primary copyright notice?</a></li> |
| <li><a href="#when-primary-copyright-notice">When do I need to add a primary copyright notice?</a></li> |
| <li><a href="#when--copyright-notice">When do I need to add a copyright notice for a license?</a></li> |
| <li><a href="#when-copyright-notice-vs-notice">Should I use a copyright-notice or a notice?</a></li> |
| <li><a href="#sample-meta-data">Are any samples available?</a></li></ol> |
| <p><b>Generating Licensing Documents</b></p> |
| <ol style="list-style-type: decimal"> |
| <li><a href="#when-notice">When will a NOTICE be generated?</a></li> |
| <li><a href="#when-source-links">Can Whisker Generate Source Links?</a></li></ol> |
| <p><b>Licensing</b></p> |
| <ol style="list-style-type: decimal"> |
| <li><a href="#what-whisker-is-not">Will Whisker Automagically Solve my Licensing Problems?</a></li> |
| <li><a href="#what-this-documentation-is-not">Can I rely on this documentation as legal advice?</a></li> |
| <li><a href="#what-is-a-license">What is a license?</a></li> |
| <li><a href="#what-license">What do you mean by <code>LICENSE</code>?</a></li> |
| <li><a href="#what-notice">What do you mean by <code>NOTICE</code>?</a></li> |
| <li><a href="#what-copyright-notice">What is a copyright notice?</a></li> |
| <li><a href="#notice-vs-copyright-notice">What is the difference between a <code>NOTICE</code> and a copyright notice?</a></li> |
| <li><a href="#notice-vs-license">What is the difference between a <code>NOTICE</code> and a <code>LICENSE</code>?</a></li> |
| <li><a href="#when-notice-needed">When is a <code>NOTICE</code> needed?</a></li> |
| <li><a href="#notice-needed-for-al2">Do I need to add a <code>NOTICE</code> for my Apache Licensed Project?</a></li> |
| <li><a href="#complex-software-applications">When is Whisker needed?</a></li> |
| <li><a href="#licensor">What do you mean by licensor?</a></li> |
| <li><a href="#what-is-downstream">What is a downstream consumer?</a></li> |
| <li><a href="#what-is-an-open-source-license">What is an Open Source License?</a></li> |
| <li><a href="#what-copyleft">What Do You Mean By Copyleft?</a></li> |
| <li><a href="#what-weak-copyleft">What Do You Mean By Weak Copyleft?</a></li> |
| <li><a href="#what-source-clause">What Do You Mean By Source Clause?</a></li> |
| <li><a href="#what-is-license-family">What do you mean by a license family?</a></li></ol> |
| <p><b>Is there an Example...</b></p> |
| <ol style="list-style-type: decimal"> |
| <li><a href="#mit-example">Using the MIT License?</a></li> |
| <li><a href="#no-notice-example">Of a Project without a NOTICE?</a></li> |
| <li><a href="#add-org-example">Of Adding an Organisation?</a></li> |
| <li><a href="#a3rd-party-individual-example">Of a Third Party Dependency licensed from an Individual?</a></li> |
| <li><a href="#a3rd-party-corporate-example">Of a Third Party Dependency licensed from a for- or non-profit organisation?</a></li> |
| <li><a href="#a3rd-party-individual-example">Of a Third Party Dependency licensed from an Informal Group?</a></li></ol> |
| <p><b>Learning</b></p> |
| <ol style="list-style-type: decimal"> |
| <li><a href="#more-resources">I'm interested in learning more about software licensing. Where should I start?</a></li></ol></section><section> |
| <h2><a name="Meta_Data"></a>Meta Data</h2> |
| <dl> |
| <dt><a name="why-ids">Why Reference Licenses, Notices and Organisations by ID?</a></dt> |
| <dd> |
| |
| <p> |
| <a class="externalLink" href="http://dbpedia.org/resource/Don't_repeat_yourself">DRY</a> rules. |
| </p> |
| |
| <p> |
| Each license, notice and organisation should be described once, and then |
| referenced by <code>id</code>. For complex projects, this reduces duplication |
| and eases maintenance. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="id-freedom">Am I Free to Pick Any ID?</a></dt> |
| <dd> |
| |
| <p> |
| IDs need to be unique (within the document) |
| but otherwise you are free. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="name-freedom">Am I Free to Pick Any Name?</a></dt> |
| <dd> |
| |
| <p> |
| Yes, but... |
| </p> |
| |
| <p> |
| Whisker adopts the convention that <code>name</code> attributes |
| (for example, on <code>license</code> elements) are used |
| for presentation, so it is strong recommended that a suitably |
| human-readable title is chosen. |
| </p> |
| |
| <p> |
| Where possibly, pick the standard name for this license: either the |
| title within the text, or the name adopted by a standards organisation |
| for example <a class="externalLink" href="http://www.opensource.org">The Open Source Initiative</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="url-freedom">Am I Free to Pick Any URL?</a></dt> |
| <dd> |
| |
| <p> |
| Whisker adopts the convention that <code>url</code> attributes |
| (for example, on <code>license</code> elements) are used to present |
| a reference location for a reader. It is recommended that a |
| standard URL is given, where possible, for example from the |
| <a class="externalLink" href="http://www.opensource.org">The Open Source Initiative</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="parameter-name-freedom">Am I Free to Pick Any Name for a Parameter?</a></dt> |
| <dd> |
| |
| <p> |
| Yes |
| </p> |
| |
| <p> |
| Where possible, we recommend reusing the name adopted by a standards organisation, |
| for example <a class="externalLink" href="http://www.opensource.org">The Open Source Initiative</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="where-is-reference">Is a reference available?</a></dt> |
| <dd> |
| |
| <p> |
| <a href="meta-data.html">Yes</a> |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-is-primary">What do you mean by 'primary'?</a></dt> |
| <dd> |
| |
| <p> |
| Whisker documentation often talks about a <em>primary license</em>, |
| a <em>primary organisation</em> and so on. |
| The meta-data contains elements like <code>primary-license</code> and |
| <code>primary-notice</code>. Though the intended meaning might accord |
| with intuition, a more precise description may help to deepen |
| understanding of software licensing. |
| </p> |
| |
| <p> |
| By <em>primary</em>, we mean the |
| main license, notice or organisation associated with the project. |
| Take, for example, a project here at <a class="externalLink" href="http://www.apache.org">Apache</a>. |
| In this case, the primary license would be |
| <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.html">The Apache License, Version 2</a> |
| (<abbr><code>AL2</code></abbr>) |
| and the primary organisation |
| <a class="externalLink" href="http://www.apache.org/foundation/">The Apache Software Foundation</a>. |
| </p> |
| |
| <p> |
| The <em>primary license</em> should cover most of the original content contributed |
| by the project to the software distributed. Apache, for example, |
| <a class="externalLink" href="http://www.apache.org/legal/src-headers.html">insists</a> that |
| original source is |
| <abbr><code>AL2</code></abbr> licensed. |
| The <em>primary organisation</em> should be the legal entity |
| issuing the primary license. Apache, for example, uses |
| <a class="externalLink" href="http://www.apache.org/licenses/index.html#clas">contributor license agreements</a>, |
| <a class="externalLink" href="http://www.apache.org/licenses/index.html#grants">grants</a> and |
| <code><abbr>AL2</abbr> Section 5</code> |
| to allow the foundation to issue open source licenses. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="primary-license-organisation-relationship">What is the relationship between the Primary License and the Primary Organsation?</a></dt> |
| <dd> |
| |
| <p> |
| The <em>primary license</em> covers most of the original content contributed |
| by the project to the software distributed. Apache, for example, |
| <a class="externalLink" href="http://www.apache.org/legal/src-headers.html">insists</a> that |
| original source is |
| <abbr><code>AL2</code></abbr> licensed. |
| </p> |
| |
| <p> |
| The <em>primary organisation</em> should be the legal entity |
| issuing the <em>primary license</em>. Apache, for example, uses |
| <a class="externalLink" href="http://www.apache.org/licenses/index.html#clas">contributor license agreements</a>, |
| <a class="externalLink" href="http://www.apache.org/licenses/index.html#grants">grants</a> and |
| <code><abbr>AL2</abbr> Section 5</code> |
| to allow the foundation to issue open source licenses. Alternatively |
| (as practiced by |
| <a class="externalLink" href="http://www.gnu.org/prep/maintain/html_node/Copyright-Papers.html#Copyright-Papers">GNU</a>, |
| for example) |
| copyright may be assigned to the organisation by its contributions. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-is-org">What do you mean by an 'organisation'?</a></dt> |
| <dd> |
| |
| <p> |
| Whisker uses <em>organisation</em> to identify and describe groups or individuals |
| who license the third party works distributed. This includes a wide variety of |
| entities, for example |
| </p> |
| |
| <ul> |
| |
| <li>non-profit corporations such as |
| <a class="externalLink" href="http://www.apache.org/foundation">The Apache Software Foundation</a>, |
| <a class="externalLink" href="http://www.fsf.org/about/">The Free Software Foundation</a> and |
| <a class="externalLink" href="http://www.gnome.org/foundation/">The GNOME Foundation</a>; |
| </li> |
| |
| <li> |
| for-profit corporations such as |
| VMWare Inc., Google Inc. and IBM Corporation; |
| </li> |
| |
| <li> |
| academic institutions such as the |
| <a class="externalLink" href="http://berkeley.edu/">University of California, Berkeley</a>, |
| the |
| <a class="externalLink" href="http://web.mit.edu/">Massachusetts Institute of Technology</a> and |
| <a class="externalLink" href="http://osuosl.org/">Oregon State University</a>; |
| </li> |
| |
| <li> |
| groups and collectives such as |
| <a class="externalLink" href="http://www.bouncycastle.org">The Legion of the Bouncy Castle</a> and |
| <a class="externalLink" href="http://www.joda.org">Joda</a> |
| </li> |
| |
| <li>and individual maintainers. |
| </li> |
| </ul> |
| |
| <p> |
| To reduce duplication and increase comprehension, Whisker often |
| groups results by organisation. |
| </p> |
| |
| <p> |
| See <a href="#add-org-example">here</a> for examples. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="where-is-dtd">Does an organisation have to be a formal corporation or company?</a></dt> |
| <dd> |
| |
| <p> |
| No |
| </p> |
| |
| <p> |
| As far as Whisker is concerned, |
| a wide variety of entities are organisations, |
| as well as some individual maintainers. |
| </p> |
| |
| <p> |
| Read more <a href="#what-is-org">here</a> and see comments |
| on <a href="#third-party-ad-hoc">informal groups</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="third-party-individual">What about third party software licensed from an individual?</a></dt> |
| <dd> |
| |
| <p> |
| As far as Whisker is concerned, each individual maintainer is an |
| organisation. |
| </p> |
| |
| <p> |
| See this |
| <a href="./examples/3rd-party-individual.html">example</a>. |
| </p> |
| |
| <p> |
| Read more <a href="#what-is-org">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="third-party-corporation">What about third party software licensed from a corporation?</a></dt> |
| <dd> |
| |
| <p> |
| As far as Whisker is concerned, each corporation (whether non-profit or for-profit) is an |
| organisation. |
| </p> |
| |
| <p> |
| See this |
| <a href="./examples/3rd-party-corporate.html">example</a>. |
| </p> |
| |
| <p> |
| Read more <a href="#what-is-org">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="third-party-ad-hoc">What about third party software licensed by an informal group?</a></dt> |
| <dd> |
| |
| <p> |
| As far as Whisker is concerned, each group or collective is an organisation. |
| You might want to check that the <a href="#licensor">licensor</a> |
| has the rights required to issue the license, |
| though, before adding it to your distribution. |
| </p> |
| |
| <p> |
| See this |
| <a href="./examples/3rd-party-group.html">example</a>. |
| </p> |
| |
| <p> |
| Read more <a href="#what-is-org">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="organisation-verses-organization">Why organisation, not organization?</a></dt> |
| <dd> |
| |
| <p> |
| No particular reason |
| </p> |
| |
| <p> |
| Apologies to those tripped up by this choice |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="where-is-dtd">Is a DTD available?</a></dt> |
| <dd> |
| |
| <p> |
| Yes, in the |
| <a href="meta-data.html#Described_By_DTD">meta data reference</a> |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="why-dtd">Why only a DTD?</a></dt> |
| <dd> |
| |
| <p> |
| The <a class="externalLink" href="http://www.xml.com/axml/target.html#dt-doctype">DTD</a> is |
| aimed at IDE users and developers, |
| and is not prescriptive but descriptive. |
| </p> |
| |
| <p> |
| For the present, schema validation is not enforced. |
| If it were, probably a language like |
| <a class="externalLink" href="http://relaxng.org/">Relax NG</a> would be chosen. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="ide">I prefer to use an IDE. Can it help me write the meta-data?</a></dt> |
| <dd> |
| |
| <p> |
| A DTD is available in the |
| <a href="meta-data.html#Described_By_DTD">meta data reference</a>, |
| which should be of some use. |
| </p> |
| |
| <p> |
| There are currently no known plugins. If you know of a plugin please |
| <a href="./mail-lists.html">let us know</a> or |
| <a href="./source-repository.html">contribute a patch</a> for this documentation. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="how-root-dir">What represents the root directory?</a></dt> |
| <dd> |
| |
| <p> |
| <code>.</code> |
| </p> |
| |
| <p> |
| As in <within dir='.'> |
| </p> |
| |
| <p> |
| Read how directories are modeled <a href="#how-dir-model">here</a> |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="how-dir-model">How are directories modeled?</a></dt> |
| <dd> |
| |
| <p> |
| Directories are modeled by a flat list of <code>within</code> |
| elements. |
| </p> |
| |
| <p> |
| Read why <a href="#why-dir-model">here</a> |
| </p> |
| |
| <p> |
| See how the root directory is modelled <a href="#how-root-dir">here</a> |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="why-dir-model">Why are directories modeled as a flat list?</a></dt> |
| <dd> |
| |
| <p> |
| Simplicity |
| </p> |
| |
| <p> |
| Within a file system, the containment relationship between |
| directories typically forms a natural tree. Modern file systems |
| typically allow cyclic links only with special links (for example, |
| <code>symbolic links</code> in |
| <a class="externalLink" href="http://dbpedia.org/resource/Unix-like">*nix</a>). |
| Including these links would allow directory containment |
| to become a graph. XML element containment forms a natural |
| tree structure, but representing a graph in XML requires |
| links to break this structure. |
| This would introduce more complexity |
| and more ways to make mistakes but little gain. |
| </p> |
| |
| <p> |
| Read how directories are modeled <a href="#how-dir-model">here</a> |
| </p> |
| |
| <p> |
| See how the root directory is modelled <a href="#how-root-dir">here</a> |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="how-contents">How are the contents of a distribution represented?</a></dt> |
| <dd> |
| |
| <p> |
| Resources are grouped |
| </p> |
| |
| <ul> |
| |
| <li><code>by-organisation</code></li> |
| |
| <li><code>with-license</code></li> |
| |
| <li><code>within</code> a directory.</li> |
| </ul> |
| |
| <p> |
| The directory structure is not represented by |
| nesting <code>within</code> elements. These elements are simply listed. |
| </p> |
| |
| <p> |
| See the <a href="#sample-meta-data">samples</a> for examples. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="how-license-family">Are license families supported?</a></dt> |
| <dd> |
| |
| <p> |
| Yes |
| </p> |
| |
| <p> |
| Add a template <code>license</code> and parameterise. |
| </p> |
| |
| <p> |
| Read how <a href="meta-data.html#Templates_For_License_Families">here</a>. |
| </p> |
| |
| <p> |
| Read the rational for templates <a href="#why-license-family">here</a>. |
| </p> |
| |
| <p> |
| See this <a href="examples/license-family.html">example</a>. |
| </p> |
| |
| <p> |
| Read more about license families <a href="#what-is-license-family">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="why-license-family">Why use templates for license families?</a></dt> |
| <dd> |
| |
| <p> |
| Templates are not strictly necessary. |
| </p> |
| <p> |
| Just pasting every complete license into the <code>text</code> would work, |
| though the meta-data would be less concise than using templates. |
| There is some additional work involved with drawing up each template, |
| so you might think that this is not a worthwhile tradeoff. |
| </p> |
| <p> |
| But there are reasons why using templates today may benefit a project |
| tomorrow. |
| </p> |
| |
| <p> |
| License families share important legal qualities. In the future, it should |
| be possible to |
| automate some licensing policy checks but only if licenses are |
| categorised in a form which enables automated reasoning. |
| Using a template for all members of a family is likely to help. |
| </p> |
| |
| <p> |
| Read more about license families <a href="#what-is-license-family">here</a>. |
| </p> |
| |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-primary-copyright-notice">What do you mean by a primary copyright notice?</a></dt> |
| <dd> |
| |
| <p> |
| An (optional) <a href="#what-copyright-notice">copyright notice</a>, |
| included in a <code>LICENSE</code> document but positioned above the license text |
| (rather than being part of it). For example, conventionally a copyright notice |
| is positioned above the |
| <a class="externalLink" href="http://opensource.org/licenses/mit-license.php/">MIT License</a> text. |
| </p> |
| |
| <p> |
| Learn about copyright notices <a href="#what-copyright-notice">here</a>. |
| </p> |
| |
| <p> |
| Read about the different between a <code>NOTICE</code> |
| and a copyright notice <a href="#notice-vs-copyright-notice">here</a>. |
| </p> |
| |
| <p> |
| Read about when you need to add a primary copyright notice |
| <a href="#when-primary-copyright-notice">here</a>. |
| </p> |
| |
| <p> |
| Read about how you need add a primary copyright notice |
| <a href="#how-primary-copyright-notice">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="how-primary-copyright-notice">How do I add a primary copyright notice?</a></dt> |
| <dd> |
| |
| <p> |
| Add a <code>copyright-notice</code> child to the <code>primary-license</code>. |
| See the example <a href="./examples/in-5-mins.html">here</a>. |
| </p> |
| |
| <p> |
| Learn about copyright notices <a href="#what-copyright-notice">here</a>. |
| </p> |
| |
| <p> |
| Read about the different between a <code>NOTICE</code> |
| and a copyright notice <a href="#notice-vs-copyright-notice">here</a>. |
| </p> |
| |
| <p> |
| Read about when you need to add a primary copyright notice |
| <a href="#when-primary-copyright-notice">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="when-primary-copyright-notice">When do I need to add a primary copyright notice?</a></dt> |
| <dd> |
| |
| <p> |
| <a href="#what-is-license-family">Template licenses</a> |
| (for example the |
| <a class="externalLink" href="http://opensource.org/licenses/BSD-2-Clause">BSD License 2 Clause</a>) |
| typically includes a |
| parameterised copyright notice. Licenses |
| <a href="#when-notice-needed">with</a> a <code>NOTICE</code> |
| (for example the |
| <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License, Version 2</a>) |
| usually include the copyright notice in the <code>NOTICE</code>. |
| </p> |
| <p> |
| Some other licenses (for example the |
| <a class="externalLink" href="http://opensource.org/licenses/mit-license.php/">MIT License</a>) |
| conventionally include a copyright notice above the text: |
| to use these licenses with Whisker, add a primary copyright notice |
| and use the plain license text. |
| </p> |
| |
| <p> |
| Learn about copyright notices <a href="#what-copyright-notice">here</a>. |
| </p> |
| |
| <p> |
| Read about the different between a <code>NOTICE</code> |
| and a copyright notice <a href="#notice-vs-copyright-notice">here</a>. |
| </p> |
| |
| <p> |
| Read about how you need add a primary copyright notice |
| <a href="#how-primary-copyright-notice">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="when--copyright-notice">When do I need to add a copyright notice for a license?</a></dt> |
| <dd> |
| |
| <p> |
| <a href="#what-is-license-family">Template licenses</a> |
| (for example the |
| <a class="externalLink" href="http://opensource.org/licenses/BSD-2-Clause">BSD License 2 Clause</a>) |
| typically includes a |
| parameterised copyright notice. Licenses |
| <a href="#when-notice-needed">with</a> a <code>NOTICE</code> |
| (for example the |
| <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License, Version 2</a>) |
| usually include the copyright notice in the <code>NOTICE</code>. When using these |
| licenses with Whisker, to set a copyright claim use the parameter or |
| <code>notice</code> rather than |
| the <code>copyright-notice</code> element. |
| </p> |
| <p> |
| Some other licenses (for example the |
| <a class="externalLink" href="http://opensource.org/licenses/mit-license.php/">MIT License</a>) |
| conventionally include a copyright notice above the text: |
| to use these licenses with Whisker, add a copyright notice |
| and use the plain license text. |
| </p> |
| |
| <p> |
| Learn about copyright notices <a href="#what-copyright-notice">here</a>. |
| </p> |
| |
| <p> |
| Read about the different between a <code>NOTICE</code> |
| and a copyright notice <a href="#notice-vs-copyright-notice">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="when-copyright-notice-vs-notice">Should I use a copyright-notice or a notice?</a></dt> |
| <dd> |
| |
| <p> |
| If the copyright claim belongs in the <code>LICENSE</code> document then |
| use a <code>copyright-notice</code>. |
| </p> |
| <p> |
| If the copyright claim belongs in the <code>NOTICE</code> |
| document then include it within a <code>notice</code>. |
| </p> |
| |
| <p> |
| Learn about copyright notices <a href="#what-copyright-notice">here</a>. |
| </p> |
| |
| <p> |
| Read about the different between a <code>NOTICE</code> |
| and a copyright notice <a href="#notice-vs-copyright-notice">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="sample-meta-data">Are any samples available?</a></dt> |
| <dd> |
| |
| <p> |
| Yes |
| </p> |
| |
| <p> |
| See |
| </p> |
| |
| <ul> |
| |
| <li> |
| <a href="./examples/james.xml">Apache James</a>, sample meta-data |
| for a complex open source application; |
| </li> |
| |
| <li> |
| <a href="./examples/template-license.xml">Template License</a>, an |
| annotated outline useful for new meta-data; or |
| </li> |
| |
| <li>simple annotated educational samples for |
| |
| <ul> |
| |
| <li> |
| <a href="./examples/public-domain.xml">public domain</a> |
| </li> |
| |
| <li> |
| <a href="./examples/license-family-sample.xml">license family</a> using a template |
| </li> |
| |
| <li> |
| Whisker In 5 Minutes featuring the |
| <a href="./examples/in-5-mins-sample.xml">MIT License</a> |
| </li> |
| |
| <li> |
| distributing work licensed from |
| |
| <ul> |
| |
| <li> |
| an <a href="./examples/3rd-party-individual-sample.xml">individual maintainer</a> |
| </li> |
| <li> |
| a for- or non-profit <a href="./examples/3rd-party-corporate-sample.xml">corporation</a> |
| </li> |
| <li> |
| an informal <a href="./examples/3rd-party-group-sample.xml">group</a> |
| </li> |
| |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| <p align="right"><a href="#top">[top]</a></p></dd></dl></section><section> |
| <h2><a name="Generating_Licensing_Documents"></a>Generating Licensing Documents</h2> |
| <dl> |
| <dt><a name="when-notice">When will a NOTICE be generated?</a></dt> |
| <dd> |
| |
| <p>Whisker should generate a <code>NOTICE</code> document only when |
| <a href="#when-notice-needed">needed</a>. |
| Examples include:</p> |
| |
| <ul> |
| |
| <li>when the primary notice is not empty; and</li> |
| |
| <li>when at least one distributed artifact requires an attribution.</li> |
| </ul> |
| |
| <p>If you have a use case where an unnecessary <code>NOTICE</code> is generated, |
| or when a <code>NOTICE</code> isn't generated when it is needed please open an |
| <a href="./issue-tracking.html">issue</a> or let us know |
| <a href="./mail-lists.html">on list</a>.</p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="when-source-links">Can Whisker Generate Source Links?</a></dt> |
| <dd> |
| |
| <p> |
| Yes - use the <code>source</code> element. |
| </p> |
| |
| <p> |
| Learn about the <code>source</code> element |
| <a href="./meta-data.html#Source_Links">here</a>. |
| </p> |
| |
| <p> |
| Learn about source clauses <a href="#what-source-clause">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p></dd></dl></section><section> |
| <h2><a name="Licensing"></a>Licensing</h2> |
| <dl> |
| <dt><a name="what-whisker-is-not">Will Whisker Automagically Solve my Licensing Problems?</a></dt> |
| <dd> |
| |
| <p> |
| No |
| </p> |
| |
| <p> |
| Whisker is just an efficient way to maintain licensing documentation for |
| <a href="#complex-software-applications">complex applications</a>. It is no |
| substitute for accurate legal legwork. |
| </p> |
| |
| <p> |
| Learn about copyright and software licensing <a href="#more-resources">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-this-documentation-is-not">Can I rely on this documentation as legal advice?</a></dt> |
| <dd> |
| |
| <p> |
| Most definitely <strong>no</strong> |
| </p> |
| |
| <p> |
| This documentation guides users assumed to have a practical understanding of the relevant |
| laws in appropriate jurisdictions. In order to explain how Whisker can help, |
| we need to agree some terms with the reader. |
| </p> |
| |
| <p> |
| Learn about copyright and software licensing <a href="#more-resources">here</a>. |
| </p> |
| |
| <p> |
| Intellectual property laws are complex, and vary from country to country. |
| Anyone looking for legal advice should consult the best lawyer they can. |
| We cannot help. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-is-a-license">What is a license?</a></dt> |
| <dd> |
| |
| <p> |
| In some general sense, a license is a permission. We're |
| thinking in particular about copyright or patent permissions. |
| </p> |
| |
| <p> |
| Whisker focuses on tracking explicit licenses, and so almost always |
| when we talk about a license, we're thinking about a |
| written document conditionally granting some copyright |
| and patents permissions for a work. |
| </p> |
| |
| <p> |
| Learn about copyright and software licensing <a href="#more-resources">here</a>. |
| </p> |
| |
| <p> |
| We adopt the convention <code>LICENSE</code> for the principle licensing |
| document. Read more about this convention <a href="#what-license">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-license">What do you mean by <code>LICENSE</code>?</a></dt> |
| <dd> |
| |
| <p> |
| We adopt the convention that <code>LICENSE</code> means the principle licensing |
| document for the project. |
| </p> |
| |
| <p> |
| Learn about copyright and software licensing <a href="#more-resources">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-notice">What do you mean by <code>NOTICE</code>?</a></dt> |
| <dd> |
| |
| <p> |
| A <code>NOTICE</code> is informational documentation, whose retention |
| is required by a license condition. |
| </p> |
| |
| <p> |
| Some licenses (for example the |
| <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License, Version 2</a>) |
| may require the retention of a document named <code>NOTICE</code> (or at least its contents). |
| By <code>NOTICE</code> we mean information that <code>MUST</code> be preserved |
| to satisfy some condition of a license. Take care not to confuse <code>NOTICE</code> with |
| <a href="#notice-vs-copyright-notice">copyright notice</a> or |
| <a href="#notice-vs-license"><code>LICENSE</code></a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-copyright-notice">What is a copyright notice?</a></dt> |
| <dd> |
| |
| <p> |
| A phrase or symbol informing a reader about a underlying claim of copyright ownership. |
| </p> |
| <p> |
| For example <em>"Copyright (c) 2525 Apache Software Foundation"</em> |
| </p> |
| <p> |
| Though copyright laws differ from country to country, copyright notices |
| are may well be considered important, and may be governed by statue. |
| </p> |
| |
| <p> |
| Take care not to confuse copyright notice with |
| <a href="#notice-vs-copyright-notice"><code>NOTICE</code></a>. |
| </p> |
| |
| <p> |
| Learn about copyright and software licensing <a href="#more-resources">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="notice-vs-copyright-notice">What is the difference between a <code>NOTICE</code> and a copyright notice?</a></dt> |
| <dd> |
| |
| <p> |
| A <code>NOTICE</code> is informational documentation, whereas a copyright notice |
| informs a reader about a legal claim of ownership. A license may be conditional |
| on the redistribution of the contents of a <code>NOTICE</code> but typically |
| a copyright notice is governed directly by statue. |
| </p> |
| <p> |
| A <code>NOTICE</code> document often contains |
| copyright notices, but is not limited to just this sort of content. |
| </p> |
| |
| <p> |
| Read more on <code>NOTICE</code> documents <a href="#what-notice">here</a>. |
| </p> |
| |
| <p> |
| Read more on copyright notices <a href="#what-copyright-notice">here</a>. |
| </p> |
| |
| <p> |
| Learn about copyright and software licensing <a href="#more-resources">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="notice-vs-license">What is the difference between a <code>NOTICE</code> and a <code>LICENSE</code>?</a></dt> |
| <dd> |
| |
| <p> |
| A <code>NOTICE</code> is informational documentation, whereas a <code>LICENSE</code> |
| is legal documentation. |
| A <code>NOTICE</code> may be subject to a <a href="#when-notice-needed">retention clause</a>. |
| </p> |
| |
| <p> |
| Read more on <code>NOTICE</code> documents <a href="#what-notice">here</a>. |
| </p> |
| |
| <p> |
| Learn about copyright and software licensing <a href="#more-resources">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="when-notice-needed">When is a <code>NOTICE</code> needed?</a></dt> |
| <dd> |
| |
| <p> |
| It depends :-) |
| </p> |
| |
| <p> |
| Some licenses require <code>NOTICE</code> documents to be retained. |
| For example, clause 4.4 in the |
| <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License, Version 2</a> |
| is a retention clause covering any <code>NOTICE</code> distributed with the original. |
| When creating or distributing a modified version of a project licensed with a retention clause, |
| you need to ensure that the <code>NOTICE</code> is distributed. |
| </p> |
| |
| <p> |
| Read more on <code>NOTICE</code> documents <a href="#what-notice">here</a>. |
| </p> |
| |
| <p> |
| Learn about copyright and software licensing <a href="#more-resources">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="notice-needed-for-al2">Do I need to add a <code>NOTICE</code> for my Apache Licensed Project?</a></dt> |
| <dd> |
| |
| <p> |
| Not necessarily, though Apache Software Foundation projects |
| MUST include a <code>NOTICE</code> |
| of <a class="externalLink" href="http://www.apache.org/legal/src-headers.html#notice">standard form</a>. |
| </p> |
| |
| <p> |
| The <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License, Version 2</a> |
| requires that a <code>NOTICE</code> is retained but if your project contains only |
| original files then you could opt not to have a <code>NOTICE</code>. Please read |
| <a href="#when-notice-needed">this</a>. |
| </p> |
| |
| <p> |
| It is polite to include a minimal <code>NOTICE</code>. Otherwise, |
| <a href="#what-is-downstream">downstream consumers</a> may need to manually verify that no |
| <code>NOTICE</code> exists |
| for the release. |
| </p> |
| |
| <p> |
| Read more on <code>NOTICE</code> documents <a href="#what-notice">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="complex-software-applications">When is Whisker needed?</a></dt> |
| <dd> |
| |
| <p> |
| For projects distributing applications containing only a few third party dependencies, |
| manually maintaining and verifying the <code>LICENSE</code> and <code>NOTICE</code> documents |
| shipped is not a major burden. When releasing complex applications containing scores of |
| third party dependencies from dozens of sources, producing accurate licensing documentation |
| without automation takes a lot of time. This is where Whisker has the biggest value. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="licensor">What do you mean by licensor?</a></dt> |
| <dd> |
| |
| <p> |
| The entity issuing the license. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-is-downstream">What is a downstream consumer?</a></dt> |
| <dd> |
| |
| <p> |
| Software flows downstream from the source to the end user. |
| Dependencies are <em>upstream</em> of a project, and software |
| that relies on a project are <em>downstream consumers</em>. |
| </p> |
| |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-is-an-open-source-license">What is an Open Source License?</a></dt> |
| <dd> |
| |
| <p> |
| An open-source license complies with the |
| <a class="externalLink" href="http://opensource.org/docs/osd">Open Source Definition</a>. |
| Open Source Licenses are those on this |
| <a class="externalLink" href="http://opensource.org/licenses/index.html">list</a>. |
| Both are maintained by the |
| <a class="externalLink" href="http://www.opensource.org">Open Source Initiative</a>. |
| </p> |
| |
| <p> |
| Learn more about Open Source <a class="externalLink" href="http://opensource.org/history">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-copyleft">What Do You Mean By Copyleft?</a></dt> |
| <dd> |
| |
| <p> |
| A reciprocal |
| <a href="#what-is-an-open-source-license">open source</a> |
| copyright |
| <a href="#what-is-a-license">license</a> |
| limiting some rights of <a href="#what-is-downstream">downstream consumers</a> |
| to distribute under more restrictive licenses |
| (following <a class="externalLink" href="http://www.rosenlaw.com/oslbook.htm" target="_blank">Open Source Licensing</a>, |
| Lawrence Rosen). |
| </p> |
| |
| <p> |
| Read more about copyleft <a class="externalLink" href="http://www.gnu.org/copyleft/" target="_blank">here</a>. |
| </p> |
| |
| <p> |
| Read more about open source licenses <a href="#more-resources">here</a>. |
| </p> |
| |
| <p> |
| Learn more about Free Software <a class="externalLink" href="http://www.fsf.org/" target="_blank">here</a>. |
| </p> |
| |
| <p> |
| Learn more about weak copyleft <a href="#what-weak-copyleft">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-weak-copyleft">What Do You Mean By Weak Copyleft?</a></dt> |
| <dd> |
| |
| <p> |
| A <a href="#what-copyleft">copyleft</a> license that allows some forms |
| of derivative work to be distributed under more restrictive licenses |
| by <a href="#what-is-downstream">downstream consumers</a>. |
| </p> |
| |
| <p> |
| Read more about copyleft <a href="#what-copyleft">here</a>. |
| </p> |
| |
| <p> |
| Read more about open source licenses <a href="#more-resources">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-source-clause">What Do You Mean By Source Clause?</a></dt> |
| <dd> |
| |
| <p> |
| Some (typically <a href="#what-weak-copyleft">weak copyleft</a>) |
| <a href="#what-is-an-open-source-license">open source</a> |
| licenses ask that distributors of binaries built from their sources |
| facilitate <a href="#what-is-downstream">downstream consumers</a> |
| in obtaining the source for the distributed binary. |
| The part of the license explaining exactly |
| what this means we refer to as a <em>source clause</em>. |
| </p> |
| |
| <p> |
| For example, the |
| <a class="externalLink" href="http://www.opensource.org/licenses/CDDL-1.0" target="_blank">CDDL 1.0</a> |
| contains: |
| </p> |
| |
| <blockquote> |
| |
| <p>3.1. Availability of Source Code.</p> |
| |
| <p> |
| Any Covered Software that You distribute or otherwise make available in Executable form must |
| also be made available in Source Code form and that Source Code form must be distributed |
| only under the terms of this License. You must include a copy of this License with every |
| copy of the Source Code form of the Covered Software You distribute or otherwise make |
| available. You must inform recipients of any such Covered Software in Executable form as to |
| how they can obtain such Covered Software in Source Code form in a reasonable manner on or |
| through a medium customarily used for software exchange. |
| </p> |
| </blockquote> |
| |
| <p> |
| A distributor of CDDL licensed materials should consider including |
| (within the distribution) either the source, or information about how the source |
| could be obtain - perhaps in the form of an URL linking to the source. |
| </p> |
| |
| <p> |
| Source clauses differ. Read, |
| understand and comply with each. The term <em>source clause</em> |
| is a useful |
| <a class="externalLink" href="http://en.wiktionary.org/wiki/aide-m%C3%A9moire#English">aide memoire</a>: |
| |
| when a license has a source clause distributors need to remember to act to |
| satisfy it. |
| </p> |
| |
| <p> |
| Learn how Whisker can help <a href="#when-source-links">here</a>. |
| </p> |
| |
| <p> |
| Learn about copyright and software licensing |
| <a href="#more-resources">here</a>. |
| </p> |
| |
| <p> |
| Read more about licenses <a href="#what-is-a-license">here</a>. |
| </p> |
| |
| <p> |
| Read more about weak copyleft licenses |
| <a href="#what-weak-copyleft">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="what-is-license-family">What do you mean by a license family?</a></dt> |
| <dd> |
| |
| <p> |
| <a href="#what-is-an-open-source-license">Open source licenses</a> |
| are designed to be re-usable: |
| both you and I can use the same basic text to license our works. |
| Many license texts can be reused without modification (for example, |
| the <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License, Version 2</a>). |
| Others require that a small number of details are changed. |
| </p> |
| |
| <p>For example, to use the |
| <a class="externalLink" href="http://opensource.org/licenses/BSD-2-Clause">BSD License (2 Clause)</a> |
| your name, organisation and the year of publication must be inserted. We call |
| licenses of this sort a <em>license family</em> to emphasis that the text is |
| a template from which instances of the licenses are created by parameterisation. |
| </p> |
| |
| <p> |
| Each family shares the share legal qualities, typically differing only in details |
| related |
| to the act of publication. Knowing that a license belongs to a family allows |
| knowledge about that family to be applied without extensive analysis of the text. |
| So, for example, even though BSD License (2 Clause) texts differ we can confidently |
| state that each is an |
| <a href="#what-is-an-open-source-license">Open Source License</a>. |
| </p> |
| |
| <p> |
| Learn how Whisker supports license families <a href="#how-license-family">here</a>. |
| </p> |
| |
| <p> |
| Read more about licenses <a href="#what-is-a-license">here</a>. |
| </p> |
| |
| <p> |
| Learn about copyright and software licensing <a href="#more-resources">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p></dd></dl></section><section> |
| <h2><a name="Is_there_an_Example..."></a>Is there an Example...</h2> |
| <dl> |
| <dt><a name="mit-example">Using the MIT License?</a></dt> |
| <dd> |
| |
| <p><a href="examples/in-5-mins.html">Yes</a></p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="no-notice-example">Of a Project without a NOTICE?</a></dt> |
| <dd> |
| |
| <p><a href="examples/in-5-mins.html">Yes</a></p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="add-org-example">Of Adding an Organisation?</a></dt> |
| <dd> |
| |
| <p>Yes</p> |
| |
| <p>Including examples focussing on</p> |
| |
| <ul> |
| |
| <li> |
| <a href="examples/3rd-party-individual.html">an individual maintainer</a> |
| </li> |
| |
| <li><a href="examples/3rd-party-corporate.html">a corporation</a></li> |
| |
| <li><a href="examples/3rd-party-group.html">an informal group</a></li> |
| </ul> |
| |
| <p> |
| Read more about organisations <a href="#what-is-org">here</a>. |
| </p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="a3rd-party-individual-example">Of a Third Party Dependency licensed from an Individual?</a></dt> |
| <dd> |
| |
| <p><a href="examples/3rd-party-individual.html">Yes</a></p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="a3rd-party-corporate-example">Of a Third Party Dependency licensed from a for- or non-profit organisation?</a></dt> |
| <dd> |
| |
| <p><a href="examples/3rd-party-corporate.html">Yes</a></p> |
| |
| <p align="right"><a href="#top">[top]</a></p><hr /></dd> |
| <dt><a name="a3rd-party-individual-example">Of a Third Party Dependency licensed from an Informal Group?</a></dt> |
| <dd> |
| |
| <p><a href="examples/3rd-party-group.html">Yes</a></p> |
| |
| <p align="right"><a href="#top">[top]</a></p></dd></dl></section><section> |
| <h2><a name="Learning"></a>Learning</h2> |
| <dl> |
| <dt><a name="more-resources">I'm interested in learning more about software licensing. Where should I start?</a></dt> |
| <dd> |
| |
| <p> |
| Some recommended resources |
| </p> |
| |
| <ul> |
| |
| <li><a class="externalLink" href="http://www.rosenlaw.com/oslbook.htm">Open Source Licensing</a> by Lawrence Rosen</li> |
| |
| <li><a class="externalLink" href="http://www.softwarefreedom.org/">Software Freedom Law Center</a> |
| <a class="externalLink" href="http://www.softwarefreedom.org/resources/">publications</a></li> |
| |
| <li><a class="externalLink" href="http://www.ifosslr.org/">International Free and Open Source Software Law Review</a></li> |
| |
| <li><a class="externalLink" href="http://ifosslawbook.org">The International Free and Open Source Software Law Book</a></li> |
| </ul> |
| |
| |
| <p align="right"><a href="#top">[top]</a></p></dd></dl></section> |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright"> |
| Copyright © 2012 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache Creadur, Creadur, Apache Rat, Apache Tentacles, Apache Whisker, Apache and the Apache feather logo are trademarks |
| of The Apache Software Foundation. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| This is user documentation, not legal advice. |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| </body> |
| </html> |