home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / v / videobase / Manual < prev   
Encoding:
Text File  |  1996-10-13  |  23.4 KB  |  626 lines
  1.  
  2.  
  3.  
  4.  
  5.     CONTENTS
  6.  
  7.  
  8.  
  9.      1. Introduction.......................................................1
  10.      2. Getting Started....................................................2
  11.      3. Adding A New Tape..................................................3
  12.      4. Adding A New Recording.............................................4
  13.      5. Saving Files.......................................................4
  14.      6. Editing An Existing Recording......................................4
  15.      7. Making A Selection.................................................5
  16.      8. Exporting Data To Other Applications...............................5
  17.      9. Searching The DataBase.............................................6
  18.     10. Deleting Recordings................................................6
  19.     11. Deleting Tapes.....................................................6
  20.     12. Customisation......................................................6
  21.     13. Registration.......................................................7
  22.     14. Availability Of Source Code........................................7
  23.     15. Conversion of VideoBase Version 1 Files............................7
  24.     16. Acknowledgements...................................................8
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.     
  71.  
  72.  
  73.  
  74.     VideoBase 2
  75.     ________________________________________________________________________
  76.  
  77.  
  78.     1. Introduction
  79.     ———————————————
  80.     Videobase is an application to keep track of recordings and free spaces
  81.     on a collection of video tapes. It is designed to make maintaining the
  82.     database as easy as possible and to avoid the possibility of
  83.     inappropriate inputs.
  84.  
  85.     It uses a filetype of &344 by default at the moment which is NOT Acorn
  86.     approved. Now that the design of the file format is stable I will be
  87.     applying for an official filetype number.
  88.  
  89.     VideoBase is not 'Public Domain' or 'FreeWare', it is 'ShareWare'. This
  90.     is explained in in next few paragraphs.
  91.  
  92.     Shareware distribution gives users a chance to try software before
  93.     buying it. If you try a Shareware program and continue using it, you
  94.     are expected to register. Individual programs differ on details -- some
  95.     request registration while others require it, some specify a maximum
  96.     trial period. With registration, you get anything from the simple right
  97.     to continue using the software to an updated program with printed
  98.     manual.
  99.  
  100.     Copyright laws apply to both Shareware and commercial software, and the
  101.     copyright holder retains all rights, with a few specific exceptions as
  102.     stated below. Shareware authors are accomplished programmers, just like
  103.     commercial authors, and the programs are of comparable quality. (In
  104.     both cases, there are good programs and bad ones!) The main difference
  105.     is in the method of distribution. The author specifically grants the
  106.     right to copy and distribute the software, either to all and sundry or
  107.     to a specific group. For example, some authors require written
  108.     permission before a commercial disk vendor may copy their Shareware.
  109.  
  110.     Shareware is a distribution method, not a type of software. You should
  111.     find software that suits your needs and pocketbook, whether it's
  112.     commercial or Shareware. The Shareware system makes fitting your needs
  113.     easier, because you can try before you buy. And because the overhead is
  114.     low, prices are low also. Shareware has the ultimate money-back
  115.     guarantee -- if you don't use the product, you don't pay for it.
  116.  
  117.     Users of VideoBase must accept this disclaimer of warranty: "VideoBase
  118.     is supplied as is. The author disclaims all warranties, expressed or
  119.     implied, including, without limitation, the warranties of
  120.     merchantability and of fitness for any purpose. The author assumes no
  121.     liability for damages, direct or consequential, which may result from
  122.     the use of VideoBase."
  123.  
  124.     VideoBase is a "shareware program" and is provided at no charge to the
  125.     user for evaluation. Feel free to share it with your friends, but
  126.     please do not give it away altered or as part of another system. The
  127.     essence of "user-supported" software is to provide personal computer
  128.     users with quality software without high prices, and yet to provide
  129.     incentive for programmers to continue to develop new products. If you
  130.     find this program useful and find that you are using VideoBase and
  131.     continue to use VideoBase after a reasonable trial period, you must
  132.  
  133.  
  134.  
  135.  
  136.                                     Page 1
  137.  
  138.  
  139.  
  140.     
  141.  
  142.  
  143.  
  144.     VideoBase 2
  145.     ________________________________________________________________________
  146.  
  147.  
  148.     make a registration payment of £8.00 (or the equivalent in local
  149.     currency) to the author. The £8.00 registration fee will license one
  150.     copy for use on any one computer at any one time. You must treat this
  151.     software just like a book. An example is that this software may be used
  152.     by any number of people and may be freely moved from one computer
  153.     location to another, so long as there is no possibility of it being
  154.     used at one location while it's being used at another. Just as a book
  155.     cannot be read by two different persons at the same time.
  156.  
  157.     VideoBase may be distributed to anyone, via any medium but the
  158.     registration file 'User' inside the application (click SHIFT-SELECT
  159.     over VideoBase in a directory display to open it) must be removed
  160.     before distribution.
  161.  
  162.     You are encouraged to pass a copy of VideoBase along to your friends
  163.     for evaluation. Please encourage them to register their copy if they
  164.     find that they can use it. All registered users will receive a copy of
  165.     the latest version of the VideoBase application. Please see the later
  166.     section on registration for details on how to register.
  167.  
  168.     2. Getting Started
  169.     ——————————————————
  170.     In this manual the mouse buttons will be referred to in the standard
  171.     Acorn manner, i.e SELECT is the leftmost button, MENU the middle one
  172.     and ADJUST the rightmost one. 'Type CTRL-A' means hold down the key
  173.     marked 'Ctrl' and press the 'A' key at the same time.
  174.  
  175.     VideoBase does not need to be installed on a hard disk to work but it
  176.     can be copied onto one if required. The media can be write protected -
  177.     or in a read only archive - but will then be unable to save its
  178.     configuration files. The application is loaded in the usual way (by
  179.     double clicking on its icon in a directory display) and will appear on
  180.     the right hand side of the icon bar.
  181.  
  182.     If the program is run from floppy disc you should note that the floppy
  183.     containing !VideoBase will need to remain in the drive while the
  184.     application is running. This is because some of the data is not read in
  185.     when the program starts up but rather when it is needed. This is to
  186.     reduce the time needed to start the program. If enough people think
  187.     this is a problem than it could be changed.
  188.  
  189.     The program requires a total of 280K of RAM to run, claiming extra RAM
  190.     as needed for storage of the data.
  191.  
  192.     It has not been tested on Risc OS 2 although it should run (it will
  193.     probably be desirable to edit the template file to tidy up the windows
  194.     though). It has been tested on an A4 portable running Risc OS 3.1 and
  195.     on a Risc PC running Risc OS 3.5 and 3.7 (it is also StrongARM
  196.     compatible).
  197.  
  198.     If you have an unregistered copy of VideoBase a banner window will open
  199.     advising you of this fact. Once your copy has been registered you will
  200.     be sent a small file to disable the banner.
  201.  
  202.  
  203.  
  204.  
  205.  
  206.                                     Page 2
  207.  
  208.  
  209.  
  210.     
  211.  
  212.  
  213.  
  214.     VideoBase 2
  215.     ________________________________________________________________________
  216.  
  217.  
  218.     It is a good idea at this point to run Acorn's Help application (or
  219.     preferably  BubbleHelp available from David Pilling) as VideoBase
  220.     supports interactive help and this will enable you to master the
  221.     application more quickly.
  222.  
  223.     Click MENU on the iconbar icon and choose 'Options...'. Ensure that if
  224.     your video recorder has a 'Real time' tape counter (i.e. it displays in
  225.     hours and minutes) that the 'Real time' option is on. If your recorder
  226.     uses an arbitrary number as a tape counter then turn it off. Save the
  227.     options at this point if possible (if you have run VideoBase from a CD
  228.     or a read only archive then it won't be).
  229.  
  230.     Clicking SELECT on the icon bar icon will open the main window. Most of
  231.     the icons will be greyed out at this stage as the database is empty. If
  232.     a demo file has been supplied with your copy it can be loaded by double
  233.     clicking SELECT on it or dragging it to the main window or the icon bar
  234.     icon.
  235.  
  236.     The main window always shows the entire contents of a tape. To display
  237.     different tapes in the database click SELECT or ADJUST on the up/down
  238.     arrows next to the 'Tape id' field on the button bar. You can also jump
  239.     directly to a particular tape by clicking SELECT or MENU on the 'Tape
  240.     id' field itself which will call up a menu of the tape ids in the
  241.     database - providing more than one tape has been added of course.
  242.  
  243.     The colours used in the main window display can be altered. See the
  244.     later section on customisation.
  245.  
  246.     3. Adding A New Tape
  247.     ————————————————————
  248.     With the main window open either click SELECT on the icon second from
  249.     the left on the button bar, type CTRL-A or choose 'Add tape' from the
  250.     main window menu obtained by pressing MENU over the main window or the
  251.     button bar.
  252.  
  253.     The dialogue box for adding a new tape will open which allows the
  254.     inputting of the length of the tape and the tape id number. Each tape
  255.     in the database must have a unique id number which can be chosen by
  256.     clicking on the up and down icons next to the field containing the tape
  257.     id. Tape ids that are already in use will be skipped over when adding a
  258.     new tape.
  259.  
  260.     The length of the new tape can be selected from the menu icon next to
  261.     the tape length field. A value can be selected from the menu, or the
  262.     last item on the menu is writable and will accept any value.
  263.  
  264.     The length of the initial free space record created on the tape depends
  265.     on the tape length selected and on the short/long play setting (the
  266.     SP/LP icons). I suggest that a tape is designated as either short play
  267.     or long play and that you don't mix the two types of recording on the
  268.     same tape.
  269.  
  270.     It is possible to alter the menus that show the preset values for tape
  271.     lengths and tape makes. See the section on customisation for details.
  272.  
  273.  
  274.  
  275.  
  276.                                     Page 3
  277.  
  278.  
  279.  
  280.     
  281.  
  282.  
  283.  
  284.     VideoBase 2
  285.     ________________________________________________________________________
  286.  
  287.  
  288.  
  289.     4. Adding A New Recording
  290.     —————————————————————————
  291.     If the free space that you wish to use for the recording is visible in
  292.     the main window, just click SHIFT-SELECT on it to open the editing
  293.     dialogue box. Should a suitable free space not be visible, click SELECT
  294.     on the fourth button from the left on the button bar, press CTRL-N or
  295.     select 'New record...' from the menu obtained by pressing MENU over the
  296.     main window or button bar.
  297.  
  298.     The 'Find space' dialogue box will open displaying all the available
  299.     free spaces in the database. The SP/LP setting can be altered, as can
  300.     the desired length of the space. Clicking SELECT on a gap in the
  301.     scrolling window and then clicking on the 'Add recording' icon will
  302.     open the 'Editing free space record' dialogue box where the details of
  303.     the recording can be entered.
  304.  
  305.     The speed of the recording or the free space (i.e. short or long play)
  306.     can be altered by clicking directly on the SP/LP field. If you are
  307.     converting a long play recording to a short play one then the length
  308.     will be halved and subsequent recordings on the same tape will have
  309.     their start times adjusted if VideoBase is in 'Real time' mode.
  310.     Converting a short play record to long play has the opposite effect.
  311.  
  312.     If you do this be sure to actually record something with this SP/LP
  313.     setting on the tape as otherwise you'll be out of step with the start
  314.     times held by VideoBase.
  315.  
  316.     The menus for titles, subjects and channels can be altered, see the
  317.     later section on customisation.
  318.  
  319.     5. Saving Files
  320.     ———————————————
  321.     Click SELECT on the leftmost icon on the button bar, press F3 or choose
  322.     'Save data' from the menu obtained by pressing MENU over the main
  323.     window or button bar to open the save file dialogue box. This works in
  324.     the usual Risc OS manner, either type a name into the filename icon or
  325.     drag the file icon to a directory display to save the file.
  326.  
  327.     Closing the main window or shutting down the computer while unsaved
  328.     data is being edited will open a confirmation dialogue box to prevent
  329.     the accidental loss of data.
  330.  
  331.     6. Editing An Existing Recording
  332.     ————————————————————————————————
  333.     Clicking SHIFT-SELECT or double clicking SELECT over a recording in the
  334.     main window will open an editing dialogue box which enables the title,
  335.     subject, length of recording etc to be altered. Using a double click to
  336.     edit a record will also select it, cancelling any previous selection.
  337.     This a consequence of the way that Risc OS reports mouse clicks - if
  338.     this is a problem use SHIFT-SELECT instead.
  339.  
  340.     If the length of an existing recording is decreased a free space record
  341.     will be created between the end of the recording and the start of the
  342.  
  343.  
  344.  
  345.  
  346.                                     Page 4
  347.  
  348.  
  349.  
  350.     
  351.  
  352.  
  353.  
  354.     VideoBase 2
  355.     ________________________________________________________________________
  356.  
  357.  
  358.     next one on the same tape. If the length is increased and no free space
  359.     exists at the end of it confirmation will be requested before
  360.     shortening the following recording by changing its start counter.
  361.  
  362.     When VideoBase has been set up to use 'Real time' tape counters
  363.     altering the length of a recording will also alter the end time.
  364.  
  365.     If the length of the last recording on a tape is increased beyond the
  366.     current end of the tape then the tape length will be increased. This is
  367.     deliberate as tapes are usually five or six minutes (in short play)
  368.     longer than they should be. It is also possible to decrease the length
  369.     of a tape by editing the last free space record on it, but note that
  370.     this does not change the stored length of the tape displayed on the
  371.     button bar.
  372.  
  373.     7. Making A Selection
  374.     —————————————————————
  375.     Clicking SELECT over a recording in the main window will select it (!)
  376.     and using ADJUST will add an entry to the selection. In addition the
  377.     fifth icon from the left on the icon bar or pressing CTRL-S will open a
  378.     dialogue box that allows selections to be made by searching titles,
  379.     subjects and other attributes.
  380.  
  381.     Drag selection is not supported in this version of VideoBase, all
  382.     selections require a mouse click.
  383.  
  384.     Once a selection has been made the recordings can be exported to other
  385.     applications, deleted or have various operations performed on them such
  386.     as setting the selection as 'seen', unlocking/locking the selection etc.
  387.  
  388.     The number of recordings currently selected is shown in an icon on the
  389.     button bar. If no recordings match the selection in the dialogue box
  390.     then a warning is displayed.
  391.  
  392.     8. Exporting Data To Other Applications
  393.     ———————————————————————————————————————
  394.     Clicking SELECT on the sixth icon from the left on the button bar,
  395.     pressing CTRL-R or choosing 'Reports...' from the main window menu will
  396.     open a dialogue box. If a selection has been made you have the choice
  397.     of exporting just the selection or a range of tapes from the database.
  398.     Drag either the text file icon or the CSV icon to another application
  399.     or to a directory display to export the data. A CSV (comma separated
  400.     value) file can be imported into applications like PipeDream or other
  401.     databases.
  402.  
  403.     Clicking SELECT on the 'Send to editor' icon will export the data
  404.     direct to the default text editor. This is a quick way of performing a
  405.     search operation on the database.
  406.  
  407.     Clicking ADJUST on the 'Report' icon on the button bar will send the
  408.     current selection (if there is one) to the system text editor. If there
  409.     is no selection then the whole database will be sent. This enables a
  410.     sort of 'Search the database' function rather more easily than before.
  411.  
  412.  
  413.  
  414.  
  415.  
  416.                                     Page 5
  417.  
  418.  
  419.  
  420.     
  421.  
  422.  
  423.  
  424.     VideoBase 2
  425.     ________________________________________________________________________
  426.  
  427.  
  428.     9. Searching The DataBase
  429.     —————————————————————————
  430.     From version 2.12 on a search function has been implemented. You still
  431.     have to create a selection first (see section 7) but once you have the
  432.     number of selected recordings is displayed on the button bar and next
  433.     to it is a 'menu' icon that has a list of the selected recordings.
  434.     Selecting a recording from this menu changes the main window display to
  435.     show the contents of the tape containing the selected recording.
  436.  
  437.     10. Deleting Recordings
  438.     ———————————————————————
  439.     A selection of recordings can be deleted by pressing CTRL-X or by
  440.     choosing 'Selection -> Delete' from the main window menu. If the
  441.     selection contains locked records you will be asked if you want to
  442.     delete them anyway. CTRL-SELECT will delete records that are not
  443.     selected, again if the recording is locked confirmation will be asked
  444.     for.
  445.  
  446.     Free spaces cannot be deleted but as they are created they will be
  447.     merged into one contiguous block providing they have the same SP/LP
  448.     setting. Clicking CTRL-SELECT over a free space record will move it to
  449.     after the next recording if possible. This is so that if two recordings
  450.     are made in one session and the first turns out to be shorter than
  451.     expected the start time of the second recording can easily be altered.
  452.  
  453.     This is, however, only likely to be of use when the video recorder is
  454.     controlled by signals sent by the broadcaster as it normally is here in
  455.     Germany (the VPS system). When this is not the case you will have
  456.     programmed the recorder to record for a certain duration so the start
  457.     and end times will be correct anyway.
  458.  
  459.     11. Deleting Tapes
  460.     ——————————————————
  461.     The third icon from the left on the button bar opens a dialogue box to
  462.     enable a whole tape to be deleted from the database. Initially the
  463.     'tape id' field shows the currently displayed tape id, but other tapes
  464.     can be selected from the menu obtained by clicking SELECT or MENU on
  465.     the icon next to it. If another tape is chosen the main window displays
  466.     the contents of this tape instead.
  467.  
  468.     Should the tape contain recordings that are locked against accidental
  469.     deletion you will be informed and given an opportunity to abandon the
  470.     operation.
  471.  
  472.     12. Customisation
  473.     —————————————————
  474.     The menus for 'Tape makes', 'Tape lengths', 'Tape formats', 'Titles',
  475.     'Subjects' and 'Channels' can be edited to include suitable defaults.
  476.  
  477.     Open the 'Options' dialogue box from the menu on iconbar icon or the
  478.     icon on the button bar. Buttons are provided in this dialogue box to
  479.     allow the editing of each of the menu definition files. The menu files
  480.     are as follows:
  481.  
  482.  
  483.  
  484.  
  485.  
  486.                                     Page 6
  487.  
  488.  
  489.  
  490.     
  491.  
  492.  
  493.  
  494.     VideoBase 2
  495.     ________________________________________________________________________
  496.  
  497.  
  498.     Titles       - Titles of recordings that you make repeatedly
  499.     Subjects     - Categories for recordings, i.e. Sport, Music etc
  500.     Channels     - Channel that the recording was made from
  501.     Tape formats - Format of the tape, i.e. VHS, SVHS etc
  502.     Tape lengths - Length of tapes, i.e. E180, E240 etc
  503.     Tape makes   - Make of tape, i.e. Sony etc
  504.  
  505.     Any of these menu files can be edited as required, but they must be
  506.     present.
  507.  
  508.     The colours used for the main window display can be set by choosing
  509.     'Options...' from the icon bar menu. This dialogue box also allows you
  510.     to set the main window position and whether the tape counter is 'Real
  511.     time' i.e. it displays in hours and minutes or whether it is just an
  512.     arbitary number.
  513.  
  514.     13. Registration
  515.     ————————————————
  516.     Registration costs £8.00p or the equivalent in local currency. Cheques
  517.     drawn on an English bank are preferred, however. Registering your copy
  518.     supports further development and updates will be provided on request to
  519.     registered users. A blank disc is not required when requesting updates
  520.     - it's only around 140K and I've got hundreds of 800K discs lying
  521.     around.
  522.  
  523.     To register your copy send the fee to:
  524.  
  525.     Paul Hobbs
  526.     Rheinpfalzstrasse 2
  527.     85049 Ingolstadt
  528.     Germany
  529.  
  530.     EMail   : Paul.Hobbs@t-online.de
  531.     Fax     : +49 (0)8458 6314
  532.     Tel     : +49 (0)841 47467
  533.     Web site: http://www.angel.co.uk/phobbs/vbase2.htm (updates
  534.               available here)
  535.  
  536.     14. Availability Of Source Code
  537.     ———————————————————————————————
  538.     VideoBase is not distributed with its source code for two reasons.
  539.     Firstly it is over 450K and secondly it would defeat the ShareWare
  540.     banner mechanism which is the only protection used by the application.
  541.  
  542.     The source code may well be of interest to others using my EvntShell
  543.     system and parts of it will be made available on request.
  544.  
  545.     15. Conversion of VideoBase Version 1 Files
  546.     ———————————————————————————————————————————
  547.     Should there be anybody out there still using my first stab at this
  548.     program the old style files can be converted by dropping one of the
  549.     three files (WVCALDATA, WVFORMAT or WVDATA) onto the main window. All
  550.     three files must be in the same directory and will not be altered by
  551.     the conversion process.
  552.  
  553.  
  554.  
  555.  
  556.                                     Page 7
  557.  
  558.  
  559.  
  560.     
  561.  
  562.  
  563.  
  564.     VideoBase 2
  565.     ________________________________________________________________________
  566.  
  567.  
  568.  
  569.     As the conversion can take some time the first record on each converted
  570.     tape will be displayed in the main window to reassure you that the
  571.     application really is converting your file.
  572.  
  573.     Once the file has been converted the entire contents of the lowest
  574.     numbered tape id will be displayed and the file can be saved again as a
  575.     single version 2 file.
  576.  
  577.     16. Acknowledgements
  578.     ————————————————————
  579.     It might seem strange to acknowledge myself at this point, but here
  580.     goes.
  581.  
  582.     This program has been written using the routines supplied with the
  583.     EvntShell library which is copyright Paul Hobbs. More details about
  584.     EvntShell are available from the author, or from the EvntShell web site
  585.     at http://www.angel.co.uk/phobbs.
  586.  
  587.     EvntShell is a starting point for developing your own applications that
  588.     run under the RISC-OS wimp system. The EvntShell library contains code
  589.     to handle most of the 'Events' (i.e. opening a menu, closing a window
  590.     etc) that can occur, and all your application has to do is inform the
  591.     library what it should do when certain events occur. For example a menu
  592.     can be attached to a window or to an icon - the library will open the
  593.     menu for you (in the correct position!) when the <MENU> button on the
  594.     mouse is used.
  595.  
  596.     The memory management routines used by the EvntShell library are
  597.     copyright Risc User and are used with permission. Thanks to Guttorm Vik
  598.     for StrongEd and StrongHlp, Dick Alstein for TemplEd and BLink and
  599.     David Holden of APDL whose campaign against inadequate manuals supplied
  600.     with ShareWare/PD software has resulted in this effort. It may not be
  601.     perfect, but it's better than you would have got without David pricking
  602.     my conscience...
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.                                     Page 8
  626.