Andrew Sterling Hanenkamp > Yukki-0.140290 > Yukki

Download:
Yukki-0.140290.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.140290   Source  

NAME ^

Yukki - Yet Uh-nother wiki

VERSION ^

version 0.140290

DESCRIPTION ^

This is intended to be the simplest, stupidest wiki on the planet. It uses git for versioning and it is perfectly safe to clone this repository and push and pull and all that jazz to maintain this wiki in multiple places.

For information on getting started see Yukki::Manual::Installation.

WITH ROLES ^

ATTRIBUTES ^

config_file

This is the name of the configuraiton file. The application will try to find it in etc within the current working directory first. If not there, it will check the YUKKI_CONFIG environment variable.

settings

This is the configuration loaded from the "config_file".

METHODS ^

view

  my $view = $app->view('Page');

Not implemented in this class. See Yukki::Web.

controller

  my $controller = $app->controller('Page');

Not implemented in this class. See Yukki::Web.

model

  my $model = $app->model('Repository', { repository => 'main' });

Returns an instance of the requested model class. The parameters are passed to the instance constructor.

locate

  my $file = $app->locate('user_path', 'test_user');

The first argument is the name of the configuration directive naming the path. It may be followed by one or more path components to be tacked on to the end.

Returns a Path::Class::File for the file.

locate_dir

  my $dir = $app->locate_dir('repository_path', 'main.git');

The arguments are identical to "locate", but returns a Path::Class::Dir for the given file.

check_access

  my $access_is_ok = $app->check_access({
      user       => $user, 
      repository => 'main',
      needs      => 'read',
  });

The user is optional. It should be an object returned from Yukki::Model::User. The repository is required and should be the name of the repository the user is trying to gain access to. The needs is the access level the user needs. It must be an "AccessLevel" in Yukki::Types.

The method returns a true value if access should be granted or false otherwise.

hasher

Returns a message digest object that can be used to create a cryptographic hash.

WHY? ^

I wanted a Perl-based, MultiMarkdown-supporting wiki that I could take sermon notes and personal study notes for church and Bible study and such. However, I'm offline at church, so I want to do this from my laptop and sync it up to the master wiki when I get home. That's it.

Does it suit your needs? I don't really care, but if I've shared this on the CPAN or the GitHub, then I'm offering it to you in case you might find it useful WITHOUT WARRANTY. If you want it to suit your needs, bug me by email at hanenkamp@cpan.org and send me patches.

AUTHOR ^

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by Qubling Software LLC.

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

syntax highlighting: