The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Yukki-0.991_004
River stage zero No dependents
2 ++
/ Yukki::Web::Settings

NAME

Yukki::Web::Settings - provides structure and validation to web settings in yukki.conf

VERSION

version 0.991_004

DESCRIPTION

Yukki::Web needs a few additional settings.

ATTRIBUTES

template_path

THis is the folder where Yukki will find templates under the root. The default is root/template.

static_path

This is the folder where Yukki will find the static files to serve for your application.

base_url

This configures the "base_url" in Yukki::Web::Context attribute. It is either an absolute URL or the words SCRIPT_NAME or REWRITE. See "base_url" in Yukki::Web::Context for more information.

The default is SCRIPT_NAME.

scripts

styles

This is a list of the JavaScript and CSS files, respectively, to load into the shell template. If not set, the defaults are:

  scripts:
      - script/lib/jquery/jquery.js
      - script/lib/jquery/jquery-ui.js
      - script/lib/jquery/jquery.caret.js
      - script/lib/jquery/jquery.tag-editor.js
      - script/lib/plupload/plupload.full.js
      - script/lib/sha1/sha1.js
      - script/yukki.js

  styles:
      - style/yukki.css
      - style/lib/jquery/jquery.css
      - style/lib/jquery/jquery.tag-editor.css

As you can see, these are full paths and may be given as paths to foreign hosts. In order to keep Yukki working in good order, you will probaby want to include at least the scripts listed above.

In case your templates have custom menus on them, you may need to set this. The default is:

  menu_names:
      - repository
      - user
      - page
      - page_bottom
      - admin

This will insure that those menus are empty when they should be empty.

page_views

This is the list of page views to provide. By default, this is

  page_views:
      default:
          label: View
          sort: 10
          template: shell.html
      slides:
          label: Slides
          sort: 11
          template: slides.html
          hide: 1
          vars:
              "head link.local":
                  - style/slides.css
              "head script.local":
                  - script/slides.js

plugins

This is the list of plugins to use. This is an array of hashes. The hashes must have a module key naming the class defining the plugin. The rest of the keys will be passed to the plugin constructor.

media_types

This is a list of custom media types. Because media types are detected using LWP::MediaTypes, you may also configured media types by putting a .media.types file in the home directory of the user running Yukki.

By default, "text/yukki" is mapped to the "yukki" file extension.

METHODS

all_scripts

Convenience accessor that returns scripts as a list.

all_styles

Convenience accessor that returns styles as a list.

AUTHOR

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 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.