/ 
Posy-Plugin-InfoFind-0.0501
/ Posy::Plugin::InfoFind

NAME

Posy::Plugin::InfoFind - Posy plugin to find files using their Info content.

VERSION

This describes version 0.0501 of Posy::Plugin::InfoFind.

SYNOPSIS

    @plugins = qw(Posy::Core
		  ...
		  Posy::Plugin::Info
		  Posy::Plugin::InfoFind
		  ...);
    @actions = qw(init_params
	    ...
	    head_template
	    infofind_set
	    head_render
	    ...
	);

DESCRIPTION

This plugin checks the parameters for a find query, and uses the .info files defined by the Posy::Plugin::Info plugin to search for files depending on their Info information. Thus this depends on the Posy::Plugin::Info plugin.

This plugin sets the page-type to 'info_find', so that one can make find-specific flavour templates. Then it falls back on the 'find' and 'category' page-types.

Note that all fields you wish to be able to search on must be defined in the info_type_spec config variable.

The search form will search from the current directory downwards. This enables you to customize the particular Info setup to be different in different directories. If you want to search the whole site, the search form needs to be put in a file at the top of the site.

This fills in a few variables which can be used within your flavour templates. You can also use them in your entry files if you are using the Posy::Plugin::TextTemplate plugin.

$flow_infofind_form

Contains a search-form definition for setting the 'info_find' parameters.

$flow_infofind_criteria

Contains the values which were searched on; useful for putting on a results page.

$flow_infofind_sort_criteria

Contains the fields which were sorted by; useful for putting on a results page.

$flow_num_found

The number of entries which were found which matched the search parameters.

This plugin also provides some "Helper Methods" which can be called from within flavour templates and/or entries if one is using the Posy::Plugin::TextTemplate plugin.

Cautions

This plugin does not work if you have a hybrid site (partially static-generated, partially dynamic) and also use the Posy::Plugin:;Canonical plugin, since the Canonical plugin will redirect your search query. Also, if you have a hybrid site, don't forget to set the "infofind_url" config variable.

Search result pages cannot be generated with static-generation.

Activation

This plugin needs to be added to the plugins list and the actions list. This overrides the 'select_entries' 'parse_path' 'get_alt_path_types' methods; therefore care needs to be taken with other plugins if they override the same methods.

In the actions list 'infofind_set' needs to go somewhere after head_template and before head_render, since this needs to set values before the head is rendered.

Configuration

This expects configuration settings in the $self->{config} hash, which, in the default Posy setup, can be defined in the main "config" file in the config directory.

infofind_field_size

The size to make the length of the input fields for the form. (default: 50)

infofind_url

The URL to use for the "action" part of the search form. This defaults to the global $self->{url} value, but may need to be overridden for things like a hybrid static/dynamic site. This is because the global $self->{url} for static generation needs to hide the name of the script used to generate it, but this plugin needs to know the path to the CGI script. If this is set, this plugin assumes this is a hybrid site and makes its links with explicit 'path' parameters.

OBJECT METHODS

Documentation for developers and those wishing to write plugins.

init

Do some initialization; make sure that default config values are set.

Flow Action Methods

Methods implementing actions.

parse_path

Parse the PATH_INFO (or 'path' parameter) to get the parts of the path and figure out various bits of information about the path.

Calls the parent 'parse_path' then checks if the 'find' parameter is set (and there is no error), and sets the path-type to find, if so.

select_entries

$self->select_entries($flow_state);

If the path-type is 'find', checks and uses the 'find' parameter value as a regular expression to grep for files. Uses the category directory given in the path as the directory to start from. Sets $flow_state->{find} if the find parameter is legal. Sets $flow_state->{num_found} to the number of matching entries.

Otherwise, just selects entries by looking at the path information.

Assumes that no entries have been selected before. Sets $flow_state->{entries}. Assumes it hasn't already been set.

infofind_set

$self->infofind_set($flow_state)

Sets $flow_state->{infofind_form} (aka $flow_infofind_form) to be used inside flavour files.

Helper Methods

Methods which can be called from within other methods, or from within a flavour or entry file if using a plugin such as Posy::Plugin::TextTemplate.

infofind_make_form

<?perl $Posy->infofind_make_form(fields=>\@fields); perl?>

