Difference between revisions of "Extensions GPL notices"

From Joomla! Documentation

(New page: {{incomplete}} {{RightTOC}} To list your file in JED under GPL license its required 3 things All source code files in the core Joomla distribution must contain the following comment block...)
 
m (→‎Additional Reading: clean up categories with <noinclude> tags)
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{incomplete}}
 
 
{{RightTOC}}
 
{{RightTOC}}
−
To list your file in JED under GPL license its required 3 things
+
To list your file in JED under a GPL license, you must include proper notices for the license chosen.
 +
Its easy as A, B, C!
  
−
All source code files in the core Joomla distribution must contain the following comment block as the header:
+
==(A) XML file==
−
 
+
A <license> tag in your extension's XML file and state it is licensed under the GPL,
−
==PHP files==
 
−
1- Notice at the top of each php file stating that it is distributed under the terms of the GPL
 
−
* see http://www.fsf.org/licensing/licenses/gpl-howto.html for details
 
−
 
 
−
as in this comment block as the header:
 
−
<source lang="php">
 
−
<?php
 
−
/**
 
−
* @extension Module XYZ for Joomla! 1.5
 
−
* @version $Id: mod_XYZ.php 599 2010-03-20 23:26:33Z you $
 
−
* @author YOUR NAME HERE
 
−
* @copyright (C) 2010- YOUR NAME HERE
 
−
* @license GNU/GPL http://www.gnu.org/copyleft/gpl.html
 
−
* @link http://www.yoursite.com
 
−
* Joomla! is free software. This version may have been modified pursuant
 
−
* to the GNU General Public License, and as distributed it includes or
 
−
* is derivative of works licensed under the GNU General Public License or
 
−
* other free or open source software licenses.
 
−
**/
 
−
</source>
 
−
 
 
−
==XML file==
 
−
A <license> tag in your extension's XML file stating that it is under GPL,
 
 
as in this tags for a module:
 
as in this tags for a module:
 
<source lang="php">
 
<source lang="php">
Line 36: Line 13:
 
<author>Author name goes here</author>
 
<author>Author name goes here</author>
 
<copyright>Copyright holder name goes here</copyright>
 
<copyright>Copyright holder name goes here</copyright>
−
<license>GNU/GPLv3 http://www.gnu.org/copyleft/gpl.html</license>
+
<license>GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html</license>
 
<authorEmail>you@youremail.com</authorEmail>
 
<authorEmail>you@youremail.com</authorEmail>
 
<authorUrl>http://www.yoursite.com</authorUrl>
 
<authorUrl>http://www.yoursite.com</authorUrl>
Line 42: Line 19:
 
<description>DESCRIPTION GOES HERE</description>
 
<description>DESCRIPTION GOES HERE</description>
 
</source>
 
</source>
−
For GPL you could use other versions of the license:
+
For GPL you can use other versions of the license, but GNU/GPLv3 is preferable:
 
* GNU/GPL http://www.gnu.org/copyleft/gpl.html
 
* GNU/GPL http://www.gnu.org/copyleft/gpl.html
 
* GNU/GPL v2 or later http://www.gnu.org/licenses/gpl-2.0.html
 
* GNU/GPL v2 or later http://www.gnu.org/licenses/gpl-2.0.html
 
* GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 
* GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  
−
==TXT file==
 
−
3- Provide a copy of the GPL license within your package
 
−
*note: this file doesn't need to be installed with the extension, just included with the package as a text file
 
  
−
==Libraries==
+
==(B) PHP files==
−
Libraries (Js scripts, flash) can be licensed under other licenses as in:
+
The file headers of an extension should contain a copyright notice and a notice that the file and extension is distributed under the terms of the GPL,
 +
as in this comment block:
 +
<source lang="php">
 +
<?php
 +
/**
 +
* @package Module XYZ for Joomla! 1.5
 +
* @version $Id: mod_XYZ.php 599 2010-03-20 23:26:33Z you $
 +
* @author YOUR NAME HERE
 +
* @copyright (C) 2010- YOUR NAME HERE
 +
* @license GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 +
**/
 +
</source>
 +
Note: Additional informations about the extension, author, copyright and version date are considered good practices
 +
 
 +
 
 +
==(C) TXT file==
 +
Provide a copy of the GPL license within your package
 +
* GNU GPL v2 text
 +
note: this file doesn't need to be installed with the extension, just included with the package as a text file
 +
 
 +
