File Coverage

blib/lib/Toader/Render/General.pm

Criterion	Covered	Total	%
statement	57	1607	3.5
branch	0	586	0.0
condition	0	18	0.0
subroutine	19	69	27.5
pod	50	50	100.0
total	126	2330	5.4

package Toader::Render::General;

use warnings;
use strict;
use base 'Error::Helper';
use Toader::Templates;
use Toader::Entry::Helper;
use Toader::Entry::Manage;
use Toader::Page::Helper;
use Toader::Page::Manage;
use Toader::Render::CSS;
use Toader::Render::Entry;
use Toader::Render::supportedObjects;
use Toader::pathHelper;
use Toader::Gallery;
use File::Spec;
use Toader::Directory;
use Email::Address;
use Toader::AutoDoc;
use Image::ExifTool;
use Script::isAperlScript;

=head1 NAME

Toader::Render::General - Renders various general stuff for Toader as well as some other stuff.

=head1 VERSION

Version 0.5.0

=cut

our $VERSION = '0.5.0';

=head1 METHODS

=head2 new

This initiates the object.

=head3 args hash ref

=head4 toader

This is the L object.

=head4 obj

This is the L object being worked with.

=head4 toDir

This is the path to use for getting back down to the directory.

Lets say we have rendered a single entry to it's page, then it would
be "../../", were as if we rendered a page of multiple entries it
would be "../".

The default is "../../".

This is set to '' if fullURL is set to true.

=head4 fullURL

This is if it should make a non-relative link for when generating links. If set to 1,
it makes links non-relative. If not defined/false it uses relative links.

=head4 dir

This is the directory that it is currently in. This can differ from the object directory
and if not defined will be set to the object directory, which is found via $args{obj}->dirGet.

    my $g=Toader::Render::General->new(\%args);
    if($g->error){
        warn('error: '.$g->error.":".$g->errorString);
    }

=cut

sub new{
	my %args;
	if(defined($_[1])){
		%args= %{$_[1]};
	};

	my $self={
			  error=>undef,
			  errorString=>'',
			  perror=>undef,
			  isatd=>Toader::isaToaderDir->new,
			  soc=>Toader::Render::supportedObjects->new,
			  toDir=>'../../',
			  fullURL=>0,
			  locationSub=>'',
			  errorExtra=>{
				  flags=>{
					  1=>'noToaderObj',
					  2=>'notAtoaderObj',
					  3=>'toaderPerror',
					  4=>'noRenderableObj',
					  5=>'notArenderableObj',
					  6=>'objPerror',
					  7=>'noDirSet',
					  8=>'noLinkDefined',
					  9=>'templateFetchErrored',
					  11=>'noToaderdirSpecified',
					  12=>'notAtoaderDir',
					  13=>'noEntryIDspecified',
					  14=>'entryDoesNotExist',
					  15=>'noPageSpecified',
					  16=>'pageDoesNotExist',
					  17=>'noFileSpecified',
					  18=>'templateInitErrored',
					  19=>'r2rErrored',
					  20=>'b2rErrored',
					  21=>'pathhelperInitErrored',
					  22=>'subToaderDirListErrored',
					  23=>'pageManageDirSetErrored',
					  24=>'listPagesErrored',
					  25=>'entryManageErrored',
					  26=>'readEntryErrored',
					  27=>'renderEntryInitErrored',
					  28=>'renderEntryErrored',
					  29=>'noAuthorsLineSpecified',
					  30=>'authorsLineParseFailed',
					  31=>'entryManageDirSetErrored',
					  32=>'pageListErrored',
					  33=>'pageReadErrored',
					  34=>'autoDocFileDotDotError',
					  35=>'noURLinConfig',
					  36=>'noImageURLspecified',
					  37=>'noImageFileSpecified',
					  38=>'imageDoesNotExist',
					  39=>'pathCleanupErrored',
					  40=>'galleryInitErrored',
					  41=>'outputURLnotSpecified',
					  42=>'noSrcPathSpecified',
					  43=>'noURLspecified',
					  44=>'relativeDirContainsAperiod',
					  45=>'noSrcURLspecified',
				  },
			  },
			  };
	bless $self;

	if ( defined ( $args{toDir} ) ){
		$self->{toDir}=$args{toDir};
	}


	if ( defined( $args{fullURL} ) ){
		$self->{fullURL}=$args{fullURL};
	}

	#make sure we have a usable Toader object
	if ( ! defined( $args{toader} ) ){
		$self->{perror}=1;
		$self->{error}=1;
		$self->{errorString}='No Toader object defined';
		$self->warn;
		return $self;
	}
	if ( ref( $args{toader} ) ne 'Toader' ){
		$self->{perror}=1;
        $self->{error}=2;
        $self->{errorString}='The specified Toader object is actually a "'.ref( $args{ref} ).'"';
        $self->warn;
        return $self;
    }
	if ( ! $args{toader}->errorblank ){
		$self->{perror}=1;
        $self->{error}=3;
        $self->{errorString}='The Toader object has a permanent error set';
        $self->warn;
        return $self;
	}
	$self->{toader}=$args{toader};
	$self->{ph}=$self->{toader}->getPathHelper;

	#make sure we have a usable object
	if ( ! defined( $args{obj} ) ){
		$self->{perror}=1;
		$self->{error}=4;
		$self->{errorString}='No object specified for the renderable object';
		$self->warn;
		return $self;
	}
	if ( ! $self->{soc}->isSupported( $args{obj} ) ){
		$self->{perror}=1;
		$self->{error}=5;
		$self->{errorString}='"'.ref( $args{obj} ).'" does not appear to be a Toader renderable object';
		$self->warn;
		return $self;
	}
	if ( ! $args{obj}->errorblank ){
		$self->{perror}=1;
		$self->{error}=6;
		$self->{errorString}='The specified renderable object has a permanent error set';
		$self->warn;
		return $self;
	}
	$self->{obj}=$args{obj};

	#make sure the renderable object has a directory set
	$self->{odir}=$self->{obj}->dirGet;
	if ( ! defined( $self->{odir} ) ){
		$self->{perror}=1;
		$self->{error}=7;
		$self->{errorString}='The renderable object does not have a directory specified';
		$self->warn;
		return $self;
	}

	#initialize the Toader::pathHelper
	$self->{ph}=Toader::pathHelper->new( $self->{odir} );
	if ( $self->{ph}->error ){
		$self->{perror}=1;
		$self->{error}=6;
		$self->{errorString}='Failed to initiate pathHelper. error="'.
			$self->{ph}->error.'" errorString="'.$self->{ph}->errorString.'"';
		$self->warn;
		return $self;
	}

	#cleans up the object directory path
    $self->{odir}=$self->{ph}->cleanup( $self->{odir} );
    if ( $self->{ph}->error ){
		$self->{perror}=1;
		$self->{error}=39;
		$self->{errorString}='Failed to clean up the path for "'.$self->{odir}.'"';
		$self->warn;
		return undef;
    }

	#get this once as it does not change and is likely to be used
	#gets the r2r for the object
	$self->{or2r}=$self->{ph}->relative2root( $self->{odir} );
	if ( $self->{ph}->error ){
		$self->{perror}=1;
		$self->{error}=19;
		$self->{errorString}='pathHelper failed to find the relative2root path for "'.
			$self->{odir}.'"';
		$self->warn;
		return $self;
	}
	#get the b2r for the object
	$self->{ob2r}=$self->{toDir}.'/'.$self->{ph}->back2root( $self->{odir} );
	if ( $self->{ph}->error ){
		$self->{perror}=1;
		$self->{error}=20;
		$self->{errorString}='pathHelper failed to find the relative2root path for "'.
			$self->{odir}.'"';
		$self->warn;
		return $self;
	}
	#makes gets the directory to work in
	if ( defined( $args{dir} ) ){
		$self->{dir}=$args{dir};
		$self->{r2r}=$self->{ph}->relative2root( $self->{dir} );
		if ( $self->{ph}->error ){
			$self->{perror}=1;
			$self->{error}=19;
			$self->{errorString}='pathHelper failed to find the relative2root path for "'.
				$self->{dir}.'"';
			return $self;
		}
		$self->{b2r}=$self->{toDir}.'/'.$self->{toDir}.'/'.$self->{ph}->relative2root( $self->{dir} );
		if ( $self->{ph}->error ){
			$self->{perror}=1;
			$self->{error}=20;
			$self->{errorString}='pathHelper failed to find the relative2root path for "'.
				$self->{dir}.'"';
			return $self;
		}
	}else{
		$self->{dir}=$self->{odir};
		$self->{r2r}=$self->{or2r};
		$self->{b2r}=$self->{ob2r};
	}

	#clean up the various paths
	$self->{dir}=File::Spec->canonpath( $self->{dir} );
	$self->{r2r}=File::Spec->canonpath( $self->{r2r} );
	$self->{b2r}=File::Spec->canonpath( $self->{b2r} );
    $self->{or2r}=File::Spec->canonpath( $self->{or2r} );
    $self->{ob2r}=File::Spec->canonpath( $self->{ob2r} );

	#gets the base URL
	my $c=$self->{toader}->getConfig;
	if ( defined( $c->{'_'}->{'url'} ) ){
		$self->{url}=$c->{'_'}->{'url'};
	}
	if ( $self->{fullURL} ){
		if ( ! defined( $c->{'_'}->{url} ) ){
			$self->{perror}=1;
			$self->{error}=35;
			$self->{errorString}='No URL specified in the Toader config';
			$self->warn;
			return $self;
		}
		$self->{toDir}='';
	}

	#figures out the file directory
	$self->{toFiles}=$self->{b2r}.'/'.$self->{or2r}.'/'.$self->{obj}->filesDir;
	$self->{toFiles}=File::Spec->canonpath( $self->{toFiles} );

	#initiates the Templates object
	$self->{t}=Toader::Templates->new({
		dir=>$self->{dir},
		toader=>$args{toader},
									  });
	if ( $self->{t}->error ){
		$self->{perror}=1;
		$self->{error}=18;
		$self->{errorString}='Failed to initialize the Toader::Templates module';
		$self->warn;
		return $self;
	}

	#checks if it is at the root or not
	$self->{atRoot}=$self->{ph}->atRoot( $self->{odir} );

	return $self;
}

=head2 adlink

This generates a link to the the specified documentation file.

Three arguments are taken. The first is the relative directory to the
Toader root in which it resides, which if left undefined is the same
as the object used to initiate this object. The second is file found by
autodoc. The third is the text for the link, which if left undefined is
the same as the file.

If the text is left undefined and the file ends in ".html", the ".html"
part is removed.

    $g->cdlink( $directory,  $file, $text );

The template used for this is 'linkDirectory', which by default
is as below.

    [== $text ==]

The variables passed to it are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
	obj - This is the object that Toader was initiated with.

=cut

