Debian Codegraph @

README

raw
1 WordNet::QueryData perl module
2 ------------------------------
3
4 WordNet::QueryData provides a direct interface to the WordNet database
5 files. It requires the WordNet package
6 (http://wordnet.princeton.edu/). It allows the user direct access to
7 the full WordNet semantic lexicon. All parts of speech are supported
8 and access is generally very efficient because the index and morphical
9 exclusion tables are loaded at initialization. This initialization
10 step is slow (appx. 10-15 seconds), but queries are very fast
11 thereafter---thousands of queries can be completed every second.
12
13 PREREQUISITES
14 -------------
15
16 - Perl5
17 - WordNet Database Package version 3.0
18
19 DOCUMENTATION
20 -------------
21
22 Make sure to read the included man page ("perldoc QueryData.pm" or
23 "perldoc WordNet::QueryData" to extract).
24
25 The ChangeLog file lists a summary of changes to the code.
26
27 See http://groups.google.com/group/wn-perl for information on the mailing list.
28
29 WINDOWS INSTALLATION
30 --------------------
31
32 This assumes that perl was installed to the default location (C:\perl).
33
34 0) Make sure that you have installed WordNet to C:\Program Files\WordNet\3.0
35 1) Unpack the WordNet QueryData distribution
36 2) Create the directory C:\perl\site\lib\WordNet
37 3) Copy QueryData.pm to C:\perl\site\lib\WordNet
38 4) Run "perl test.pl" to test the installation
39
40 Alternatively, you can install NMake and use the Make installation steps.
41 See http://johnbokma.com/perl/make-for-windows.html for info on NMake.
42
43 MAKE INSTALLATION
44 -----------------
45
46 Installation uses the perl MakeMaker utility ('perldoc
47 ExtUtils::MakeMaker'). To build and test the distribution do:
48
49 perl Makefile.PL
50 make
51 make test
52
53 If "perl Makefile.PL" breaks or "make test" doesn't work at all ("not ok 1"),
54 you may not have the WNHOME or WNSEARCHDIR environment variables defined
55 correctly. Read the QueryData manual page ("perldoc QueryData.pm") to find out
56 how to tell it where your WordNet database is located (you'll need to edit
57 test.pl). Note that if you are are using Debian/Ubuntu and have the standard
58 wordnet package installed , you should set WNSEARCHDIR to /usr/share/wordnet.
59
60 If any of the tests fail, send e-mail to the wn-perl mailing list (see
61 DOCUMENTATION).
62
63 If the tests run okay, install with (this may need to be run as root):
64
65 make install
66
67 CUSTOM DIRECTORY
68 ----------------
69
70 To install WordNet::QueryData in /foo/bar/baz do:
71
72 mkdir /foo/bar/baz/WordNet
73 cp QueryData.pm /foo/bar/baz/WordNet
74
75 Make sure to add /foo/bar/baz to perl's @INC variable (e.g. -I/foo/bar/baz)
76
77 COPYRIGHT
78 ---------
79
80 Copyright (C) 1999-2006 Jason Rennie. All rights reserved.
81
82 This module is free software; you can redistribute it and/or modify
83 it under the same terms as Perl itself.
84
85 CITATION
86 --------
87
88 If you use this software as a contribution to a published work, please
89 cite it like this:
90
91 @misc{Rennie00
92 ,author = "Jason Rennie"
93 ,title = "WordNet::QueryData: a {P}erl module for accessing the {W}ord{N}et
94 database"
95 ,howpublished = "http://people.csail.mit.edu/~jrennie/WordNet"
96 ,year = 2000
97 }
98
99 KNOWN BUGS
100 ----------
101
102 validForms does not implement WordNet's morphological processing
103 correctly. Only the first element of the list returned by validForms
104 is guaranteed to be valid. Later elements may not be valid.