@DATABASE DiskOrg.guide
@AUTHOR "Simone Tellini"
@(C) "Simone Tellini Software"
@$VER: DiskOrg.guide 1.3 (25.8.96)


@NODE main "DiskOrg User Manual - ©1995-1996 by Simone Tellini"

                     Welcome to THE disk cataloguer!

    @{" Disclaimer        " link disclaimer}  Standard disclaimer
    @{" Copyright         " link copyright}  Legal notes... read this before going to bed.

    @{B}@{" How to register   " link register}  Please read this.@{UB}

    @{" Introduction      " link intro}  What's DiskOrg?

    @{" The Main Window   " link mainw}  The first thing you'll see...
    @{" Args & ToolTypes  " link args}  Easy database loading
    @{" Program's menus   " link menus}  ...yes, you guessed it! ;-)

    @{" History           " link history}  Some boring notes...
@ENDNODE


@NODE disclaimer "Standard International Disclaimer"

THERE  IS  NO  WARRANTY  FOR  THE  SOFTWARE  TO  THE  EXTENT  PERMITTED BY
APPLICABLE  LAW.   EXCEPT  WHERE OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY
OF  ANY  KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE  IMPLIED  WARRANTIES  OF  MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.   THE  ENTIRE  RISK  AS  TO  THE  QUALITY  AND PERFORMANCE OF THE
SOFTWARE IS WITH YOU.  SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE
COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE SOFTWARE
AS  PERMITTED  BELOW, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
SPECIAL,  INCIDENTAL  OR  CONSEQUENTIAL  DAMAGES ARISING OUT OF THE USE OR
INABILITY  TO  USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA
OR  DATA  BEING  RENDERED  INACCURATE  OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES  OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN  IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
@ENDNODE



@NODE "copyright" "Copyright and Distribution"

                                 DiskOrg

               © Copyright 1995-96 Simone Tellini Software

                      Written using PhxAss v4.22 by
                             Simone  Tellini
                           Piazza Resistenza  2
                           42016  Guastalla  RE
                                  Italia

                    Fido:  2:332/502 (Simone Tellini)
                      EMail:  03804aaa@mbox.it.net

                               User Manual
              © Copyright 1995-1996 Simone Tellini Software

          reqtools.library is ©1992-1994 Copyright Nico François
                              ©1995 Copyright Magnus Holmgren


DiskOrg  is (C) 1995-96 by  Simone  Tellini  Software.   This  program  is
SHAREWARE:   if  you  use it, you should @{"send me" link author} your registration fee; in
that  way you will become a registered user of DiskOrg, you'll receive the
registered  version  (without  that  annoying  requester  and the one that
doesn't remember you to register when you export the files list ;).

This  program  may  be  freely  distributed  provided  that  all files are
included  in  the  distribution  without any modifications.  You may @{B}*NOT*@{UB}
charge more than Fred Fish does for a single library disk.

This  program  may @{B}*not*@{UB} be uploaded on BBS's that claim copyrights on the
uploaded material.

I'll  be  glad  to  give  the  permission  to  insert this program on disk
magazines or cover disks if I receive a copy of it.  @{"Write me" link author} for details.
@ENDNODE



@NODE register "How to register"

I know it! Some of you won't ever read this chapter...  :-|

But  I  will  always  trust  in  the honest Amiga users!  I know that they
exist, I'd just like to know where they hide...  ;)

I  know  that  this program isn't the biggest (or the best) project you've
seen,  but if you think that it's useful, you should consider registering:
I don't ask you a lot, just a sign of your existence!  :)

Even  if  you can't afford to pay the fee (which doesn't seem very high to
me, anyway), I will appreciate very much to receive at least a postcard, a
letter, an e-mail from you...

Registering  to  DiskOrg is very simple:  all you have to do is sending me
your fee!  ;-D


Method A  -  By SnailMail
-------------------------

        Simone Tellini
        Piazza Resistenza 2
        42016  Guastalla  RE
        ITALY

Don't  forget  to specify clearly your name and address, otherwise I might
forget to send you your registered copy...  ;)

The  registration fee is US $10 (if you like to send me more, don't worry,
do it!  $-).

If you decide to send cash, wrap up the money with some sheets:  you know,
it's always a risk to send money via snail mail!


