Pyntor components
-----------------

Pyntor is a very flexible presentation program. Although it provides a
general framework such as for setting up the screen, tracking the mouse
and keyboard, handling errors etc., the real work is all done by components.

Some components are included and documented below. Others can be added for
custom presentations. Maybe you might even want to contribute your hyper-cool
module for inclusion!
There's a section in 'documentation.txt' about component sharing.

Note that from version 0.6 on, component documentation is in many cases also
available by running pyntor-components --doc <component>. To see a list of all
installed components, use pyntor-components --list.

Overview
--------

Major slide-show components:
 - TPP
 - POD
 - Slides
Minor graphical components:
 - Background
 - Titlepage
 - Image
 - Fortune
 - Flags
 - Barslider
 - Video
Special graphical components:
 - Pyromaniac
Interactivity components:
 - Wait
 - Nowait

Pyntor::POD: Plain Old Documentation
------------------------------------
POD comes from the Perl world and is used as an embedded documentation format
suitable for source code files. Some people who are familar with POD can now
use Pyntor to give a POD-slide show! (Pod-Blasting, haha)

Note that the POD component currently renders everything on one huge page.
Supported keys are up/down for scrolling, page up/page down for faster
scrolling, and g/G for vi-like jumps to the beginning/the end.

Pyntor::TPP: Text-slide features
--------------------------------
TPP is a presentation program written by Andreas Krennmair and Nico Golde.
Since the 'cool' presentation programs will stand united against the 'uncool'
ones, Pyntor supports TPP slides as good as it can. As a matter of fact, this
saves the TPP authors the work of hacking in HTML or PDF export :-)

Navigation only happens via enter/backspace to navigate forth and back.
A compatibility mode for TPP keyboard shortcuts might be introduced in the
future.

Pyntor::Slides: Slideshow features
----------------------------------
- saving slides statically as to use them elsewhere ('s' key)
- toggle between fullscreen and window mode ('f' key)
- adjust brightness of background ('+' and '-' keys)
- going forth and back ('enter' and 'backspace' keys)
- browser launch support on urls, and program launch support
- wiki-style markup:
  * title page (title line above ====, subtitle below)
  * pages (page titles above ----, page content below)
  * urls ([url:foo]) and images ([img:foo])
- page ranges or single pages out of a document
- switch mouse cursor on and off ('m' key)
- mark text (left mouse button if mouse cursor is visible)

Pyntor::Pyromaniac: Browser features
------------------------------------
- HTML browser
- works on remote URLs also
- scaling of webpages ('+' and '-' keys)
- jump to previous/next slide ('p' and 'n' keys)
  * if HTML pages contain comment about their order
- history always available ('alt+left' and 'alt+right' keys)
- screenshot ('f12' key)
- reload ('r' key)
- page width adjustments ('1' and '2' keys)
- toggle fullscreen ('f' key)

Pyntor::Background: Background image settings
---------------------------------------------
- type: non-interactive rendering component
- arguments: image (PNG, JPEG etc.) or colour in rgb-hex format (like ffffff)

Pyntor::Titlepage: Opening slide for a presentation
---------------------------------------------------
- type: non-interactive rendering component
- arguments: titlepage file
- this file contains title, subtitle, author and date fields
- see 'title' for a format example

Pyntor::Image: Displays a positioned image
------------------------------------------
- type: non-interactive rendering component
- arguments: x position, y position, and image file name
- positions can be absolute pixels or xx% values

Pyntor::Fortune: TODO
Pyntor::Flags: TODO
Pyntor::Barslider: TODO
Pyntor::Video: TODO

Pyntor::Wait: TODO
Pyntor::Nowait: TODO

