/ 
Apache2-Translation-0.34
River stage zero No dependents
/ Apache2::Translation::Admin

NAME

Apache2::Translation::Admin - A WEB interface for Apache2::Translation

SYNOPSIS

PerlModule Apache2::Translation::Admin

<Location /-/transadm/>
  SetHandler modperl
  PerlResponseHandler Apache2::Translation::Admin
</Location>

or

<Perl>
  $My::Transadmin=
    Apache2::Translation::Admin->new(...);
</Perl>

<Location /-/transadm/>
  SetHandler modperl
  PerlResponseHandler $My::Transadmin->handler
</Location>

DESCRIPTION

This module implements a WEB application to manage Apache2::Translation rulesets. Get it running, then read on how to use it.

NOTE: the configured location must be called with a trailing slash or /index.html.

CONFIGURATION

There are 2 ways of configuration. The simplest is just to declare the module as handler for a certain location. In this case the translation provider used for the current server (or virtual server) is used to read and store rules.

The second way involves creation of an Apache2::Translation::Admin object in a <Perl> section and declaring $object->handler as PerlResponseHandler. In this case you can specify the translation provider directly. You even don't need to run Apache2::Translation as PerlTransHandler.

Object Creation

new(provider=>$provider)

The provider is created separately and passed to the constructor method.

new(provider_url=>$url)

specify an URL where a Apache2::Translation::Config handler listens.

new(provider_spec=>[@params])

specify a provider as 'File', ConfigFile=>'/path/to/config/file' or similar.

USAGE

With an empty ruleset you'll see just the 3 headlines

PREPREOCESS PHASE
PROCESS PHASE
SUBROUTINES

with arrow images on the left.

Click on one of these arrows to create a new block list.

Now edit the Key, Uri and Action fields. A symbol showing a discette will appear. You can save the block list by clicking on it. When a block list is saved the discette disappears but a new symbol allowing you to reload the current block list from the provider appears. Try to click on it.

Maybe you have already noticed the symbol on the left end of a block list header that animates the process of opening, saving and reloading a block list from the provider. By clicking on it you can close or open a block list. For a closed block list only the header is shown.

By now you have a block list consisting of one block group with one block. Click now on one of the single arrows on the right side of an action element. It creates more action blocks in the same block group. All blocks of a block group have the same block number. You can identify them by their border color. All consecutive actions with the same border color are in the same block group. The order of the blocks is determined by the order in which they appear on the screen.

Now please click on one of the double arrows. They create new block groups. Hence their border color and block number are different. There are 3 colors used light green, light red and light blue.

The red cross on the right side of an action deletes it.

When a block list is saved empty actions are purged.

The action field itself is divided into 2 text areas. The left one holds the action text, e.g.:

Do: warn "here I am"

The right one holds a comment, e.g.

Transadmins "hello world!"

The comment field is shown only if the provider supports notes.

The lower border of each action block is a little broader. It can be used to resize the action element.

Keyboard Shortcuts

There are defined a few keyboard shortcuts:

  • Ctrl-s

    save the block list with the focus.

  • Ctrl-Shift-c

    close the block list with the focus.

  • Ctrl-Shift-d

    delete the action element with the focus.

  • Ctrl-Shift-u

    reload the block list with the focus.

  • Ctrl->

  • Ctrl-<

    create a new block in the current block group above or below the current block.

  • Ctrl-Shift->

  • Ctrl-Shift-<

    create a new block group below or above the current block group.

SEE ALSO

Apache2::Translation

AUTHOR

Torsten Foertsch, <torsten.foertsch@gmx.net>

COPYRIGHT AND LICENSE

Copyright (C) 2005-2008 by Torsten Foertsch

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