Method B  -  By Credit Card
---------------------------

Point your favourite WWW browser to http://www.alberts.com, log in, search
for  DiskOrg:  you'll  be  able  to  pay  it  by  Credit Card and download
immediately the registered version of DiskOrg. Easier than that! ;-)
@ENDNODE


@NODE author "Who is the author of DiskOrg ???"

This is my address:

      Simone Tellini
      Piazza Resistenza 2
      42016  Guastalla  RE
      ITALY

Send   here  your  registration  fees,  your  letters,  postcards,  gifts,
sisters... ;-)

I can be reached also via elettronic mail:

 - from FidoNet:       2:332/502  (Simone Tellini)

 - from InterNet:      03804aaa@mbox.it.net    (preferred)
                       simonet@freenet.hut.fi  (don't know how long I'll
                                                keep this box)
@ENDNODE



@NODE intro "Introduction"

One  day  I  was  searching for a file I knew to own, but I wasn't able to
find it anywhere...

I thought I had to write a disk cataloguer... so DiskOrg was born.

I've  tried  to include in DiskOrg the most useful function one could want
in a program like this.  I hope you'll like the result of my efforts.

DiskOrg   lets   you   organize   your   files  in  how  many  categories,
sub-categories, sub-sub-categories, sub...  etc...  you want ;).

You  can sort files by name, disk name, date or size.  You can search them
by  name,  comment or disk.  You can have a look on them just with a mouse
click...

Moreover,  DiskOrg  is  a  little  program (just about 30k) and it's quite
fast.

So try it and you'll like it! :-)

Well,  wait  a  minute...   before  trying it, read the manual:  you can't
imagine how I *HATE* writing docs! So don't make my effort vain...  ;))
@ENDNODE


@NODE mainw "DiskOrg's Main Window"

Once DiskOrg is loaded, you'll see this window.


In  upper part of this window you'll se a row of buttons, here it is their
function:

   @{"Load" link load} a database
   @{"Export" link export} the selected fields

   @{"View" link view} the selected files

   @{"Search" link find} for file(s)
   @{"Sort criteria" link sorttype}
   @{"Move" link move} files between categories

   Parent (/)   -  Return to the parent category
   Root   (:)   -  Return to the root category


In  the  center of the window there's a big listview:  it's the file list.
The file listed will appear in this form:



Fields    Sel | File Name    | Disk        | Comment
          ---------------------------------------------------------------
Examples    DskOrg11.lha       PD1           Very good disk organiser
          × File.test          PD2           Test file.



As you can see, the selected files will have a × before their name.

If you double-clicked on a file name, a window will appear:  there you can
see the files data and change its comment.

Moreover you'll see some lines like this:

»»»  Uncataloged

Well,  this  is a category:  double-clicking on it, you'll enter that sub.
To  return  in  the parent category, use the gadget "/".  You can also use
the gadget ":" to move directly to the root category.

NOTE:   The  "Uncataloged" category is a bit special:  it can't be @{"renamed" link rencat}
        or  @{"removed" link remcat} since when DiskOrg scans a disk, the new files will be
        put here.
@ENDNODE




@NODE view "Viewing a file"

Clicking over this gadget you'll see the selected files with the utilities
you've specified in the @{"Viewers" link viewers} requester.

If the disk where the files are is not present, DiskOrg will request it.

This function is mostly useful when dealing with archives.
@ENDNODE


@NODE sorttype "Sort criteria"

With this gadget you can cycle through the four types of sorting supported
by DiskOrg, that's to say by Name, by Disk, by Date and by Size.
@ENDNODE




@NODE args "CLI and WB args & ToolTypes..."

DiskOrg  can accept both CLI and Workbench argument:  from CLI this is
the template:

FILE,PUBSCREEN/K

FILE is the name of a database after the command DiskOrg  to  load  it  on
startup.

Ex.  DiskOrg MyFiles.do

PUBSCREEN is the name of a public screen on which to open the GUI.

Ex. DiskOrg PUBSCREEN GOLDED.1


From  WB, click 1 time on DiskOrg's icon and then double-click on the icon
of the database you want to load.


If  none of this arguments is given, DiskOrg will try to read the FILENAME
ToolType from its icon (if DO was launched from WB, of course).

