!Help file for !StickyPad
~~~~~~~~~~~~~~~~~~~~~~~~~

       Version: 1.08 (30th Oct 2007)
        Author: Paul Vigay <nospam@vigay.com>
Available from: http://www.vigay.com/software/stickypad.html


Purpose
~~~~~~~
PostIt notes for the desktop.


Status
~~~~~~
StickyPad is SHAREWARE. If you find StickyPad useful and continue using for more than 30 days,
you should register by sending me a donation, say 5.00 ukp.

Unregistered versions of StickyPad are limited to a maximum of 5 notes on screen. Registering
StickyPad provides a personalised registration code which removes this limit and allows up to
75 sticky notes on screen, plus allows you to obtain technical support via email.

Cheques should be payable to "Digital Phenomena Ltd" and posted to the address given below
(contacting me).


Requirements
~~~~~~~~~~~~
!StickyPad requires the ABCLibrary module in order to run. This is the runtime library required
for !ABC compiled applications.
The latest version can be downloaded from http://www.vigay.com/thirdparty/

Once downloaded it should be un-archived and placed inside the
!Boot.Resources.!System.310.modules directory.


How to use it
~~~~~~~~~~~~~
Double-click on !StickyPad to load it and you'll automatically get a single sticky note created
on the screen for you.

Enter your notes.

Double-click the top line on the note to minimise the note, and double-click it again to expand
the note again.

The following keys can be used to control sticky notes:-

	CTRL-B	Put to the back
	CTRL-X 	Delete the current note
	CTRL-C	Copy the current note into a new note
	CTRL-V	Paste the last deleted note into a new note
	CTRL-F	Bring to the front
	CTRL-E	Load into a text Editor (such as !Edit or !Zap etc)
	CTRL-N	Create a new note
	f2	Reload notes
	f3	Save notes
	f9	Insert line
	f10	Delete line
	CTRL up/down	Move to beginning/end of note
	Escape	Stop editing current note and remove caret.

Click and drag the note to re-position it around the desktop.

If you enter a URL on a sticky note, you should be able to double-click on it to launch in a web
browser. StickyPad recognises URLs by the http:// or www. at the beginning so if your URLs don't
start with either, they probably won't be recognised as such, and you won't be able to double-
click on them to launch a web browser.
Additionally, StickyPad (from v1.06 onwards) will recognise email addresses by detecting an @
symbol on a line. You can double-click on the line to write a new email to the person.

StickyPad was reviewed in Qercus magazine (http://www.qercus.co.uk/) issue 283 (Summer 2007)


Main Menu
~~~~~~~~~
Clicking MENU over any notes will give access to the main menu, from where you can gain
additional feature, help or quit StickyPad.

The 'Note' sub-menu allows you to control the various hotkey functions from a menu instead of
the relevant hotkey.

The 'Notes' sub-menu allows you to bring all notes to the front or back, either making them all
visible on screen, or hiding them all. The 'Save positions' option will save the current note
positions onscreen without saving the actual notes. This is useful if you're sharing the notes
with another machine via a network, and just want to update/save the screen positions.


Choices
~~~~~~~
Selecting 'Choices...' from the main menu will open the choices window, from where you can set
various preferences in order to customise !StickyPad.

The Notes location is the directory in which !StickyPad will create its 'stickypad' directory,
in which to store the individual sticky notes. Normally, you shouldn't need to change this and
!StickyPad will store all data inside Boot:Choices.StickyPad.
This can be useful for people who wish to store the notes on a shared drive so that more than
one computer can access them.

Drag a directory to the choices window to set the new path to where the notes will be stored.
NOTE: If StickyPad detects existing notes at the new location, THEY will be loaded an replace
the notes currently loaded, whereas if StickyPad can't detect notes at the new location, the
existing ones will be moved. This policy is used to prevent StickyPad from overwriting another
copy of StickyPad's notes if you drag from a different location. To share notes, load StickyPad
on the second machine and locate and drag the StickyPad choices directory on the first machine.
This will allow the second machine to access the first machines notes without overwriting them.
Effectively the first machine controls the master copy of your sticky notes.

If the 'Public Access'option is set, then any notes saved will have public read/write access
so that other machines on your network can load and re-save them.

'Auto Save' will automatically save the notes then you either add a new note, or quit !StickyPad
You may want to disable this if you've accessing shared notes across a network, as this will 
prevent a second copy of !StickyPad from overwriting your original notes if you quit the second
copy.
If 'Auto Save' is on, StickyPad will also save the notes automatically as soon as the caret
moves from a sticky note window to another window.

The line spacing for sticky notes can be set to large, medium or small, which will benefit 
anyone who has a different sized font for the desktop. The three settings correspond to 44, 36
and 28 pixels spacing. Changes won't take effect until next time you load !StickyPad.

Auto expand will automatically expand and contract notes as soon as you move the mouse pointer
over them.

Start minimised will automatically set all notes to their minimised size each time you load
!StickyPad.

Start maximised will automatically set all notes to their maximised size each time you load
!StickyPad.

Add horizintal scrollbars will take effect next time you load StickyPad and will automatically
add a horizontal scroll bar to each note. This gives slightly more flexibility over layout, but
at the sacrifice of visual tidyness.

Use iconbar will place an icon on the iconbar.

Clicking on the 'Advanced' button will load the choices file into a text editor, for advanced
editing (see below).


Advanced Users
~~~~~~~~~~~~~~
IMPORTANT NOTE: DO NOT EDIT the choices file whilst !StickyPad is running. This is because
!StickyPad automatically saves its choices when you quit, thus overwriting any changes you may
make. Make sure you quit !StickyPad BEFORE you make any manual changes to the choices file.

For advanced users, there are a few additional options stored in the 'Choices' file, which
aren't controllable from the choices window. These can be edited manually in a text editor if
you want. The 'choices' file is stored within the Boot:Choices directory. On normal RISC OS
machines, this is inside !Boot.Choices.StickyPad, but if you have Select or Adjust, it will be
inside the relevant local user choices directory. Alternatively, click on the 'Advanced' button
in the choices window.
Note that changing some of these values won't take effect until next time !StickyPad is loaded.

The additional options are:

	colour		The default wimp colour of the sticky notes.
			Default = 12 (pale yellow)
			
	border		The default wimp colour of the sticky note borders.
			Default = 9 (bright yellow)

        ink		The default wimp colour of the sticky note text.
                        Default = 7 (black)
                        			
	newx		The X offset from the previous note for creating new ones.
			Default = 100
			
	newy		The Y offset from the previous note for creating new ones.
			Default = -32
			
	key1		Hotkey code for CTRL-B put note to back
			Default = 2 (CTRL-B)
	
	key2		Hotkey code for CTRL-F bring note to front
			Default = 6 (CTRL-F)
	
	key3		Hotkey code for CTRL-N new note
			Default = 14 (CTRL-N)
	
	key4		Hotkey code for CTRL-X delete note
			Default = 24 (CTRL-X)
	
	key5		Hotkey code for F9 insert line
			Default = 393 (F9)
	
	key6		Hotkey code for F10 delete line
			Default = 458 (F10)
	
	key7		Hotkey code for F2 reload notes
			Default = 386 (F2)
	
	key8		Hotkey code for F3 save notes
			Default = 387 (F3)
	
	key9		Hotkey for CTRL-V paste note
			Default = 22 (CTRL-V)
	
	key10		Hotkey for CTRL-C copy note
			Default = 3 (CTRL-C)
	
	key11		Hotkey for CTRL-E load into a text editor
			Default = 5 (CTRL-E)

After the values detailed above, there are the individual notes window parameters, in the format

	posX,0		minimum X position for note X
	posX,1		minimum Y position for note X
	posX,2		maximum X position for note X
	posX,3		maximum Y position for note X
	posX,4		Number of lines on note X
	poxX,5		Colours of note X
	
			The colours for note X are defined as follows:-
			&ABC where A, B and C are hexadecimal values for the colour required.
			
			A = border colour (0 - F)
			B = paper colour (0 - F)
			C = ink colour (0 - F)
			
			Thus, a value of &9B0 will make note X have a bright yellow border, red
			paper and white ink. I may add a menu option in the future, to make it
			easier to change the colours of individual notes.
			An example sprite file called 'colours' is provided in the original
			archive of !StickyPad, to aid calculating colour values.


Discussion
~~~~~~~~~~
If you would like to discuss the use and future development of StickyPad, or indeed discuss
RISC OS in general, please feel free to join my friendly online discussion forum at
http://forum.vigay.com/
Membership is free and everyone is welcome.


Limitations
~~~~~~~~~~~
StickyPad is limited to 50 lines per note, 80 characters per line and a maximum of 75 sticky
notes on screen at once. After much experimentation here, I decided that this was a reasonable
specification to work to. Feel free to contact me if you have other requirements.

Although you can change the default overall colours of the sticky notes and the colours of 
individual notes, you can only do so by manually editing the choices file. Thus, this facility
is mainly for advanced users. I may add a menu option to change colours in a future version.

Some people have expressed a wish to have URLs highlighted. This poses a slight problem because
each line of a note is actually a RISC OS icon, and limitations of RISC OS impose that all
contents of a single icon are the same colour and font.


Known Bugs
~~~~~~~~~~
As of v1.06 there are no 'obvious' bugs, so please contact me if something happens which you 
don't think was expected.


Updates
~~~~~~~
Registered users can be kept up to date with notifications of updates, by emailing me an email
address, which I can add to my !StickyPad notification email list.


Contacting me
~~~~~~~~~~~~~
You can contact me in several ways:-

1. Email me at nospam@vigay.com

2. Go my RISC OS software web page at http://www.vigay.com/software/

3. Write to me at

	Digital Phenomena Ltd.,
	PO Box 813,
	Portsmouth, 
	Hampshire, 
	PO1 9EY
	
	Digital Phenomena is my trading name for RISC OS Software development and consultancy.
	Please make cheques payable to "Digital Phenomena Ltd." if registering !StickyPad.
	Thank you.


History
~~~~~~~
Changes made between versions:

 v1.08 (30th Oct 2007)
        a) Bug fix: Allow top-bit characters in sticky notes. This allows for  signs and other
           characters to be included in notes.

 v1.07 (1st Sep 2007)
        a) Added 15 minute demo period to unregistered versions.
        b) Bug fix: Now allows you to delete the first line of notes.
 
 v1.06 (29th Jul 2007)
        a) Added support for launching email addresses in notes.
        b) Added support for individual colours per note.
        
 v1.05 (10th Jul 2007)
        a) Bug fix: Deleting a line at the end of a note now works correctly.
        b) Bug fix: Implemented word wrap at the end of lines and prevented error message from
           being given if you attempt to type off the end of the line on the maximum line of a
           note.
        
 v1.04 (3rd Jul 2007)
        a) Bug fix: Corrected window adjustment for long lines shrinking window when they're
           not the longest line.
        b) Added registration window to encourage users to register !StickyPad.
        c) Added support for ink (foreground) colour, with default set to black (wimp colour 7)
        d) Added 'Advanced' button to choices window, to load the choices file into a text
           editor.
           
 v1.03 (27th Jun 2007)
        a) Added 'Auto Save' option.
        b) Updated interactive help text.
        c) Added default hotkey mappings to !Help file.
        
 v1.02 (16th Jun 2007)
        a) Added support for URLs starting with www. as well as those starting http://
        b) Added option to control public access to shared notes.
        c) Bug fix: Save window positions when you save notes via f3.
        d) Added 'Save positions' menu option to store just the new positions of notes - useful
           for networked machines if you want to store the positions of local windows without
           re-saving the actual notes.
        
 v1.01 (14th Jun 2007)
        a) Put X, Y offsets of new note into choices file, for advanced users to edit the
           default values if they want to.
        b) Changed default offset for new notes to be just below previous note when minimised.
        c) Added CTRL up/down to go to the start/end of a note.
        d) Added better support for moving notes to new positions.
        e) Added 'Note' menu option to give key shortcuts from sub-menu.
        f) Changed delete note to CTRL-X keypress due to popular demand/convention. :-)
        g) Added hotkey codes to choices file so that advanced users can redefine them.
        h) Added ability to copy and paste notes, including last deleted one.
        i) Bug fix: Improved handling of userpath for notes notes shared between computers.
        j) Added option to load note into a text editor (CTRL-E)
           
 v1.00 (12th Jun 2007)
        a) Moved totalnotes value into user-defined choices directory, so that notes can be
           stored remotely (ie. network shares etc).
        b) Added confirmation warning to saving notes (f3).
        c) Added ability to reload notes (f2).
        d) Added above two options to 'Notes' sub-menu.
        e) Re-worded some of the warning messages.
           
 v0.04 (11th Jun 2007)
        a) Bug fix: Auto expand correctly opens and closes windows when you have multiple notes
           on screen.
        b) Added 'Start maximised' option to complement 'Start minimised'.
        c) Added 'Add horizontal scroll bars' option.
        d) Bug fix: Sorted very wide notes occasionally being created on startup.
        e) Bug fix: 'Help' menu option correctly loads !Help file (silly typo in filepath!)
           
 v0.03 (10th Jun 2007)
        a) Added option to put icon on iconbar.
        b) Bug fix: Line spacing icons correctly toggled on initial loading.
        c) Bug fix (hopefully): Fixed occasional 'very wide' note being created on initial
           loading.
        d) Added facility to insert and delete lines.
        e) Bug fix: Double-clicking with 'Adjust' doesn't bring the window to the front.
        f) Implemented support for user-defined path for storing sticky notes.
        g) Set max number of notes to 75, which seems more realistic.
        h) Changed pointer to indicate links in 'Info' window.
        i) Added menu option to bring all notes to the front or put them all to the back.
        
 v0.02 (10th Jun 2007)
        a) Added 'Auto Expand' option
        b) Automatically extend notes when you type on the last line.
        c) Bug fix: Note data is no longer reset when you delete the choices file.
        d) Moved choices to dedicated choices window instead of using menus.
        e) Expanded max notes to 100 and max lines per note to 50.
        f) Added support for double-clicking on URLs.
        g) Made choices file human readable.
        h) Added preliminary support for different colours.
        i) Added minimise option (to startup with all notes minimised)
           
 v0.01 (8th Jun 2007)
        - Started coding, first version released 3 hours later (alpha test)


Paul Vigay, 8th Jun 2007