Makes the InfoFind search form with the given fields; uses the fields defined in the info_type_spec config variable if no fields are given.

This is useful if you wish to change which fields to search on, or change their order in the search form.

infofind_header_field

[==
$header_field = $Posy->infofind_header_field(0);
==]

Gives the name of the Info field which would be the header at this level of headers. (Allows for multiple levels of header because of the possibility of using Posy::Plugin::MultiHeader)

Useful for making generic search-result templates.

infofind_is_in_header

[==
if ($Posy->infofind_is_in_header($field, $level)) {
...
}
==]

Returns true if the field is in a header lower than or equal to the given level. Useful for making generic search-result templates.

infofind_make_index

    <?perl
    $Posy->infofind_make_index(field=>'Author',
	category=>'fiction/stories',
	rel_link=>'fiction/stories/series.html',
	indexstyle=>'medium',
	pre_alpha=>'<h2>',
	post_alpha=>'</h2>',
	pre_list=>'<ul>'.
	post_list=>'</ul>',
	pre_item=>'<li>',
	post_item=>'</li>',
	item_sep=>'');
    perl?>

Makes an quick-search index of the given field.

indexstyle can be 'long', 'medium' or 'short'.

The medium style is the default, and makes a list of links made up of all the unique values of that field; each link is a link to a search to match that value exactly.

The long style is similar to the medium style, but the list is split into multiple lists, grouped by the first letter.

The short style is a list of just the first letter values of that field, with a link to search for entries with that field starting with that letter.

get_alt_path_types

my @alt_path_types = $self->get_alt_path_types($path_type)

Return an array of possible alternative path-types (to use for matching in things like get_template and get_config). The array may be empty.

If the path-type is 'info_find' returns alternatives; otherwise calls the parent method.

Private Methods

_infofind_alphasplit

$list = $self->_infofind_alphasplit(field_values=>\@vals, alpha_only=>0);

Take a list of values, and split by alpha. If alpha_only is true, return a list of just the the first alpha letter of all the values. If false (the default) return a list of lists, containing both the first-letters and the values grouped by first-letter.

_infofind_long_links

Traverse the given list of lists values to make a set of lists of links.

_infofind_make_links

Traverse the given list of values to make a list of links.

INSTALLATION

Installation needs will vary depending on the particular setup a person has.

Administrator, Automatic

If you are the administrator of the system, then the dead simple method of installing the modules is to use the CPAN or CPANPLUS system.

cpanp -i Posy::Plugin::InfoFind

This will install this plugin in the usual places where modules get installed when one is using CPAN(PLUS).

Administrator, By Hand

If you are the administrator of the system, but don't wish to use the CPAN(PLUS) method, then this is for you. Take the *.tar.gz file and untar it in a suitable directory.

To install this module, run the following commands:

perl Build.PL
./Build
./Build test
./Build install

Or, if you're on a platform (like DOS or Windows) that doesn't like the "./" notation, you can do this:

perl Build.PL
perl Build
perl Build test
perl Build install

User With Shell Access

If you are a user on a system, and don't have root/administrator access, you need to install Posy somewhere other than the default place (since you don't have access to it). However, if you have shell access to the system, then you can install it in your home directory.

Say your home directory is "/home/fred", and you want to install the modules into a subdirectory called "perl".

Download the *.tar.gz file and untar it in a suitable directory.

perl Build.PL --install_base /home/fred/perl
./Build
./Build test
./Build install

This will install the files underneath /home/fred/perl.

You will then need to make sure that you alter the PERL5LIB variable to find the modules, and the PATH variable to find the scripts (posy_one, posy_static).

Therefore you will need to change: your path, to include /home/fred/perl/script (where the script will be)

PATH=/home/fred/perl/script:${PATH}

the PERL5LIB variable to add /home/fred/perl/lib

PERL5LIB=/home/fred/perl/lib:${PERL5LIB}

REQUIRES

Test::More
grep

SEE ALSO

perl(1). Posy

BUGS

Please report any bugs or feature requests to the author.

AUTHOR

Kathryn Andersen (RUBYKAT)
perlkat AT katspace dot com
http://www.katspace.com

COPYRIGHT AND LICENCE

Copyright (c) 2005 by Kathryn Andersen

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