Another ToolType accepted by DiskOrg is PUBSCREEN.
@ENDNODE




@NODE menus "DiskOrg's Menus"

  Project
     @{" About...          " link about}
     @{" New               " link new}
     @{" Open...           " link load}
     @{" Save              " link save}
     @{" Save As...        " link saveas}
     @{" Export            " link export}
     @{" Quit              " link quit}


  Files
     @{" Auto Scan         " link autoscan}
     @{" Do recursion      " link recursion}
     @{" Scan disk...      " link scandisk}
     @{" Drive             " link drive}


  Database
     @{" Pattern select... " link patsel}
     @{" Edit item...      " link edit}
     @{" Remove selected   " link remove}
     @{" Move...           " link move}

     @{" Find...           " link find}
     @{" Find doubles      " link finddoubles}
     @{" View last search  " link lastsearch}

     @{" Add category...   " link addcat}
     @{" Remove category   " link remcat}
     @{" Rename category   " link rencat}
     @{" Sort by           " link sortby}


  Settings
     @{" Devices...        " link devices}
     @{" Filters...        " link filters}
     @{" Viewers...        " link viewers}
     @{" Export fields...  " link exfields}
     @{" Save settings     " link saveset}
@ENDNODE



@NODE about "Project/About..."

It will open a requester with some infos about the @{"author" link author} of DiskOrg.
@ENDNODE


@NODE new "Project/New"

This will removed all files and categories.
@ENDNODE



@NODE load "Project/Open..."

This  will open an ASL File Requester with which you can select a database
to load.
@ENDNODE


@NODE save "Project/Save"

This will save the current database.
@ENDNODE


@NODE saveas "Project/Save As..."

This  will  open  a File Requester allowing you to select the file to save
the database.
@ENDNODE


@NODE export "Project/Export/"

This  will save the file list in a plain ASCII file.  You can choose which
fields must be exported with the @{"Export fields" link exfields} requester.

As you can imagine, "Export/Whole archive..." will export all the files of
the database, while "Export/Selected fields..." only the ones selected. ;)
@ENDNODE


@NODE quit "Project/Quit"

I know you know what this do! :-)
@ENDNODE



@NODE autoscan "Files/Autoscan"

When this is enabled, every time a disk is inserted in the @{"drive" link drive} selected,
DiskOrg will scan it.

Note that DiskOrg execute a quite intelligent scan:  if a disk has already
been  scanned,  only the new files (if any) will be added to the database.
Moreover,  if  a  file has a filenote attached to it, DiskOrg will read it
and put in its Comment field.
@ENDNODE


@NODE recursion "Files/Do recursion"

If  enabled,  DiskOrg  will  scan the disks recursively, otherwise it will
scan only the root directory.
@ENDNODE


@NODE scandisk "Files/Scan disk..."

This  will  open  an ASL requester:  you'll have just to select the @{B}VOLUME@{UB}
you  want  to  scan.  ;) If you select a directory on that volume, DiskOrg
will scan that directory, of course. :^)
@ENDNODE


@NODE drive "Files/Drive/"

This  sub-menu  lets you select in which drive DiskOrg must look for disks
to scan.
@ENDNODE


@NODE patsel "Database/Pattern select..."

This  will  open  a  string  requester  in which you can insert a standard
AmigaDOS  pattern.   Then  DiskOrg  will  select  the files in the current
category that match that pattern.
@ENDNODE


@NODE edit "Database/Edit item..."

This  will  open  a  little requester which shows the infos about the file
selected and which lets you enter a comment for the file.
@ENDNODE


@NODE remove "Database/Remove selected"

This will remove all selected files from the database. @{B}Be careful!@{UB}
@ENDNODE



@NODE move "Database/Move..."

Selecting this, the Move Files requester will pop up.

It consists of two listviews and some buttons... ;)

You  can  move  files from one list to the other using the gadgets ">" and
"»".  The first moves only the selected files, the latter all the files.
@ENDNODE



@NODE find "Database/Find..."

This will open a requester in which you can insert the string to look for.
You can insert also wildcards.

You  can  also  decide  if  the search must be limited to file names or if
DiskOrg should consider the disk names and the comments too.

NOTE: if you insert "xy", DiskOrg will search for "#?xy#?"


