Welcome to Pinboard 2.0
=======================

Thanks for downloading Pinboard 2.0 - we hope you enjoy using it as
much as we have done in making it.  This has been a fun, passion-
project for us, and we hope that shows in its usefulness.

Since this is the first public release of Pinboard 2.0, documentation
is limited.  We hope to add a proper manual in due course.  For now,
we have listed the key features/goals of Pinboard 2.0, which should
guide you in what to look for...

Goals:     
     
     Open source licence, written in C for future portability and
     easy maintenance

     100% Compatible with previous Pinboard

     Ideally compatible with RISC OS Ltd (Adjust/Six) Pinboard too

     New functionality configurable to classic behaviour when 
     practical

     Allow more wallpaper graphic formats via ChangeFSI if available

     Cache wallpaper conversion to sprite.  Native JPEG rendering is 
     super-slow for large JPEGs, causing noticeable drop in 
     smoothness when dragging windows.  Using a pre-converted sprite 
     is much faster, at the expense of a little extra RAM.

     Allow wallpapers to fill the screen dimensions (ie. under 
     iconbar) to avoid dodgy aspect ratios - eg. a 1920x1080 backdrop 
     can properly fill a 1920x1080 desktop, rather than being scaled 
     down to accommodate iconbar, or spilling off the screen.

     No need to save pinboard before shutting down.

     Better text blending, so that text backgrounds aren't necessary

     Allow files to be saved to Pinboard.  Goal - solve the classic 
     RISC OS "issue" of where to save files when screen is full.  
     Also to help new users who expect to be able to save to desktop.
     This is achieved via a configurable folder which by default 
     lives in <Choices$Write>.Pinboard

     Indicate pinned files vs saved files

     Allow filer-like operations

     "Sticky" notes
     
     Draw file images can be overlaid as "watermarks" to allow your
     desktop to incorporate scalable, vector graphic elements such
     as logos or other elements
     
     Wallpaper carousel feature
     
     Pinboard to front functionality - via menu, and can be set to
     a keystroke (we suggest Shift+WindowsKey) via PinSetup
     
     Transparent iconbar for full screen backdrops which extend behind
     the iconbar
     
     Can show file info for items on the pinboard when hovering over.
     This feature must be activated in the Misc settings in PinSetup. 

     
Essentially, Pinboard 2.0 takes the concept of a "Pinboard" to its logical 
extensions, whilst incorporating the more natural elements of other 
operating systems.  Meanwhile, the intention is that existing users should 
be able to have a consistant experience.


Installation
------------

Please run the Install file supplied in this zip to install Pinboard 2.

You can uninstall by running the supplied Uninstall file.  This will
remove Pinboard 2.0 from PreDesk.  You'll need to reboot after this.

Since the new !Configure plugin is designed to be backwards compatible,
this is not removed if no backup of !PinSetup is found (for testing purpose). 
If for some reason you wish to revert to "classic ROOL" configure plugin,
it can be downloaded from the ROOL website as part of the nightly beta
build.  Look in !Boot.RO500hook.Res.Configure.Plugins. (!PinSetup)


PinSetup
--------

Most of Pinboard 2.0's functionality can be found via !PinSetup which
integrates with the computer's configuration system.  Ether double
click on !Boot to access this, or press menu over the desktop (pinboard)
and choose "Configure..."


Carousel
--------

Pinboard 2 can display a slideshow of images - a "carousel" - as well as a fixed
backdrop.  To enable this, drag a folder of images to the backdrop icon in PinSetup
instead of a single image.  Alternatively, use *backdrop <directory path>

eg. *Backdrop SDFS::0.$.Images


Saving files to the Pinboard
----------------------------

Although Pinboard 2.0 gives the impression of allowing you to save to the
Pinboard itself, in practise it uses a special folder on your main drive
to house the contents of the Pinboard.  The is normally !Boot.Choices.Pinboard
but PinSetup allows you to choose a different location.  This is important 
to know for backup purposes.

Pinboard 2.0 is smart enough to be able to track file additions, deletions, 
renames, copies, moves etc in the special folder, so the Pinboard should
always accurately reflect its contents.


Files vs Pins (shortcuts)
-------------------------

The Pinboard is somewhat unique in RISC OS as traditionally, items placed 
on it (pinned items) are actually shortcuts/links to the files/applications
on disc.  Since Pinboard 2.0 now allows you to save files to the Pinboard,
it becomes important to know which items are pinned shortcuts, and which
are actual files/folders/apps stored in the Pinboard's special folder.

With this in mind, pinned items now have a pin icon (red) overlaid on them,
to indicate that they are pinned.  Files (or other items) that are stored
on the Pinboard (in the special folder) are shown with normal icons (no pin).

There is an additional colour of pin - blue - which is used to indicate items
that are locked in place on the Pinboard.  These aren't different to the 
files vs pins mentioned above, but rather are locked in place so that they
cannot be accidentally dragged/copied/removed.


Pinboard to Front
-----------------

This feature allows you to bring the Pinboard to the front of the window
stack to allow you to access items on it.  By default this is accessed
by pressing Menu mouse button over the Pinboard, and choosing the 
"Show pinboard" option.

We are aware that in many cases, the Pinboard may not be visible if you
have a lot of windows open (especially on smaller monitors).  For this
situation you can specify a keyboard shortcut to bring the Pinboard to
the front.  To do this, look in the "Misc" section of PinSetup and 
enable the keypress for "Enable show/hide all windows keypress".
You can click "Set code" to define a keystroke - we suggest Shift+Win Key
if your keyboard has such a button.



Best wishes,

RISC OS Developments
E&OE.