README.txt

last modified: 4/16/2004 by clbecker
verbalgorithm3.0

Notes:

Maintain the following relative file/directory structure:

	\rels
	\paths
	\yourdemo.demo
	\verbalgorithm3.0\ConstructFindLists.cl
	\verbalgorithm3.0\ConstructFoundLists.cl 
	\verbalgorithm3.0\Output.cl              
	\verbalgorithm3.0\Processing.cl          
	\verbalgorithm3.0\defun_verb.cl  

Run yourdemo.demo from the directory it is in.  

If you want to change this you may have to change the paths for the 
load statements in defun_verb.cl that load the other 4 .cl files.  

In the beginning of your demo, insert the line:

	^(load "verbalgorithm3.0/defun_verb.cl")

Where you want to define the verb, add the line:

	^(defineVerb 'verb)

And replace "verb" with your word.  Leave the quote (').  


* * *
NOTES FOR THOSE WORKING ON THE VERB ALGORITHM:

	IMPORTANT:

	Anytime you make a change to any of the files, be sure
	to make a note of it in the section of the modified file labeled 
	"Modification History" located at the top of each file.  
	
	In the past modifications have been made to the various algorithms
	and no future student was able to figure out what was changed.  
	This is meant to avoid situations like that.  



	Inserting new case frames/paths:

	If you want to insert a new path or case frame, 
	you need to modify either *ArgsToFind*, *ArgRelsToFind*
	or *MiscItemsToFind* located in ConstructFindLists.cl.
	The results will automatically be printed.  

	If you want the algorithm to collect data for a particular
	processing function, and do not want that data to be
	printed out in a raw format, modify  *ProcessingDataToFind* 
	located in ConstructFindLists.cl.




	Adding new functions:
	
	If you want to add a new function, be sure to separate its 
	output from the processing components.  

	To have the function called, add a line to *ProcessList*
	located in the file defun_verb.cl

	Add your processing function to the file Processing.cl

	Add your output function to the file Output.cl

	Do not use global variables with the exception of those that were
	created in ConstructFindLists.cl or ConstructFoundLists.cl

	If you must set up a new global variable, be sure to describe it
	in the notes at the top of the file.  



* * *

FUTURE WORK FOR THE VERB ALGORITHM


Set up tracing

The function defineVerb is already defined to take an optional
second argument which, like in the previous version of the verb
algorithm, can be a 0 or 1, which is used to set or unset tracing.  

Additional functions to write:

	Reflexive-test:
		test whether the verb is used reflexively

	Categorize-verb:
		use information to place the verb into a category.
		Categories may be based on conceptual dependency,
		or whatever supercedes it in future CVA work.  

		
	*remember that for each of these functions, a separate output
	function should be written so as best to modularize the whole system.