==Special cases==
 +
 
 +
===Tools===
 +
Tools for creating and maintaining Joomla! websites or for developing Joomla! extensions, but not meant to be installed or change core files in Joomla!, are listed under category "Tools". They can be licensed under other licenses
 +
* You must include a TXT file for license info
 +
 
 +
 
 +
===Independent Libraries===
 +
Libraries (as in Js scripts) single packed can be licensed under a GPL compatible license listed by the Free Software Foundation, as in LGPL:
 +
* LGPLv3 - http://www.gnu.org/licenses/lgpl-3.0.html
 +
You must include a TXT file for license info
 +
 
 +
 
 +
===Files packed with extensions===
 +
 
 +
====Libraries packed with extensions====
 +
Libraries which can stand alone (as in Js scripts) can be licensed under GPL compatible licenses as in:
 
* LGPLv3 - http://www.gnu.org/licenses/lgpl-3.0.html
 
* LGPLv3 - http://www.gnu.org/licenses/lgpl-3.0.html
 +
You must include a TXT file for license info and a statement in the extension XML file license tag
 +
 +
====Non code files====
 +
Non code files which can stand alone (as in Images, compiled flash files), packed with extensions, can be licensed under other licenses.
 +
* You must include a TXT file for license info and a statement in the extension XML file license tag
 +
 +
 +
==Additional Reading==
 +
Before submitting an extension to JED, please read:
 +
* FAQ: [[Extensions_and_GPL]]
 +
* JED editors Checklist: [[JED_Entries_License_Checklist]]
 +
 
 +
  
−
[[Category:JED]] [[Category:Licence]]
+
<noinclude>[[Category:JED]][[Category:Licence]]
 +
[[Category:FAQ]][[Category:Template Development]]
 +
[[Category:Module Development]]
 +
[[Category:Plugin Development]]
 +
[[Category:Component Development]]</noinclude>

Revision as of 15:22, 1 September 2012

To list your file in JED under a GPL license, you must include proper notices for the license chosen. Its easy as A, B, C!

(A) XML file[edit]

A <license> tag in your extension's XML file and state it is licensed under the GPL, as in this tags for a module: 

<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">
	<name>Extension name goes here</name>
	<creationDate>20 April 2010</creationDate>
	<author>Author name goes here</author>
	<copyright>Copyright holder name goes here</copyright>
	<license>GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html</license>
	<authorEmail>you@youremail.com</authorEmail>
	<authorUrl>http://www.yoursite.com</authorUrl>
	<version>1.0</version>
	<description>DESCRIPTION GOES HERE</description>

For GPL you can use other versions of the license, but GNU/GPLv3 is preferable:


(B) PHP files[edit]

The file headers of an extension should contain a copyright notice and a notice that the file and extension is distributed under the terms of the GPL, as in this comment block: 

<?php
/**
 * @package Module XYZ for Joomla! 1.5
 * @version $Id: mod_XYZ.php 599 2010-03-20 23:26:33Z you $
 * @author YOUR NAME HERE
 * @copyright (C) 2010- YOUR NAME HERE
 * @license GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
**/

Note: Additional informations about the extension, author, copyright and version date are considered good practices


(C) TXT file[edit]

Provide a copy of the GPL license within your package

  • GNU GPL v2 text

note: this file doesn't need to be installed with the extension, just included with the package as a text file

Special cases[edit]

Tools[edit]

Tools for creating and maintaining Joomla! websites or for developing Joomla! extensions, but not meant to be installed or change core files in Joomla!, are listed under category "Tools". They can be licensed under other licenses

  • You must include a TXT file for license info


Independent Libraries[edit]

Libraries (as in Js scripts) single packed can be licensed under a GPL compatible license listed by the Free Software Foundation, as in LGPL:

You must include a TXT file for license info


Files packed with extensions[edit]

Libraries packed with extensions[edit]

Libraries which can stand alone (as in Js scripts) can be licensed under GPL compatible licenses as in:

You must include a TXT file for license info and a statement in the extension XML file license tag

Non code files[edit]

Non code files which can stand alone (as in Images, compiled flash files), packed with extensions, can be licensed under other licenses.

  • You must include a TXT file for license info and a statement in the extension XML file license tag


Additional Reading[edit]

Before submitting an extension to JED, please read:

Retrieved from "https://docs.joomla.org/index.php?title=Extensions_GPL_notices&oldid=73502"