Shlomi Fish > SVN-RaWeb-Light > SVN::RaWeb::Light

Download:
SVN-RaWeb-Light-0.60003.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.60003   Source  

NAME ^

SVN::RaWeb::Light - Lightweight and Fast Browser for a URLed Subversion repository similar to the default Subversion http:// hosting.

SYNOPSIS ^

    #!/usr/bin/perl

    use SVN::RaWeb::Light;

    my $app = SVN::RaWeb::Light->new(
        'url' => "svn://myhost.net/my-repos-path/",
    );

    $app->run();

DESCRIPTION ^

SVN::RaWeb::Light is a class implementing a CGI script for browsing a Subversion repository given as a URL, and accessed through the Subversion Repository-Access layer. Its interface emulates that of the default Subversion http://-interface, with some improvements.

To use it, install the module (using CPAN or by copying it to your path) and write the CGI script given in the SYNOPSIS with the URL to the repository passed as the 'url' parameter to the constructor.

To use it just fire up a web-browser to the URL of the script.

URL Translations

URL translations are a method to translate the current path of the script to to a URL. The latter is usually a URL of the Subversioned resource, which can be manipulated directly using the svn client and other clients.

One can specify pre-defined URL translations, inside the value of the 'url_translations' argument:

    #!/usr/bin/perl -w

    use SVN::RaWeb::Light;

    my $app = SVN::RaWeb::Light->new(
        'url' => "svn://svn.berlios.de/web-cpan/",
        'url_translations' =>
        [
            {
                'label' => "Read/Write URL",
                'url' => "svn+ssh://svn.berlios.de/svnroot/repos/web-cpan/",
            },
            {
                'label' => "Read URL",
                'url' => "svn://svn.berlios.de/web-cpan/",
            },
        ],
    );

    $app->run();

label specifies the label as would appear on the page. url is the URL relative to the script's base directory. The complete path would be the URL in the URL translation appended by the path that the script points to.

METHODS ^

my $app = SVN::RaWeb::Light->new(...)

Initialises a new application.

$app->run();

Runs it in the current process.

AUTHOR ^

Shlomi Fish, <shlomif@iglu.org.il>

COPYRIGHT AND LICENSE ^

Copyright (C) 2004 by Shlomi Fish

This library is free software; you can redistribute it and/or modify it under the terms of the MIT/X11 license.

syntax highlighting: