This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
directorystructure [2007/01/24 09:32] – xuesheng | directorystructure [2009/05/26 14:58] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 5: | Line 5: | ||
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/ | 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. | + | 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 |
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 " | 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 " | ||
Line 26: | Line 26: | ||
popfile/ | popfile/ | ||
popfile/ | popfile/ | ||
- | popfile/ | ||
popfile/ | popfile/ | ||
popfile/ | popfile/ | ||
popfile/ | popfile/ | ||
+ | popfile/ | ||
popfile/ | popfile/ | ||
popfile/UI/ | popfile/UI/ | ||
</ | </ | ||
+ | |||
+ | |||
===== POPFile directories for per-user data ===== | ===== POPFile directories for per-user data ===== | ||
Line 39: | Line 41: | ||
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 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: | On Windows XP the 'User Data' may be in: | ||
Line 60: | Line 64: | ||
</ | </ | ||
- | ===== CVS Structure ===== | + | In this folder POPFile also creates temporary (journal) files and log files. The journal file will be created when POPFile is about to update its database file. If POPFile can't create the journal file (e.g. when you don't have permission to create files in the folder), you'll see the ' |
+ | |||
+ | < | ||
+ | popfile.db-journal | ||
+ | popfileXXXXXXXXXX.log (The log files) | ||
+ | </ | ||
+ | |||
+ | For more information about the log files, please see [[faq: | ||
+ | |||
+ | ===== SVN Structure ===== | ||
The **engine** module has the following directory structure: | The **engine** module has the following directory structure: | ||
Line 71: | Line 84: | ||
popfile/ | popfile/ | ||
popfile/ | popfile/ | ||
- | popfile/ | ||
popfile/ | popfile/ | ||
popfile/ | popfile/ | ||
popfile/ | popfile/ | ||
+ | popfile/ | ||
popfile/ | popfile/ | ||
popfile/ | popfile/ |
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.