Home

Online FPP Documentation

Online FPP Documentation Update (12/15/2007):

I've created the infrastructure here at flashpanos.com for a comprehensive "book" of Flash Panorama Player documentation. This book will endeavor to provide "plain english" descriptions of each object, element and parameter available to FPP -- along with concrete XML and/or code examples for each entry.

Zephyr and I have begun the laborious task of writing the documentation:
See an example page here.
Some of this is taken from existing documentation, some is reworded, some is from experience. The idea isn't to replicate existing FPP documentation, but to rework and expand it.

Anyone who wishes to help out is encouraged to contact us! Whether you contribute one entry or several, you will be hugely helping to create an online resource which is available to all, in an easy-to-search (and update) format.

Comments and discussion is appreciated, especially at the outset here...

Cheers,

Patrick

Hi Patrick, what a great

Hi Patrick, what a great idea, I would like to give my support and contribution Smile

  • By PauloGGPX (not verified) at 12/15/2007 - 14:55
  • Login or register to post comments

Great Paulo! I'll contact

Great Paulo!

I'll contact you off-list with info...

Cheers, and

Thanks!,

Patrick

All are invited to help

All are invited to help expand the current FPP documentation! Simply contact Patrick with an idea of which entries you'd like to handle, and an idea of your timeline for writing them. See below for some notes...

Cheers!

Patrick

Use the entry at the link below as a guide:
http://flashpanos.com/content/parameter-fullscreen

---

The basic structure for a documentation entry is:

  • "Contributed by [name or FPP forum screen name]"
  • One or two sentence explanation of function/parameter
  • Syntax example for use in FPP XML file [as many as necessary]
  • Syntax example when called from Flash [if relevant]
  • Explanation of Syntax example(s)
  • Special Notes
  • Full XML example, including all XML tags
    • from the "<?xml" declaration to the ending </panorama>
    • showing relevant <global/>, <spot/> or <box/> example
    • Additional Full XML example if necessary
  • Am I missing anything? Smile

---

When viewing the example entry for "fullscreen", you should see an FPP Documentation menu in the right sidebar. From there you can access every single entry which I have preconfigured. I thought this was a good outline for a start. Smile Your input is appreciated!