KWIC-OOH User's Manual

Running KWIC
    To run KWIC, type KWIC-OOH.exe at the command prompt.

Command Line Options
    Two sorts of arguments on the command line can be interpreted by the KWIC program:  filenames and directory paths.  The program itself determines whether the argument is a filename or a directory.  No special syntax is required.  Files which are not plaintext are not processed.  We didn't think you really want to see concordances of long binary numbers.

Output
     The output of the KWIC program consists of the specific keyword along with its context and location in the file.   The output can he affected by several options which are set in the kwic.properties file.   Possible output formats are standard console output, writing to a text file, and outputting an HTML page.  Please see the "options" section for further information in configuring these settings.

Error Handling
    Improper settings in the properties file will not be read in.   The program can perform concordance searching on numeric data.  Invalid file input will be ignored.  You can do anything to it, and it will still work.*

Using the kwic.properties File
    Properties should be in the form of:  property=setting where 'property' is the name of the desired property and 'setting' is what you want the property to be.
    before -- controls the number of words before the keyword in the concordance     example: before=3
    after -- controls the number of words after the keyword in the concordance           example: after=3
    order -- controls the sorting method of the KWICs.  Sorts can be chained            example: order=word length
           accepted order inputs:
          word  -- alphabetical sort
          reverseword -- reverse alphabetical sort
          length -- sort by word length (shortest to longest)
          reverselength -- sort by word length (longest to shortest)
          number -- sorts by number of occurrences (most to least)
           reversenumber -- sorts by number of occurrences (least to most)
    offset -- puts the offset string before and after the keyword                                     example: offset=Aaron_rules
    color -- affects the color of HTML output                                                              example: color=FF0000
    aligned -- boolean (1 or 0).  When 1, will line the keywords up                               example: aligned=1
    min -- minimum number of letters required for a keyword                                       example: min=2
    exclude - words listed after exclude will not show up as keywords                          example: exclude=and or but
    max -- maximum number of times to show a given keyword (the first n in                example:  max=7
                sorted order will be displayed)
    output -- type of output                                                                                          example: output=HTML
       accepted output types:
          HTML -- creates an HTML document              
          text -- displays to console
          file -- creates a textfile




* Not liable in tort.