ProcessModuleLicense by kixe

Add a License Information to Module Info

MODULE LICENSE INFO

For Module Developers. This module makes license information visible in module info if set in ModuleInfo array

Use


if installed the two elements license and hreflicense could be added to any module.

public static function getModuleInfo() {

	return array(
		// other stuff
		'license' => 'CC-BY',
		'hreflicense' => 'http://creativecommons.org/licenses/by/4.0/'
	);
}

license

Shortcut of license name. I recommend to use a consistent Syntax.

Some Examples:

  • GNU-GPL
  • GNU-GPLv2
  • CC-BY-NC
  • OPL
  • MIT
  • EPL

hreflicense

Link to detailed license information. Will only be displayed if license is set.

You have 2 Options.

  • absolute url like

    'hreflicense' => 'http://creativecommons.org/licenses/by/4.0/'

  • relative url to repository file (stored in the modules folder)

    'hreflicense' => 'license.txt'

Displayed translatable linktext: read more

Screenshot


screenshot of module info

Wishlist & Roadmap


Implementation of this feature in core would be much easier. Read more:

processwire.com/talk/topic/5906-display-module-license-in-modules-directory

License


GNU-GPLv3

Author


kixe (Christoph Thelen)

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Latest news

  • ProcessWire Weekly #539
    In the 539th issue of ProcessWire Weekly we'll share the latest weekly update from Ryan, check out a new third party module called AltTextGPT, and more. Read on!
    Weekly.pw / 7 September 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer