@DATABASE TV-Logo.guide
@AUTHOR "Damir Arh"
@(c) "(C)1999-2000 Digital Amiga Dream"
@$VER: TV-Logo_english.guide 1.2 (18.08.2000)
@REMARK $Id: TV-Logo_english.guide,v 1.8 2000/08/18 11:53:43 damir Rel $

@NODE main "TV-Logo Documentation - Table of Contents"


                          @{b}TV-Logo release 1.2@{ub}

                             @{u}Documentation@{uu}


                           @{b}Table of Contents@{ub}

                             1. @{"Introduction" LINK intro}
                             2. @{"Installation" LINK install}
                             3. @{"Usage" LINK usage}
                             3.1. @{"Logo Display" LINK display}
                             3.2. @{"Additional Windows" LINK windows}
                             3.2.1. @{"Options" LINK options}
                             3.2.2. @{"Settings" LINK settings}
                             3.2.3. @{"About" LINK about}
                             4. @{"Registration" LINK feedback}
                             5. @{"Credits" LINK credits}
                             6. @{"History" LINK history}


                        @{i}(C)1999-2000 Damir Arh@{ui}


@ENDNODE

@NODE intro "TV-Logo Documentation - Introduction"


@{b}1. Introduction@{ub}


TV-Logo is a program for displaying logotypes of TV stations. To use it you
only need a plain Amiga (any Amiga will do, as long as it has KS 2.0 and a
working floppy drive. Of course you'll also need a genlock to compose the
Amiga output with the TV signal.

As you probably already noticed, the requirements are really low for such a
program. Most similar programs need better Amigas and usually a hard disk,
too. This program was designed to offer a simple solution to those who have
smaller Amigas, but would still like to use them for such purposes. The
program of course also works on better Amigas and can take use of hard disks,
but these aren't required.

According to the low requirements, the program features are not exactly the
best in comparison to other programs (these would result in bigger exe size
and higher requirements), but still they offer enough to make the user happy.

The program offers easy switching among ten different source pictures for
logotypes, ten preset logos (with specified size, RGB correction, position and
ten different texts each (with configurable colour, size, font and style))
available at a touch of a button and several other useful features.

@{"Try the program out" LINK usage} you might even like it. If you do, consider @{"registering" LINK feedback} it
and by this supporting the author and further development. In case you don't
like it, don't hesitate @{"contacting me" LINK feedback} and telling me what I should do to
improve it.


@ENDNODE

@NODE install "TV-Logo Documentation - Installation"


@{b}2. Installation@{ub}


There is an installation script provided, which does everything you need to
do to install the program. Just double click the Install icon in the same
drawer as this documentation and follow the on-screen instructions to install
TV-Logo either on the hard disk or on a floppy disk.

If for any reason you can't (or don't want to) use the provided installation
script then just do the following:

@{b}HD installation:@{ub}
  Create a new drawer called TV-Logo somewhere on your hard disk. Copy the
  contents of the files drawer (which is in the same location as this guide)
  to your newly created drawer. If you are installing the program for the first
  time or if you would rather use the provided sample program settings instead
  of your own, copy the contents of the samples drawer, too. You should also
  copy this guide to the same place for future reference. To run the program
  just double click the TV-Logo icon in your installation directory.

@{b}Floppy installation:@{ub}
  Format a floppy disk, name it TV-Logo and make it bootable (use the install
  program in your C: directory). Now copy the contents of the files drawer
  (which is in the same location as this guide) to your floppy disk. If you are
  installing the program for the first time or if you would rather use the
  provided sample program settings instead of your own, copy the contents of the
  samples drawer, too. You should also copy this guide there for future
  reference. Now copy additional files (mentioned in the AddFiles file in the
  corresponding drawer) to the c and libs drawers on your floppy from your
  system C: and LIBS: directories respectively. You have to copy:

  to @{i}TV-Logo:c/@{ui}
  - Assign
  - SetPatch
  
  to @{i}TV-Logo:libs/@{ui}
  - asl.library
  - diskfont.library

  You can now run the program from the newly created floppy disk.


@ENDNODE

@NODE usage "TV-Logo Documentation - Usage"


@{b}3. Usage@{ub}


The usage of the program is really simple. You can run the program by simply
booting from the program disk or (if the program is installed on a hard disk)
by executing the file 'TV-Logo' in the program directory.

Upon starting the program will immediatly show the default preset logotype (in
case all the options and settings are already specified) or it will open the
options window to specify these.

All the additional windows for specifying options and settings are designed in
Amiga gadget tools GUI and completely mouse driven for ease of use. This is
unfortunately not possible in the logo display itself as the mouse pointer has
to be hidden, so that it doesn't appear on the TV picture. So, the controls in
this display are all available by pressing a key or a combination of keys on
the keyboard.

To find out more details about controling a specific part of the program, look
at one of the following sections:

  3.1. @{"Logo Display" LINK display}
  3.2. @{"Additional Windows" LINK windows}
  3.2.1. @{"Options" LINK options}
  3.2.2. @{"Settings" LINK settings}
  3.2.3. @{"About" LINK about}


@ENDNODE

@NODE display "TV-Logo Documentation - Logo Display"


@{b}3.2. Logo Display@{ub}


This is the display that will probably be in use most of the time. It shows
the preset logotype, but at the same time it offers easy accessibility to most
of the program options and in this way enables quick on the fly modifications
of the display as the need arises.

A big amount of such options unfortunately results in a big amount of keys to
remember. Though, it isn't as hard as it looks. The selection of keys is very
intuitive and shouldn't be difficult to remember. But until then you should
print (or copy if you don't have a printer) out the following list (don't forget
to set your keyboard layout in the @{"Options" LINK options} window or the Z and Y keys could have
their positions switched):

@{b}ARROW KEYS@{ub}           - movement of the logotype
@{b}[SHIFT]@{ub} + @{b}ARROW KEYS@{ub} - fast movement of the logotype
@{b}1@{ub} - @{b}9@{ub} @{i}(numeric kbd)@{ui}  - positioning of the logotype into one of the edges

@{b}[ALT]@{ub} + @{b}ARROW KEYS@{ub}           - movement of the text
@{b}[ALT]@{ub} + @{b}[SHIFT]@{ub} + @{b}ARROW KEYS@{ub} - fast movement of the text
@{b}[ALT]@{ub} + @{b}1@{ub} - @{b}9@{ub} @{i}(numeric kbd)@{ui}  - positioning of the text into one of the edges
@{b}[ALT]@{ub} + @{b}1@{ub} - @{b}9@{ub} @{i}(main kbd)@{ui}     - displays a preset text

@{b}L@{ub} - locks/unlocks the movement of the text together with the logotype

@{b}R@{ub} - selects the red colour component modifying mode
@{b}G@{ub} - selects the green colour component modifying mode
@{b}B@{ub} - selects the blue colour component modifying mode
@{b}Z@{ub} - selects the x- and y-axis size modifying mode
@{b}X@{ub} - selects the x-axis size modifying mode
@{b}Y@{ub} - selects the y-axis size modifying mode

@{b}+@{ub} @{i}(numeric kbd)@{ui}           - increases the modified value (selected mode) 
@{b}-@{ub} @{i}(numeric kbd)@{ui}           - decreases the modified value (selected mode)
@{b}[SHIFT]@{ub} + @{b}+@{ub} @{i}(numeric kbd)@{ui} - quickly increases the modified value (sel. mode)
@{b}[SHIFT]@{ub} + @{b}-@{ub} @{i}(numeric kbd)@{ui} - quickly decreases the modified value (sel. mode)

@{b}[DEL]@{ub} - resets current settings to built-in default values
@{b}C@{ub}     - hides/displays the logotype

@{b}0@{ub} - @{b}9@{ub} @{i}(main kbd)@{ui}   - loads a selected logotype picture (options window)
@{b}F1@{ub} - @{b}F10@{ub}           - loads a preset logotype setting (settings window)
@{b}[SHIFT]@{ub} + @{b}F1@{ub} - @{b}F10@{ub} - saves a preset logotype setting (settings window)
@{b}[ENTER]@{ub} @{i}(main kbd)@{ui} - saves current preset logotype setting (settings window)

@{b}[HELP]@{ub}           - opens @{"the settings window" LINK settings}
@{b}[SHIFT]@{ub} + @{b}[HELP]@{ub} - opens @{"the options window" LINK options}
@{b}[ALT]@{ub} + @{b}[HELP]@{ub}   - opens @{"the about window" LINK about}

@{b}[ESC]@{ub} - quits program


@ENDNODE

@NODE windows "TV-Logo Documentation - Additional Windows


@{b}3.2. Additional Windows@{ub}


Not all of the options and settings are available by keyboard from the logo
display. And some of them are really not too intuitive to use in such a way.
So there is another way of changing these parameters available.

These are gadget tools windows, where you can visually change all of these
parameters. For more information about these windows check out the following
sections:

  3.2.1. @{"Options" LINK options}
  3.2.2. @{"Settings" LINK settings}
  3.2.3. @{"About" LINK about}


@ENDNODE

@NODE options "TV-Logo Documentation - Options"


@{b}3.2.1. Options@{ub}


This window is dedicated to setting the global options for the program. It
consists of the following parts:

@{b}ScreenMode@{ub}:
  Using this cycle gadget you can set the resolution, you will be using for
  the logo display. All PAL resolutions, supported by your Amiga are
  available.

@{b}Pic #n@{ub}:
  Each of these ten gadgets consists of two parts. You can use the
  corresponding text gadget to directly enter the filename of the picture file
  or you can click on the '?' button on the right to open an ASL file
  requester and select the file there. The picture files, specified in these
  gadgets, will be available from the logo display by pressing the keys 0
  through 9 on the main keyboard.

@{b}Default setting@{ub}:
  This cycle gadget lets you select the setting that is going to be used
  when the program will be started.

@{b}Keymap@{ub}:
  This cycle gadgets lets you select the keyboard layout you are using. German
  and English/American layouts are available. This option affects only the logo
  display input. Use it to map the Y and Z keys according to your keyboard.

@{b}Save@{ub}:
  Saves the current options for future use. At the same it also uses them as
  soon as the window closes. The option is also available from the pull-down
  menu, as the button is not visible on NTSC screens.

@{b}Use@{ub}:
  Closes the window and uses current options. It doesn't save them for future
  use. The option is also available from the pull-down menu, as the button is
  not visible on NTSC screens.

@{b}Cancel@{ub}:
  Closes the window and forgets all the changes you have made. It still uses
  the old options. The option is also available from the pull-down menu, as the
  button is not visible on NTSC screens.


@ENDNODE

@NODE settings "TV-Logo Documentation - Settings"


@{b}3.2.2. Settings@{ub}


This window is dedicated to setting the local settings for the particular
preset logotype display (the number of that preset display is written in
brackets in the window title). It consists of the following parts:

@{b}DeltaX@{ub}:
  The number of pixels the logotype is positioned away in horizontal direction
  from its set position by the angle selection. A positive value means a
  displacement to the right, a negative value means a displacement to the
  left.

@{b}DeltaY@{ub}:
  The number of pixels the logotype is positioned away in vertical direction
  from its set position by the angle selection. A positive value means a
  displacement down, a negative value means a displacement up.

@{b}R@{ub} and @{b}Red@{ub}:
  The percentage of the red colour correction for the logo display. A positive
  value means an increased amount of red, a negative value means a decreased
  amount of red.

@{b}G@{ub} and @{b}Green@{ub}:
  The percentage of the green colour correction for the logo display. A
  positive value means an increased amount of green, a negative value means a
  decreased amount of green.

