Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

wiki::toolkit::setup::pg(3pm) [debian man page]

Wiki::Toolkit::Setup::Pg(3pm)				User Contributed Perl Documentation			     Wiki::Toolkit::Setup::Pg(3pm)

NAME

       Wiki::Toolkit::Setup::Pg - Set up tables for a Wiki::Toolkit store in a Postgres database.

SYNOPSIS

	 use Wiki::Toolkit::Setup::Pg;
	 Wiki::Toolkit::Setup::Pg::setup($dbname, $dbuser, $dbpass, $dbhost);

       Omit $dbhost if the database is local.

DESCRIPTION

       Set up a Postgres database for use as a Wiki::Toolkit store.

FUNCTIONS

       setup
	     use Wiki::Toolkit::Setup::Pg;
	     Wiki::Toolkit::Setup::Pg::setup($dbname, $dbuser, $dbpass, $dbhost);

	   or

	     Wiki::Toolkit::Setup::Pg::setup( $dbh );

	   You can either provide an active database handle $dbh or connection parameters.

	   If you provide connection parameters the following arguments are mandatory -- the database name, the username and the password. The
	   username must be able to create and drop tables in the database.

	   The $dbhost argument is optional -- omit it if the database is local.

	   NOTE: If a table that the module wants to create already exists, "setup" will leave it alone. This means that you can safely run this
	   on an existing Wiki::Toolkit database to bring the schema up to date with the current Wiki::Toolkit version. If you wish to completely
	   start again with a fresh database, run "cleardb" first.

       cleardb
	     use Wiki::Toolkit::Setup::Pg;

	     # Clear out all Wiki::Toolkit tables from the database.
	     Wiki::Toolkit::Setup::Pg::cleardb($dbname, $dbuser, $dbpass, $dbhost);

	   or

	     Wiki::Toolkit::Setup::Pg::cleardb( $dbh );

	   You can either provide an active database handle $dbh or connection parameters.

	   If you provide connection parameters the following arguments are mandatory -- the database name, the username and the password. The
	   username must be able to drop tables in the database.

	   The $dbhost argument is optional -- omit it if the database is local.

	   Clears out all Wiki::Toolkit store tables from the database. NOTE that this will lose all your data; you probably only want to use this
	   for testing purposes or if you really screwed up somewhere. Note also that it doesn't touch any Wiki::Toolkit search backend tables; if
	   you have any of those in the same or a different database see Wiki::Toolkit::Setup::DBIxFTS or Wiki::Toolkit::Setup::SII, depending on
	   which search backend you're using.

ALTERNATIVE CALLING SYNTAX

       As requested by Podmaster.  Instead of passing arguments to the methods as

	 ($dbname, $dbuser, $dbpass, $dbhost)

       you can pass them as

	 ( { dbname => $dbname,
	     dbuser => $dbuser,
	     dbpass => $dbpass,
	     dbhost => $dbhost
	   }
	 )

       or indeed as

	 ( { dbh => $dbh } )

       Note that's a hashref, not a hash.

AUTHOR

       Kake Pugh (kake@earth.li).

COPYRIGHT

	    Copyright (C) 2002-2004 Kake Pugh.	All Rights Reserved.
	    Copyright (C) 2006-2008 the Wiki::Toolkit team. All Rights Reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

       Wiki::Toolkit, Wiki::Toolkit::Setup::DBIxFTS, Wiki::Toolkit::Setup::SII

perl v5.14.2							    2011-09-25					     Wiki::Toolkit::Setup::Pg(3pm)

Check Out this Related Man Page

Wiki::Toolkit::Formatter::Multiple(3pm) 		User Contributed Perl Documentation		   Wiki::Toolkit::Formatter::Multiple(3pm)

NAME

       Wiki::Toolkit::Formatter::Multiple - Allows a Wiki::Toolkit wiki to use more than one formatter.

DESCRIPTION

       A "dummy" formatter for Wiki::Toolkit.  Passes methods through to other Wiki::Toolkit formatters, depending on supplied metadata.

SYNOPSIS

	 use Wiki::Toolkit::Formatter::Multiple;
	 use Wiki::Toolkit::Formatter::Pod;
	 use Wiki::Toolkit::Formatter::UseMod;

	 my $pod_fmtr = Wiki::Toolkit::Formatter::Pod->new(
	     node_prefix => "wiki.cgi?node=",
	 );

	 my $usemod_fmtr = Wiki::Toolkit::Formatter::UseMod->new(
	     node_prefix    => "wiki.cgi?node=",
	     extended_links => 1,
	     allowed_tags   => [ qw( p b i div br ) ],
	 );

	 my $formatter = Wiki::Toolkit::Formatter::Multiple->new(
	     documentation => $pod_fmtr,
	     discussion    => $usemod_fmtr,
	     _DEFAULT	   => $usemod_fmtr,
	 );

	 my $wiki = Wiki::Toolkit->new( store	  => ...,
					formatter => $formatter );
	 my $output = $wiki->format( "This is some discussion.",
				     { formatter => "discussion" } );

METHODS

       new
	     my $formatter = Wiki::Toolkit::Formatter::Multiple->new(
		 label_1  => Formatter1->new( ... ),
		 label_2  => Formatter2->new( ... ),
		 _DEFAULT => Wiki::Toolkit::Formatter::Default->new,
	     );

	   You may supply as many formatter objects as you wish.  They don't have to be of different classes; you may just wish to, for example,
	   permit different HTML tags to be used on different types of pages.

	   The "labels" supplied as the keys of the parameter hash should be unique.  When you write a node, you should store a key-value pair in
	   its metadata where the key is "formatter" and the value is the label of the formatter that should be used to render that node.

	   The "_DEFAULT" label is special - it defines the formatter that will be used for any node that does not have a "formatter" stored in
	   its metadata.  The "_DEFAULT" formatter, if not supplied to "->new", will default to the very basic Wiki::Toolkit::Formatter::Default.

       format( $raw, \%metadata )
	       my $output = $formatter->format( "Here is some text.", undef,
						{ formatter => "discussion" } );

	   Uses the value of "formatter" given in the metadata to decide which of the formatter objects passed on instantiation to use, then uses
	   it to format the provided rawwikitext.

	   The "undef" second element of the parameter array in the example is there because when this is called from a Wiki::Toolkit object, the
	   wiki object passes itself in as the second parameter.

       find_internal_links( $raw, $metadata )

SEE ALSO

       Wiki::Toolkit

AUTHOR

       Kake Pugh <kake@earth.li>

SUPPORT

       Bug reports, questions and feature requests should go to cgi-wiki-dev@earth.li

COPYRIGHT

	    Copyright (C) 2003-4 Kake Pugh.  All Rights Reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2011-09-25				   Wiki::Toolkit::Formatter::Multiple(3pm)
Man Page