This shows you the differences between two versions of the page.
— | devel:directorystructure [2008/02/08 19:49] (current) – created - external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== The POPFile Directory Structure ====== | ||
+ | |||
+ | POPFile needs access to two kinds of files and it will try two ways to find them. | ||
+ | |||
+ | The first kind of file POPFile will have to access is the POPFile source code provided in various modules. The second kind of file is comprised by a couple of configuration/ | ||
+ | |||
+ | Both kinds of files do not have to be in the same place. To find the two kinds of files POPFile will first try to read the environment variables POPFILE_ROOT and POPFILE_USER. The former contains a path that points to the POPFile directory in which the source code modules are stored. The latter points to per-user data, like configuration parameters and the corpus database. If the environment variables are not set, POPFile will try to find everything in the current directory. | ||
+ | |||
+ | When you are using the windows version of POPFile, everything is set up by the installer. It will install the source code modules to your " | ||
+ | |||
+ | ===== POPFile source code directories ===== | ||
+ | |||
+ | This is the directory structure when POPFile is installed (either through the Windows installer, or by unzipping the cross-platform version). | ||
+ | |||
+ | < | ||
+ | popfile/ | ||
+ | </ | ||
+ | |||
+ | The root of the POPFile installation which contains the main POPFile script (popfile.pl), | ||
+ | |||
+ | This directory has the following sub-directories: | ||
+ | |||
+ | < | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/UI/ | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | ===== POPFile directories for per-user data ===== | ||
+ | |||
+ | On recent versions of Windows (XP and 2000 for sure), you will usually find another " | ||
+ | |||
+ | The Windows installer and its 'Add POPFile User' wizard make it very easy to select a different location from the default one, and even if the default locations are used it can be difficult to find the relevant folder so the [[http:// | ||
+ | |||
+ | The Windows installer installs the PFI Diagnostic utility when it installs POPFile and creates some Start Menu shortcuts for the utility. The utility can do more than just display the location of the per-user data (see the utility' | ||
+ | |||
+ | On Windows XP the 'User Data' may be in: | ||
+ | // | ||
+ | |||
+ | This directory usually has at least one subdirectory (messages): | ||
+ | |||
+ | < | ||
+ | backup/ | ||
+ | messages/ | ||
+ | </ | ||
+ | |||
+ | which will contain the messages that POPFile presents to you when you access the history. Normally messages are only stored here for 2 days and then automatically deleted by POPFile (you can use the Configuration page in the UI to change the number of days for which messages will be kept) | ||
+ | |||
+ | On the same level as the messages directory, you will find several files. The most important ones are: | ||
+ | |||
+ | < | ||
+ | popfile.cfg | ||
+ | popfile.db | ||
+ | stopwords | ||
+ | </ | ||
+ | |||
+ | ===== CVS Structure ===== | ||
+ | |||
+ | The **engine** module has the following directory structure: | ||
+ | |||
+ | < | ||
+ | popfile/ | ||
+ | |||
+ | |||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | </ | ||
+ | |||
+ | The **windows** module contains the directories: | ||
+ | |||
+ | < | ||
+ | popfile/ | ||
+ | |||
+ | popfile/ | ||
+ | popfile/ | ||
+ | popfile/ | ||
+ | |||
+ | popfile/ | ||
+ | |||
+ | popfile/ | ||
+ | </ | ||
+ | |||
+ | The files in the " | ||
+ | |||
+ | ------- | ||
+ | This probably should go on another page, but for now its here. I moved it over from an obsolete/ | ||
+ | |||
+ | notes on popfile.cfg: | ||
+ | < | ||
+ | presence/ | ||
+ | windows style back-slashes must be converted to unix style forward slashes</ | ||
Should you find anything in the documentation that is incomplete, unclear, outdated or just plain wrong, please let us know and leave a note in the Documentation Forum.