Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

software::license::custom(3pm) [debian man page]

Software::License::Custom(3pm)				User Contributed Perl Documentation			    Software::License::Custom(3pm)

NAME
Software::License::Custom - custom license handler VERSION
version 0.103004 DESCRIPTION
This module extends Software::License to give the possibility of specifying all aspects related to a software license in a custom file. This allows for setting custom dates, notices, etc. while still preserving compatibility with all places where Software::License is used, e.g. Dist::Zilla. In this way, you should be able to customise some aspects of the licensing messages that would otherwise be difficult to tinker, e.g. adding a note in the notice, setting multiple years for the copyright notice or set multiple authors and/or copyright holders. The license details should be put inside a file that contains different sections. Each section has the following format: header line This is a line that begins and ends with two underscores "__". The string between the begin and the end of the line is first depured of any non-word character, then used as the name of the section; body a Text::Template (possibly a plain text file) where items to be expanded are enclosed between double braces Each section is terminated by the header of the following section or by the end of the file. Example: __[ NAME ]__ The Foo-Bar License __URL__ http://www.example.com/foo-bar.txt __[ META_NAME ]__ foo_bar_meta __{ META2_NAME }__ foo_bar_meta2 __[ NOTICE ]__ Copyright (C) 2000-2002 by P.R. Evious Copyright (C) {{$self->year}} by {{$self->holder}}. This is free software, licensed under {{$self->name}}. __[ LICENSE ]__ The Foo-Bar License Well... this is only some sample text. Verily... only sample text!!! Yes, spanning more lines and more paragraphs. The different formats for specifying the section name in the example above are only examples, you're invited to use a consistent approach. METHODS
new my $slc = Software::License::Custom->new({filename => 'LEGAL'}); Create a new object. Arguments are passed through an anonymous hash, the following keys are allowed: filename - the file where the custom software license details are stored load_sections_from $slc->load_sections_from('MY-LEGAL-ASPECTS'); Loads the different sections of the license from the provided filename. Returns the input object. section_data my $notice_template_reference = $slc->section_data('NOTICE'); Returns a reference to a textual template that can be fed to Text::Template (it could be simple text), according to what is currently loaded in the object. MORE METHODS
The following methods, found in all software license classes, look up and render the template with the capitalized form of their name. In other words, the "license" method looks in the "LICENSE" template. For now, the "meta_name" and "meta2_name" methods return "custom" if called on the class. This may become fatal in the future. o name o url o meta_name o meta2_name o license o notice o fulltext o version AUTHOR
Ricardo Signes <rjbs@cpan.org> COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Ricardo Signes. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. perl v5.14.2 2012-03-23 Software::License::Custom(3pm)

Check Out this Related Man Page

Locale::Maketext::Extract::Plugin::TextTemplate(3)	User Contributed Perl Documentation	Locale::Maketext::Extract::Plugin::TextTemplate(3)

NAME
Locale::Maketext::Extract::Plugin::TextTemplate - Text::Template format parser VERSION
version 0.99 SYNOPSIS
$plugin = Locale::Maketext::Extract::Plugin::TextTemplate->new( $lexicon # A Locale::Maketext::Extract object @file_types # Optionally specify a list of recognised file types ) $plugin->extract($filename,$filecontents); DESCRIPTION
Extracts strings to localise from Text::Template files SHORT PLUGIN NAME
text VALID FORMATS
Sentences between STARTxxx and ENDxxx are extracted individually. KNOWN FILE TYPES
All file types SEE ALSO
xgettext.pl for extracting translatable strings from common template systems and perl source files. Locale::Maketext::Lexicon Locale::Maketext::Extract::Plugin::Base Locale::Maketext::Extract::Plugin::FormFu Locale::Maketext::Extract::Plugin::Perl Locale::Maketext::Extract::Plugin::TT2 Locale::Maketext::Extract::Plugin::YAML Locale::Maketext::Extract::Plugin::Mason Locale::Maketext::Extract::Plugin::Generic AUTHORS
Audrey Tang <cpan@audreyt.org> COPYRIGHT
Copyright 2002-2013 by Audrey Tang <cpan@audreyt.org>. This software is released under the MIT license cited below. The "MIT" License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. AUTHORS
o Clinton Gormley <drtech@cpan.org> o Audrey Tang <cpan@audreyt.org> COPYRIGHT AND LICENSE
This software is Copyright (c) 2014 by Audrey Tang. This is free software, licensed under: The MIT (X11) License perl v5.18.2 2014-02-03 Locale::Maketext::Extract::Plugin::TextTemplate(3)
Man Page

Featured Tech Videos