INSTRUCTIONS FOR INSTALLING AND USING KPML WITH LISPWORKS
PERSONAL EDITION.

January 2016-2020
John Bateman, Bremen University

---------------------------------------------------
Parts I--II need to be done only once. Subsequently,
starting up the system begins at Part III.
---------------------------------------------------

Part I: compiling and installing Loom
        This only needs to be done once when first 
	installing KPML.

  1) edit the path given in the file: 
     " ...\KPML-LW-PE\loom4.0\0-loom-where-am-I.lisp"
     to identify where Loom is to be found ...

  2) startup up Lispworks Personal Edition
  3) from the folder: "...\KPML-LW-PE\loom4.0\"
     load (menu: File>Load)... 

	If you get given warnings
	about defining macros or some such: these can be 
     	ignored, just continue.

     (i)   version-utilities.lisp
     (ii)  defsystem.lisp
     (iii) compile-loom.lisp

  This should run through to completion. 

Part II: compiling KPML
     	 This also only needs to be done once.

   from the folder: "...\KPML-LW-PE\KPML4\"
     load (menu: File>Load): KPML-INSTALLATION.lisp

   you will be asked several configuration questions:
   answer these as follows:

   	  Compile KPML system?					yes

	  Compile window interface?				no
	  Are linguistic resources in XML to be used?		no
	  Include the specified KR system?   			yes
	  Compile everything from scratch?			yes

   This will run through to completion and then ask you if
   you wish to load the KPML system: this is Part III of
   the installation. Now that the system has been installed,
   restarting the system can always be done beginning with
   Part III. The previous steps in Parts I and II do *not*
   need to be repeated. Loading KPML-INSTALLATION.lisp
   directly into Lispworks personal edition will be enough.

Part III: loading KPML ready for use

   you will be asked several configuration questions:
   answer these as follows:

   	  Compile KPML system?					no
	  Load KPML system?					yes

	  Compile window interface?				no
	  Are linguistic resources in XML to be used?		no
	  Include the specified KR system?   			yes
	  Load linguistic resources?				no
	  Load general upper model?				yes
	  Load general inquiry implementations?			no

Part IV: the system is now ready to be used. The following
         instructions are all to be typed into the Lisp Listener...

     1) it is generally useful to move to the KPML package
     	to save typing later:

	(in-package KPML)

     2)	load a grammar for a language, e.g.:

     	(load-linguistic-resources :english)

	Any language that has been stored into the RESOURCES folder/directory 
	can be used.

     3) sentences can be generated from semantic specifications (SPLs,
        see documentation), using the Lisp function 'say'. The first time the 
	function is called, the syystem may output some diagnostics concerning 
	state of the grammar. These can be ignored.

	To generate:

	(say '(s / sail :actor (p / ship :lex ship)))

	This should produce: "A ship sails.". If it does not, then the grammar
	has not been installed properly.

	To see the structure that was generated, issue:

	(say '(s / sail :actor (p / ship :lex ship)) :details T)

	This should produce:

	1: Function structure:
	 [SENTENCE]	    
	     [TOPICAL\#1/MEDIUM\#1/SUBJECT\#1]
	             [DEICTIC\#2]                     = "A "
		     [THING\#2]                       = "ship "
	     [VOICE\#1/TEMPO0\#1/FINITE\#1/LEXVERB\#1/PROCESS\#1] = "sails ."
	"A  ship  sails ."

	You are now ready to generate.







     

     
     