@{b}B@{ub} and @{b}Blue@{ub}:
  The percentage of the blue colour correction for the logo display. A
  positive value means an increased amount of blue, a negative value means a
  decreased amount of blue.

@{b}Angle@{ub}:
  This cycle gadget specifies, where the logotype will roughly appear. The
  fine adjustments are then done using the DeltaX and DeltaY gadgets.

@{b}Preset@{ub}:
  Each preset logotype can have up to 10 different texts preset for immediate
  use, which can then be selected using [ALT] together with keys 0 through 9
  on the main keyboard. Using this cycle gadget you select the one you are
  going to modify and is going to be displayed after you close this window,
  confirming your changes.

@{b}Text@{ub}:
  Here you enter the text you want to display. A special character '§' denotes
  a new line. By using it you can force the text to be written in several lines.

@{b}Font@{ub}:
  Here you can specify the font you want to use for your text. You can either
  enter its name and size in the text and integer gadget on the left, or you
  can press the "Browse" button on the right and select the font by using an
  ASL font requester.

@{b}Bold@{ub}:
  This checkmark indicates whether or not the text will be displayed using a
  bold font style.

@{b}Italic@{ub}:
  This checkmark indicates whether or not the text will be displayed using an
  italic font style.

@{b}Underlined@{ub}:
  This checkmark indicates whether or not the text will be displayed using an
  underlined font style.

@{b}Lock@{ub}:
  This checkmark indicates whether you want the text to be moved together with
  the logotype or not.

@{b}Shadow@{ub}:
  This checkmark indicates whether or not there will be a shadow drawn beneath
  the text.

@{b}Outline@{ub}:
  This checkmark indicates whether or not there will be a border drawn around
  the letters (known as outline font style).

@{b}Text DX@{ub}:
  This value indicates the x-axis displacement of the text from its default
  position (under the logotype if locked, top left corner if not). The
  positive and negative values have the same meaning as in the DeltaX gadget.

@{b}Text DY@{ub}:
  This value indicates the y-axis displacement of the text from its default
  position (under the logotype if locked, top left corner if not). The
  positive and negative values have the same meaning as in the DeltaY gadget.

@{b}Colours@{ub}, @{b}R@{ub}, @{b}G@{ub} and @{b}B@{ub}:
  These gadgets are used to specify the colour of the text, text shadow and
  text border.  The boxes after the Colours text display the currently selected
  colours in respective order, the sliders marked as R, G and B allow you to
  modify the red, green and blue colour component of the colour you are
  currently modifying. You can select the colour you want to modify by clicking
  on its respective box.

@{b}OK@{ub}:
  Stores all the changes and goes back to the logo display. You still have to
  save these settings if you want to use them the next time you load the
  program or select the settings from this saved slot. The option is also
  available from the pull-down menu, as the button is not visible on NTSC
  screens.

@{b}Apply@{ub}:
  Applies the changes to the current logo display in the background. You can
  check it out by dragging the current window down (click and hold left mouse
  button on the title bar and move the mouse down). You can now decide if you
  like the settings and then use or forget them. The option is also available
  from the pull-down menu, as the button is not visible on NTSC screens.

@{b}Cancel@{ub}:
  Drops all the changes, recovers the old settings and closes this window. The
  option is also available from the pull-down menu, as the button is not visible
  on NTSC screens.


@ENDNODE

@NODE about "TV-Logo Documentation - About"


@{b}3.2.3. About@{ub}


This window displays the information about the authors of the program, about
the program copyrights, the program version and the owner of the program copy.
You can close this window by clicking on the 'OK' button in the bottom or on
the window close gadget.


@ENDNODE

@NODE feedback "TV-Logo Documentation - Registration"


@{b}4. Registration@{ub}


You tried the program out and you really like it. It's just the thing you were
looking for. But there is a problem. All the time you can see 'Demo' written
on the logo display and you certainly can't use such a program on the TV. What
would the people watching it think?

