Home

Sourcecode for Visuwords™

The sourcecode is now available for Visuwords™ under a public license agreement.

>> Download From Here <<

Also required: WordNet 3.0

The source code is well commented and should be pretty much self-explanatory. Currently there is no additional documentation, although some may appear here in the future depending on demand. Enough files are included so that you will have a working version of Visuwords™ on your own web server provided that you also download and unpack the required WordNet files to accompany the project.

Princeton University's WordNet can be obtained from the link found above. It's licensing agreement is completely separate from Visuwords™. Please ensure that any use of either or both products strictly adheres to each of these licenses as applicable.

Please note also, that it is recommended that you download "WordNet 3.0 for UNIX-like systems", even if you plan to run Visuwords™ in a Windows environment. There is a specific subset of the WordNet files that are required (as documented in the Visuwords™ readme.txt file). All development and testing was done using these WordNet v3.0 files.

Please consider making a small donation if you find this source or service useful. Any questions or comments regarding the source code or this web site can be directed to myself, Paul Dunn, at admin :at: visuwords :dot: com.

Installation Instructions

  1. Verify that PHP 4 or better is installed and running correctly on your web server.
  2. Make a folder in your web folder's document directory (usually htdocs) and name it 'visuwords' (this should be set for at least read access and all other folders likewise unless stated otherwise).
  3. Make a folder inside the 'visuwords' folder you just made and name it 'v2.0'.
  4. Unzip the contents of Visuwords20a.zip into the 'v2.0' folder you just made. The file structure should resemble this:
    • {doc_root}/v2.0/class/dictionary.php
    • {doc_root}/v2.0/class/xml.php
    • {doc_root}/v2.0/lex.php
    • {doc_root}/v2.0/license.txt
    • {doc_root}/v2.0/Manager.as
    • {doc_root}/v2.0/Node.as
    • {doc_root}/v2.0/Nodegroup.as
    • {doc_root}/v2.0/readme.txt
    • {doc_root}/v2.0/visuwords.fla
    • {doc_root}/v2.0/visuwords.swf
    • {doc_root}/v2.0/wordnet_dependencies.txt
  5. Create another folder inside 'v2.0'and name it 'dict' (this folder should be set for read/write access).
  6. Into the 'dict' folder you just made, copy the following files from the "WordNet 3.0 for UNIX-like systems" package. All of these files come from within the 'dict' folder from WordNet. It is important to obtain "WordNet 3.0 for UNIX-like systems", EVEN IF YOU ARE RUNNING IN A WINDOWS ENVIRONMENT! WordNet does not currently provide a Windows version of WordNet v3.0, but all we need are some of the data files from it. Please make sure that you understand and abide by the WordNet license agreement.
    • data.adj
    • data.adv
    • data.noun
    • data.verb
    • index.sense
    • lexnames
  7. Test that lex.php works correctly. Call up http://localhost/visuwords/v2.0/lex.php in your browser. You should see an XML dump similar to this. If you don't see a similar XML dump (it will be filled with data for a random word) then ensure that you have followed all of the instructions so far and that your web server is performing properly. The unmodified front-end Flash applet makes calls directly to 'http://localhost/visuwords/v2.0/lex.php' for its data feeds. If you have installed it in any other URL path then you will need to modify the Manager.as file (lines 19 and 20) and rebuild the visuwords.swf file from the included visuwords.fla file. (Adobe/Macromedia Flash v8.0 or later is required). It is strongly recommended that you at least get it working in the default path first, before trying to customize it.
  8. If lex.php works correctly, then you should be able to run the front side of the application which is a Flash applet. Make sure you have installed the latest Flash player that is compatible with your browser and call up http://localhost/visuwords/v2.0/visuwords.swf in your browser. You can confirm that you have a compatible player if the online version of Visuwords works from the website ( http://www.visuwords.com ), operates correctly.
  9. Jump for joy, you are done.

If you see a message that says "XML Load Failed!" then stop jumping. You're probably not getting an XML response from your web server. Go back to step 7.

Understanding and Using the Source

The code for Visuwords™ runs in two places; on a web server and on a web client. All of the PHP source needs to be copied to the webserver (along with the WordNet data files) where they can serve up XML synset files that contain the guts of the information presented. The Flash and actionscript files are used to construct a compiled SWF file that also must be copied to the web server.

First of all you will need to have a web server that has been configured to serve up PHP scripted documents. Visuwords has been tested in Windows/IIS, Windows/Apache, and Linux/Apache configurations. There are probably other combinations that will work also. PHP 4.3.11 as well as PHP 5.2.0 are both known to work well. Configuration of a web server and PHP are outside the realm of this website. You will need to consult other sources for information on how to do that. Alternatively you can use a third party hosting company.

Ultimately, it is the compiled SWF file called up by a user's browser that manages the flow of information from the server and renders it. The Flash and Actionscript files (.fla and .as extensions) need to be used in conjunction with the Macromedia Flash 8 editor or later.



License Terms and Conditions

-----------------------
Visuwords 2.0
Program and source code
(c) 2007 dunnbypaul.net
-----------------------
LICENSE AGREEMENT:

TERMS AND CONDITIONS:
1. The Visuwords (v2.0) package includes the following files (with their associated directories as 
  they are originally distributed.)

    ./class/xml.php
    ./class/dictionary.php
    ./lex.php
    ./Manager.as
    ./Node.as
    ./Nodegroup.as
    ./visuwords.fla
    ./visuwords.swf


2. This license applies to each part of the Visuwords (as listed above), including PHP source 
  files, actionscript source files and a Flash Document file.

3. Permission is hereby granted for the use of the Visuwords source code to scholars, developers, 
  or anybody else.  Use of the source code can include, but is not limited to, duplication, 
  distribution, modification, or adaptation to alternate systems and/or languages. Any such use of 
  the code must be accompanied by an original copy of this license.

4. Any original or derivate redistributions of this work, in whole or in part, are to be licensed
  as a whole at no charge to all third parties under the same terms and conditions as this license.
  That is, any work that contains derivates of the Visuwords package must be licensed under these 
  terms.

NO WARRANTY:
  The source code and software is provided "as is" without warranty of any kind, either expressed
  or implied.
 
NO LIABILITY: 
  No person or organization can be held responsible for any damages incurred from the use of or 
  inability to use any of this software or its individual parts, either alone or in combination 
  with other software and/or systems.