Author: MeredithLesly Date: 2006-07-06 13:58:12 -0500 (Thu, 06 Jul 2006) New Revision: 10838 Added: twiki/scratch/TWikiFns/EmptyFn/ twiki/scratch/TWikiFns/EmptyFn/data/ twiki/scratch/TWikiFns/EmptyFn/data/Sandbox/ twiki/scratch/TWikiFns/EmptyFn/data/Sandbox/TagTestEmptyFn.txt twiki/scratch/TWikiFns/EmptyFn/data/TWiki/ twiki/scratch/TWikiFns/EmptyFn/data/TWiki/EmptyFn.txt twiki/scratch/TWikiFns/EmptyFn/lib/ twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/ twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/Fns/ twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/Fns/EMPTY.pm twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/ twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn.pm twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/ twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/DEPENDENCIES twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/MANIFEST twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/build.pl twiki/scratch/TWikiFns/EmptyFn/test/ Log: First cut at EmptyFn Added: twiki/scratch/TWikiFns/EmptyFn/data/Sandbox/TagTestEmptyFn.txt =================================================================== --- twiki/scratch/TWikiFns/EmptyFn/data/Sandbox/TagTestEmptyFn.txt 2006-07-06 17:56:36 UTC (rev 10837) +++ twiki/scratch/TWikiFns/EmptyFn/data/Sandbox/TagTestEmptyFn.txt 2006-07-06 18:58:12 UTC (rev 10838) @@ -0,0 +1,4 @@ +%META:TOPICINFO{author="TWikiContributor" date="1042728360" format="1.0" version="$Rev$"}% +%META:TOPICPARENT{name="TWiki.EmptyPlugin"}% + +SOME EXAMPLES OF THE PLUGIN Added: twiki/scratch/TWikiFns/EmptyFn/data/TWiki/EmptyFn.txt =================================================================== --- twiki/scratch/TWikiFns/EmptyFn/data/TWiki/EmptyFn.txt 2006-07-06 17:56:36 UTC (rev 10837) +++ twiki/scratch/TWikiFns/EmptyFn/data/TWiki/EmptyFn.txt 2006-07-06 18:58:12 UTC (rev 10838) @@ -0,0 +1,44 @@ +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="$Rev: 9189 $"}% +---+ Empty TWiki Tag + +This is an empty Tag you can use as a template to build your own TWikiTag. + +---++ Syntax Rules + +(none) + +---++ Tag Settings + +Tag settings are stored as preferences variables. To reference +a plugin setting write ==%<nop><plugin>_<setting>%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%== + + * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic: + * Set SHORTDESCRIPTION = Empty Tag used as a template for new Tags + + * Your own setting, for example: + * Set EXAMPLE = got it! + + * Debug plugin: (See output in =data/debug.txt=) + * Set DEBUG = 0 + +---++ Tag Installation Instructions + + * This plugin is preinstalled, you do not need to install it. + +---++ Tag Info + +| Tag Author: | %MAINWEB%.MeredithLesly | +| Copyright: | © 2001-2006, %MAINWEB%.MeredithLesly | +| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | +| Tag Version: | 06 Jun 2006 | +| Change History: | <!-- versions below in reverse order --> | +| CPAN Dependencies: | none | +| Other Dependencies: | none | +| Perl Version: | 5.8 | +| Tag Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% | +| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | +| Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal | + +__Related Topics:__ %TWIKIWEB%.TWikiTags, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences + +-- %TWIKIWEB%.TWikiContributor - 01 Feb 2006 Added: twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/Fns/EMPTY.pm =================================================================== --- twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/Fns/EMPTY.pm 2006-07-06 17:56:36 UTC (rev 10837) +++ twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/Fns/EMPTY.pm 2006-07-06 18:58:12 UTC (rev 10838) @@ -0,0 +1 @@ +link ../UserFns/EmptyFn.pm \ No newline at end of file Property changes on: twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/Fns/EMPTY.pm ___________________________________________________________________ Name: svn:special + * Added: twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/DEPENDENCIES =================================================================== Added: twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/MANIFEST =================================================================== --- twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/MANIFEST 2006-07-06 17:56:36 UTC (rev 10837) +++ twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/MANIFEST 2006-07-06 18:58:12 UTC (rev 10838) @@ -0,0 +1,4 @@ +data/TWiki/EmptyFn.txt Tag doc page +lib/TWiki/UserFns/EmptyFn.pm Tag Perl module +lib/TWiki/Fns/EMPTY.pm Tag Perl module +data/Sandbox/FnTestEMPTY.txt Tag examples Added: twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/build.pl =================================================================== --- twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/build.pl 2006-07-06 17:56:36 UTC (rev 10837) +++ twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn/build.pl 2006-07-06 18:58:12 UTC (rev 10838) @@ -0,0 +1,52 @@ +#!/usr/bin/perl -w +# +# Example build class. Copy this file to the equivalent place in your +# plugin or contrib and edit. +# +# Read the comments at the top of lib/TWiki/Contrib/Build.pm for +# details of how the build process works, and what files you +# have to provide and where. +# +# Requires the environment variable TWIKI_LIBS (a colon-separated path +# list) to be set to point at the build system and any required dependencies. +# Usage: ./build.pl [-n] [-v] [target] +# where [target] is the optional build target (build, test, +# install, release, uninstall), test is the default.` +# Two command-line options are supported: +# -n Don't actually do anything, just print commands +# -v Be verbose +# + +# Standard preamble +BEGIN { + unshift @INC, split( /:/, $ENV{TWIKI_LIBS} ); +} + +use TWiki::Contrib::Build; + +# Declare our build package +package BuildBuild; +use base qw( TWiki::Contrib::Build ); + +sub new { + my $class = shift; + return bless( $class->SUPER::new( "EmptyTag" ), $class ); +} + +# Example: Override the build target +sub target_build { + my $this = shift; + + $this->SUPER::target_build(); + + # Do other build stuff here +} + +package main; + +# Create the build object +$build = new BuildBuild(); + +# Build the target on the command line, or the default target +$build->build($build->{target}); + Added: twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn.pm =================================================================== --- twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn.pm 2006-07-06 17:56:36 UTC (rev 10837) +++ twiki/scratch/TWikiFns/EmptyFn/lib/TWiki/UserFns/EmptyFn.pm 2006-07-06 18:58:12 UTC (rev 10838) @@ -0,0 +1,40 @@ +# Plugin for TWiki Enterprise Collaboration Platform, http://TWiki.org/ +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. For +# more details read LICENSE in the root of this distribution. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# +# For licensing info read LICENSE file in the TWiki root. +# +# '$Rev$' + +=pod + +---+ package EmptyFn + +This is an empty TWiki tag. It is a fully defined tag, but is +disabled by default in a TWiki installation. Use it as a template +for your own tags; see TWiki.TWikiTags for details. + +=cut + +# Always use strict to enforce variable scoping +use strict; + +use vars qw($tagname); + +$tagname = 'EMPTY'; + +sub EMPTY { + my ($session, $params, $topic, $web) = @_; + return ""; +} + +# Always return the function that implements the tag +return \&EMPTY; |