sub adlink{
	my $self=$_[0];
	my $dir=$_[1];
	my $file=$_[2];
	my $txt=$_[3];

	#blanks any previous errors
	if ( ! $self->errorblank ){
        return undef;
	}

	if ( ! defined( $dir ) ){
		$dir=$self->{r2r};
	}

	# make sure a file is specified
	if ( ! defined( $file ) ){
		$self->{error}=17;
		$self->{errorString}='No file specified';
		$self->warn;
		return undef;
	}

	#make sure it does not start with ../
	if ( $file =~ /^\.\.\// ){
		$self->{error}=34;
		$self->{errorString}='File matches /^..\//';
		$self->warn;
		return undef;
	}

	my $checker=Script::isAperlScript->new({
		any=>1,
		env=>1,
										   });
	#append .html for POD docs
	if ( $file =~ /\.[Pp][Oo][Dd]$/ ){
		$file=$file.'.html';
	}
	if ( $file =~ /\.[Pp][Mm]$/ ){
		$file=$file.'.html';
	}
	if ( $checker->isAperlScript( $self->{dir}.'/'.$file ) ){
		$file=$file.'.html';
	}

	if ( ! defined( $txt ) ){
		$txt=$file;
		$txt=~s/\.html$//;
	}

	my $link='';
	if ( $self->{fullURL} ){
		$link=$dir.'/.autodoc/.files/'.$file;
		$link=~s/\/\/*/\//g;
		$link=$self->{url}.$link;
	}else{
		$link=$self->{b2r}.'/'.$dir.'/.autodoc/.files/'.$file;
		$link=~s/\/\/*/\//g;
	}

    #renders the AutoDoc link
    my $adlink=$self->{t}->fill_in(
        'autodocLink',
        {
            toDir=>$self->{toDir},
            toFiles=>$self->{toFiles},
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
			url=>$link,
			text=>$txt,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

	return $adlink;
}

=head2 adListLink

This returns a link to the documentation list.

The template used for this is 'linkAutoDocList', which by default
is as below.

    [== $text ==]

The variables passed to it are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.

=cut

sub adListLink{
	my $self=$_[0];
	my $text=$_[1];

    if ( ! $self->errorblank ){
        return undef;
    }

	if (! defined( $text ) ){
		$text='Documentation';
	}

    my $link='';
    if ( $self->{fullURL} ){
        $link=$self->{r2r};
		$link=~s/\/\/*/\//g;
		$link=$self->{url}.$link;
    }else{
		$link=$self->{b2r}.'/'.$self->{r2r}.'/.autodoc/';
		$link=~s/\/\/*/\//g;
    }


    #renders the beginning of the authors links
    my $adllink=$self->{t}->fill_in(
        'linkAutoDocList',
        {
            toDir=>$self->{toDir},
            toFiles=>$self->{toFiles},
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
            url=>$link,
            text=>$text,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

    return $adllink;
}

=head2 atRoot

This returns a Perl boolean value for if the current directory
is the root L directory or not.

    my $atRoot=$g->atRoot;
    if ( $aRoot ){
        print "At root.\n";
    }

=cut

sub atRoot{
	my $self=$_[0];

	if ( ! $self->errorblank ){
		return undef;
	}

	return $self->{atRoot};
}

=head2 authorsLink

Used for generating the author line.

This parses a From header, such as the value returned
from Toader::Entry->fromGet.

One value is requied and that is what is to be parsed and
returned as a link.

    $g->authorsLink($entry->fromGet);

=head3 Templates

=head4 authorBegin

This begins the authors link section.

The default template is blank.

The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.

=head4 authorLink

This is a link for one of the authors.

The default template is as below.

    [== $name ==]

The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    address - The email address of the author.
    comment - The comment portion of it.
    original - The original form for this chunk.
    name - The name of the author.

=head4 authorJoin

This is used for joining multiple authors.

The default template is as below.

    ,


The variables passed to it are as below.

The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.

=head4 authorEnd

This ends the authors link section.

The default template is blank.

The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.

=cut

sub authorsLink{
	my $self=$_[0];
	my $aline=$_[1];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	#make sure we have a authors line
	if ( ! defined( $aline ) ){
		$self->{error}=29;
		$self->{errorString}='No author line defined';
		$self->warn;
		return undef;
	}

	#parses the address
	my @a=Email::Address->parse($aline);
	if ( ! defined( $a[0] ) ){
		$self->{error}=30;
		$self->{errorString}='The author line "'.$aline.'" could not be parsed';
		$self->warn;
		return undef;
	}

	#process each
	my $int=0;
	my @tojoin;
	while ( defined( $a[$int] ) ){
		my $rendered=$self->{t}->fill_in(
			'authorLink',
			{
				toDir=>$self->{toDir},
				toFiles=>$self->{toFiles},
				obj=>\$self->{obj},
				c=>\$self->{toader}->getConfig,
				toader=>\$self->{toader},
				self=>\$self,
				address=>$a[$int]->address,
				comment=>$a[$int]->comment,
				original=>$a[$int]->original,
				name=>$a[$int]->name,
				g=>\$self,
			}
			);
		if ( $self->{t}->error ){
			$self->{error}=10;
			$self->{errorString}='Failed to fill in the template. error="'.
				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
			$self->warn;
			return undef;
		}

		push( @tojoin, $rendered );

		$int++;
	}

	#renders the joiner
	my $joiner=$self->{t}->fill_in(
		'authorJoin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the beginning of the authors links
	my $begin=$self->{t}->fill_in(
		'authorBegin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}


	#renders the end of the authors links
	my $end=$self->{t}->fill_in(
		'authorEnd',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $begin.join( $joiner, @tojoin ).$end;
}

=head2 autodocList

This a list of generates a table of the various
documents.

One argument is accepted and the directory under the l root
directory. If not specified, it is the same as object used to initate
this object.

    $g->autodocList;

=head3 Templates

=head4 autodocListBegin

This initiates the table for the list.

The default template is as below.

     




779




 





 





 





 





 





 



        File  




780




 





 





 





 





 





 



      




781




 





 





 





 





 





 



   




782




 





 





 





 





 





 



 The variables passed to it are as below. 




783




 





 





 





 





 





 



   




784




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




785




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




786




 





 





 





 





 





 



     obj - This is the object that it was invoked for. 




787




 





 





 





 





 





 



     c - The L object containing the Toader config. 




788




 





 





 





 





 





 



     toader - This is a L object. 




789




 





 





 





 





 





 



     self - This the L object. 




790




 





 





 





 





 





 



     g - This the L object. 




791




 





 





 





 





 





 



     dir - This is the directory relative to the root L directory. 




792




 





 





 





 





 





 



   




793




 





 





 





 





 





 



 =head4 autodocListRow 




794




 





 





 





 





 





 



   




795




 





 





 





 





 





 



 This is the represents a row in the document table. 




796




 





 





 





 





 





 



   




797




 





 





 





 





 





 



 The default template is as below. 




798




 





 





 





 





 





 



   




799




 





 





 





 





 





 



        




800




 





 





 





 





 





 



         [== $g->adlink( $dir, $file ) ==] 




801




 





 





 





 





 





 



        




802




 





 





 





 





 





 



   




803




 





 





 





 





 





 



 The variables passed to it are as below. 




804




 





 





 





 





 





 



   




805




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




806




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




807




 





 





 





 





 





 



     obj - This is the object that it was invoked for. 




808




 





 





 





 





 





 



     c - The L object containing the Toader config. 




809




 





 





 





 





 





 



     toader - This is a L object. 




810




 





 





 





 





 





 



     self - This the L object. 




811




 





 





 





 





 





 



     g - This the L object. 




812




 





 





 





 





 





 



     dir - This is the directory relative to the root L directory. 




813




 





 





 





 





 





 



     file - This is the file to show. 




814




 





 





 





 





 





 



   




815




 





 





 





 





 





 



 =head4 autodocListJoin 




816




 





 





 





 





 





 



   




817




 





 





 





 





 





 



 This is used to join the table rows. 




818




 





 





 





 





 





 



   




819




 





 





 





 





 





 



 The default template is blank. 




820




 





 





 





 





 





 



   




821




 





 





 





 





 





 



 The variables passed to it are as below. 




822




 





 





 





 





 





 



   




823




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




824




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




825




 





 





 





 





 





 



     obj - This is the object that it was invoked for. 




826




 





 





 





 





 





 



     c - The L object containing the Toader config. 




827




 





 





 





 





 





 



     toader - This is a L object. 




828




 





 





 





 





 





 



     self - This the L object. 




829




 





 





 





 





 





 



     g - This the L object. 




830




 





 





 





 





 





 



     dir - This is the directory relative to the root L directory. 




831




 





 





 





 





 





 



   




832




 





 





 





 





 





 



 =head4 autodocListEnd 




833




 





 





 





 





 





 



   




834




 





 





 





 





 





 



 This is ends the documentation list. 




835




 





 





 





 





 





 



   




836




 





 





 





 





 





 



 The default template is as below. 




837




 





 





 





 





 





 



   




838



The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    dir - This is the directory relative to the root L directory.

=head4 autodocListRow

This is the represents a row in the document table.

The default template is as below.





The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    dir - This is the directory relative to the root L directory.
    file - This is the file to show.

=head4 autodocListJoin

This is used to join the table rows.

The default template is blank.

The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    dir - This is the directory relative to the root L directory.

=head4 autodocListEnd

This is ends the documentation list.

The default template is as below.



The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    dir - This is the directory relative to the root L directory.

=cut

sub autodocList{
	my $self=$_[0];
	my $dir=$_[1];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	if ( ! defined( $dir ) ){
		$dir=$self->{r2r};
	}

	my $fullpath=$self->{toader}->getRootDir.'/'.$dir;

	my $ad=Toader::AutoDoc->new( $self->{toader} );
	if ( $ad->error ){
		$self->{error}=46;
		$self->{errorString}='Failed to initialize Toader::AutoDoc. error="'.
			$ad->error.'" errorString="'.$ad->errorString.'"';
		$self->warn;
		return undef;
	}

	$ad->dirSet( $fullpath );
	if ( $ad->error ){
		$self->{error}=35;
		$self->{errorString}='Failed to set the directory for the Toader::AutoDoc object to "'.$fullpath.'"';
		$self->warn;
		return undef;
	}

	my @files=$ad->findDocs;
	if ( $ad->error ){
		$self->{error}=36;
		$self->{errorString}='';
		$self->warn;
		return undef;
	}
	@files=sort(@files);

	#puts together the list of docs
	my $int=0;
	my @links;
	while ( defined( $files[$int] ) ){

		my $rendered=$self->{t}->fill_in(
			'autodocListRow',
			{
				toDir=>$self->{toDir},
				toFiles=>$self->{toFiles},
				obj=>\$self->{obj},
				c=>\$self->{toader}->getConfig,
				toader=>\$self->{toader},
				self=>\$self,
				g=>\$self,
				file=>$files[$int],
				dir=>$dir,
			}
			);
        if ( $self->{t}->error ){
			$self->{error}=10;
			$self->{errorString}='Failed to fill in the template. error="'.
				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
			$self->warn;
			return undef;
        }

		push( @links, $rendered );

		$int++;
	}

	my $begin=$self->{t}->fill_in(
		'autodocListBegin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
			dir=>$dir,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

    my $join=$self->{t}->fill_in(
        'autodocListJoin',
        {
            toDir=>$self->{toDir},
            toFiles=>$self->{toFiles},
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
            dir=>$dir,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

    my $end=$self->{t}->fill_in(
        'autodocListEnd',
        {
            toDir=>$self->{toDir},
            toFiles=>$self->{toFiles},
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
            dir=>$dir,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

	return $begin.join($join, @links).$end;
}

=head2 b2r

This returns the current value to get back to the root.

    my $b2r=$g->b2r;

=cut

sub b2r{
	my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	return $self->{b2r};
}

=head2 cdlink

This generates a link to the current directory.

There is one option arguement. This is the text for the link.
If not specified, it defaults to ".".

    $g->cdlink( "to current directory" );

The template used for this is 'linkDirectory', which by default
is as below.

    [== $text ==]

The variables passed to it are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub cdlink{
	my $self=$_[0];
	my $text=$_[1];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	#set the text to the same as the link if no text is defined
	if ( ! defined( $text ) ){
		$text='./';
	}

	my $url=$self->{toDir};
	$url=~s/\/\/*/\//g;
	if ( $self->{fullURL} ){
		$url=$self->{url}.$self->{r2r};
	}

	#render it
	my $rendered=$self->{t}->fill_in(
		'linkDirectory',
		{
			url=>$url,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 css

This renders the CSS template and returns it.

    $g->css;

For more information on the CSS template and rendering
please see 'Documentation/CSS.pod'.

=cut

sub css{
	my $self=$_[0];

	if ( ! $self->errorblank ){
		return undef;
	}

	my $renderCSS=Toader::Render::CSS->new( $self->{toader} );

	my $css=$renderCSS->renderCSS;
	if ( $renderCSS->error ){
		$self->{error}=18;
		$self->{errorString}='Failed to render the CSS. error="'.
			$renderCSS->error.'" errorString="'.
			$renderCSS->errorString.'"';
		$self->warn;
		return undef;
	}

	return $css;
}

=head2 cssLocation

This returns the relative location to a the CSS file.

    $g->cssLocation;

=cut

sub cssLocation{
	my $self=$_[0];

	if ( ! $self->errorblank ){
		return undef;
	}

	if ( ! $self->{fullURL} ){
		return $self->{b2r}.'/toader.css';
	}else{
		return $self->{url}.'toader.css';
	}
}

=head2 dlink

This generates a link to a different directory object.

Two arguments are taken.

The first and required one is the L directory
to link to. This needs to be relative.

The second is the text, which if not specified will will be the
same the link.

    $g->link( "./foo/bar", "more info on foo/bar" );

The template used for this is 'linkDirectory', which by default
is as below.

    [== $text ==]

The variables passed to it are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the L config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub dlink{
	my $self=$_[0];
	my $dir=$_[1];
	my $text=$_[2];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	#make sure we have a link
	if ( ! defined( $dir ) ){
		$self->{error}=11;
		$self->{errorString}='No Toader directory defined';
		$self->warn;
		return undef;
	}

	#set the text to the same as the link if no text is defined
	if ( ! defined( $text ) ){
		$text=$dir;
	}

	#handles it if it is a full path
	my $dirtest;
	if ( $dir =~ /^\// ){
		$dir=$self->{toader}->getRootDir.$dir;
		$dirtest=$dir;
		$dir=$self->{ph}->relative2root( $dir );
	}else{
		$dirtest=$self->{dir}.'/'.$dir;
	}

	#make sure it is a Toader directory
	if ( ! $self->{isatd}->isaToaderDir( $dirtest ) ){
		$self->{error}=12;
		$self->{errorString}='"'.$dirtest.'" is not a Toader directory';
		$self->warn;
		return undef;
	}

	if ( $self->{fullURL} ){
        $dir=$dir;
		$dir=~s/\/\/*/\//g;
		$dir=$self->{url}.$dir;
    }else{
		$dir=$self->{toDir}.$dir;
		$dir=~s/\/\/*/\//g;
    }

	#render it
	my $rendered=$self->{t}->fill_in(
		'linkDirectory',
		{
			url=>$dir,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 elink

This generates a link to a different directory object.

Two arguments are taken.

The first and required one is the L directory containing
the L object. This needs to be relative.

The second is the entry to link to.

The third is the text, which if not specified will will be the
same the link.

    $g->link( $dir, $entryID, "whatever at foo.bar" );

The template used is 'linkEntry' and the default is as below.

    [== $text ==]

The variables passed are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the L config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub elink{
	my $self=$_[0];
	my $dir=$_[1];
	my $entry=$_[2];
	my $text=$_[3];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	#use the object dir if not is specified
	if ( ! defined( $dir ) ){
		$self->{error}=11;
		$self->{errorString}='No Toader directory defined';
		$self->warn;
		return undef;
	}

	#make sure we have a link
	if ( ! defined( $dir ) ){
		$self->{error}=13;
		$self->{errorString}='No Toader Entry ID defined';
		$self->warn;
		return undef;
	}

	#set the text to the same as the link if no text is defined
	if ( ! defined( $text ) ){
		$text=$entry;
	}

	#handles it if it is a full path
	my $dirtest;
	if ( $dir =~ /^\// ){
		$dir=$self->{toader}->getRootDir.$dir;
		$dirtest=$dir;
		$dir=$self->{ph}->relative2root( $dir );
	}else{
		$dirtest=$self->{dir}.'/'.$dir;
	}

	#make sure it is a Toader directory
	if ( ! $self->{isatd}->isaToaderDir( $dirtest ) ){
		$self->{error}=12;
		$self->{errorString}='"'.$dirtest.'" is not a Toader directory';
		$self->warn;
		return undef;
	}

	#make sure entry exists... will also make sure it exists
	my $eh=Toader::Entry::Helper->new( $self->{toader} );
	$eh->setDir( $dirtest );
	if ( ! $eh->entryExists( $entry ) ){
		$self->{error}=14;
		$self->{errorString}='The entry ID "'.$entry.'" does not exist for the Toader directory "'.$dirtest.'"';
		$self->warn;
		return undef;
	}

	if ( $self->{fullURL} ){
		$dir=$dir.'/.entries/'.$entry.'/';
		$dir=~s/\/\/*/\//g;
		$dir=$self->{url}.$dir;
	}else{
		$dir=$self->{toDir}.$dir.'/.entries/'.$entry.'/';
		$dir=~s/\/\/*/\//g;
	}

	#render it
	my $rendered=$self->{t}->fill_in(
		'linkEntry',
		{
			url=>$dir,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 entryArchive

This creates the entry archive for the current directory.

No arguments are taken.

    $g->entryArchive;

=head3 Templates

=head4 entryArchiveBegin

This begins the entry archive table.

     




1393




 





 





 





 





 





 



        Date Title Summary  




1394




 





 





 





 





 





 



   




1395




 





 





 





 





 





 



 The variables passed to it are as below. 




1396




 





 





 





 





 





 



   




1397




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




1398




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




1399




 





 





 





 





 





 



     obj - This is the object that it was invoked for. 




1400




 





 





 





 





 





 



     c - The L object containing the Toader config. 




1401




 





 





 





 





 





 



     toader - This is a L object. 




1402




 





 





 





 





 





 



     self - This the L object. 




1403




 





 





 





 





 





 



     g - This the L object. 




1404




 





 





 





 





 





 



   




1405




 





 





 





 





 





 



 =head4 entryArchiveRow 




1406




 





 





 





 





 





 



   




1407




 





 





 





 





 





 



 This generates a row in the entry archive table. 




1408




 





 





 





 





 





 



   




1409




 





 





 





 





 





 



 The default template is as below. 




1410




 





 





 





 





 





 



   




1411




 





 





 





 





 





 



        




1412




 





 





 





 





 





 



         [== $g->elink( "./", $date, $date ) ==] 




1413




 





 





 





 





 





 



         [== $title ==] 




1414




 





 





 





 





 





 



         [== $summary ==] 




1415




 





 





 





 





 





 



        




1416




 





 





 





 





 





 



   




1417




 





 





 





 





 





 



 The variables passed to it are as below. 




1418




 





 





 





 





 





 



   




1419




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




1420




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




1421




 





 





 





 





 





 



     obj - This is the object that it was invoked for. 




1422




 





 





 





 





 





 



     c - The L object containing the Toader config. 




1423




 





 





 





 





 





 



     toader - This is a L object. 




1424




 





 





 





 





 





 



     self - This the L object. 




1425




 





 





 





 





 





 



     g - This the L object. 




1426




 





 





 





 





 





 



     date - This is the entry name/date stamp. 




1427




 





 





 





 





 





 



     title - This is the title of the entyr. 




1428




 





 





 





 





 





 



     summary - This is a summary of the entry. 




1429




 





 





 





 





 





 



   




1430




 





 





 





 





 





 



 =head4 entryArchiveJoin 




1431




 





 





 





 





 





 



   




1432




 





 





 





 





 





 



 This joins the entry rows. 




1433




 





 





 





 





 





 



   




1434




 





 





 





 





 





 



 The default template is blank. 




1435




 





 





 





 





 





 



   




1436




 





 





 





 





 





 



 The variables passed to it are as below. 




1437




 





 





 





 





 





 



   




1438




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




1439




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




1440




 





 





 





 





 





 



     obj - This is the object that it was invoked for. 




1441




 





 





 





 





 





 



     c - The L object containing the L config. 




1442




 





 





 





 





 





 



     toader - This is a L object. 




1443




 





 





 





 





 





 



     self - This the L object. 




1444




 





 





 





 





 





 



     g - This the L object. 




1445




 





 





 





 





 





 



   




1446




 





 





 





 





 





 



 =head4 entryArchiveEnd 




1447




 





 





 





 





 





 



   




1448




 





 





 





 





 





 



 This ends the authors link section. 




1449




 





 





 





 





 





 



   




1450




 





 





 





 





 





 



 The default template is as below. 




1451




 





 





 





 





 





 



   




1452


The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.

=head4 entryArchiveRow

This generates a row in the entry archive table.

The default template is as below.







The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    date - This is the entry name/date stamp.
    title - This is the title of the entyr.
    summary - This is a summary of the entry.

=head4 entryArchiveJoin

This joins the entry rows.

The default template is blank.

The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the L config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.

=head4 entryArchiveEnd

This ends the authors link section.

The default template is as below.



The variables passed to it are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a Toader object.
    self - This the L object.
    g - This the L object.

=cut

sub entryArchive{
	my $self=$_[0];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	my $em=Toader::Entry::Manage->new( $self->{toader} );
	$em->setDir( $self->{odir} );
	if ( $em->error ){
		$self->{error}=25;
		$self->{errorString}='Failed to set the directory, "'.$self->{odir}.
			'", for Toader::Entry::Manage. error="'.$em->error
			.'" errorString="'.$em->errorString.'"';
		$self->warn;
		return undef;
	}

	#lists the entries for the directory
	my @entries=$em->published;
	if ( $em->error ){
		$self->{error}=25;
		$self->{errorString}='Failed to read the entries for "'.$self->{odir}.
			'". error="'.$em->error.'" errorString="'.$em->errorString.'"';
		$self->warn;
		return undef;
	}

	#return '' if there are none
	if ( ! defined( $entries[0] ) ){
		return '';
	}

	#sort and order from last to first
	@entries=sort(@entries);
	@entries=reverse(@entries);

	#process each one
	my @tojoin;
	my $int=0;
	while ( defined( $entries[$int] ) ){
		my $entry=$em->read( $entries[$int] );
		if ( $em->error ){
			$self->{error}=26;
			$self->{errorString}='Failed to read "'.$entries[$int].'" in "'
				.$self->{odir}.'". error="'.$em->error.'" errorstring="'
				.$em->errorString.'"';
			$self->warn;
			return undef;
		}

		#renders the row
		my $rendered=$self->{t}->fill_in(
			'entryArchiveRow',
			{
				toDir=>$self->{toDir},
				toFiles=>$self->{toFiles},
				obj=>\$self->{obj},
				c=>\$self->{toader}->getConfig,
				toader=>\$self->{toader},
				self=>\$self,
				title=>$entry->titleGet,
				summary=>$entry->summaryGet,
				date=>$entry->entryNameGet,
				g=>\$self,
			}
			);
		if ( $self->{t}->error ){
			$self->{error}=10;
			$self->{errorString}='Failed to fill in the template. error="'.
				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
			$self->warn;
			return undef;
		}

		push( @tojoin, $rendered );

		$int++;
	}

	#renders the joiner
	my $joiner=$self->{t}->fill_in(
		'entryArchiveJoin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the end of the dir list
	my $end=$self->{t}->fill_in(
		'entryArchiveEnd',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the end of the dir list
	my $begin=$self->{t}->fill_in(
		'entryArchiveBegin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $begin.join( $joiner, @tojoin ).$end;
}

=head2 entriesArchiveLink

Link to the entries directory.

One argument is taken and that is the text to use.
If not specifieid, it defaults to "Index".

	$g->entriesIndexLink;

The template is 'entriesArchiveLink' and the default is
as below.

    [== $text ==]

The variables used are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub entriesArchiveLink{
	my $self=$_[0];
	my $text=$_[1];

	if ( ! defined( $text ) ){
		$text='Archive';
	}

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	my $url;
	if ( $self->{fullURL} ){
		$url=$self->{r2r}.'/.entries/archive.html';
		$url=~s/\/\/*/\//g;
		$url=$self->{url}.$url;
	}else{
		$url=$self->{toDir}.'/.entries/archive.html';
		$url=~s/\/\/*/\//g;
	}

	#render it
	my $rendered=$self->{t}->fill_in(
		'entriesArchiveLink',
		{
			url=>$url,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 entriesLink

Link to the entries directory.

One argument is taken and that is the text to use.
If not specifieid, it defaults to "Latest".

	$g->entriesLink;

The template 'entriesLink' is used and the default is as below.

    [== $text ==]

The variables are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub entriesLink{
	my $self=$_[0];
	my $text=$_[1];

	if ( ! defined( $text ) ){
		$text='Latest';
	}

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	my $url;
    if ( $self->{fullURL} ){
        $url=$self->{r2r}.'/.entries/';
		$url=~s/\/\/*/\//g;
		$url=$self->{url}.$url;
    }else{
		$url=$self->{toDir}.'/.entries/';
        $url=~s/\/\/*/\//g;
    }

	#render it
	my $rendered=$self->{t}->fill_in(
		'entriesLink',
		{
			url=>$url,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 flink

This generates a link to a included file for the object.

Two arguements are taken. The first and required is the file.
The second and optional is the text to use, which if not specified
is the name of the file.

    $g->flink( $file );

The template 'linkFile' is used and the default is as below.

    [== $text ==]

The variables passed are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub flink{
	my $self=$_[0];
	my $file=$_[1];
	my $text=$_[2];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	#make sure we have a link
	if ( ! defined( $file ) ){
		$self->{error}=17;
		$self->{errorString}='No file specified';
		$self->warn;
		return undef;
	}

	if ( ! defined( $text ) ){
		$text=$file;
	}

	#creates the URL and cleans it up
	my $url=$self->{toFiles}.'/'.$file;
	$url=~s/\/\/*/\//g;

	#render it
	my $rendered=$self->{t}->fill_in(
		'linkFile',
		{
			url=>$self->{toFiles}.'/'.$file,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 galleryDirURL

This returns the URL for a gallery directory.

Three arguments are accepted. The first is the Toader
directory to for the gallery, if not specified it uses
the Toader directory for the current object. The
second is the relative gallery directory, which if not
specified defaults to the '', the root gallery directory.

    [== $g->galleryDirURL ==]

=cut

sub galleryDirURL{
    my $self=$_[0];
    my $dir=$_[1];
    my $gdir=$_[2];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	if ( ! defined( $gdir ) ){
		$gdir='';
	}

	#clean it up, removing any possible multi /
	$gdir=~s/\/\/*/\//g;

    #gets the directory to use if none is specified
    if ( ! defined( $dir ) ){
        $dir=$self->{r2r};
    }

    #puts together the full path
    my $toaderDir=$self->{toader}->getRootDir.'/'.$dir;

	#gets a Gallery object
	my $tg;
	if ( ref( $self->{obj} ) ne 'Toader::Gallery' ){
		$tg=Toader::Gallery->new;
		$tg->dirSet( $toaderDir );
		if ( $tg->error ){
			$self->{error}=40;
			$self->{errorString}='Failed to initialize Toader::Gallery';
			$self->warn;
			return undef;
		}
	}else{
		$tg=$self->{obj};
	}

    #gets the output URL
    my $outputURL=$tg->outputURLget;
    if ( ! defined( $outputURL ) ){
        $self->{error}=41;
        $self->{errorString}='Failed to get the output URL for Toader::Gallery for "'.$dir.'"';
        $self->warn;
        return undef;
    }

	my $link='.toader-gallery/html/'.$gdir;
	$link=~s/\/\/*/\//g;
	return $outputURL.$link;
}

=head2 galleryImageLarge

This generates the HTML for a large gallery image.

Two arguments are taken. The first and optional one is the
directory, which if not specified, it uses the Toader current
directory. The second and required is the gallery directory for
the image, which if not specified it defaults to the root
directory, ''. The third and required is the gallery image.

    [== $g->galleryImageLarge( undef, '', $someImage (.

This uses imageDiv with the content provided by imageExifTables.

=cut

sub galleryImageLarge{
	my $self=$_[0];
	my $dir=$_[1];
	my $gdir=$_[2];
	my $image=$_[3];

	#blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    #gets the directory to use if none is specified
    if ( ! defined( $dir ) ){
        $dir=$self->{r2r};
    }

	if ( ! defined( $gdir ) ){
		$gdir='';
	}

	#puts together the full path
	my $toaderDir=$self->{toader}->getRootDir.'/'.$dir;

	#gets a Gallery object
	my $tg;
	if ( ref( $self->{obj} ) ne 'Toader::Gallery' ){
		$tg=Toader::Gallery->new;
		$tg->dirSet( $toaderDir );
		if ( $tg->error ){
			$self->{error}=40;
			$self->{errorString}='Failed to initialize Toader::Gallery';
			$self->warn;
			return undef;
		}
	}else{
		$tg=$self->{obj};
	}

	#gets the output URL
	my $outputURL=$tg->outputURLget;
	if ( ! defined( $outputURL ) ){
		$self->{error}=41;
		$self->{errorString}='Failed to get the output URL for Toader::Gallery for "'.$dir.'"';
		$self->warn;
		return undef;
	}

	#gets the source path
    my $srcPath=$tg->srcPathGet;
    if ( ! defined( $srcPath ) ){
        $self->{error}=42;
        $self->{errorString}='No source path specified';
        $self->warn;
        return undef;
    }

	#puts together the image URL
	my $imageURL='.toader-gallery/large/'.$gdir.'/'.$image;
	$imageURL=~s/\/\/*/\//g;
	$imageURL=$outputURL.$imageURL;

	#returns the URL for the source gallery image
	my $srcURL=$self->gallerySrcURL( $dir, $gdir, $image );

	my $imagePath=$srcPath.'/'.$gdir.'/'.$image;
	$imagePath=~s/\/\/*/\//g;

	#puts together the EXIF table
	my $exifTables=$self->imageExifTables( $imagePath );
	if ( $self->error ){
		$self->warnString('imageExifTables failed');
		return undef;
	}

	my $rendered=$self->imageDiv( $imageURL, $srcURL, undef, $exifTables );
	if ( $self->error ){
		$self->warnString('imageDiv failed');
		return undef;
	}

	return $rendered;
}

=head2 galleryImageSmall

This generates the HTML for a small gallery image.

Two arguments are taken. The first and optional one is the
directory, which if not specified, it uses the Toader current
directory. The second and required is the gallery directory for
the image. The third and required is the gallery image.

This invokes imageDiv, using the name of the image as the content.

    [== $g->gallerImageSmall( undef, $gdir, $image ); ==]

This uses imageDiv with the link URL being the link to the image details
and the lower text being the image file name.

=cut

sub galleryImageSmall{
	my $self=$_[0];
	my $dir=$_[1];
	my $gdir=$_[2];
	my $image=$_[3];

	#blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	if ( ! defined( $gdir ) ){
		$gdir='';
	}

    #gets the directory to use if none is specified
    if ( ! defined( $dir ) ){
        $dir=$self->{r2r};
    }

	#puts together the full path
	my $toaderDir=$self->{toader}->getRootDir.'/'.$dir;

	#gets a Gallery object
	my $tg;
	if ( ref( $self->{obj} ) ne 'Toader::Gallery' ){
		$tg=Toader::Gallery->new;
		$tg->dirSet( $toaderDir );
		if ( $tg->error ){
			$self->{error}=40;
			$self->{errorString}='Failed to initialize Toader::Gallery';
			$self->warn;
			return undef;
		}
	}else{
		$tg=$self->{obj};
	}

	#gets the output URL
	my $outputURL=$tg->outputURLget;
	if ( ! defined( $outputURL ) ){
		$self->{error}=41;
		$self->{errorString}='Failed to get the output URL for Toader::Gallery for "'.$dir.'"';
		$self->warn;
		return undef;
	}

	#puts together the image URL
	my $imageURL='.toader-gallery/small/'.$gdir.'/'.$image;
	$imageURL=~s/\/\/*/\//g;
	$imageURL=$outputURL.$imageURL;

	#returns the URL for the large gallery image
	my $largeURL=$self->galleryLargeURL( $dir, $gdir, $image );

	my $rendered=$self->imageDiv( $imageURL, $largeURL, undef, $image );
	if ( $self->error ){
		$self->warnString('imageDiv failed');
		return undef;
	}

	return $rendered;
}

=head2 galleryLargeURL

This returns the large URL for a directory image.

Three arguments are accepted. The first is the Toader
directory to for the gallery, if not specified it uses
the Toader directory for the current object. The
second is the relative gallery directory, which if not
specified defaults to the '', the root gallery directory.
The third is the image in that directory.

    [== $g->galleryLargeURL; ==]

=cut

sub galleryLargeURL{
    my $self=$_[0];
    my $dir=$_[1];
    my $gdir=$_[2];
	my $image=$_[3];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    #gets the directory to use if none is specified
    if ( ! defined( $dir ) ){
        $dir=$self->{r2r};
    }

	if ( ! defined( $gdir ) ){
		$gdir='';
	}

	#make sure there no multi /
	$gdir=~s/\/\/*/\//g;

    #puts together the full path
    my $toaderDir=$self->{toader}->getRootDir.'/'.$dir;

	#gets a Gallery object
	my $tg;
	if ( ref( $self->{obj} ) ne 'Toader::Gallery' ){
		$tg=Toader::Gallery->new;
		$tg->dirSet( $toaderDir );
		if ( $tg->error ){
			$self->{error}=40;
			$self->{errorString}='Failed to initialize Toader::Gallery';
			$self->warn;
			return undef;
		}
	}else{
		$tg=$self->{obj};
	}

    #gets the output URL
    my $outputURL=$tg->outputURLget;
    if ( ! defined( $outputURL ) ){
        $self->{error}=41;
        $self->{errorString}='Failed to get the output URL for Toader::Gallery for "'.$dir.'"';
        $self->warn;
        return undef;
    }

	my $url='.toader-gallery/html/'.$gdir.'/'.$image.'.html';
	$url=~s/\/\/*/\//g;
	return $outputURL.$url;
}

=head2 galleryLargeImageURL

This returns the URL for the large gallery image.

Three arguments are accepted. The first is the Toader
directory to for the gallery, if not specified it uses
the Toader directory for the current object. The
second is the relative gallery directory, which if not
specified defaults to the '', the root gallery directory.
The third is the image in that directory.

    [== $g->galleryLargeImageURL( undef, $gdir, $image ); ==]

=cut

sub galleryLargeImageURL{
    my $self=$_[0];
    my $dir=$_[1];
    my $gdir=$_[2];
    my $image=$_[3];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    #gets the directory to use if none is specified
    if ( ! defined( $dir ) ){
        $dir=$self->{r2r};
    }

	if ( ! defined( $gdir ) ){
		$gdir='';
	}

    #puts together the full path
    my $toaderDir=$self->{toader}->getRootDir.'/'.$dir;

	#gets a Gallery object
	my $tg;
	if ( ref( $self->{obj} ) ne 'Toader::Gallery' ){
		$tg=Toader::Gallery->new;
		$tg->dirSet( $toaderDir );
		if ( $tg->error ){
			$self->{error}=40;
			$self->{errorString}='Failed to initialize Toader::Gallery';
			$self->warn;
			return undef;
		}
	}else{
		$tg=$self->{obj};
	}

    #gets the output URL
    my $outputURL=$tg->outputURLget;
    if ( ! defined( $outputURL ) ){
        $self->{error}=41;
        $self->{errorString}='Failed to get the output URL for Toader::Gallery for "'.$dir.'"';
        $self->warn;
        return undef;
    }

	my $url='.toader-gallery/large/'.$gdir.'/'.$image;
	$url=~s/\/\/*/\//g;
	return $outputURL.$url;
}

=head2 galleryLocationbar

Two arguments taken for this. The first argument is required and
it is the relative gallery directory, which if not specified
defaults to the '', the root gallery directory. The second and
optional is a image name, if any.

    [== $g->galleryLocationbar; ==]

This is largely useful for setting a locationSub for a gallery
item. See L for a example of that.

=head3 Templates

=head4 galleryLocationStart

This starts the location bar insert.

The default template is as below.

    Gallery Location:

The variables below are passed to it.

    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.

=head4 galleryLocationPart

This is a one of the gallery directories in the path to the one specified.

    [== $text ==]

The variables below are passed to it.

    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.
    gdir - The gallery directory this part is for.
    url - The URL for that gallery directory.
    text - The text(directory name) for that directory.

=head4 galleryLocationJoin

This joins the gallery parts together.

     /

The variables below are passed to it.

    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.

=head4 galleryLocationEnd

This ends the gallery location bar.

The default template is as below.




The variables below are passed to it.

    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.

=head4 galleryLocationImage

This is appended if something is specified for a image.

The default

    Image: [== $image ==]

The variables below are passed to it.

    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.
    gdir - The gallery directory this part is for.
    url - The URL for that large(details) image page.
    text - The text(directory name) for that directory.

=cut

sub galleryLocationbar{
	my $self=$_[0];
	my $gdir=$_[1];
	my $image=$_[2];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	if ( ! defined( $gdir ) ){
		$gdir='';
	}

	#save this for later errors, if needed
	my $gdirOrig=$gdir;

	#makes sure it does not have a ./, which can safely be removed
	$gdir=~s/^\.\///;
	#make sure it does not start with a /, which can safely be removed
	$gdir=~s/^\///;
	#make sure it does not have any multie-/, which can safely be made one
	$gdir=~s/\/\/*/\//g;
	#make sure it does not end in a /, which can safely be removed
	$gdir=~s/\/$//;

	#if we get here and it still has a period, we have an issue
	if ( $gdir=~/^\./ ){
		$self->{error}=44;
		$self->{errorString}='"'.$gdirOrig.'" can not be used as a relative gallery directory as it starts with a period';
		$self->warn;
		return undef;
	}

	#splits the gdir apart
	my @gdirSplit=split( /\//, $gdir);

	#gets a Gallery object
	my $tg;
	if ( ref( $self->{obj} ) ne 'Toader::Gallery' ){
		$tg=Toader::Gallery->new;
		$tg->dirSet( $self->{dir} );
		if ( $tg->error ){
			$self->{error}=40;
			$self->{errorString}='Failed to initialize Toader::Gallery';
			$self->warn;
			return undef;
		}
	}else{
		$tg=$self->{obj};
	}

    #renders the gallery link
    my $start=$self->{t}->fill_in(
        'galleryLocationStart',
        {
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
			gdir=>$gdir,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

    #renders the gallery link
    my $joiner=$self->{t}->fill_in(
        'galleryLocationJoin',
        {
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
			gdir=>$gdir,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

	#the parts that will later be joined
	my @parts;

	#gets the url to use
	my $url=$self->galleryDirURL( undef, undef );
	if ( $self->error ){
		$self->warnString('galleryDirURL errored');
		return undef;
	}

	#renders the gallery link
    my $rendered=$self->{t}->fill_in(
        'galleryLocationPart',
        {
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
            gdir=>$gdir,
			url=>$url,
			text=>'root',
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }
	push( @parts, $rendered );

	#process each part
	my $int=0;
	my $currentGdir='';
	while( defined( $gdirSplit[$int] ) ){
		#gets the url to use
		$currentGdir=$currentGdir.'/'.$gdirSplit[$int];
		$currentGdir=~s/\/\/*/\//g;
		$currentGdir=~s/^\///;

		my $url=$self->galleryDirURL( undef, $currentGdir );
		if ( $self->error ){
			$self->warnString('galleryDirURL errored');
			return undef;
		}

		#renders the gallery link
		$rendered=$self->{t}->fill_in(
			'galleryLocationPart',
			{
				obj=>\$self->{obj},
				c=>\$self->{toader}->getConfig,
				toader=>\$self->{toader},
				self=>\$self,
				g=>\$self,
				gdir=>$gdir,
				url=>$url,
				text=>$gdirSplit[$int],
			}
			);
		if ( $self->{t}->error ){
			$self->{error}=10;
			$self->{errorString}='Failed to fill in the template. error="'.
				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
			$self->warn;
			return undef;
		}
		push( @parts, $rendered );

		$int++;
	}

	#renders the gallery link
    my $end=$self->{t}->fill_in(
        'galleryLocationEnd',
        {
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
            gdir=>$gdir,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

	#handles a specified image...
	my $imageLine='';
	if ( defined( $image ) ){
        my $url=$self->galleryLargeURL( undef, $gdir, $image );
        if ( $self->error ){
            $self->warnString('galleryDirURL errored');
            return undef;
        }

		#renders the image link
		$imageLine=$self->{t}->fill_in(
			'galleryLocationImage',
			{
				obj=>\$self->{obj},
				c=>\$self->{toader}->getConfig,
				toader=>\$self->{toader},
				self=>\$self,
				g=>\$self,
				gdir=>$gdir,
				image=>$image,
				url=>$url,
			}
			);
		if ( $self->{t}->error ){
			$self->{error}=10;
			$self->{errorString}='Failed to fill in the template. error="'.
				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
			$self->warn;
			return undef;
		}

	}

	return $start.join( $joiner, @parts ).$end.$imageLine;
}

=head2 gallerySmallImageURL

This returns the URL for the small gallery image.

Three arguments are accepted. The first is the Toader
directory to for the gallery, if not specified it uses
the Toader directory for the current object. The
second is the relative gallery directory, which if not
specified defaults to the '', the root gallery directory.
The third is the image in that directory.

    [== $g->gallerySmallImageURL; ==]

=cut

sub gallerySmallImageURL{
    my $self=$_[0];
    my $dir=$_[1];
    my $gdir=$_[2];
    my $image=$_[3];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    #gets the directory to use if none is specified
    if ( ! defined( $dir ) ){
        $dir=$self->{r2r};
    }

	if ( ! defined( $gdir ) ){
		$gdir='';
	}

    #puts together the full path
    my $toaderDir=$self->{toader}->getRootDir.'/'.$dir;

	#gets a Gallery object
	my $tg;
	if ( ref( $self->{obj} ) ne 'Toader::Gallery' ){
		$tg=Toader::Gallery->new;
		$tg->dirSet( $toaderDir );
		if ( $tg->error ){
			$self->{error}=40;
			$self->{errorString}='Failed to initialize Toader::Gallery';
			$self->warn;
			return undef;
		}
	}else{
		$tg=$self->{obj};
	}

    #gets the output URL
    my $outputURL=$tg->outputURLget;
    if ( ! defined( $outputURL ) ){
        $self->{error}=41;
        $self->{errorString}='Failed to get the output URL for Toader::Gallery for "'.$dir.'"';
        $self->warn;
        return undef;
    }

    my $url='.toader-gallery/small/'.$gdir.'/'.$image;
	$url=~s/\/\/*/\//g;
	return $outputURL.$url;
}

=head2 galleryLink

This links to a Toader::Gallery gallery.

There are three optional arguments taken. The first is Toader
directory this is for, if it is not specified, it assumes
it is the current one. The second is the second one is the directory
under it that it should link to, which defaults to the root of it
if none is specified. The third is text of the link, which defaults
to 'Gallery' if not specified.

    [== $g->galleryLink( undef, $gdir, $text ); ==]

The template used is 'linkGallery'. It is as below.

    [== $text ==]

The variables passed are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.

=cut

sub galleryLink{
    my $self=$_[0];
	my $dir=$_[1];
	my $gdir=$_[2];
	my $text=$_[3];


    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	#default to the root if nothing is defined for the directory under the gallery
	if ( ! defined( $gdir ) ){
		$gdir='';
	}

	#sets the default text if needed...
	if ( ! defined( $text ) ){
		$text='Gallery';
	}

	#gets the directory to use if none is specified
	if ( ! defined( $dir ) ){
		$dir=$self->{r2r};
	}

	#turns the relative directory into a full path and clean it up
	$dir=$self->{toader}->getRootDir.'/'.$dir;
	$dir=$self->{ph}->cleanup( $dir );
	if ( $self->{ph}->error ){
		$self->{error}=39;
		$self->{errorString}='Failed to clean up the path for "'.$dir.'"';
		$self->warn;
		return undef;
	}

	#gets a Gallery object
	my $tg;
	if ( ref( $self->{obj} ) ne 'Toader::Gallery' ){
		$tg=Toader::Gallery->new;
		$tg->dirSet( $dir );
		if ( $tg->error ){
			$self->{error}=40;
			$self->{errorString}='Failed to initialize Toader::Gallery';
			$self->warn;
			return undef;
		}
	}else{
		$tg=$self->{obj};
	}

	#gets the output URL
	my $outputURL=$tg->outputURLget;
	if ( ! defined( $outputURL ) ){
		$self->{error}=41;
		$self->{errorString}='Failed to get the output directory for Toader::Gallery for "'.$dir.'"';
		$self->warn;
		return undef;
	}

	#makes the URL for what is being linked to
	my $link='.toader-gallery/html/'.$gdir;
	$link=~s/\/\/*/\//g;
	$link=$outputURL.$link;

    #renders the gallery link
    my $galleryLink=$self->{t}->fill_in(
        'linkGallery',
        {
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
			url=>$link,
			text=>$text,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

	return $galleryLink;
}

=head2 gallerySrcURL

This returns the URL for the source gallery image.

Three arguments are accepted. The first is the Toader
directory to for the gallery, if not specified it uses
the Toader directory for the current object. The
second is the relative gallery directory, which if not
specified defaults to the '', the root gallery directory.
The third is the image in that directory.

    [== $g->gallerySrcURL( undef, $gdir, $image ); ==]

=cut

sub gallerySrcURL{
    my $self=$_[0];
    my $dir=$_[1];
    my $gdir=$_[2];
    my $image=$_[3];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    #gets the directory to use if none is specified
    if ( ! defined( $dir ) ){
        $dir=$self->{r2r};
    }

	if ( ! defined( $gdir ) ){
		$gdir='';
	}

    #puts together the full path
    my $toaderDir=$self->{toader}->getRootDir.'/'.$dir;

	#gets a Gallery object
	my $tg;
	if ( ref( $self->{obj} ) ne 'Toader::Gallery' ){
		$tg=Toader::Gallery->new;
		$tg->dirSet( $toaderDir );
		if ( $tg->error ){
			$self->{error}=40;
			$self->{errorString}='Failed to initialize Toader::Gallery';
			$self->warn;
			return undef;
		}
	}else{
		$tg=$self->{obj};
	}

    #gets the output URL
    my $srcURL=$tg->srcURLget;
    if ( ! defined( $srcURL ) ){
        $self->{error}=45;
        $self->{errorString}='Failed to get the source URL for Toader::Gallery for "'.$dir.'"';
        $self->warn;
        return undef;
    }

	my $url=$gdir.'/'.$image;
	$url=~s/\/\/*/\//g;
	return $srcURL.$url;
}

=head2 hasDocs

This returns true if the current directory has any
documentation.

    if ( $g->hasDocs ){
        print "This directory has documentation...";
    }

=cut

sub hasDocs{
    my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    #returns true if there is a autodoc directory for the current Toader directory
    if ( -d $self->{odir}.'/.toader/autodoc/' ){
        return 1;
    }

    return 0;
}

=head2 hasEntries

Check if a entries directory exists for the
Toader directory for the current object.

A boolean value is returned.

    my $hasEntries=$g->hasEntries;

=cut

sub hasEntries{
	my $self=$_[0];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	#returns true if there is a entries directory for the current Toader directory
	if ( -d $self->{odir}.'/.toader/entries/' ){
		return 1;
	}

	return 0;
}

=head2 hasGallery

This returns true if the current Toader directory has a gallery.

This is checked for by seeing if the gallery config exists.

=cut

sub hasGallery{
    my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    #returns true if there is a autodoc directory for the current Toader directory
    if ( -f $self->{odir}.'/.toader/gallery.ini' ){
        return 1;
    }

	return 0;
}

=head2 hasAnyDirs

This returns true if there are either Toader sub directories or
it is not at root.

    if ( $g->hasAnyDirs ){
        print "Either not at root or there are Toader sub directires...";
    }

=cut

sub hasAnyDirs{
    my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	my $subs=$self->hasSubDirs;
	if ( $self->error ){
		$self->warnString('Failed to check if the directory has any Toader sub directories');
		return undef;
	}

	#return 1 as there are directories
	if ( $subs ){
		return 1;
	}

	#if we are at root and there no Toader sub directories then this is the only Toader directory
	if ( $self->atRoot ){
		return 0;
	}

	#we are not at root then there is a directory that can be go gone to
	return 1;
}

=head2 hashToTable

This renders a hash to a table.

Four arguments are taken. The first and required a hash
reference to operate on. The second and optional is the title
to use for the key column. The third and optional is the title
to use for the value column. The fourth and optional is the
CSS ID to use, which defaults to to "hashToTable".

    my $table=$foo->hashToTable( \%hash );

=head3 Templates

=head4 hashToTableBegin

This begins the table.

The default is as below.

     




2944




 





 





 





 





 





 



      




2945




 





 





 





 





 





 



   




2946




 





 





 





 





 





 



 The passed variables are as below. 




2947




 





 





 





 





 





 



   




2948




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




2949




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




2950




 





 





 





 





 





 



     obj - This is the object that it was invoked for. 




2951




 





 





 





 





 





 



     c - The L object containing the Toader config. 




2952




 





 





 





 





 





 



     toader - This is a L object. 




2953




 





 





 





 





 





 



     self - This the L object. 




2954




 





 





 





 





 





 



     g - This the L object. 




2955




 





 





 





 





 





 



     cssID - The CSS ID to use. 




2956




 





 





 





 





 





 



   




2957




 





 





 





 





 





 



 =head4 hashToTableTitle 




2958




 





 





 





 





 





 



   




2959




 





 





 





 





 





 



 This is a row that acts as the title row at the top of the table. 




2960




 





 





 





 





 





 



   




2961




 





 





 





 





 





 



 It is only rendered if a title is defined for either key or value. 




2962




 





 





 





 





 





 



   




2963




 





 





 





 





 





 



 The default is as below. 




2964




 





 





 





 





 





 



   




2965




 





 





 





 





 





 



        




2966




 





 





 





 





 





 



         [== $keyTitle ==] 




2967




 





 





 





 





 





 



         [== $valueTitle ==] 




2968




 





 





 





 





 





 



        




2969




 





 





 





 





 





 



      




2970




 





 





 





 





 





 



   




2971




 





 





 





 





 





 



 The passed variables are as below. 




2972




 





 





 





 





 





 



   




2973




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




2974




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




2975




 





 





 





 





 





 



     obj - This is the object that it was invoked for. 




2976




 





 





 





 





 





 



     c - The L object containing the Toader config. 




2977




 





 





 





 





 





 



     toader - This is a L object. 




2978




 





 





 





 





 





 



     self - This the L object. 




2979




 





 





 





 





 





 



     g - This the L object. 




2980




 





 





 





 





 





 



     cssID - The CSS ID to use. 




2981




 





 





 





 





 





 



     keyTitle - The title to use for the key column. 




2982




 





 





 





 





 





 



     valueTitle - The title to use for th value column. 




2983




 





 





 





 





 





 



   




2984




 





 





 





 





 





 



 =head4 hashToTableRow 




2985




 





 





 





 





 





 



   




2986




 





 





 





 





 





 



 This represents a row containing a key/value pair. 




2987




 





 





 





 





 





 



   




2988




 





 





 





 





 





 



 The default is as below. 




2989




 





 





 





 





 





 



   




2990




 





 





 





 





 





 



        




2991




 





 





 





 





 





 



         [== $key ==] 




2992




 





 





 





 





 





 



         [== $value ==] 




2993




 





 





 





 





 





 



        




2994




 





 





 





 





 





 



   




2995




 





 





 





 





 





 



   




2996




 





 





 





 





 





 



 The passed variables are as below. 




2997




 





 





 





 





 





 



   




2998




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




2999




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




3000




 





 





 





 





 





 



     obj - This is the object that it was invoked for. 




3001




 





 





 





 





 





 



     c - The L object containing the Toader config. 




3002




 





 





 





 





 





 



     toader - This is a L object. 




3003




 





 





 





 





 





 



     self - This the L object. 




3004




 





 





 





 





 





 



     g - This the L object. 




3005




 





 





 





 





 





 



     cssID - The CSS ID to use. 




3006




 





 





 





 





 





 



     key - The key for the row. 




3007




 





 





 





 





 





 



     value - The value for the row. 




3008




 





 





 





 





 





 



   




3009




 





 





 





 





 





 



 =head4 hashToTableJoin 




3010




 





 





 





 





 





 



   




3011




 





 





 





 





 





 



 This joins together the rendered rows. 




3012




 





 





 





 





 





 



   




3013




 





 





 





 





 





 



 The default is as below. 




3014




 





 





 





 





 





 



   




3015




 





 





 





 





 





 



      




3016




 





 





 





 





 





 



   




3017




 





 





 





 





 





 



 The passed variables are as below. 




3018




 





 





 





 





 





 



   




3019




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




3020




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




3021




 





 





 





 





 





 



     obj - This is the object that it was invoked for. 




3022




 





 





 





 





 





 



     c - The L object containing the Toader config. 




3023




 





 





 





 





 





 



     toader - This is a L object. 




3024




 





 





 





 





 





 



     self - This the L object. 




3025




 





 





 





 





 





 



     g - This the L object. 




3026




 





 





 





 





 





 



     cssID - The CSS ID to use. 




3027




 





 





 





 





 





 



   




3028




 





 





 





 





 





 



 =head4 hashToTableEnd 




3029




 





 





 





 





 





 



   




3030




 





 





 





 





 





 



 This ends the table. 




3031




 





 





 





 





 





 



   




3032




 





 





 





 





 





 



 The default is as below. 




3033




 





 





 





 





 





 



   




3034


The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    cssID - The CSS ID to use.

=head4 hashToTableTitle

This is a row that acts as the title row at the top of the table.

It is only rendered if a title is defined for either key or value.

The default is as below.







The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    cssID - The CSS ID to use.
    keyTitle - The title to use for the key column.
    valueTitle - The title to use for th value column.

=head4 hashToTableRow

This represents a row containing a key/value pair.

The default is as below.







The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    cssID - The CSS ID to use.
    key - The key for the row.
    value - The value for the row.

=head4 hashToTableJoin

This joins together the rendered rows.

The default is as below.



The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    cssID - The CSS ID to use.

=head4 hashToTableEnd

This ends the table.

The default is as below.



The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.
    cssID - The CSS ID to use.

=cut

sub hashToTable{
	my $self=$_[0];
	my $hash=$_[1];
	my $keyTitle=$_[2];
	my $valueTitle=$_[3];
	my $cssID=$_[4];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	#sets the default CSS ID if none is given
	if( !defined( $cssID ) ){
		$cssID='hashToTable';
	}

	#checks if it has a column title bar for either
	my $titleRow='';
	my $renderTitleRow=0;
	if (
		defined( $keyTitle ) ||
		defined( $valueTitle )
		){
		if ( ! defined( $keyTitle ) ){
			$keyTitle='';
		}
		if ( ! defined( $valueTitle ) ){
			$valueTitle='';
		}
		$renderTitleRow=1;
	}

	#renders the title row if needed...
	if ( $renderTitleRow ){
		$titleRow=$self->{t}->fill_in(
			'hashToTableTitle',
			{
				toDir=>$self->{toDir},
				toFiles=>$self->{toFiles},
				obj=>\$self->{obj},
				c=>\$self->{toader}->getConfig,
				toader=>\$self->{toader},
				self=>\$self,
				g=>\$self,
				cssID=>$cssID,
				keyTitle=>$keyTitle,
				valueTitle=>$valueTitle,
			}
			);
        if ( $self->{t}->error ){
			$self->{error}=10;
			$self->{errorString}='Failed to fill in the template. error="'.
				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
			$self->warn;
			return undef;
        }
	}

	#renders the top of the table
	my $begin=$self->{t}->fill_in(
            'hashToTableBegin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
			cssID=>$cssID,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

    #renders the bottom of the table
    my $end=$self->{t}->fill_in(
            'hashToTableEnd',
        {
            toDir=>$self->{toDir},
            toFiles=>$self->{toFiles},
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
            cssID=>$cssID,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

    #renders the row joiner
    my $join=$self->{t}->fill_in(
		'hashToTableJoin',
        {
            toDir=>$self->{toDir},
            toFiles=>$self->{toFiles},
            obj=>\$self->{obj},
            c=>\$self->{toader}->getConfig,
            toader=>\$self->{toader},
            self=>\$self,
            g=>\$self,
            cssID=>$cssID,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

	#renders each row
	my @keys=sort {uc($a) cmp uc($b)} keys( %$hash );
	my @rows;
	my $int=0;
	while( defined( $keys[$int] ) ){
		my $row=$self->{t}->fill_in(
			'hashToTableRow',
			{
				toDir=>$self->{toDir},
				toFiles=>$self->{toFiles},
				obj=>\$self->{obj},
				c=>\$self->{toader}->getConfig,
				toader=>\$self->{toader},
				self=>\$self,
				g=>\$self,
				cssID=>$cssID,
				key=>$keys[$int],
				value=>$hash->{$keys[$int]},
			}
			);
		if ( $self->{t}->error ){
			$self->{error}=10;
			$self->{errorString}='Failed to fill in the template. error="'.
				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
			$self->warn;
			return undef;
		}
		push( @rows, $row );

		$int++;
	}

	return $begin.$titleRow.join( $join, @rows ).$end;
}

=head2 hasSubDirs

This returns to true if the current object
directory has any Toader sub directories.

    if ( $g->hasSubDirs ){
        print "This directory has sub directories.";
    }

=cut

sub hasSubDirs{
    my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    #gets a list of directories
	my @dirs;
	if ( ref( $self->{odir} ) eq 'Toader::Directory' ){
		@dirs=$self->{odir}->listSubToaderDirs;
		if ( $self->{odir}->error ){
			$self->{error}=22;
			$self->{errorString}='Failed to get a list of Toader sub directories. error="'
				.$self->{odir}->error.'" errorString="'.$self->{odir}->errorString.'"';
			return undef;
		}
	}else{
		my $dobj=Toader::Directory->new( $self->{toader} );
		$dobj->dirSet( $self->{odir} );
		@dirs=$dobj->listSubToaderDirs;
		if ( $dobj->error ){
			$self->{error}=22;
			$self->{errorString}='Failed to get a list of Toader sub directories. error="'
				.$dobj->error.'" errorString="'.$dobj->{odir}->errorString.'"';
			return undef;
		}
	}

	if ( defined( $dirs[0] ) ){
		return 1;
	}

	return 0;
}

=head2 imageDiv

This can be used for creating a captioned image.

The takes five arguments. The first and required is the URL
for the image. Second and optional is link to use for if the image
is clicked on, which if not defined, the image will not be setup
as a link. The third and optional is a caption to show above the
image, which if left undefined defaults to ''. The fourth and
optional is a caption to show below the image, which if left
undefined defaults to ''. The fifth is the CSS ID to use,
which if not defined defaults to 'imageDiv'. The sixth and
optional is the alt test to use, which if not specified defaults
to the provided image URL..

    $g-imageDiv( $imageURL, $imageLink, , 'some caption below it');

The default template, 'imageDiv' is as below.


      [== $above ==]
      [== if ( defined( $link ) ){ return '     }else{ return '' } ==]

      [== if ( defined( $link ) ){ return '    ' }else{ return '' } ==]
      [== $below ==]


The variables passed are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.
    image - This is the source URL to usse.
    above - This is the caption above the image.
    below - This is the caption below the image.
    link - This is a optional link to link to if the image is clicked on.
    alt - This is the alt text for the image.

=cut

sub imageDiv{
    my $self=$_[0];
	my $imageURL=$_[1];
	my $imageLink=$_[2];
	my $above=$_[3];
	my $below=$_[4];
	my $cssID=$_[5];
	my $alt=$_[6];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	#error if we have no URL for the image
	if ( ! defined( $imageURL ) ){
		$self->{error}=36;
		$self->{errorString}='No URL specified for the image';
		$self->warn;
		return undef;
	}

	#sets the default value for above if none is given
	if ( ! defined( $above ) ){
		$above='';
	}

	#sets the default value for below if none is given
	if ( ! defined( $below ) ){
		$below='';
	}

	#sets the default CSS ID if none is specified
	if ( ! defined( $cssID ) ){
		$cssID='imageDiv';
	}

	#sets alt to the URL if not specified
	if ( ! defined( $alt ) ){
		$alt=$imageURL;
	}

	my $rendered=$self->{t}->fill_in(
            'imageDiv',
            {
                toDir=>$self->{toDir},
                toFiles=>$self->{toFiles},
                obj=>\$self->{obj},
                c=>\$self->{toader}->getConfig,
                toader=>\$self->{toader},
                self=>\$self,
                g=>\$self,
                cssID=>$cssID,
				image=>$imageURL,
				above=>$above,
				below=>$below,
				alt=>$alt,
				link=>$imageLink,
            }
		);
        if ( $self->{t}->error ){
            $self->{error}=10;
            $self->{errorString}='Failed to fill in the template. error="'.
                $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
            $self->warn;
            return undef;
        }

	return $rendered;
}

=head2 imageExifTables

This returns the table of the tags for a image.

This puts together a tables of the common EXIF tag groups.

    [== $g->imageExifTables( $image ); ==]

this methode ignores the EXIF tables listed below.

    ExifTool
    System
    PrintIM
    File
    Printing
    Copy1

=head3 Templates

=head4 imageExifTables

This begins it.

The default template is as below.

    Image:  [== $filename ==]
    [== $tables ==]


The variables passed are as below.

    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.
    filename - This is the name of the image file.
    tables - This is the rendered tables from generated by the templates below.

=head3 imageExifTablesBegin

This begins the prefixes joining of the tables.

The default template is blank.

The variables passed are as below.

    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.

=head3 imageExifTablesGroup

This is a EXIF tag group.

The default table is as below.


    EXIF Tag Group: [== $group ==]
    [== $table ==]


The variables passed are as below.

    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.
    group - This is the EXIF tag group.
    table - This is the generated by hash2table.

=head3 imageExifTablesJoin

This joins the text rendered for imageExifTablesGroup

The default template is blank.

The variables passed are as below.

    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.

=head3 imageExifTablesEnd

This ends the prefixes joining of the tables.

The default template is blank.

The variables passed are as below.

    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    obj - This is the object that Toader was initiated with.

=cut

sub imageExifTables{
	my $self=$_[0];
	my $image=$_[1];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	if ( ! defined( $image ) ){
		$self->{error}=37;
		$self->{errorString}='No image file specified';
		$self->warn;
		return undef;
	}

	if ( ! -f $image ){
		$self->{error}=38;
		$self->{errorString}='The specified image, "'.$image.'", does not exist';
		$self->warn;
		return undef;
	}

	my $filename=$image;
	$filename=~s/.*\///;

	my $et=Image::ExifTool->new;
	$et->ExtractInfo( $image );

	my @foundTags=$et->GetFoundTags;

	my %tags;

	my $int=0;
	while( defined( $foundTags[$int] ) ){
        my $value=$et->GetValue( $foundTags[$int] );

        if (ref $value eq 'SCALAR') {
			$value='(unprintable value)'
        }

        my @groups=$et->GetGroup( $foundTags[$int] );

        my $int2=0;
        while( defined( $groups[$int2] ) ){
			if ( $groups[$int2] eq "" ){
				$groups[$int2]='""';
			}

			if ( ( $groups[$int2] ne 'ExifTool' ) &&
				 ( $groups[$int2] ne 'System' ) &&
				 ( $groups[$int2] ne 'PrintIM' ) &&
				 ( $groups[$int2] ne 'File' ) &&
				 ( $groups[$int2] ne 'Printing' ) &&
				 ( $groups[$int2] ne 'Copy1' )
				){
				if ( ! defined( $tags{ $groups[$int2] } ) ){
					$tags{ $groups[$int2] }={};
				}

				$tags{ $groups[$int2] }{ $foundTags[$int] }=$value;
			}

			$int2++;
        }

        $int++;
	}

	my @groups=sort( keys( %tags ) );

	my @renderedGroups;

	#puts together the Composite table if needed
	$int=0;
	while ( defined( $groups[$int] ) ){
		my $table=$self->hashToTable( $tags{ $groups[$int] } );
		if ( $self->error ){
           $self->warnString('Failed to convert the hash to a table for "'.$groups[$int].'"');
            return undef;
        }
        #renders the table
        my $rendered=$self->{t}->fill_in(
            'imageExifTablesGroup',
            {
                obj=>\$self->{obj},
                c=>\$self->{toader}->getConfig,
                toader=>\$self->{toader},
                self=>\$self,
                table=>$table,
				group=>$groups[$int],
            }
            );
        if ( $self->{t}->error ){
            $self->{error}=10;
            $self->{errorString}='Failed to fill in the template. error="'.
                $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
            $self->warn;
            return undef;
        }
		push( @renderedGroups, $rendered );

		$int++;
	}

	#renders the table joiner
	my $begin=$self->{t}->fill_in(
		'imageExifTablesBegin',
		{
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the table joiner
	my $join=$self->{t}->fill_in(
		'imageExifTablesJoin',
		{
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the table joiner
	my $end=$self->{t}->fill_in(
		'imageExifTablesEnd',
		{
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	my $joinedtables=$begin.join('', @renderedGroups ).$end;

	#renders the tables together
    my $rendered=$self->{t}->fill_in(
        'imageExifTables',
        {
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			tables=>$joinedtables,
			filename=>$filename,
        }
        );
    if ( $self->{t}->error ){
        $self->{error}=10;
        $self->{errorString}='Failed to fill in the template. error="'.
            $self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
        $self->warn;
        return undef;
    }

	return $rendered;
}

=head2 lastEntries

This returns the last entries, post rendering each one and joining them.

There is one optional and that is number of last entries to show. If
not specified, it shows the last 15.

    $g->lastEntries;

=head3 Templates

=head4 entryListBegin

This begins the list of the last entries.

The default template is blank.

The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.

=head4 entryListJoin

This joins the rendered entries.

The default template is as below.




The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.

=head4 entryListEnd

This ends the list of rendered entries.

The default template is as below.




The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - This is the object that it was invoked for.
    c - The L object containing the Toader config.
    toader - This is a L object.
    self - This the L object.
    g - This the L object.

=cut

sub lastEntries{
	my $self=$_[0];
	my $show=$_[1];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	#default to 15 to show
	if ( ! defined( $show ) ){
		$show=15;
	}

	my $em=Toader::Entry::Manage->new( $self->{toader} );
	$em->setDir( $self->{odir} );
	if ( $em->error ){
		$self->{error}=25;
		$self->{errorString}='Failed to set the directory, "'.$self->{odir}.
			'", for Toader::Entry::Manage. error="'.$em->error
			.'" errorString="'.$em->errorString.'"';
		$self->warn;
		return undef;
	}

	#lists the entries for the directory
	my @entries=$em->list;
	if ( $em->error ){
		$self->{error}=25;
		$self->{errorString}='Failed to read the entries for "'.$self->{odir}.
			'". error="'.$em->error.'" errorString="'.$em->errorString.'"';
		$self->warn;
		return undef;
	}

	#return '' if there are none
	if ( ! defined( $entries[0] ) ){
		return '';
	}

	#sort and order from last to first
	@entries=sort(@entries);
	@entries=reverse(@entries);

	#process each one
	my @tojoin;
	my $int=0;
	while ( defined( $entries[$int] ) ){
		my $entry=$em->read( $entries[$int] );
		if ( $em->error ){
			$self->{error}=26;
			$self->{errorString}='Failed to read "'.$entries[$int].'" in "'
				.$self->{odir}.'". error="'.$em->error.'" errorstring="'
				.$em->errorString.'"';
			$self->warn;
			return undef;
		}

		my $r=Toader::Render::Entry->new({
			obj=>$entry,
			toader=>$self->{toader},
			toDir=>$self->{toDir},
			});
		if ( $r->error ){
			$self->{error}=27;
			$self->{errorString}='Failed to initialize Toader::Render::Entry for "'.
				$entries[$int].'" in "'.$self->{odir}.'". error="'.$r->error.
				'" errorString="'.$r->errorString.'"';
			$self->warn;
			return undef;
		}

		my $rendered=$r->content;
		if ( $r->error ){
			$self->{error}=28;
			$self->{errorString}='Failed to render "'.$entries[$int].'" in "'
				.$self->{odir}.'". error="'.$r->error.'" errorString="'.$r->errorString.'"';
			$self->warn;
			return undef;
		}

		push( @tojoin, $rendered );

		$int++;
	}

	#renders the joiner
	my $joiner=$self->{t}->fill_in(
		'entryListJoin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the begining of the end of the last entries
	my $begin=$self->{t}->fill_in(
		'entryListBegin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the end of the end of the last entries
	my $end=$self->{t}->fill_in(
		'entryListEnd',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}


	return $begin.join( $joiner, @tojoin ).$end;
}

=head2 link

This generates a HTML link.

Two arguments are taken. The first and required one is the link.
The second is the text, which if not specified will will be the same
the link.

    $g->link( "http://foo.bar/whatever/", "whatever at foo.bar" );

The template used is 'link' and by default it is as below.

    [== $text ==]

The variables passed are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub link{
	my $self=$_[0];
	my $link=$_[1];
	my $text=$_[2];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	#make sure we have a link
	if ( ! defined( $link ) ){
		$self->{error}=8;
		$self->{errorString}='No link defined';
		$self->warn;
		return undef;
	}

	#set the text to the same as the link if no text is defined
	if ( ! defined( $text ) ){
		$text=$link;
	}

	#render it
	my $rendered=$self->{t}->fill_in(
		'link',
		{
			url=>$link,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			self=>\$self,
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 listDirs

This builds the side bar list of directories.

No options are taken.

    $g->listDirs;

This does not currently play nicely with any thing that will
set fullURL.

=head3 Templates

=head4 dirListBegin

This begins the dirlist.

The template used is 'dirListBegin' and by default is blank.

The variables passed are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=head4 dirListJoin

This joins items in the directory list.

The default template is 'dirListJoin' and it is as below.




The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=head4 dirListLink

This is a link for a directory in the directory list.

The template is 'dirListLink' and it is by default as below.

    [== $text ==]

The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L> object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=head4 dirListEnd

This ends the directory list.

The template used is 'dirListEnd' and the default is as below.




The passed variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub listDirs{
    my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	#renders the joiner
	my $joiner=$self->{t}->fill_in(
		'dirListJoin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the beginning of the dir list
	my $begin=$self->{t}->fill_in(
		'dirListBegin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the end of the dir list
	my $end=$self->{t}->fill_in(
		'dirListEnd',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#gets a list of directories
	my @dirs;
	if ( ref( $self->{odir} ) eq 'Toader::Directory' ){
		@dirs=$self->{odir}->listSubToaderDirs;
		if ( $self->{odir}->error ){
			$self->{error}=22;
			$self->{errorString}='Failed to get a list of Toader sub directories. error="'
				.$self->{odir}->error.'" errorString="'.$self->{odir}->errorString.'"';
			return undef;
		}
	}else{
		my $dobj=Toader::Directory->new( $self->{toader} );
		$dobj->dirSet( $self->{odir} );
		@dirs=$dobj->listSubToaderDirs;
		if ( $dobj->error ){
			$self->{error}=22;
			$self->{errorString}='Failed to get a list of Toader sub directories. error="'
				.$dobj->error.'" errorString="'.$dobj->{odir}->errorString.'"';
			return undef;
		}
	}
	@dirs=sort(@dirs);

	#return black here if there is nothing
	if ( ! defined( $dirs[0] ) ){
		return '';
	}

	#will hold it all prior to joining
	my @tojoin;

	#process it all
	my $int=0;
	while ( defined( $dirs[$int] ) ){
		#add the toDir to it
		my $dir=$self->{toDir}.$dirs[$int];
		$dir=~s/\/\/*/\//g;

		#render it
		my $rendered=$self->{t}->fill_in(
			'dirListLink',
			{
				url=>$dir,
				text=>$dirs[$int],
				toDir=>$self->{toDir},
				toFiles=>$self->{toFiles},
				obj=>\$self->{obj},
				c=>\$self->{toader}->getConfig,
				self=>\$self,
				toader=>\$self->{toader},
				g=>\$self,
			}
			);
		if ( $self->{t}->error ){
			$self->{error}=10;
			$self->{errorString}='Failed to fill in the template. error="'.
				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
			$self->warn;
			return undef;
		}

		push( @tojoin, $rendered );

		$int++;
	}

	return $begin.join( $joiner, @tojoin ).$end;
}

=head2 listPages

This returns returns a list of pages.

No options are taken.

    $g->listPages;

=head3 Templates

=head4 pageListBegin

This begins the page list.

The template is 'pageListBegin' and is blank.

The variables passed are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=head4 pageListJoin

This joins the items in the page list.

The template is 'pageListJoin' and is blank.




The variables passed are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=head4 pageListLink

This is a link to a page

The template is 'pageListLink' and is blank.

    [== $text ==]

The variables passed are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=head4 pageListEnd

This joins the items in the page list.

The template is 'pageListJoin' and is blank.




The variables passed are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub listPages{
	my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	#renders the begin
	my $begin=$self->{t}->fill_in(
		'pageListBegin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the joiner
	my $joiner=$self->{t}->fill_in(
		'pageListJoin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the end of the dir list
	my $end=$self->{t}->fill_in(
		'pageListEnd',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#gets a list of pages
	my $pm=Toader::Page::Manage->new( $self->{toader} );
	$pm->setDir( $self->{odir} );
	if ( $pm->error ){
		$self->{error}=23;
		$self->{errorString}='Failed to set the directory for Toader::Page::Manage. '.
			'error="'.$pm->error.'" errorString="'.$pm->errorString.'"';
		$self->warn;
		return undef;
	}
	my @pages=$pm->list;
	if ( $pm->error ){
		$self->{error}=24;
		$self->{errorString}='Failed to get a list of pages. error="'
			.$pm->error.'" errorString="'.$pm->errorString.'"';
		$self->warn;
		return undef;
	}

	#return blank if there pages
	if ( ! defined( $pages[0] ) ){
		return '';
	}

	#puts it together
	my $int=0;
	my @tojoin;
	while ( $pages[$int] ){
		#add the toDir to it
		my $dir=$self->{toDir}.'/.pages/'.$pages[$int].'/';
		$dir=~s/\/\/*/\//g;

		#render it
		my $rendered=$self->{t}->fill_in(
			'pageListLink',
			{
				url=>$dir,
				text=>$pages[$int],
				toDir=>$self->{toDir},
				toFiles=>$self->{toFiles},
				obj=>\$self->{obj},
				c=>\$self->{toader}->getConfig,
				self=>\$self,
				toader=>\$self->{toader},
				g=>\$self,
			}
			);
		if ( $self->{t}->error ){
			$self->{error}=10;
			$self->{errorString}='Failed to fill in the template. error="'.
				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
			$self->warn;
			return undef;
		}

		push( @tojoin, $rendered );

		$int++;
	}

	return $begin.join( $joiner, @tojoin ).$end;
}

=head2 locationbar

This puts together the the location bar.

One argument is taken and that is what to use for the lcation ID.

    $g->locationbar( $locationID );

=head3 Templates

=head4 locationStart

This starts the location bar.

The template used is 'locationStart' and the default is as below.

    Location:

The variabled passed are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=head4 locationPart

This is a part of the path in the location bar.

The template used is 'locationPart' and the default is as below.

    [== $text ==] /

The variables passed are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=head4 locationEnd

This is the end of the location bar.

The template used is 'locationEnd' and the default is as below.

    [== $locationID ==]


The variables passed are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    locationID - The string to use for the end location bar.

=cut

sub locationbar{
	my $self=$_[0];
	my $locationID=$_[1];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	my @parts=split( /\//, $self->{r2r} );

	#render it
	my $rendered=$self->{t}->fill_in(
		'locationStart',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			self=>\$self,
			c=>\$self->{toader}->getConfig,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#creates the url and cleans it up
	my $url=$self->{b2r};
	$url=~s/\/\/*/\//g;

	if ( $self->{fullURL} ){
		$url=$self->{url};
	}

	#does the initial link to the root directory
	$rendered=$rendered.$self->{t}->fill_in(
		'locationPart',
		{
			url=>$url,
			text=>'root',
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#processes each item
	my $int=0;
	my $dir=$self->{b2r}.'/';
	while ( defined( $parts[$int] ) ){

		if ( $parts[$int] ne '.' ){
			$dir=$dir.$parts[$int].'/';
			$dir=~s/\/\/*/\//g;
			$rendered=$rendered.$self->{t}->fill_in(
				'locationPart',
				{
					url=>$dir,
					text=>$parts[$int],
					toDir=>$self->{toDir},
					toFiles=>$self->{toFiles},
					obj=>\$self->{obj},
					c=>\$self->{toader}->getConfig,
					self=>\$self,
					toader=>\$self->{toader},
					g=>\$self,
				}
				);
			if ( $self->{t}->error ){
				$self->{error}=10;
				$self->{errorString}='Failed to fill in the template. error="'.
					$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
				$self->warn;
				return undef;
			}
		}

		$int++;
	}

	#gets the location ID
	if( ! defined( $locationID ) ){
		$locationID=$self->{obj}->locationID;
	}


	$rendered=$rendered.$self->{t}->fill_in(
		'locationEnd',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			locationID=>$locationID,
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 locationSubSet

This returns what ever has been set for the location sub via
L->locationSubSet.

    [== $g->locationSub ==]

=cut

sub locationSub{
    my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    return $self->{locationSub};
}

=head2 locationSub

This sets the location sub.

One argument is taken and that is what to set it to.

If not defined, '' is used.

    [== $g->locationSubSet( $whatever ) ==]

=cut

sub locationSubSet{
    my $self=$_[0];
	my $locationSub=$_[1];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	if ( ! defined( $locationSub ) ){
		$locationSub='';
	}

    $self->{locationSub}=$locationSub;

	return 1;
}

=head2 or2r

This returns the current value to from the root directory
to directory for the object that initialized this instance
of L.

    my $or2r=$g->or2r;

=cut

sub or2r{
    my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    return $self->{or2r};
}

=head2 pageSummary

This creates a summary of the pages in the current directory.

No arguments are taken.

    $g->pageSummary;

=head3 Templates

=head4 pageSummaryBegin

The begins the summary of the pages.

The template used is 'pageSummaryBegin' and the default is as below.

     




4688




 





 





 





 





 





 



        Name Summary  




4689




 





 





 





 





 





 



      




4690




 





 





 





 





 





 



   




4691




 





 





 





 





 





 



 The variabled passed are as below. 




4692




 





 





 





 





 





 



   




4693




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




4694




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




4695




 





 





 





 





 





 



     obj - The Toader::Entry object. 




4696




 





 





 





 





 





 



     c - The Config::Tiny object containing the Toader config. 




4697




 





 





 





 





 





 



     self - The Toader::Render::Entry object. 




4698




 





 





 





 





 





 



     toader - This is a Toader object. 




4699




 





 





 





 





 





 



     g - This is a Toader::Render::General object. 




4700




 





 





 





 





 





 



   




4701




 





 





 





 





 





 



 =head4 pageSummaryJoin 




4702




 





 





 





 





 





 



   




4703




 





 





 





 





 





 



 This joins the rows. 




4704




 





 





 





 





 





 



   




4705




 





 





 





 





 





 



 The template used is 'pageSummaryJoin' and by default is blank. 




4706




 





 





 





 





 





 



   




4707




 





 





 





 





 





 



 The variabled passed are as below. 




4708




 





 





 





 





 





 



   




4709




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




4710




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




4711




 





 





 





 





 





 



     obj - The L object. 




4712




 





 





 





 





 





 



     c - The L object containing the Toader config. 




4713




 





 





 





 





 





 



     self - The L object. 




4714




 





 





 





 





 





 



     toader - This is a L object. 




4715




 





 





 





 





 





 



     g - This is a L object. 




4716




 





 





 





 





 





 



   




4717




 





 





 





 





 





 



 =head4 pageSummarySummary 




4718




 





 





 





 





 





 



   




4719




 





 





 





 





 





 



 This is a row in the table of pages. 




4720




 





 





 





 





 





 



   




4721




 





 





 





 





 





 



 The template used is 'pageSummarySummary' and by default is as below. 




4722




 





 





 





 





 





 



   




4723




 





 





 





 





 





 



        




4724




 





 





 





 





 





 



         [== $name ==] 




4725




 





 





 





 





 





 



         [== $summary ==] 




4726




 





 





 





 





 





 



        




4727




 





 





 





 





 





 



   




4728




 





 





 





 





 





 



 The variabled passed are as below. 




4729




 





 





 





 





 





 



   




4730




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




4731




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




4732




 





 





 





 





 





 



     obj - The L object. 




4733




 





 





 





 





 





 



     c - The L object containing the Toader config. 




4734




 





 





 





 





 





 



     self - The L object. 




4735




 





 





 





 





 





 



     toader - This is a L object. 




4736




 





 





 





 





 





 



     g - This is a L object. 




4737




 





 





 





 





 





 



     name - This is the name of the page. 




4738




 





 





 





 





 





 



     summary - This is a summary of the page. 




4739




 





 





 





 





 





 



   




4740




 





 





 





 





 





 



 =cut 




4741




 





 





 





 





 





 



   




4742




 





 





 





 





 





 



 sub pageSummary{ 




4743




0





 





 




  
0
  



  
1
  




 



 	my $self=$_[0]; 




4744




 





 





 





 





 





 



   




4745




 





 





 





 





 





 



 	#blank any previous errors 




4746




0




  
  0
  




 





 





 





 



 	if ( ! $self->errorblank ){ 




4747




0





 





 





 





 





 



 		return undef; 




4748




 





 





 





 





 





 



 	} 




4749




 





 





 





 





 





 



   




4750




0





 





 





 





 





 



 	my $pm=Toader::Page::Manage->new( $self->{toader} ); 




4751




0





 





 





 





 





 



 	$pm->setDir( $self->{odir} ); 




4752




0




  
  0
  




 





 





 





 



 	if ( $pm->error ){ 




4753




0





 





 





 





 





 



 		$self->{error}=31; 




4754




0





 





 





 





 





 



 		$self->{errorString}='Failed to set the directory, "'.$self->{odir}. 




4755




 





 





 





 





 





 



 			'", for Toader::Page::Manage. error="'.$pm->error 




4756




 





 





 





 





 





 



 			.'" errorString="'.$pm->errorString.'"'; 




4757




0





 





 





 





 





 



 		$self->warn; 




4758




0





 





 





 





 





 



 		return undef; 




4759




 





 





 





 





 





 



 	} 




4760




 





 





 





 





 





 



   




4761




 





 





 





 





 





 



 	#lists the entries for the directory 




4762




0





 





 





 





 





 



 	my @pages=$pm->published; 




4763




0




  
  0
  




 





 





 





 



 	if ( $pm->error ){ 




4764




0





 





 





 





 





 



 		$self->{error}=32; 




4765




0





 





 





 





 





 



 		$self->{errorString}='Failed to list the pages for "'.$self->{odir}. 




4766




 





 





 





 





 





 



 			'". error="'.$pm->error.'" errorString="'.$pm->errorString.'"'; 




4767




0





 





 





 





 





 



 		$self->warn; 




4768




0





 





 





 





 





 



 		return undef; 




4769




 





 





 





 





 





 



 	} 




4770




 





 





 





 





 





 



   




4771




 





 





 





 





 





 



 	#return '' if there are none 




4772




0




  
  0
  




 





 





 





 



 	if ( ! defined( $pages[0] ) ){ 




4773




0





 





 





 





 





 



 		return ''; 




4774




 





 





 





 





 





 



 	} 




4775




 





 





 





 





 





 



   




4776




 





 





 





 





 





 



 	#sort and order from last to first 




4777




0





 





 





 





 





 



 	@pages=sort(@pages); 




4778




0





 





 





 





 





 



 	@pages=reverse(@pages); 




4779




 





 





 





 





 





 



   




4780




 





 





 





 





 





 



 	#process each one 




4781




0





 





 





 





 





 



 	my @tojoin; 




4782




0





 





 





 





 





 



 	my $int=0; 




4783




0





 





 





 





 





 



 	while ( defined( $pages[$int] ) ){ 




4784




0





 





 





 





 





 



 		my $entry=$pm->read( $pages[$int] ); 




4785




0




  
  0
  




 





 





 





 



 		if ( $pm->error ){ 




4786




0





 





 





 





 





 



 			$self->{error}=33; 




4787




0





 





 





 





 





 



 			$self->{errorString}='Failed to read "'.$pages[$int].'" in "' 




4788




 





 





 





 





 





 



 				.$self->{odir}.'". error="'.$pm->error.'" errorstring="' 




4789




 





 





 





 





 





 



 				.$pm->errorString.'"'; 




4790




0





 





 





 





 





 



 			$self->warn; 




4791




0





 





 





 





 





 



 			return undef; 




4792




 





 





 





 





 





 



 		} 




4793




 





 





 





 





 





 



   




4794




 





 





 





 





 





 



 		#renders the row 




4795




0





 





 





 





 





 



 		my $rendered=$self->{t}->fill_in( 




4796




 





 





 





 





 





 



 			'pageSummaryRow', 




4797




 





 





 





 





 





 



 			{ 




4798




 





 





 





 





 





 



 				toDir=>$self->{toDir}, 




4799




 





 





 





 





 





 



 				toFiles=>$self->{toFiles}, 




4800




 





 





 





 





 





 



 				obj=>\$self->{obj}, 




4801




 





 





 





 





 





 



 				c=>\$self->{toader}->getConfig, 




4802




 





 





 





 





 





 



 				toader=>\$self->{toader}, 




4803




 





 





 





 





 





 



 				self=>\$self, 




4804




 





 





 





 





 





 



 				name=>$entry->nameGet, 




4805




 





 





 





 





 





 



 				summary=>$entry->summaryGet, 




4806




 





 





 





 





 





 



 				g=>\$self, 




4807




 





 





 





 





 





 



 			} 




4808




 





 





 





 





 





 



 			); 




4809




0




  
  0
  




 





 





 





 



 		if ( $self->{t}->error ){ 




4810




0





 





 





 





 





 



 			$self->{error}=10; 




4811




0





 





 





 





 





 



 			$self->{errorString}='Failed to fill in the template. error="'. 




4812




 





 





 





 





 





 



 				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"'; 




4813




0





 





 





 





 





 



 			$self->warn; 




4814




0





 





 





 





 





 



 			return undef; 




4815




 





 





 





 





 





 



 		}		 




4816




 





 





 





 





 





 



 		 




4817




0





 





 





 





 





 



 		push( @tojoin, $rendered ); 




4818




 





 





 





 





 





 



   




4819




0





 





 





 





 





 



 		$int++; 




4820




 





 





 





 





 





 



 	} 




4821




 





 





 





 





 





 



   




4822




 





 





 





 





 





 



 	#renders the joiner 




4823




0





 





 





 





 





 



 	my $joiner=$self->{t}->fill_in( 




4824




 





 





 





 





 





 



 		'pageSummaryJoin', 




4825




 





 





 





 





 





 



 		{ 




4826




 





 





 





 





 





 



 			toDir=>$self->{toDir}, 




4827




 





 





 





 





 





 



 			toFiles=>$self->{toFiles}, 




4828




 





 





 





 





 





 



 			obj=>\$self->{obj}, 




4829




 





 





 





 





 





 



 			c=>\$self->{toader}->getConfig, 




4830




 





 





 





 





 





 



 			toader=>\$self->{toader}, 




4831




 





 





 





 





 





 



 			self=>\$self, 




4832




 





 





 





 





 





 



 			g=>\$self, 




4833




 





 





 





 





 





 



 		} 




4834




 





 





 





 





 





 



 		); 




4835




0




  
  0
  




 





 





 





 



 	if ( $self->{t}->error ){ 




4836




0





 





 





 





 





 



 		$self->{error}=10; 




4837




0





 





 





 





 





 



 		$self->{errorString}='Failed to fill in the template. error="'. 




4838




 





 





 





 





 





 



 			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"'; 




4839




0





 





 





 





 





 



 		$self->warn; 




4840




0





 





 





 





 





 



 		return undef; 




4841




 





 





 





 





 





 



 	} 




4842




 





 





 





 





 





 



   




4843




 





 





 





 





 





 



 	#renders the end of the dir list 




4844




0





 





 





 





 





 



 	my $end=$self->{t}->fill_in( 




4845




 





 





 





 





 





 



 		'pageSummaryEnd', 




4846




 





 





 





 





 





 



 		{ 




4847




 





 





 





 





 





 



 			toDir=>$self->{toDir}, 




4848




 





 





 





 





 





 



 			toFiles=>$self->{toFiles}, 




4849




 





 





 





 





 





 



 			obj=>\$self->{obj}, 




4850




 





 





 





 





 





 



 			c=>\$self->{toader}->getConfig, 




4851




 





 





 





 





 





 



 			toader=>\$self->{toader}, 




4852




 





 





 





 





 





 



 			self=>\$self, 




4853




 





 





 





 





 





 



 			g=>\$self, 




4854




 





 





 





 





 





 



 		} 




4855




 





 





 





 





 





 



 		); 




4856




0




  
  0
  




 





 





 





 



 	if ( $self->{t}->error ){ 




4857




0





 





 





 





 





 



 		$self->{error}=10; 




4858




0





 





 





 





 





 



 		$self->{errorString}='Failed to fill in the template. error="'. 




4859




 





 





 





 





 





 



 			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"'; 




4860




0





 





 





 





 





 



 		$self->warn; 




4861




0





 





 





 





 





 



 		return undef; 




4862




 





 





 





 





 





 



 	} 




4863




 





 





 





 





 





 



   




4864




 





 





 





 





 





 



 	#renders the end of the dir list 




4865




0





 





 





 





 





 



 	my $begin=$self->{t}->fill_in( 




4866




 





 





 





 





 





 



 		'pageSummaryBegin', 




4867




 





 





 





 





 





 



 		{ 




4868




 





 





 





 





 





 



 			toDir=>$self->{toDir}, 




4869




 





 





 





 





 





 



 			toFiles=>$self->{toFiles}, 




4870




 





 





 





 





 





 



 			obj=>\$self->{obj}, 




4871




 





 





 





 





 





 



 			c=>\$self->{toader}->getConfig, 




4872




 





 





 





 





 





 



 			toader=>\$self->{toader}, 




4873




 





 





 





 





 





 



 			self=>\$self, 




4874




 





 





 





 





 





 



 			g=>\$self, 




4875




 





 





 





 





 





 



 		} 




4876




 





 





 





 





 





 



 		); 




4877




0




  
  0
  




 





 





 





 



 	if ( $self->{t}->error ){ 




4878




0





 





 





 





 





 



 		$self->{error}=10; 




4879




0





 





 





 





 





 



 		$self->{errorString}='Failed to fill in the template. error="'. 




4880




 





 





 





 





 





 



 			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"'; 




4881




0





 





 





 





 





 



 		$self->warn; 




4882




0





 





 





 





 





 



 		return undef; 




4883




 





 





 





 





 





 



 	} 




4884




 





 





 





 





 





 



   




4885




0





 





 





 





 





 



 	return $begin.join( $joiner, @tojoin ).$end; 




4886




 





 





 





 





 





 



 } 




4887




 





 





 





 





 





 



   




4888




 





 





 





 





 





 



 =head2 pageSummaryLink 




4889




 





 





 





 





 





 



   




4890




 





 





 





 





 





 



 This is a link to summary of the pages for directory of the object. 




4891




 





 





 





 





 





 



   




4892




 





 





 





 





 





 



 On argument is accepted and that is the text to use for the link. If 




4893




 





 





 





 





 





 



 not specified, it defaults to 'Pages'. 




4894




 





 





 





 





 





 



   




4895




 





 





 





 





 





 



     $g->pageSummaryLink; 




4896




 





 





 





 





 





 



   




4897




 





 





 





 





 





 



 The template used is 'pageSummaryLink' and the default is as below. 




4898




 





 





 





 





 





 



   




4899




 





 





 





 





 





 



     [== $text ==] 




4900




 





 





 





 





 





 



   




4901




 





 





 





 





 





 



 The variables passed are as below. 




4902




 





 





 





 





 





 



   




4903




 





 





 





 





 





 



     url - This is the relative URL for this. 




4904




 





 





 





 





 





 



     text - This to use for with the link. 




4905




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




4906




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




4907




 





 





 





 





 





 



     obj - The L object. 




4908




 





 





 





 





 





 



     c - The L object containing the Toader config. 




4909




 





 





 





 





 





 



     self - The L object. 




4910




 





 





 





 





 





 



     toader - This is a L object. 




4911




 





 





 





 





 





 



     g - This is a L object. 




4912




 





 





 





 





 





 



   




4913




 





 





 





 





 





 



 =cut 




4914




 





 





 





 





 





 



   




4915




 





 





 





 





 





 



 sub pageSummaryLink{ 




4916




0





 





 




  
0
  



  
1
  




 



 	my $self=$_[0]; 




4917




0





 





 





 





 





 



 	my $text=$_[1]; 




4918




 





 





 





 





 





 



   




4919




0




  
  0
  




 





 





 





 



 	if ( ! defined( $text ) ){ 




4920




0





 





 





 





 





 



 		$text='Pages'; 




4921




 





 





 





 





 





 



 	} 




4922




 





 





 





 





 





 



   




4923




 





 





 





 





 





 



 	#blank any previous errors 




4924




0




  
  0
  




 





 





 





 



 	if ( ! $self->errorblank ){ 




4925




0





 





 





 





 





 



 		return undef; 




4926




 





 





 





 





 





 



 	} 




4927




 





 





 





 





 





 



   




4928




0





 





 





 





 





 



 	my $url; 




4929




0




  
  0
  




 





 





 





 



 	if ( $self->{fullURL} ){ 




4930




0





 





 





 





 





 



 		$url=$self->{r2r}.'/.pages/summary.html'; 




4931




0





 





 





 





 





 



 		$url=~s/\/\/*/\//g; 




4932




0





 





 





 





 





 



 		$url=$self->{url}; 




4933




 





 





 





 





 





 



 	}else{ 




4934




0





 





 





 





 





 



 		$url=$self->{toDir}.'/.pages/summary.html'; 




4935




0





 





 





 





 





 



 		$url=~s/\/\/*/\//g; 




4936




 





 





 





 





 





 



 	} 




4937




 





 





 





 





 





 



   




4938




 





 





 





 





 





 



 	#render it 




4939




0





 





 





 





 





 



 	my $rendered=$self->{t}->fill_in( 




4940




 





 





 





 





 





 



 		'pageSummaryLink', 




4941




 





 





 





 





 





 



 		{ 




4942




 





 





 





 





 





 



 			url=>$url, 




4943




 





 





 





 





 





 



 			text=>$text, 




4944




 





 





 





 





 





 



 			toDir=>$self->{toDir}, 




4945




 





 





 





 





 





 



 			toFiles=>$self->{toFiles}, 




4946




 





 





 





 





 





 



 			obj=>\$self->{obj}, 




4947




 





 





 





 





 





 



 			c=>\$self->{toader}->getConfig, 




4948




 





 





 





 





 





 



 			self=>\$self, 




4949




 





 





 





 





 





 



 			toader=>\$self->{toader}, 




4950




 





 





 





 





 





 



 			g=>\$self, 




4951




 





 





 





 





 





 



 		} 




4952




 





 





 





 





 





 



 		); 




4953




0




  
  0
  




 





 





 





 



 	if ( $self->{t}->error ){ 




4954




0





 





 





 





 





 



 		$self->{error}=10; 




4955




0





 





 





 





 





 



 		$self->{errorString}='Failed to fill in the template. error="'. 




4956




 





 





 





 





 





 



 			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"'; 




4957




0





 





 





 





 





 



 		$self->warn; 




4958




0





 





 





 





 





 



 		return undef; 




4959




 





 





 





 





 





 



 	} 




4960




 





 





 





 





 





 



   




4961




0





 





 





 





 





 



 	return $rendered; 




4962




 





 





 





 





 





 



 } 




4963




 





 





 





 





 





 



   




4964




 





 





 





 





 





 



 =head2 plink 




4965




 





 





 





 





 





 



   




4966




 





 





 





 





 





 



 This generates a link to a different page object. 




4967




 





 





 





 





 





 



   




4968




 





 





 





 





 





 



 Two arguments are taken. 




4969




 





 





 





 





 





 



   




4970




 





 





 





 





 





 



 The first and required one is the Toader directory containing 




4971




 





 





 





 





 





 



 the Toader object. 




4972




 





 





 





 





 





 



   




4973




 





 





 





 





 





 



 The second is the page to link to. 




4974




 





 





 





 





 





 



   




4975




 





 





 





 





 





 



 The third is the text, which if not specified will will be the 




4976




 





 





 





 





 





 



 same the link. 




4977




 





 





 





 





 





 



   




4978




 





 





 





 





 





 



     $g->plink( $dir, $page, "whatever at foo.bar" ); 




4979




 





 





 





 





 





 



   




4980




 





 





 





 





 





 



 The template used is 'linkPage' and it is by default as below. 




4981




 





 





 





 





 





 



   




4982




 





 





 





 





 





 



     [== $text ==] 




4983




 





 





 





 





 





 



   




4984




 





 





 





 





 





 



 The variables passed are as below. 




4985




 





 





 





 





 





 



   




4986




 





 





 





 





 





 



     url - This is the relative URL for this. 




4987




 





 





 





 





 





 



     text - This to use for with the link. 




4988




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




4989




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




4990




 





 





 





 





 





 



     obj - The L object. 




4991




 





 





 





 





 





 



     c - The L object containing the Toader config. 




4992




 





 





 





 





 





 



     self - The L object. 




4993




 





 





 





 





 





 



     toader - This is a L object. 




4994




 





 





 





 





 





 



     g - This is a L object. 




4995




 





 





 





 





 





 



   




4996




 





 





 





 





 





 



 =cut 




4997




 





 





 





 





 





 



   




4998




 





 





 





 





 





 



 sub plink{ 




4999




0





 





 




  
0
  



  
1
  




 



 	my $self=$_[0]; 




5000




0





 





 





 





 





 



 	my $dir=$_[1]; 




5001




0





 





 





 





 





 



 	my $page=$_[2]; 




5002




0





 





 





 





 





 



 	my $text=$_[3]; 




5003




 





 





 





 





 





 



   




5004




 





 





 





 





 





 



 	#blank any previous errors 




5005




0




  
  0
  




 





 





 





 



 	if ( ! $self->errorblank ){ 




5006




0





 





 





 





 





 



 		return undef; 




5007




 





 





 





 





 





 



 	} 




5008




 





 





 





 





 





 



   




5009




 





 





 





 





 





 



 	#make sure we have a link 




5010




0




  
  0
  




 





 





 





 



 	if ( ! defined( $dir ) ){ 




5011




0





 





 





 





 





 



 		$self->{error}=11; 




5012




0





 





 





 





 





 



 		$self->{errorString}='No Toader directory defined'; 




5013




0





 





 





 





 





 



 		$self->warn; 




5014




0





 





 





 





 





 



 		return undef; 




5015




 





 





 





 





 





 



 	} 




5016




 





 





 





 





 





 



   




5017




 





 





 





 





 





 



 	#make sure we have a link 




5018




0




  
  0
  




 





 





 





 



 	if ( ! defined( $page ) ){ 




5019




0





 





 





 





 





 



 		$self->{error}=15; 




5020




0





 





 





 





 





 



 		$self->{errorString}='No Toader page defined'; 




5021




0





 





 





 





 





 



 		$self->warn; 




5022




0





 





 





 





 





 



 		return undef; 




5023




 





 





 





 





 





 



 	} 




5024




 





 





 





 





 





 



   




5025




 





 





 





 





 





 



 	#set the text to the same as the link if no text is defined 




5026




0




  
  0
  




 





 





 





 



 	if ( ! defined( $text ) ){ 




5027




0





 





 





 





 





 



 		$text=$page; 




5028




 





 





 





 





 





 



 	} 




5029




 





 





 





 





 





 



   




5030




 





 





 





 





 





 



 	#handles it if it is a full path 




5031




0





 





 





 





 





 



 	my $dirtest; 




5032




0




  
  0
  




 





 





 





 



 	if ( $dir =~ /^\// ){ 




5033




0





 





 





 





 





 



 		$dir=$self->{toader}->getRootDir.$dir; 




5034




0





 





 





 





 





 



 		$dirtest=$dir; 




5035




0





 





 





 





 





 



 		$dir=$self->{ph}->relative2root( $dir ); 




5036




 





 





 





 





 





 



 	}else{ 




5037




0





 





 





 





 





 



 		$dirtest=$self->{dir}.'/'.$dir; 




5038




 





 





 





 





 





 



 	} 




5039




 





 





 





 





 





 



   




5040




 





 





 





 





 





 



 	#make sure it is a Toader directory 




5041




0




  
  0
  




 





 





 





 



 	if ( ! $self->{isatd}->isaToaderDir( $dirtest ) ){ 




5042




0





 





 





 





 





 



 		$self->{error}=12; 




5043




0





 





 





 





 





 



 		$self->{errorString}='"'.$dirtest.'" is not a Toader directory'; 




5044




0





 





 





 





 





 



 		$self->warn; 




5045




0





 





 





 





 





 



 		return undef; 




5046




 





 





 





 





 





 



 	} 




5047




 





 





 





 





 





 



   




5048




 





 





 





 





 





 



 	#make sure entry exists... will also make sure it exists 




5049




0





 





 





 





 





 



 	my $ph=Toader::Page::Helper->new( $self->{toader} ); 




5050




0





 





 





 





 





 



 	$ph->setDir( $dirtest ); 




5051




0




  
  0
  




 





 





 





 



 	if ( ! $ph->pageExists( $page ) ){ 




5052




0





 





 





 





 





 



 		$self->{error}=16; 




5053




0





 





 





 





 





 



 		$self->{errorString}='The Toader page "'.$page.'" does not exist for the Toader directory "'.$dirtest.'"'; 




5054




0





 





 





 





 





 



 		$self->warn; 




5055




0





 





 





 





 





 



 		return undef; 




5056




 





 





 





 





 





 



 	} 




5057




 





 





 





 





 





 



   




5058




0




  
  0
  




 





 





 





 



 	if ( $self->{fullURL} ){ 




5059




0





 





 





 





 





 



 		$dir=$dir.'/.pages/'.$page.'/'; 




5060




0





 





 





 





 





 



 		$dir=~s/\/\/*/\//g; 




5061




0





 





 





 





 





 



 		$dir=$self->{url}.$dir; 




5062




 





 





 





 





 





 



 	}else{ 




5063




0





 





 





 





 





 



 		$dir=$self->{toDir}.'/'.$dir.'/.pages/'.$page.'/'; 




5064




0





 





 





 





 





 



 		$dir=~s/\/\/*/\//g; 




5065




 





 





 





 





 





 



 	} 




5066




 





 





 





 





 





 



   




5067




 





 





 





 





 





 



 	#render it 




5068




0





 





 





 





 





 



 	my $rendered=$self->{t}->fill_in( 




5069




 





 





 





 





 





 



 		'linkPage', 




5070




 





 





 





 





 





 



 		{ 




5071




 





 





 





 





 





 



 			url=>$dir, 




5072




 





 





 





 





 





 



 			text=>$text, 




5073




 





 





 





 





 





 



 			toDir=>$self->{toDir}, 




5074




 





 





 





 





 





 



 			toFiles=>$self->{toFiles}, 




5075




 





 





 





 





 





 



 			obj=>\$self->{obj}, 




5076




 





 





 





 





 





 



 			c=>\$self->{toader}->getConfig, 




5077




 





 





 





 





 





 



 			self=>\$self, 




5078




 





 





 





 





 





 



 			toader=>\$self->{toader}, 




5079




 





 





 





 





 





 



 			g=>\$self, 




5080




 





 





 





 





 





 



 		} 




5081




 





 





 





 





 





 



 		); 




5082




0




  
  0
  




 





 





 





 



 	if ( $self->{t}->error ){ 




5083




0





 





 





 





 





 



 		$self->{error}=10; 




5084




0





 





 





 





 





 



 		$self->{errorString}='Failed to fill in the template. error="'. 




5085




 





 





 





 





 





 



 			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"'; 




5086




0





 





 





 





 





 



 		$self->warn; 




5087




0





 





 





 





 





 



 		return undef; 




5088




 





 





 





 





 





 



 	} 




5089




 





 





 





 





 





 



   




5090




0





 





 





 





 





 



 	return $rendered; 




5091




 





 





 





 





 





 



 } 




5092




 





 





 





 





 





 



   




5093




 





 





 





 





 





 



 =head2 r2r 




5094




 





 





 





 





 





 



   




5095




 





 





 





 





 





 



 This returns the current value to from the root directory 




5096




 





 





 





 





 





 



 to current directory. 




5097




 





 





 





 





 





 



   




5098




 





 





 





 





 





 



     my $r2r=$g->r2r; 




5099




 





 





 





 





 





 



   




5100




 





 





 





 





 





 



 =cut 




5101




 





 





 





 





 





 



   




5102




 





 





 





 





 





 



 sub r2r{ 




5103




0





 





 




  
0
  



  
1
  




 



     my $self=$_[0]; 




5104




 





 





 





 





 





 



   




5105




 





 





 





 





 





 



     #blank any previous errors 




5106




0




  
  0
  




 





 





 





 



     if ( ! $self->errorblank ){ 




5107




0





 





 





 





 





 



         return undef; 




5108




 





 





 





 





 





 



     } 




5109




 





 





 





 





 





 



   




5110




0





 





 





 





 





 



     return $self->{r2r}; 




5111




 





 





 





 





 





 



 } 




5112




 





 





 





 





 





 



   




5113




 





 





 





 





 





 



 =head2 rlink 




5114




 





 





 





 





 





 



   




5115




 





 





 





 





 





 



 This generates a link to the root directory. 




5116




 





 





 





 





 





 



   




5117




 





 





 





 





 





 



 One option arguement is taken. It is the text part of the link. 




5118




 





 





 





 





 





 



 If not defined it defaults to the relative path to the root 




5119




 





 





 





 





 





 



 directory. 




5120




 





 





 





 





 





 



   




5121




 





 





 





 





 





 



     $g->rlink("to root"); 




5122




 





 





 





 





 





 



   




5123




 





 





 





 





 





 



 The template used is 'toRootLink' and is as below. 




5124




 





 





 





 





 





 



   




5125




 





 





 





 





 





 



     [== $text ==] 




5126




 





 





 





 





 





 



   




5127




 





 





 





 





 





 



 The variables are as below. 




5128




 





 





 





 





 





 



   




5129




 





 





 





 





 





 



     url - This is the relative URL for this. 




5130




 





 





 





 





 





 



     text - This to use for with the link. 




5131




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




5132




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




5133




 





 





 





 





 





 



     obj - The L object. 




5134




 





 





 





 





 





 



     c - The L object containing the Toader config. 




5135




 





 





 





 





 





 



     self - The L object. 




5136




 





 





 





 





 





 



     toader - This is a L object. 




5137




 





 





 





 





 





 



     g - This is a L object. 




5138




 





 





 





 





 





 



   




5139




 





 





 





 





 





 



 =cut 




5140




 





 





 





 





 





 



   




5141




 





 





 





 





 





 



 sub rlink{ 




5142




0





 





 




  
0
  



  
1
  




 



 	my $self=$_[0]; 




5143




0





 





 





 





 





 



 	my $text=$_[1]; 




5144




 





 





 





 





 





 



   




5145




 





 





 





 





 





 



 	#blank any previous errors 




5146




0




  
  0
  




 





 





 





 



 	if ( ! $self->errorblank ){ 




5147




0





 





 





 





 





 



 		return undef; 




5148




 





 





 





 





 





 



 	} 




5149




 





 





 





 





 





 



   




5150




0




  
  0
  




 





 





 





 



 	if ( ! defined( $text ) ){ 




5151




0





 





 





 





 





 



 		$text='/'; 




5152




 





 





 





 





 





 



 	} 




5153




 





 





 





 





 





 



   




5154




 





 





 





 





 





 



 	#creates the url and cleans it up 




5155




0





 





 





 





 





 



 	my $url=''; 




5156




0




  
  0
  




 





 





 





 



 	if ( $self->{fullURL} ){ 




5157




0





 





 





 





 





 



 		$url=$self->{url}; 




5158




 





 





 





 





 





 



 	}else{ 




5159




0





 





 





 





 





 



 		$url=$self->{b2r}; 




5160




0





 





 





 





 





 



 		$url=~s/\/\/*/\//g; 




5161




 





 





 





 





 





 



 	} 




5162




 





 





 





 





 





 



   




5163




 





 





 





 





 





 



 	#render it 




5164




0





 





 





 





 





 



 	my $rendered=$self->{t}->fill_in( 




5165




 





 





 





 





 





 



 		'toRootLink', 




5166




 





 





 





 





 





 



 		{ 




5167




 





 





 





 





 





 



 			url=>$url, 




5168




 





 





 





 





 





 



 			text=>$text, 




5169




 





 





 





 





 





 



 			toDir=>$self->{toDir}, 




5170




 





 





 





 





 





 



 			toFiles=>$self->{toFiles}, 




5171




 





 





 





 





 





 



 			obj=>\$self->{obj}, 




5172




 





 





 





 





 





 



 			c=>\$self->{toader}->getConfig, 




5173




 





 





 





 





 





 



 			self=>\$self, 




5174




 





 





 





 





 





 



 			toader=>\$self->{toader}, 




5175




 





 





 





 





 





 



 			g=>\$self, 




5176




 





 





 





 





 





 



 		} 




5177




 





 





 





 





 





 



 		); 




5178




0




  
  0
  




 





 





 





 



 	if ( $self->{t}->error ){ 




5179




0





 





 





 





 





 



 		$self->{error}=10; 




5180




0





 





 





 





 





 



 		$self->{errorString}='Failed to fill in the template. error="'. 




5181




 





 





 





 





 





 



 			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"'; 




5182




0





 





 





 





 





 



 		$self->warn; 




5183




0





 





 





 





 





 



 		return undef; 




5184




 





 





 





 





 





 



 	} 




5185




 





 





 





 





 





 



   




5186




0





 





 





 





 





 



 	return $rendered; 




5187




 





 





 





 





 





 



 } 




5188




 





 





 





 





 





 



   




5189




 





 





 





 





 





 



 =head2 sidebar 




5190




 





 





 





 





 





 



   




5191




 





 





 





 





 





 



 This renders the sidebar for a page. 




5192




 





 





 





 





 





 



   




5193




 





 





 





 





 





 



 The template is 'sidebar' and the default is as below. 




5194




 





 





 





 





 





 



   




5195




 





 





 





 





 





 



     [== 




5196




 





 





 





 





 





 



       if ( ! $g->hasEntries ){ 




5197




 





 





 





 





 





 



         return ""; 




5198




 





 





 





 





 





 



       } 




5199




 





 





 





 





 





 



       return "Entries\n". 




5200




 





 





 





 





 





 



         "		".$g->entriesLink." \n". 




5201




 





 





 





 





 





 



         "		".$g->entriesArchiveLink." \n"; 




5202




 





 





 





 





 





 



     ==] 




5203




 





 





 





 





 





 



     [== 




5204




 





 





 





 





 





 



       my $pages=$g->listPages; 




5205




 





 





 





 





 





 



       if ( ( ! defined( $pages ) ) || ( $pages eq "" ) ){ 




5206




 





 





 





 





 





 



         return ""; 




5207




 





 





 





 





 





 



       } 




5208




 





 





 





 





 





 



       return "		".$g->pageSummaryLink."\n".$pages."\n		\n"; 




5209




 





 





 





 





 





 



     ==] 




5210




 





 





 





 





 





 



     [== 




5211




 





 





 





 





 





 



       if( $g->hasGallery ){ 




5212




 





 





 





 





 





 



         return "\n".$g->galleryLink.""; 




5213




 





 





 





 





 





 



       }else{ 




5214




 





 





 





 





 





 



         return ""; 




5215




 





 





 





 





 





 



       } 




5216




 





 





 





 





 





 



     ==] 




5217




 





 





 





 





 





 



     [== 




5218




 





 





 





 





 





 



       if( $g->hasAnyDirs ){ 




5219




 





 





 





 





 





 



           return "\nDirectories"; 




5220




 





 





 





 





 





 



       }else{ 




5221




 





 





 





 





 





 



         return ""; 




5222




 





 





 





 





 





 



       } 




5223




 





 





 





 





 





 



     ==] 




5224




 





 





 





 





 





 



     [==  




5225




 





 





 





 





 





 



       if ( $g->atRoot ){ 




5226




 





 





 





 





 





 



         return ""; 




5227




 





 





 





 





 





 



       } 




5228




 





 





 





 





 





 



       return $g->rlink("Go To The Root")."		\n		". 




5229




 





 





 





 





 





 



         $g->upOneDirLink."		\n		"; 




5230




 





 





 





 





 





 



     ==] 




5231




 





 





 





 





 





 



      




5232




 





 





 





 





 





 



     [==  




5233




 





 





 





 





 





 



       if ( $g->hasSubDirs ){ 




5234




 





 





 





 





 





 



         return $g->listDirs; 




5235




 





 





 





 





 





 



       } 




5236




 





 





 





 





 





 



       return ""; 




5237




 





 





 





 





 





 



     ==] 




5238




 





 





 





 





 





 



     [== 




5239




 





 





 





 





 





 



       if ( $g->hasDocs ){ 




5240




 





 





 





 





 





 



         return "".$g->adListLink; 




5241




 





 





 





 





 





 



       } 




5242




 





 





 





 





 





 



       return ""; 




5243




 





 





 





 





 





 



     ==] 




5244




 





 





 





 





 





 



   




5245




 





 





 





 





 





 



 The variables are as below. 




5246




 





 





 





 





 





 



   




5247




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




5248




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




5249




 





 





 





 





 





 



     obj - The L object. 




5250




 





 





 





 





 





 



     c - The L object containing the Toader config. 




5251




 





 





 





 





 





 



     self - The L object. 




5252




 





 





 





 





 





 



     toader - This is a L object. 




5253




 





 





 





 





 





 



     g - This is a L object. 




5254




 





 





 





 





 





 



   




5255




 





 





 





 





 





 



 =cut 




5256




 





 





 





 





 





 



   




5257




 





 





 





 





 





 



 sub sidebar{ 




5258




0





 





 




  
0
  



  
1
  




 



     my $self=$_[0]; 




5259




 





 





 





 





 





 



   




5260




 





 





 





 





 





 



     #blank any previous errors 




5261




0




  
  0
  




 





 





 





 



     if ( ! $self->errorblank ){ 




5262




0





 





 





 





 





 



         return undef; 




5263




 





 





 





 





 





 



     } 




5264




 





 





 





 





 





 



   




5265




 





 





 





 





 





 



 	#render it 




5266




0





 





 





 





 





 



 	my $rendered=$self->{t}->fill_in( 




5267




 





 





 





 





 





 



 		'sidebar', 




5268




 





 





 





 





 





 



 		{ 




5269




 





 





 





 





 





 



 			toDir=>$self->{toDir}, 




5270




 





 





 





 





 





 



 			toFiles=>$self->{toFiles}, 




5271




 





 





 





 





 





 



 			obj=>\$self->{obj}, 




5272




 





 





 





 





 





 



 			c=>\$self->{toader}->getConfig, 




5273




 





 





 





 





 





 



 			self=>\$self, 




5274




 





 





 





 





 





 



 			toader=>\$self->{toader}, 




5275




 





 





 





 





 





 



 			g=>\$self, 




5276




 





 





 





 





 





 



 		} 




5277




 





 





 





 





 





 



 		); 




5278




0




  
  0
  




 





 





 





 



 	if ( $self->{t}->error ){ 




5279




0





 





 





 





 





 



 		$self->{error}=10; 




5280




0





 





 





 





 





 



 		$self->{errorString}='Failed to fill in the template. error="'. 




5281




 





 





 





 





 





 



 			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"'; 




5282




0





 





 





 





 





 



 		$self->warn; 




5283




0





 





 





 





 





 



 		return undef; 




5284




 





 





 





 





 





 



 	} 




5285




 





 





 





 





 





 



   




5286




0





 





 





 





 





 



 	return $rendered; 




5287




 





 





 





 





 





 



 } 




5288




 





 





 





 





 





 



   




5289




 





 





 





 





 





 



 =head2 toDir 




5290




 





 





 





 





 





 



   




5291




 





 





 





 





 





 



 This returns the value that was set for toDir. 




5292




 





 





 





 





 





 



   




5293




 





 





 





 





 





 



     my $toDir=>$g->toDir; 




5294




 





 





 





 





 





 



   




5295




 





 





 





 





 





 



 =cut 




5296




 





 





 





 





 





 



   




5297




 





 





 





 





 





 



 sub toDir{ 




5298




0





 





 




  
0
  



  
1
  




 



     my $self=$_[0]; 




5299




 





 





 





 





 





 



   




5300




 





 





 





 





 





 



     #blank any previous errors 




5301




0




  
  0
  




 





 





 





 



     if ( ! $self->errorblank ){ 




5302




0





 





 





 





 





 



         return undef; 




5303




 





 





 





 





 





 



     } 




5304




 





 





 





 





 





 



   




5305




0





 





 





 





 





 



 	return $self->{toDir}; 




5306




 





 





 





 





 





 



 } 




5307




 





 





 





 





 





 



   




5308




 





 





 





 





 





 



 =head2 top 




5309




 





 





 





 





 





 



   




5310




 





 





 





 





 





 



 This renders the top include. 




5311




 





 





 





 





 





 



   




5312




 





 





 





 





 





 



     $g->top; 




5313




 





 





 





 





 





 



   




5314




 





 





 





 





 





 



 The template is 'top' and the default is as below. 




5315




 





 





 





 





 





 



   




5316




 





 





 





 





 





 



     [== $c->{_}->{site} ==] 




5317




 





 





 





 





 





 



   




5318




 





 





 





 





 





 



 The variables are as below. 




5319




 





 





 





 





 





 



   




5320




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




5321




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




5322




 





 





 





 





 





 



     obj - The L object. 




5323




 





 





 





 





 





 



     c - The L object containing the Toader config. 




5324




 





 





 





 





 





 



     self - The L object. 




5325




 





 





 





 





 





 



     toader - This is a L object. 




5326




 





 





 





 





 





 



     g - This is a L object. 




5327




 





 





 





 





 





 



   




5328




 





 





 





 





 





 



 =cut 




5329




 





 





 





 





 





 



   




5330




 





 





 





 





 





 



 sub top{ 




5331




0





 





 




  
0
  



  
1
  




 



 	my $self=$_[0]; 




5332




 





 





 





 





 





 



   




5333




 





 





 





 





 





 



 	#blank any previous errors 




5334




0




  
  0
  




 





 





 





 



 	if ( ! $self->errorblank ){ 




5335




0





 





 





 





 





 



 		return undef; 




5336




 





 





 





 





 





 



 	} 




5337




 





 





 





 





 





 



   




5338




0





 





 





 





 





 



 	my $dir=$self->{b2r}; 




5339




 





 





 





 





 





 



   




5340




 





 





 





 





 





 



 	#add the toDir to it 




5341




0





 





 





 





 





 



 	$dir=$self->{toDir}.$dir; 




5342




 





 





 





 





 





 



 	 




5343




 





 





 





 





 





 



 	#render it 




5344




0





 





 





 





 





 



 	my $rendered=$self->{t}->fill_in( 




5345




 





 





 





 





 





 



 		'top', 




5346




 





 





 





 





 





 



 		{ 




5347




 





 





 





 





 





 



 			toDir=>$self->{toDir}, 




5348




 





 





 





 





 





 



 			toFiles=>$self->{toFiles}, 




5349




 





 





 





 





 





 



 			obj=>\$self->{obj}, 




5350




 





 





 





 





 





 



 			c=>\$self->{toader}->getConfig, 




5351




 





 





 





 





 





 



 			toader=>\$self->{toader}, 




5352




 





 





 





 





 





 



 			self=>\$self, 




5353




 





 





 





 





 





 



 			g=>\$self, 




5354




 





 





 





 





 





 



 		} 




5355




 





 





 





 





 





 



 		); 




5356




0




  
  0
  




 





 





 





 



 	if ( $self->{t}->error ){ 




5357




0





 





 





 





 





 



 		$self->{error}=10; 




5358




0





 





 





 





 





 



 		$self->{errorString}='Failed to fill in the template. error="'. 




5359




 





 





 





 





 





 



 			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"'; 




5360




0





 





 





 





 





 



 		$self->warn; 




5361




0





 





 





 





 





 



 		return undef; 




5362




 





 





 





 





 





 



 	} 




5363




 





 





 





 





 





 



   




5364




0





 





 





 





 





 



 	return $rendered; 




5365




 





 





 





 





 





 



 } 




5366




 





 





 





 





 





 



   




5367




 





 





 





 





 





 



 =head2 upOneDirLink 




5368




 





 





 





 





 





 



   




5369




 





 





 





 





 





 



 This creates a link up to the next directory. 




5370




 





 





 





 





 





 



   




5371




 





 





 





 





 





 



 One argument is taken and that is text to show for the link. If 




5372




 





 





 





 





 





 



 not specified, it defaults to 'Up One Directory'. 




5373




 





 





 





 





 





 



   




5374




 





 





 





 





 





 



     $g->upOneDirLink; 




5375




 





 





 





 





 





 



   




5376




 





 





 





 





 





 



 The template is 'upOneDirLink' and the default is as below. 




5377




 





 





 





 





 





 



   




5378




 





 





 





 





 





 



     [== $text ==] 




5379




 





 





 





 





 





 



   




5380




 





 





 





 





 





 



 The passed variables are as below. 




5381




 





 





 





 





 





 



   




5382




 





 





 





 





 





 



     url - This is the relative URL for this. 




5383




 





 





 





 





 





 



     text - This to use for with the link. 




5384




 





 





 





 





 





 



     toDir - This is the relative back to the directory. 




5385




 





 





 





 





 





 



     toFiles - This is the relative path to the '.files' directory. 




5386




 





 





 





 





 





 



     obj - The L object. 




5387




 





 





 





 





 





 



     c - The L object containing the Toader config. 




5388




 





 





 





 





 





 



     self - The L object. 




5389




 





 





 





 





 





 



     toader - This is a L object. 




5390




 





 





 





 





 





 



     g - This is a L object. 




5391




 





 





 





 





 





 



   




5392




 





 





 





 





 





 



 =cut 




5393




 





 





 





 





 





 



   




5394




 





 





 





 





 





 



 sub upOneDirLink{ 




5395




0





 





 




  
0
  



  
1
  




 



 	my $self=$_[0]; 




5396




0





 





 





 





 





 



 	my $text=$_[1]; 




5397




 





 





 





 





 





 



   




5398




 





 





 





 





 





 



     #blank any previous errors 




5399




0




  
  0
  




 





 





 





 



     if ( ! $self->errorblank ){ 




5400




0





 





 





 





 





 



         return undef; 




5401




 





 





 





 





 





 



     } 




5402




 





 





 





 





 





 



   




5403




0




  
  0
  




 





 





 





 



 	if ( ! defined( $text ) ){ 




5404




0





 





 





 





 





 



 		$text='Up One Directory'; 




5405




 





 





 





 





 





 



 	} 




5406




 





 





 





 





 





 



   




5407




 





 





 





 





 





 



 	#creates the url and cleans it up 




5408




0





 





 





 





 





 



 	my $url=$self->{toDir}.'/../'; 




5409




0





 





 





 





 





 



 	$url=~s/\/\/*/\//g; 




5410




 





 





 





 





 





 



   




5411




 





 





 





 





 





 



 	#render it 




5412




0





 





 





 





 





 



 	my $rendered=$self->{t}->fill_in( 




5413




 





 





 





 





 





 



 		'upOneDirLink', 




5414




 





 





 





 





 





 



 		{ 




5415




 





 





 





 





 





 



 			url=>$url, 




5416




 





 





 





 





 





 



 			text=>$text, 




5417




 





 





 





 





 





 



 			toDir=>$self->{toDir}, 




5418




 





 





 





 





 





 



 			toFiles=>$self->{toFiles}, 




5419




 





 





 





 





 





 



 			obj=>\$self->{obj}, 




5420




 





 





 





 





 





 



 			c=>\$self->{toader}->getConfig, 




5421




 





 





 





 





 





 



 			self=>\$self, 




5422




 





 





 





 





 





 



 			toader=>\$self->{toader}, 




5423




 





 





 





 





 





 



 			g=>\$self, 




5424




 





 





 





 





 





 



 		} 




5425




 





 





 





 





 





 



 		); 




5426




0




  
  0
  




 





 





 





 



 	if ( $self->{t}->error ){ 




5427




0





 





 





 





 





 



 		$self->{error}=10; 




5428




0





 





 





 





 





 



 		$self->{errorString}='Failed to fill in the template. error="'. 




5429




 





 





 





 





 





 



 			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"'; 




5430




0





 





 





 





 





 



 		$self->warn; 




5431




0





 





 





 





 





 



 		return undef; 




5432




 





 





 





 





 





 



 	} 




5433




 





 





 





 





 





 



   




5434




0





 





 





 





 





 



 	return $rendered; 




5435




 





 





 





 





 





 



 } 




5436




 





 





 





 





 





 



   




5437




 





 





 





 





 





 



 =head1 ERROR CODES 




5438




 





 





 





 





 





 



   




5439




 





 





 





 





 





 



 =head2 1, noToaderObj 




5440




 





 





 





 





 





 



   




5441




 





 





 





 





 





 



 No L object defined. 




5442




 





 





 





 





 





 



   




5443




 





 





 





 





 





 



 =head2 2, notAtoaderObj 




5444




 





 





 





 





 





 



   




5445




 





 





 





 





 





 



 The object specified for the L object is not really a 




5446




 





 





 





 





 





 



 L object. 




5447




 





 





 





 





 





 



   




5448




 





 





 





 





 





 



 =head2 3, toaderPerror 




5449




 





 





 





 





 





 



   




5450




 





 





 





 





 





 



 The specified L object has a permanent error set. 




5451




 





 





 





 





 





 



   




5452




 





 





 





 





 





 



 =head2 4, noRenderableObj 




5453




 





 





 





 





 





 



   




5454




 





 





 





 





 





 



 No object specified for the renderable object. 




5455




 





 





 





 





 





 



   




5456




 





 





 





 





 





 



 =head2 5, notArenderableObj 




5457




 





 





 





 





 





 



   




5458




 





 





 





 





 





 



 The object specified for the renderable object was not defined. 




5459




 





 





 





 





 





 



   




5460




 





 





 





 





 





 



 =head2 6, objPerror 




5461




 





 





 





 





 





 



   




5462




 





 





 





 





 





 



 The specified renderable object has a permanent error set. 




5463




 





 





 





 





 





 



   




5464




 





 





 





 





 





 



 =head2 7, noDirSet 




5465




 





 





 





 





 





 



   




5466




 





 





 





 





 





 



 The renderable object does not have a directory specified. 




5467




 





 





 





 





 





 



   




5468




 





 





 





 





 





 



 =head2 8, noLinkDefined 




5469




 





 





 





 





 





 



   




5470




 





 





 





 





 





 



 Nothing defined for the link. 




5471




 





 





 





 





 





 



   




5472




 





 





 





 





 





 



 =head2 9, templateFetchErrored 




5473




 





 





 





 





 





 



   




5474




 





 





 





 





 





 



 Failed to fetch the template. 




5475




 





 





 





 





 





 



   




5476




 





 





 





 





 





 



 =head2 11, noToaderDirSpecified 




5477




 





 





 





 





 





 



   




5478




 





 





 





 





 





 



 No Toader directory specified. 




5479




 





 





 





 





 





 



   




5480




 





 





 





 





 





 



 =head2 12, notAtoaderDir 




5481




 





 





 





 





 





 



   




5482




 





 





 





 





 





 



 The specified directory is not a L directory. 




5483




 





 





 





 





 





 



   




5484




 





 





 





 





 





 



 =head2 13, noEntryIDspecified 




5485




 





 





 





 





 





 



   




5486




 





 





 





 





 





 



 No L ID defined. 




5487




 





 





 





 





 





 



   




5488




 





 





 





 





 





 



 =head2 14, entryDoesNotExist 




5489




 





 





 





 





 





 



   




5490




 





 





 





 





 





 



 The entry does not exist. 




5491




 





 





 





 





 





 



   




5492




 





 





 





 





 





 



 =head2 15, noPageSpecified 




5493




 





 





 





 





 





 



   




5494




 





 





 





 





 





 



 No L page is defined. 




5495




 





 





 





 





 





 



   




5496




 





 





 





 





 





 



 =head2 16, pageDoesNotExist 




5497




 





 





 





 





 





 



   




5498




 





 





 





 





 





 



 The page does not exist. 




5499




 





 





 





 





 





 



   




5500




 





 





 





 





 





 



 =head2 17, noFileSpecified 




5501




 





 





 





 





 





 



   




5502




 





 





 





 





 





 



 No file specified. 




5503




 





 





 





 





 





 



   




5504




 





 





 





 





 





 



 =head2 18, templateInitErrored 




5505




 





 





 





 





 





 



   




5506




 





 





 





 





 





 



 Failed to initialize the L object. 




5507




 





 





 





 





 





 



   




5508




 





 





 





 





 





 



 =head2 19, r2rErrored 




5509




 





 





 





 





 





 



   




5510




 





 





 





 





 





 



 Failed to figure out the relative from root path. 




5511




 





 





 





 





 





 



   




5512




 





 





 





 





 





 



 =head2 20, b2rErrored 




5513




 





 





 





 





 





 



   




5514




 





 





 





 





 





 



 Failed to figure out the relative back to root path. 




5515




 





 





 





 





 





 



   




5516




 





 





 





 





 





 



 =head2 21, pathhelperInitErrored 




5517




 





 





 





 





 





 



   




5518




 





 





 





 





 





 



 Failed to initialize the L object. 




5519




 





 





 





 





 





 



   




5520




 





 





 





 





 





 



 =head2 22, subToaderDirListErrored 




5521




 





 





 





 





 





 



   




5522




 





 





 





 





 





 



 Failed to get a list of L sub directories for the 




5523




 





 





 





 





 





 



 current directory. 




5524




 





 





 





 





 





 



   




5525




 





 





 





 





 





 



 =head2 23, pageManageDirSetErrored 




5526




 





 





 





 





 





 



   




5527




 





 





 





 





 





 



 Failed to set the directory for L. 




5528




 





 





 





 





 





 



   




5529




 





 





 





 





 





 



 =head2 24, listPagesErrored 




5530




 





 





 





 





 





 



   




5531




 





 





 





 





 





 



 Failed to get a list of pages. 




5532




 





 





 





 





 





 



   




5533




 





 





 





 





 





 



 =head2 25, entryManageErrored 




5534




 





 





 





 





 





 



   




5535




 





 





 





 





 





 



 L could not have it's directory set. 




5536




 





 





 





 





 





 



   




5537




 





 





 





 





 





 



 =head2 26, readEntryErrored 




5538




 





 





 





 





 





 



   




5539




 





 





 





 





 





 



 Failed to read a entry. 




5540




 





 





 





 





 





 



   




5541




 





 





 





 





 





 



 =head2 27, renderEntryInitErrored 




5542




 





 





 





 





 





 



   




5543




 





 





 





 





 





 



 Failed to initialize L. 




5544




 





 





 





 





 





 



   




5545




 





 





 





 





 





 



 =head2 28, renderEntryErrored 




5546




 





 





 





 





 





 



   




5547




 





 





 





 





 





 



 Failed to render a entry. 




5548




 





 





 





 





 





 



   




5549




 





 





 





 





 





 



 =head2 29, noAuthorsLineSpecified 




5550




 





 





 





 





 





 



   




5551




 





 





 





 





 





 



 No authors line specified. 




5552




 





 





 





 





 





 



   




5553




 





 





 





 





 





 



 =head2 30, authorsLineParseFailed 




5554




 





 





 





 





 





 



   




5555




 





 





 





 





 





 



 Failed to parse the authors line. 




5556




 





 





 





 





 





 



   




5557




 





 





 





 





 





 



 =head2 31, entryManageDirSetErrored 




5558




 





 





 





 





 





 



   




5559




 





 





 





 





 





 



 L could not have it's directory set. 




5560




 





 





 





 





 





 



   




5561




 





 





 





 





 





 



 =head2 32, pageListErrored 




5562




 





 





 





 





 





 



   




5563




 





 





 





 





 





 



 Failed to list the pages for the directory. 




5564




 





 





 





 





 





 



   




5565




 





 





 





 





 





 



 =head2 33, pageReadErrored 




5566




 





 





 





 





 





 



   




5567




 





 





 





 





 





 



 Failed to read the page. 




5568




 





 





 





 





 





 



   




5569




 





 





 





 





 





 



 =head2 34, autoDocFileDotDotError 




5570




 





 





 





 





 





 



   




5571




 





 





 





 





 





 



 The file specified for the AutoDoc link starts with a "../". 




5572




 





 





 





 





 





 



   




5573




 





 





 





 





 





 



 =head2 35, noURLinConfig 




5574




 





 





 





 





 





 



   




5575




 





 





 





 





 





 



 No URL specified in in the Toader Config. 




5576




 





 





 





 





 





 



   




5577




 





 





 





 





 





 



 =head2 36, noImageURLspecified 




5578




 





 





 





 





 





 



   




5579




 





 





 





 





 





 



 No URL specified for the image. 




5580




 





 





 





 





 





 



   




5581




 





 





 





 





 





 



 =head2 37, noImageFileSpecified 




5582




 





 





 





 





 





 



   




5583




 





 





 





 





 





 



 No image file specified. 




5584




 





 





 





 





 





 



   




5585




 





 





 





 





 





 



 =head2 38, imageDoesNotExist 




5586




 





 





 





 





 





 



   




5587




 





 





 





 





 





 



 The specified image does not exist. 




5588




 





 





 





 





 





 



   




5589




 





 





 





 





 





 



 =head2 39, pathCleanupErrored 




5590




 





 





 





 





 





 



   




5591




 





 





 





 





 





 



 Path cleanup failed. 




5592




 





 





 





 





 





 



   




5593




 





 





 





 





 





 



 =head2 40, galleryInitErrored 




5594




 





 





 





 





 





 



   




5595




 





 





 





 





 





 



 Failed to initialize Toader::Gallery. 




5596




 





 





 





 





 





 



   




5597




 





 





 





 





 





 



 =head2 41, outputURLnotSpecified 




5598




 





 





 





 





 





 



   




5599




 





 





 





 





 





 



 Undefined outputURL for Toader::Gallery. 




5600




 





 





 





 





 





 



   




5601




 





 





 





 





 





 



 =head2 42, noSrcPathSpecified 




5602




 





 





 





 





 





 



   




5603




 





 





 





 





 





 



 No source path specified for Toader::Gallery. 




5604




 





 





 





 





 





 



   




5605




 





 





 





 





 





 



 =head2 43, noURLspecified 




5606




 





 





 





 





 





 



   




5607




 





 





 





 





 





 



 No source URL specified for Toader::Gallery. 




5608




 





 





 





 





 





 



   




5609




 





 





 





 





 





 



 =head2 44, relativeDirContainsAperiod 




5610




 





 





 





 





 





 



   




5611




 





 





 





 





 





 



 The relative gallery directory contains a period. 




5612




 





 





 





 





 





 



   




5613




 





 





 





 





 





 



 =head2 45, noSrcURLspecified 




5614




 





 





 





 





 





 



   




5615




 





 





 





 





 





 



 No source URL specified for L. 




5616




 





 





 





 





 





 



   




5617




 





 





 





 





 





 



 =head2 46, toaderAutoDocInitErrored 




5618




 





 





 





 





 





 



   




5619




 





 





 





 





 





 



 Failed to initialize Toader::AutoDoc. 




5620




 





 





 





 





 





 



   




5621




 





 





 





 





 





 



 =head1 AUTHOR 




5622




 





 





 





 





 





 



   




5623




 





 





 





 





 





 



 Zane C. Bowers-Hadley, C<<  >> 




5624




 





 





 





 





 





 



   




5625




 





 





 





 





 





 



 =head1 BUGS 




5626




 





 





 





 





 





 



   




5627




 





 





 





 





 





 



 Please report any bugs or feature requests to C, or through 




5628




 





 





 





 





 





 



 the web interface at L.  I will be notified, and then you'll 




5629




 





 





 





 





 





 



 automatically be notified of progress on your bug as I make changes. 




5630




 





 





 





 





 





 



   




5631




 





 





 





 





 





 



 =head1 SUPPORT 




5632




 





 





 





 





 





 



   




5633




 





 





 





 





 





 



 You can find documentation for this module with the perldoc command. 




5634




 





 





 





 





 





 



   




5635




 





 





 





 





 





 



     perldoc Toader::Render::General 




5636




 





 





 





 





 





 



   




5637




 





 





 





 





 





 



 You can also look for information at: 




5638




 





 





 





 





 





 



   




5639




 





 





 





 





 





 



 =over 4 




5640




 





 





 





 





 





 



   




5641




 





 





 





 





 





 



 =item * RT: CPAN's request tracker 




5642




 





 





 





 





 





 



   




5643




 





 





 





 





 





 



 L 




5644




 





 





 





 





 





 



   




5645




 





 





 





 





 





 



 =item * AnnoCPAN: Annotated CPAN documentation 




5646




 





 





 





 





 





 



   




5647




 





 





 





 





 





 



 L 




5648




 





 





 





 





 





 



   




5649




 





 





 





 





 





 



 =item * CPAN Ratings 




5650




 





 





 





 





 





 



   




5651




 





 





 





 





 





 



 L 




5652




 





 





 





 





 





 



   




5653




 





 





 





 





 





 



 =item * Search CPAN 




5654




 





 





 





 





 





 



   




5655




 





 





 





 





 





 



 L 




5656




 





 





 





 





 





 



   




5657




 





 





 





 





 





 



 =back 




5658




 





 





 





 





 





 



   




5659




 





 





 





 





 





 



 =head1 ACKNOWLEDGEMENTS 




5660




 





 





 





 





 





 



   




5661




 





 





 





 





 





 



 =head1 LICENSE AND COPYRIGHT 




5662




 





 





 





 





 





 



   




5663




 





 





 





 





 





 



 Copyright 2013. Zane C. Bowers-Hadley. 




5664




 





 





 





 





 





 



   




5665




 





 





 





 





 





 



 This program is free software; you can redistribute it and/or modify it 




5666




 





 





 





 





 





 



 under the terms of either: the GNU General Public License as published 




5667




 





 





 





 





 





 



 by the Free Software Foundation; or the Artistic License. 




5668




 





 





 





 





 





 



   




5669




 





 





 





 





 





 



 See http://dev.perl.org/licenses/ for more information. 




5670




 





 





 





 





 





 



   




5671




 





 





 





 





 





 



   




5672




 





 





 





 





 





 



 =cut 




5673




 





 





 





 





 





 



   




5674




 





 





 





 





 





 



 1; # End of Toader::Render::General



The variabled passed are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The Toader::Entry object.
    c - The Config::Tiny object containing the Toader config.
    self - The Toader::Render::Entry object.
    toader - This is a Toader object.
    g - This is a Toader::Render::General object.

=head4 pageSummaryJoin

This joins the rows.

The template used is 'pageSummaryJoin' and by default is blank.

The variabled passed are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=head4 pageSummarySummary

This is a row in the table of pages.

The template used is 'pageSummarySummary' and by default is as below.






The variabled passed are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.
    name - This is the name of the page.
    summary - This is a summary of the page.

=cut

sub pageSummary{
	my $self=$_[0];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	my $pm=Toader::Page::Manage->new( $self->{toader} );
	$pm->setDir( $self->{odir} );
	if ( $pm->error ){
		$self->{error}=31;
		$self->{errorString}='Failed to set the directory, "'.$self->{odir}.
			'", for Toader::Page::Manage. error="'.$pm->error
			.'" errorString="'.$pm->errorString.'"';
		$self->warn;
		return undef;
	}

	#lists the entries for the directory
	my @pages=$pm->published;
	if ( $pm->error ){
		$self->{error}=32;
		$self->{errorString}='Failed to list the pages for "'.$self->{odir}.
			'". error="'.$pm->error.'" errorString="'.$pm->errorString.'"';
		$self->warn;
		return undef;
	}

	#return '' if there are none
	if ( ! defined( $pages[0] ) ){
		return '';
	}

	#sort and order from last to first
	@pages=sort(@pages);
	@pages=reverse(@pages);

	#process each one
	my @tojoin;
	my $int=0;
	while ( defined( $pages[$int] ) ){
		my $entry=$pm->read( $pages[$int] );
		if ( $pm->error ){
			$self->{error}=33;
			$self->{errorString}='Failed to read "'.$pages[$int].'" in "'
				.$self->{odir}.'". error="'.$pm->error.'" errorstring="'
				.$pm->errorString.'"';
			$self->warn;
			return undef;
		}

		#renders the row
		my $rendered=$self->{t}->fill_in(
			'pageSummaryRow',
			{
				toDir=>$self->{toDir},
				toFiles=>$self->{toFiles},
				obj=>\$self->{obj},
				c=>\$self->{toader}->getConfig,
				toader=>\$self->{toader},
				self=>\$self,
				name=>$entry->nameGet,
				summary=>$entry->summaryGet,
				g=>\$self,
			}
			);
		if ( $self->{t}->error ){
			$self->{error}=10;
			$self->{errorString}='Failed to fill in the template. error="'.
				$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
			$self->warn;
			return undef;
		}

		push( @tojoin, $rendered );

		$int++;
	}

	#renders the joiner
	my $joiner=$self->{t}->fill_in(
		'pageSummaryJoin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the end of the dir list
	my $end=$self->{t}->fill_in(
		'pageSummaryEnd',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	#renders the end of the dir list
	my $begin=$self->{t}->fill_in(
		'pageSummaryBegin',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $begin.join( $joiner, @tojoin ).$end;
}

=head2 pageSummaryLink

This is a link to summary of the pages for directory of the object.

On argument is accepted and that is the text to use for the link. If
not specified, it defaults to 'Pages'.

    $g->pageSummaryLink;

The template used is 'pageSummaryLink' and the default is as below.

    [== $text ==]

The variables passed are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub pageSummaryLink{
	my $self=$_[0];
	my $text=$_[1];

	if ( ! defined( $text ) ){
		$text='Pages';
	}

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	my $url;
	if ( $self->{fullURL} ){
		$url=$self->{r2r}.'/.pages/summary.html';
		$url=~s/\/\/*/\//g;
		$url=$self->{url};
	}else{
		$url=$self->{toDir}.'/.pages/summary.html';
		$url=~s/\/\/*/\//g;
	}

	#render it
	my $rendered=$self->{t}->fill_in(
		'pageSummaryLink',
		{
			url=>$url,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 plink

This generates a link to a different page object.

Two arguments are taken.

The first and required one is the Toader directory containing
the Toader object.

The second is the page to link to.

The third is the text, which if not specified will will be the
same the link.

    $g->plink( $dir, $page, "whatever at foo.bar" );

The template used is 'linkPage' and it is by default as below.

    [== $text ==]

The variables passed are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub plink{
	my $self=$_[0];
	my $dir=$_[1];
	my $page=$_[2];
	my $text=$_[3];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	#make sure we have a link
	if ( ! defined( $dir ) ){
		$self->{error}=11;
		$self->{errorString}='No Toader directory defined';
		$self->warn;
		return undef;
	}

	#make sure we have a link
	if ( ! defined( $page ) ){
		$self->{error}=15;
		$self->{errorString}='No Toader page defined';
		$self->warn;
		return undef;
	}

	#set the text to the same as the link if no text is defined
	if ( ! defined( $text ) ){
		$text=$page;
	}

	#handles it if it is a full path
	my $dirtest;
	if ( $dir =~ /^\// ){
		$dir=$self->{toader}->getRootDir.$dir;
		$dirtest=$dir;
		$dir=$self->{ph}->relative2root( $dir );
	}else{
		$dirtest=$self->{dir}.'/'.$dir;
	}

	#make sure it is a Toader directory
	if ( ! $self->{isatd}->isaToaderDir( $dirtest ) ){
		$self->{error}=12;
		$self->{errorString}='"'.$dirtest.'" is not a Toader directory';
		$self->warn;
		return undef;
	}

	#make sure entry exists... will also make sure it exists
	my $ph=Toader::Page::Helper->new( $self->{toader} );
	$ph->setDir( $dirtest );
	if ( ! $ph->pageExists( $page ) ){
		$self->{error}=16;
		$self->{errorString}='The Toader page "'.$page.'" does not exist for the Toader directory "'.$dirtest.'"';
		$self->warn;
		return undef;
	}

	if ( $self->{fullURL} ){
		$dir=$dir.'/.pages/'.$page.'/';
		$dir=~s/\/\/*/\//g;
		$dir=$self->{url}.$dir;
	}else{
		$dir=$self->{toDir}.'/'.$dir.'/.pages/'.$page.'/';
		$dir=~s/\/\/*/\//g;
	}

	#render it
	my $rendered=$self->{t}->fill_in(
		'linkPage',
		{
			url=>$dir,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 r2r

This returns the current value to from the root directory
to current directory.

    my $r2r=$g->r2r;

=cut

sub r2r{
    my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

    return $self->{r2r};
}

=head2 rlink

This generates a link to the root directory.

One option arguement is taken. It is the text part of the link.
If not defined it defaults to the relative path to the root
directory.

    $g->rlink("to root");

The template used is 'toRootLink' and is as below.

    [== $text ==]

The variables are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub rlink{
	my $self=$_[0];
	my $text=$_[1];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	if ( ! defined( $text ) ){
		$text='/';
	}

	#creates the url and cleans it up
	my $url='';
	if ( $self->{fullURL} ){
		$url=$self->{url};
	}else{
		$url=$self->{b2r};
		$url=~s/\/\/*/\//g;
	}

	#render it
	my $rendered=$self->{t}->fill_in(
		'toRootLink',
		{
			url=>$url,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 sidebar

This renders the sidebar for a page.

The template is 'sidebar' and the default is as below.

    [==
      if ( ! $g->hasEntries ){
        return "";
      }
      return "Entries\n".
        "		".$g->entriesLink." \n".
        "		".$g->entriesArchiveLink." \n";
    ==]
    [==
      my $pages=$g->listPages;
      if ( ( ! defined( $pages ) ) || ( $pages eq "" ) ){
        return "";
      }
      return "		".$g->pageSummaryLink."\n".$pages."\n		\n";
    ==]
    [==
      if( $g->hasGallery ){
        return "\n".$g->galleryLink."";
      }else{
        return "";
      }
    ==]
    [==
      if( $g->hasAnyDirs ){
          return "\nDirectories";
      }else{
        return "";
      }
    ==]
    [==
      if ( $g->atRoot ){
        return "";
      }
      return $g->rlink("Go To The Root")."		\n		".
        $g->upOneDirLink."		\n		";
    ==]

    [==
      if ( $g->hasSubDirs ){
        return $g->listDirs;
      }
      return "";
    ==]
    [==
      if ( $g->hasDocs ){
        return "".$g->adListLink;
      }
      return "";
    ==]

The variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub sidebar{
    my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	#render it
	my $rendered=$self->{t}->fill_in(
		'sidebar',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 toDir

This returns the value that was set for toDir.

    my $toDir=>$g->toDir;

=cut

sub toDir{
    my $self=$_[0];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	return $self->{toDir};
}

=head2 top

This renders the top include.

    $g->top;

The template is 'top' and the default is as below.

    [== $c->{_}->{site} ==]

The variables are as below.

    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub top{
	my $self=$_[0];

	#blank any previous errors
	if ( ! $self->errorblank ){
		return undef;
	}

	my $dir=$self->{b2r};

	#add the toDir to it
	$dir=$self->{toDir}.$dir;

	#render it
	my $rendered=$self->{t}->fill_in(
		'top',
		{
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			toader=>\$self->{toader},
			self=>\$self,
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head2 upOneDirLink

This creates a link up to the next directory.

One argument is taken and that is text to show for the link. If
not specified, it defaults to 'Up One Directory'.

    $g->upOneDirLink;

The template is 'upOneDirLink' and the default is as below.

    [== $text ==]

The passed variables are as below.

    url - This is the relative URL for this.
    text - This to use for with the link.
    toDir - This is the relative back to the directory.
    toFiles - This is the relative path to the '.files' directory.
    obj - The L object.
    c - The L object containing the Toader config.
    self - The L object.
    toader - This is a L object.
    g - This is a L object.

=cut

sub upOneDirLink{
	my $self=$_[0];
	my $text=$_[1];

    #blank any previous errors
    if ( ! $self->errorblank ){
        return undef;
    }

	if ( ! defined( $text ) ){
		$text='Up One Directory';
	}

	#creates the url and cleans it up
	my $url=$self->{toDir}.'/../';
	$url=~s/\/\/*/\//g;

	#render it
	my $rendered=$self->{t}->fill_in(
		'upOneDirLink',
		{
			url=>$url,
			text=>$text,
			toDir=>$self->{toDir},
			toFiles=>$self->{toFiles},
			obj=>\$self->{obj},
			c=>\$self->{toader}->getConfig,
			self=>\$self,
			toader=>\$self->{toader},
			g=>\$self,
		}
		);
	if ( $self->{t}->error ){
		$self->{error}=10;
		$self->{errorString}='Failed to fill in the template. error="'.
			$self->{t}->error.'" errorString="'.$self->{t}->errorString.'"';
		$self->warn;
		return undef;
	}

	return $rendered;
}

=head1 ERROR CODES

=head2 1, noToaderObj

No L object defined.

=head2 2, notAtoaderObj

The object specified for the L object is not really a
L object.

=head2 3, toaderPerror

The specified L object has a permanent error set.

=head2 4, noRenderableObj

No object specified for the renderable object.

=head2 5, notArenderableObj

The object specified for the renderable object was not defined.

=head2 6, objPerror

The specified renderable object has a permanent error set.

=head2 7, noDirSet

The renderable object does not have a directory specified.

=head2 8, noLinkDefined

Nothing defined for the link.

=head2 9, templateFetchErrored

Failed to fetch the template.

=head2 11, noToaderDirSpecified

No Toader directory specified.

=head2 12, notAtoaderDir

The specified directory is not a L directory.

=head2 13, noEntryIDspecified

No L ID defined.

=head2 14, entryDoesNotExist

The entry does not exist.

=head2 15, noPageSpecified

No L page is defined.

=head2 16, pageDoesNotExist

The page does not exist.

=head2 17, noFileSpecified

No file specified.

=head2 18, templateInitErrored

Failed to initialize the L object.

=head2 19, r2rErrored

Failed to figure out the relative from root path.

=head2 20, b2rErrored

Failed to figure out the relative back to root path.

=head2 21, pathhelperInitErrored

Failed to initialize the L object.

=head2 22, subToaderDirListErrored

Failed to get a list of L sub directories for the
current directory.

=head2 23, pageManageDirSetErrored

Failed to set the directory for L.

=head2 24, listPagesErrored

Failed to get a list of pages.

=head2 25, entryManageErrored

L could not have it's directory set.

=head2 26, readEntryErrored

Failed to read a entry.

=head2 27, renderEntryInitErrored

Failed to initialize L.

=head2 28, renderEntryErrored

Failed to render a entry.

=head2 29, noAuthorsLineSpecified

No authors line specified.

=head2 30, authorsLineParseFailed

Failed to parse the authors line.

=head2 31, entryManageDirSetErrored

L could not have it's directory set.

=head2 32, pageListErrored

Failed to list the pages for the directory.

=head2 33, pageReadErrored

Failed to read the page.

=head2 34, autoDocFileDotDotError

The file specified for the AutoDoc link starts with a "../".

=head2 35, noURLinConfig

No URL specified in in the Toader Config.

=head2 36, noImageURLspecified

No URL specified for the image.

=head2 37, noImageFileSpecified

No image file specified.

=head2 38, imageDoesNotExist

The specified image does not exist.

=head2 39, pathCleanupErrored

Path cleanup failed.

=head2 40, galleryInitErrored

Failed to initialize Toader::Gallery.

=head2 41, outputURLnotSpecified

Undefined outputURL for Toader::Gallery.

=head2 42, noSrcPathSpecified

No source path specified for Toader::Gallery.

=head2 43, noURLspecified

No source URL specified for Toader::Gallery.

=head2 44, relativeDirContainsAperiod

The relative gallery directory contains a period.

=head2 45, noSrcURLspecified

No source URL specified for L.

=head2 46, toaderAutoDocInitErrored

Failed to initialize Toader::AutoDoc.

=head1 AUTHOR

Zane C. Bowers-Hadley, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Toader::Render::General

You can also look for information at:

=over 4

=item * RT: CPAN's request tracker

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back

=head1 ACKNOWLEDGEMENTS

=head1 LICENSE AND COPYRIGHT

Copyright 2013. Zane C. Bowers-Hadley.

This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.


=cut

1; # End of Toader::Render::General