home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 1 / AU_CD1.iso / clipart / _portfolio / _help < prev    next >
Text File  |  1993-10-02  |  12KB  |  271 lines
  1.  
  2.  
  3.                               Portfolio v1.00
  4.                               ===============
  5.  
  6.                     A utility for viewing Clip-Art files
  7.                     ====================================
  8.  
  9.  
  10. Introduction
  11. ~~~~~~~~~~~~
  12.  
  13.  Portfolio is a utility which can be used to view small versions of clip-art
  14. files, called 'thumbnails'.  The advantage of viewing these rather than the
  15. actual clip-art files is that they are usually much smaller, and hence
  16. quicker to load, especially from slow systems such as CD-ROM or networks.
  17.  
  18.  Portfolio allows you to flick through a collection of thumbnails, and search
  19. for particular images on a keyword basis.  Once you have found the file you
  20. are interested in, you can drag a file icon from Portfolio's window to
  21. another application such as ArtWorks or Impression.
  22.  
  23. Important note for RISC OS 2 users:
  24. This application will work under RISC OS 2, but you must be in a 256 colour
  25. mode (e.g. mode 15 or 21), or the thumbnails will not be displayed.
  26.  
  27. Clip Art directories
  28. ~~~~~~~~~~~~~~~~~~~~
  29.  
  30. Portfolio expects clip-art to be stored in a certain way.  It expects a
  31. clip-art directory to have any of the 3 directories 'ArtWorks', 'TIFF' or
  32. 'Sprites'.  If you have a clip-art directory such as this, you may drag it to
  33. Portfolio's icon, or its main window, and it will attempt to scan it. 
  34. Portfolio is intelligent, in that you can drag either the 'ArtWorks', 'TIFF'
  35. or 'Sprites' directory, or the directory that contains them - it will sort
  36. out what you want.
  37.  
  38. The ArtWorks Clip Art CD, of course, contains directories that are already
  39. correctly structured, and Portfolio will read these directly with no
  40. problems.
  41.  
  42.  
  43. Use
  44. ~~~
  45.  
  46.  To load Portfolio, double click on it, and after a short pause its icon will
  47. appear on the icon bar.  Clicking on the icon will open the main Portfolio
  48. window.  If you are running the application from the ArtWorks Clip-Art CD,
  49. then it will attempt to scan the ArtWorks Clip-Art directory when the window
  50. opens.  When the scan is complete, the first thumbnail should be displayed,
  51. along with various information about it.  (If for some reason, Portfolio does
  52. not scan a directory when you open the main window, then drag the directory
  53. "ArtWorks" from the CD onto the Portfolio icon, or onto its main window).
  54.  
  55.  
  56.  Navigation 
  57.   
  58.  The six buttons at the top of the window are used to flick through the
  59. thumbnails (which are sorted alphabetically).  The buttons have the following
  60. functions, proceeding from left to right:
  61.  
  62.   Move to the first thumbnail in this set.
  63.   Move back 10 thumbnails.
  64.   Move to the previous thumbnail.
  65.   Nove to the next thumbnail.
  66.   Move forward 10 thumbnails.
  67.   Move to the last thumbnail in this set.
  68.   
  69.   
  70.  Status field
  71.  
  72.  Underneath these buttons is the status field - this indicates when Portfolio
  73. is scanning, or how many files it has found.  Usually it will say something
  74. like "File 1 of 704" which means there are 704 files, and you are looking at
  75. the first one.
  76.  
  77.  
  78.  File information
  79.     
  80.  The field beneath the thumbnail itself is the name of the file, and below
  81. that is displayed the type of the file, and its size.  If the clip-art file
  82. is not found, or it is of an unknown type, this is reported in this field.
  83.  
  84.  
  85.  Directory information 
  86.  
  87.  The field at the very bottom of the window tells you the name of the
  88. clip-art directory you are looking at.  This directory will usually contain
  89. the 'ArtWorks', 'TIFF' and 'Sprites' subdirectories.  You can only view one
  90. type of file at a time - that is, you cannot, for instance, look at both
  91. TIFF and ArtWorks files at the same time.  The field above the directory name
  92. on the right tells you which subdirectory you are looking at - by default it
  93. will choose ArtWorks (if there is an ArtWorks directory).  To the right of
  94. this field is a small button.  Clicking on this will bring up a menu of the
  95. subdirectories that Portfolio has found that it thinks contain clip-art. 
  96. Choosing a directory from this menu will cause Portfolio to scan this
  97. directory for clip-art.  If no clip-art is found, then Portfolio reports an
  98. error, and you will have to select another directory to view via the menu (or
  99. you can drag a directory onto Portfolio, as described above).
  100.  
  101.  
  102.  The File icon
  103.  
  104.  In the lower right of the main window is a file icon - it represents what
  105. type of file you are looking at.  This icon behaves like an icon in a RISC OS
  106. Filer window.  This means you can drag it to an application you want to load
  107. it (for example, !AWViewer), or double click on it to force an application to
  108. start up and load it if one is not already running.  If you double click with
  109. adjust, then the file will be loaded, and the Portfolio window will close,
  110. just like the Filer.
  111.  
  112.  
  113.  Goto Dialog
  114.  
  115.  Clicking on the button labelled 'Goto...' will bring up a dialog box under
  116. the mouse pointer.  This will contain a list of all the clip-art files in the
  117. current directory.  When you click on a filename, the dialog will disappear,
  118. and the main window will update to show the file you have chosen.  This
  119. enables you to move around the files quickly, or perhaps just browse through
  120. the filenames (as this is quicker than flicking through all the thumbnails).
  121.  
  122.  
  123.  Searching
  124.  
  125.  Clicking on the 'Search...' button will bring up the search dialog box.  You
  126. can type a keyword into this dialog which you would like to search for.  The
  127. files on the Clip-Art CD have a simple keyword database associated with them,
  128. and searching for 'car' for example, will find all pictures related to cars. 
  129. When you have typed in your keyword, press Return or click on OK, and
  130. Portfolio will search for your keyword in the current list of clip-art files. 
  131.  When the search has completed, the main window will show the results of the
  132. search - the status field will change to show a message such as:
  133.  "File 1 of 22 (selection)"
  134.  
  135.  The 'selection' means that you are not looking at all the files in the
  136. directory, but at a selection.  To return to looking at all files, choose the
  137. 'View All' button.  This button is only available when you have a selection
  138. of files - at other times it serves a different purpose, and is labelled
  139. 'Make Index' (see technical section for details).  So, when you click on View
  140. All, the selection is cleared, and the viewer shows the first file in the
  141. list, and the button changes to read 'Make Index'.  In normal use, you will
  142. probably not need to press 'Make Index', but it is useful if you make your
  143. own clip-art directories.
  144.  
  145.  If you have performed a search which has resulted in a lot of matches, and
  146. you would like to refine it, click on the 'Refine search' icon in the search
  147. dialog box.  This will restrict the search to only those files found as a
  148. result of the previous search.  So, for example, if you searched for
  149. 'animals' and found the number of matches too great, you could then refine
  150. the search for a particular animal.
  151.  
  152.  If you want to perform a partial search, you can put the '*' character at
  153. the end of the search. For example, 'car*' will match 'car', 'card', and
  154. 'cartoon', amongst others.
  155.  
  156.  The search system remembers the last 10 keywords you entered - they are
  157. available on the pop-up menu button to the right of the keyword entry field
  158. in the search dialog.
  159.  
  160.  Here are some examples of keywords used in the ClipArt CD database:
  161.  
  162.      object - material 'things' (this is a large group)
  163.      design - posters, pages, complicated drawings of things that are 
  164.               not objects
  165.     cartoon - cartoon-style drawings
  166.        clip - borders and similar useful things that are not objects; 
  167.               arrows etc
  168.      border - subset of the clip group
  169.       sport - sport related pictures
  170.   transport - cars, planes, etc.
  171.        text - pictures containing special or unusual text effects
  172.   landscape - landscape views, sunsets etc.
  173.       plant - plants (trees, flowers, etc)
  174.      flower - flowers
  175.   
  176.   and also: animal, people, food, computer, music, cat, building...
  177.  
  178.  The groups described above are not strict and many have very fuzzy
  179. boundaries, so experiment to find the best groups for your work.
  180.  
  181.  
  182. Technical
  183. ~~~~~~~~~
  184.  
  185.  This section is not required reading if you just want to use the Clip Art on
  186. the CD-ROM.  It explains how clip-art directories are structured, and how you
  187. might create your own.  Please note that Portfolio is NOT public domain, and
  188. is Copyright (C) Computer Concepts Ltd., and should not be redistributed in
  189. any form.
  190.  
  191.  
  192.  When scanning clip-art directories from a slow medium such as CD-ROM or a
  193. network, Portfolio can take a long time if there are many pictures.  To speed
  194. up this process, Portfolio can generate an index file for the directory, and
  195. it will then scan that instead of the file system - this is much faster. 
  196. Each clip-art directory on the ClipArt CD has a precompiled index already, so
  197. you will not need to generate them (in fact, attempting to do so will result
  198. in an error, because, obviously, CD-ROM is a read only system).
  199.  
  200.  If you wish to create your own clip-art directories for use with Portfolio,
  201. this is the structure Portfolio expects:
  202.  
  203.  
  204.                                 ClipArt
  205.                                    |
  206.                 +------------------+---------------+
  207.                 |                  |               |
  208.              ArtWorks            TIFF           Sprites
  209.                                    |
  210.                 +----------+-------+------+------+------+
  211.                 |          |       |      |      |      |
  212.             !CCStore       A       B      C1     C2    ...
  213.                 |
  214.    +-------+----+--+-----+----+-----+------+
  215.    |       |       |     |    |     |      |
  216.   CSV    Index     A     B    C1    C2    ...          
  217.  
  218.  
  219.  The 'ClipArt' directory can be called anything - this is just used to hold
  220. the ArtWorks, TIFF and Sprites directories.
  221.  
  222.  For simplicity, only the TIFF structure is shown in full in this diagram;
  223. the ArtWorks and Sprites directories will have similar structures in them. 
  224. In the following explanation, you can substitute ArtWorks or Sprites for
  225. 'TIFF'.
  226.  
  227.  The TIFF files themselves are held in the A, B, C... directories.  All files
  228. beginning with A go in the A directory, and so on.  If there are too many
  229. files to fit in the directory, you may use names such as C1, C2, ... as shown
  230. above.
  231.  
  232.  The !CCStore directory contains the resources used by Portfolio for these
  233. TIFF files:
  234.  
  235.  The A, B, C... directories contain the thumbnail sprites which correspond to
  236. the TIFF files.  These should have the same name as the TIFF file, e.g.
  237. ClipArt.TIFF.!CCStore.C1.Car is the thumbnail file for ClipArt.TIFF.C1.Car.
  238.  
  239.  How you create these thumbnails is left to you.  The snapshot facility of
  240. Paint is a good way of capturing them once you have the image displayed on
  241. screen.  Programs such as !ChangeFSI (which comes with RISC OS 3.10), or the
  242. !AWViewer application can be used to display the files at the correct size
  243. for a thumbnail, and then you can grab this with Paint. For best results, the
  244. images should not be more than 150x150 pixels in size (but can rectangular)
  245. in square pixel modes.  Larger images will display (up to a limit of 30k on
  246. the thumbnail file size) but redraw problems will occur in the Portfolio
  247. window.  The thumbnail sprite file should contain only one image (it doesn't
  248. matter what the sprite is called within the file).
  249.  
  250.  The 'CSV' file is a 'comma separated value' file, which is a list of
  251. filenames and their associated keywords.  Examine the CSV files on the CD-ROM
  252. to determine the format of this file - it's very simple.  Note that, as with
  253. all CSV files, the first line just contains the names of the fields, and is
  254. ignored by Portfolio.
  255.  
  256.  The 'Index' file is optional, and only exists if you have clicked 'Make
  257. Index' while your directory is loaded into Portfolio.  This Index file is not
  258. necessary - it merely speeds up scanning of clip-art directories.
  259.  
  260. NB. If you make an index, and then add clip-art files, then Portfolio will
  261. not find the extra files as they are not in the index.  To get around this,
  262. delete the Index file and force Portfolio to re-scan the directory (e.g. by
  263. dragging the directory to its window).  You should then see all the files
  264. correctly, and you can regenerate the index again if you like.  For this
  265. reason, it is usually best to leave Index generation until the contents of
  266. the clip-art directory become reasonably stable.
  267.  
  268.  
  269. 1st October, 1993
  270.  
  271.