Konstantin Kapitanov > Bootylicious-Plugin-TocJquery-0.06 > Bootylicious::Plugin::TocJquery

Download:
Bootylicious-Plugin-TocJquery-0.06.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.06   Source  

NAME ^

Bootylicious::Plugin::TocJquery - load TOC (Table of Contents) jQuery plugin.

DESCRIPTION ^

Bootylicious::Plugin::TocJquery - load TOC (Table of Contents) jQuery plugin for bootylicious articles The TOC plugin dynamically builds a table of contents from the headings in a document and prepends legal-style section numbers to each of the headings:

    * adds numeration in front of all headings,
    * generates an HTML table of contents

VERSION ^

version 0.06

SYNOPSIS ^

Register TocJquery and AjaxLibLoader plugins in a configuration file (bootylicious.conf), add line like this:

   "plugins" : [
                 "ajax_lib_loader" , {"jquery" : "on"},
                 "toc_jquery", {"toc_tag" : "%TOC%"}
        ]
        
 Insert into your post tag %TOC%, e.g.:

    =head1 NAME

    Futurama characters

    %TOC%

    Futurama is essentially a workplace sitcom whose plot revolves around the Planet Express interplanetary delivery company and its employees,
    a small group that doesn't conform to future society.

    [cut]

    =head2 Philip J. Fry 

    Fry is a dim-witted, immature, slovenly pizza delivery boy who falls into a cryogenic pod,
    causing it to activate and freeze him just after midnight on January 1, 2000, reawakening on New Year's Eve, 2999.

    =head2 Bender Bending Rodríguez 

    Bender is a heavy-drinking, cigar-smoking, kleptomaniacal, misanthropic, egocentric, ill-tempered robot. 

    =head2 Dr. John A. Zoidberg 

    Zoidberg is a lobster-like alien from the planet Decapod 10 and is the neurotic staff physician of Planet Express.

    =head1 TAGS

    futurama, bender

 =head1 ATTRIBUTES

toc_tag

String that is replaced by the TOC (Table of Contents).

    default %TOC%

toc_js_src

URL to TOC jQuery plugin library

    default: http://samaxesjs.googlecode.com/files/jquery.toc-1.0.2.min.js

toc_exclude

exlude option, see more here http://code.google.com/p/samaxesjs/wiki/TableOfContentsPlugin

    default: "h1,#descr,#title,#footer,#nottoc"

METHODS ^

register

This method will be called by Mojolicious::Plugins at startup time, your plugin should use this to hook into the application.

AUTHOR ^

Konstantin Kapitanov, <perlovik at gmail.com>

SEE ALSO ^

http://code.google.com/p/samaxesjs/wiki/TableOfContentsPlugin - TOC (Table of Contents) jQuery plugin

http://getbootylicious.org, Bootylicious, Mojo, Mojolicious, Mojolicious::Lite

COPYRIGHT & LICENSE ^

Copyright 2009 Konstantin Kapitanov, all rights reserved.

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

syntax highlighting: