[Bps-public-commit] r12278 - RTFM-Extension-ArticleTemplate/lib/RTFM/Extension
ruz at bestpractical.com
ruz at bestpractical.com
Mon May 12 18:19:44 EDT 2008
Author: ruz
Date: Mon May 12 18:19:44 2008
New Revision: 12278
Modified:
RTFM-Extension-ArticleTemplate/lib/RTFM/Extension/ArticleTemplates.pm
Log:
* docs
Modified: RTFM-Extension-ArticleTemplate/lib/RTFM/Extension/ArticleTemplates.pm
==============================================================================
--- RTFM-Extension-ArticleTemplate/lib/RTFM/Extension/ArticleTemplates.pm (original)
+++ RTFM-Extension-ArticleTemplate/lib/RTFM/Extension/ArticleTemplates.pm Mon May 12 18:19:44 2008
@@ -2,129 +2,43 @@
our $VERSION = '0.01';
-use warnings;
use strict;
-use Carp;
-
+use warnings;
=head1 NAME
-RTFM::Extension::ArticleTemplates - [One line description of module's purpose here]
-
-
-=head1 SYNOPSIS
-
- use RTFM::Extension::ArticleTemplates;
+RTFM::Extension::ArticleTemplates - turns articles' custom fields into templates.
-=for author to fill in:
- Brief code example(s) here showing commonest usage(s).
- This section will be as far as many users bother reading
- so make it as educational and exeplary as possible.
-
-
=head1 DESCRIPTION
-=for author to fill in:
- Write a full description of the module and its features here.
- Use subsections (=head2, =head3) as appropriate.
-
-
-=head1 METHODS
-
-=cut
-
-=head2 bla
-
-This is a method.
-
-=cut
-
-sub bla {
- my $self = shift;`
-}
-
-
-
-=head1 DIAGNOSTICS
-
-=for author to fill in:
- List every single error and warning message that the module can
- generate (even the ones that will "never happen"), with a full
- explanation of each problem, one or more likely causes, and any
- suggested remedies.
-
-=over
-
-=item C<< Error message here, perhaps with %s placeholders >>
+When this extension is installed RTFM parses content of articles as
+a template using L<Text::Template> module. Using this extension you can
+make your articles dynamic. L<Text::Template> module is used to parse
+RT's Templates as well and its syntax is pretty simple - you can consult
+RT docs/wiki or module's documentation.
-[Description of error here]
+=head1 VERY IMPORTANT
-=item C<< Another error message here >>
+It's a B<SECURITY RISK> to install this extension on systems where
+articles can be changed by not trusted users. You're warned!
-[Description of error here]
+Your articles may contain some text that looks like a template and
+will be parsed after installation when it's actually is not valid
+template.
-[Et cetera, et cetera]
+=head1 INSTALLATION
-=back
-
-
-=head1 CONFIGURATION AND ENVIRONMENT
-
-=for author to fill in:
- A full explanation of any configuration system(s) used by the
- module, including the names and locations of any configuration
- files, and the meaning of any environment variables or properties
- that can be set. These descriptions must also include details of any
- configuration language used.
-
-RTFM::Extension::ArticleTemplates requires no configuration files or environment variables.
-
-
-=head1 DEPENDENCIES
-
-=for author to fill in:
- A list of all the other modules that this module relies upon,
- including any restrictions on versions, and an indication whether
- the module is part of the standard Perl distribution, part of the
- module's distribution, or must be installed separately. ]
-
-None.
-
-
-=head1 INCOMPATIBILITIES
-
-=for author to fill in:
- A list of any modules that this module cannot be used in conjunction
- with. This may be due to name conflicts in the interface, or
- competition for system or program resources, or due to internal
- limitations of Perl (for example, many modules that use source code
- filters are mutually incompatible).
-
-None reported.
-
-
-=head1 BUGS AND LIMITATIONS
-
-=for author to fill in:
- A list of known problems with the module, together with some
- indication Whether they are likely to be fixed in an upcoming
- release. Also a list of restrictions on the features the module
- does provide: data types that cannot be handled, performance issues
- and the circumstances in which they may arise, practical
- limitations on the size of data sets, special cases that are not
- (yet) handled, etc.
-
-No bugs have been reported.
-
-Please report any bugs or feature requests to
-C<bug-rtfm-extension-articletemplates at rt.cpan.org>, or through the web interface at
-L<http://rt.cpan.org>.
+This extension requires RTFM 2.2.2 at least. To install it run the following
+commands:
+ perl Makefile.PL
+ make
+ make install
=head1 AUTHOR
Kevin Falcone C<< <falcone at bestpractical.com> >>
-
+Ruslan Zakirov C<< <ruz at bestpractical.com> >>
=head1 LICENCE AND COPYRIGHT
@@ -133,30 +47,6 @@
This module is free software; you can redistribute it and/or
modify it under the terms of version 2 of the GNU General Public License.
-
-=head1 DISCLAIMER OF WARRANTY
-
-BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
-EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
-ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
-YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
-NECESSARY SERVICING, REPAIR, OR CORRECTION.
-
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
-LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
-OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
-THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
=cut
1;
More information about the Bps-public-commit
mailing list