If DO finds some files, it will open the Search results window; here you
can see a list of the files found and four buttons:

  @{"Export" link export} the search result
  @{"Move  " link move} files away from this list
  @{"View  " link view} the selected files
  @{"Delete" link remove} the selected files
@ENDNODE


@NODE finddoubles "Database/Find doubles"

This  a  special  function  of DiskOrg:  selecting this DO will search for
files present in more than 1 disk.
@ENDNODE


@NODE lastsearch "Database/View Last Search..."

This will show you the result of the last search you've done.
@ENDNODE


@NODE addcat "Database/Add category..."

This will add a brand new sub-category in the current one.
@ENDNODE

@NODE rencat "Database/Rename category..."

If  there's  a  selected category in the listview, a string requester will
appear letting you to change its name.

You won't be able to change the name of the "Uncataloged" category.
@ENDNODE


@NODE remcat "Database/Remove Category"

This  will  delete the selected category from the database and the file it
contains as well.
@ENDNODE


@NODE sortby "Database/Sort by/"

This  sub menu lets you choose how to sort the files in the database.  You
can choose among Name, Disk, Date and Size.
@ENDNODE



@NODE devices "Settings/Devices..."

This will open the Device requester.  Here you can see four string gadget:
you  can  enter  a  different  device for every drive, so you can use DF0:
with drive 0, DS0:  with drive 1...
@ENDNODE


@NODE filters "Settings/Filters..."

This  feature of DiskOrg can be used to easily exclude some files from the
scan  process:   in  fact,  when  DO  scans a disk, it check the file name
against all the filters and if it doesn't match them it isn't accepted.

You can insert all the standard AmigaDOS patterns in the filter.

For  example, if you enter the filter " ~(#?.info) ", DiskOrg won't insert
in the database the icon files.

Setting this two filters...

~(#?.info)
a#?

...DiskOrg  will  insert  in  the database only the file whose name starts
with 'a' and doesn't end with '.info'.
@ENDNODE



@NODE viewers "Settings/Viewers..."

A  'viewer'  is  a  program used by DiskOrg to show you the files when you
click on the 'Show' button.

When  you  select  this menu item, a small requester will appear; here you
can see a listview and two string gadget.

In  the  listview  there  are the current viewers:  you can modify them by
doubleclicking  over them.  When you click on the 'Add' button you will be
asked  to enter the File Extension (that'll be showed in the listview) and
the  Viewer.  The File Extension is used by DiskOrg to decide which Viewer
must be used.  The Viewer is the command line that will be used to see the
file.

E.g.  if you want to set up a viewer for .lha archives, enter 'lha' in the
File Extension gadget and 'C:LHA l' in the Viewer gadget.


If  the  extension  of the file you want to see doesn't match to anyone in
the  list,  the  "Others"  viewer  will  be  used.  By default it's set to
MultiView.

Last  but  not  least, the output of the viewers will be redirected to the
file or console specified in the 'Output' gadget.
@ENDNODE



@NODE exfields "Settings/Export fields..."

This lets you select which fields must be included in the export report.
@ENDNODE



@NODE saveset "Settings/Save settings"

This will save the settings to S:DiskOrg.prefs
@ENDNODE



@NODE history "The History of DiskOrg"

  1.4  19/09/96   Fixed bug: DO crashed when clicking on the "Change
                  sort criteria" gadget.
                  Fixed bug: DO crashed when cancelling the requester
                  "Add Category"
                  New argument & ToolType: PUBSCREEN.
                  After a resize, the listview content is not reset
                  to the top of the list.

  1.3  25/08/96   The main window is resizable.
                  Fixed bug: DO now frees the memory allocated for
                  filters & viewers when exiting.
                  Fixed bug: DO now lets you add a category if the
                  "Auto scan" menu is not ticked.
                  Fixed bug: when adding a category, it's now possible
                  to abort the operation via the "Cancel" gadget of
                  the string requester.

  1.2  13/07/96   "Scan Disk" now can scan a single directory.
                  DO uses "GTLV_Labels, -1" instead of "GTLV_Labels, 0"
                  when it needs to update its listviews.

  1.1  26/09/95   Removed a few bugs.
                  Added the ToolTypes, CLI & WB args support.

  1.0  15/09/95   First version.
@ENDNODE
