App-SlideServer
view release on metacpan or search on metacpan
lib/App/SlideServer.pm view on Meta::CPAN
On startup, the application upgrades your slides to a proper HTML structure
(see L<HTML SPECIFICATION>) possibly by first running it through a Markdown
renderer if you provided the slides as markdown instead of HTML. It then
inspects the HTML and breaks it apart into one or more slides.
You may then start the Mojo application as a webserver, or whatever else you
wanted to do with the Mojo API.
The application comes with a collection of web assets that render your HTML
to fit fullscreen in a browser window, and to provide a user interface to the
presenter that shows navigation buttons and private notes for giving the
presentation.
=head1 CONSTRUCTOR
This is a standard Mojolicious object with a Mojo::Base C<< ->new >> constructor.
=head1 ATTRIBUTES
=head2 serve_dir
This is a Mojo::File object of the diretory containing templates and public
files. Public files live under C<< $serve_dir/public >>.
See L</slides_source_file> for the location of your slides.
The default is C<< $self->home >> (Mojolicious project root dir)
=head2 slides_source_file
Specify the actual path to the file containing your slides. The default is
to use the first existing file of:
* $serve_dir/slides.html
* $serve_dir/slides.md
* $serve_dir/public/slides.html
* $serve_dir/public/slides.md
Note that files in public/ can be downloaded as-is by the public at any time.
...but maybe that's what you want.
=head2 share_dir
This is a Mojo::File object of the directory containing the web assets that
come with App::SlideServer. The default uses File::ShareDir and should
'just work' for you.
=head2 presenter_key
This is a secret string that only you (the presenter) should know.
It is your password to let the server know that your browser is the one that
should be controlling the presentation.
If you don't initialize this, it defaults to a random value which will be
printed on STDOUT where (presumably) only you can see it.
=head2 viewers
A hashref of C<< ID => $context >> where C<$context> is the Mojo context
object for the client's websocket connection, and ID is the request ID for
that websocket. This is updated as clients connect or disconnect.
=head2 published_state
A hashref of various data which has been broadcast to all viewers.
This keeps track of things like the current slide, but you can extend it
however you like if you want to add features to the client javascript.
Use L</update_published_state> to make changes to it.
=head2 page_dom
This is a Mojo::DOM object holding the page that is served as "/" containing
the client javascript and css (but not any of the slides).
This is a cached output of L</build_slides> and may be rebuilt at any time.
=head2 slides_dom
This is an arrayref of the individual slides (Mojo::DOM objects) that the
application serves. This is a cached output of L</build_slides> and may be
rebuilt at any time.
=head2 cache_token
A value (usually an mtime) that is used by L</load_slides_html> to determine
if the source content has changed. You can clear this value to force
L</build_slides> to perform a rebuild.
=head1 METHODS
=head2 build_slides
This calls L</load_slides_html> (which calls C<markdown_to_html> if your
source is markdown) then calls L</extract_slides_dom> to break the HTML into
Mojo::DOM objects (and restructure shorthand notations into proper HTML),
then calls L</merge_page_assets> to augment the top-level page with the web
assets like javascript and css needed for the client slide UI, then stores
this result in L</page_dom> and L</slides_dom> and returns C<$self>.
It throws exceptions if it fails, leaving previous results intact.
You can override any of those methods in a subclass to customize this process.
This method is called automatically at startup and any time the mtime of your
source file changes. (detected lazily when serving '/')
=head2 load_slides_html
$html= $app->load_slides_html;
($html, $token)= $app->load_slides_html(if_changed => $token)
Reads L</slides_source_file>, calls L</markdown_to_html> if it was markdown,
and returns the content as a string I<of characters>, not bytes.
In list context, this returns both the content and a token value that can be
used to test if the content changed (usually file mtime) on the next call
using the 'if_changed' option. If you pass the 'if_chagned' value and the
content has I<not> changed, this returns undef.
=head2 markdown_to_html
$html= $app->markdown_to_html($md);
( run in 0.868 second using v1.01-cache-2.11-cpan-39bf76dae61 )