Well, there is a solution for this. Register the program and you'll receive a
special keyfile which will prevent the demo text from being written. To do that
just send me @{b}60 DEM@{ub} (or @{b}30 USD@{ub} or @{b}20 GBP@{ub}) along with a filled in registration
form. If you'd like to receive the keyfile on a floppy, you should send me
additional @{b}10 DEM@{ub} (or @{b}5 USD@{ub} or @{b}5 GBP@{ub}) to cover the costs.

Send the filled in registration form along with the money to the following
address:

S-mail: Damir Arh
        Titova 89
        SI-4270 Jesenice
        Slovenia

E-mail: damir.arh@telesat.si

You're also invited to just send me an e-mail and tell me what you like or don't
like about the program or even what you're missing in the program that prevents
you from registering it.


----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----

                           TV-Logo Registration Form


First name: ________________________ Last name: ____________________________

Street: ____________________________________________________________________

ZIP: _______________________________ City: _________________________________

Country: ___________________________________________________________________

E-mail: ____________________________________________________________________


I'd like to register TV-Logo and I enclosed:

 * 60 DEM (or the equivalent) to receive the keyfile via E-mail

 * 70 DEM (or the equivalent) to receive the keyfile via S-mail


The configuration of my Amiga:

Model: _____________________________ Processor: ____________________________

Memory: ____________________________ Graphics: _____________________________

Hard disk: _________________________ CD drive: _____________________________

Kickstart: _________________________ Workbench: ____________________________

Other: _____________________________________________________________________


I understand that I am not allowed further distibute the keyfile which I
will receive as this is considered as an act of software privacy.



Date: ______________________________ Signature: ____________________________


----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----8<----


@ENDNODE

@NODE credits "TV-Logo Documentation - Credits"


@{b}5. Credits@{ub}


This program is available as-is. The author is not responsible for any damage
or loss of profit that might be caused by the use of this program. The author
does not oblige himself to fix any of the problems that might be in the program
nor does he guarantee the further development of the title. The user uses the
program at his own risk.

This archive may be freely distributed as long as the complete package remains
unmodified. Though you are not allowed to redistribute which you receive upon
registering. This is your personal keyfile and any further distribution of it
is considered an act of software piracy.

The author would like to be informed in case that the demo of the program
gets published on a magazine cover CD. In case a review of the program is
published in a printed or electronic form, the author would also like to be
informed about it and, if possible, would like to receive a copy of the
review.


(C)1999-2000 Damir Arh, All rights reserved.


@{b}Programmer@{ub}: Damir Arh <@{u}damir.arh@telesat.si@{uu}>

@{b}Betatester@{ub}: Uros Bogataj <@{u}urosb@technologist.com@{uu}>


To find the latest version of this program and my other products, visit my web
page at:

  @{u}http://damir.gajba.net/@{uu}



Amiga is a registered trademark of Amiga, Inc.


@ENDNODE

@NODE history "TV-Logo Documentation - History"


@{b}6. History@{ub}


@{b}release 1.2@{ub} @{i}(18.08.2000)@{ui}:
  - fixed logo display window height issue with NTSC screenmodes
  - implemented keyfile support
  - fixed a bug which caused a crash when the selected font was too big
  - implemented shadow and outline text effects
  - implemented support for multiline text
  - speeded up the program a bit by removing some unnecessary calculations
  - existing user settings don't get overwritten during update any more
  - updated the documentation with new features

@{b}release 1.1@{ub} @{i}(04.08.2000)@{ui}:
  - no more crashes when run from Workbench
  - this guide is now also installed
  - fixed the settings, options and about windows for NTSC screen sizes
  - the keyboard control in the logo display is now performed using the
    intuition messages instead of the raw keyboard reading
  - implemented an option for keyboard layout selection
  - implemented a feature to blank the logo display with a keypress
  - the logo display window now automaticaly gets focus when it is in front

@{b}release 1.0@{ub} @{i}(12.07.2000)@{ui}:
  Initial release


@ENDNODE
