Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
directorystructure [2007/01/24 09:32] xueshengdirectorystructure [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/database files where options and the corpus will be stored. 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/database files where options and the corpus will be stored.
  
-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 ''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 "program files" directory and it will make sure that the per-user data is stored in your "application data" folder. It will also set the two environment variables to point to these two locations. 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 "program files" directory and it will make sure that the per-user data is stored in your "application data" folder. It will also set the two environment variables to point to these two locations.
Line 26: Line 26:
 popfile/languages/ popfile/languages/
 popfile/lib/        (on Windows, used for the minimal Perl system) popfile/lib/        (on Windows, used for the minimal Perl system)
-popfile/manual/     (the QuickStart Guide) 
 popfile/Platform/   (on Windows) popfile/Platform/   (on Windows)
 popfile/POPFile/ popfile/POPFile/
 popfile/Proxy/ popfile/Proxy/
 +popfile/Services/
 popfile/skins/ popfile/skins/
 popfile/UI/ popfile/UI/
 </code> </code>
 +
 +
  
 ===== 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://www.sugelan.co.uk/popfile/download/test/pfidiag.zip| PFI Diagnostic utility]] has been created to avoid the need to delve into the registry. The utility displays the location of the POPFile program and the location of the 'User Data'. 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://www.sugelan.co.uk/popfile/download/test/pfidiag.zip| PFI Diagnostic utility]] has been created to avoid the need to delve into the registry. The utility displays the location of the POPFile program and the location of the 'User Data'.
 +
 +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's [[howtos:pfidiagnostic|HOWTO]] page for further details).
  
 On Windows XP the 'User Data' may be in: On Windows XP the 'User Data' may be in:
Line 60: Line 64:
 </code> </code>
  
-===== 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 'unable to open database file' error. 
 + 
 +<code> 
 +popfile.db-journal    (The temporary (journal) file) 
 +popfileXXXXXXXXXX.log (The log files) 
 +</code> 
 + 
 +For more information about the log files, please see [[faq:popfilelog|FAQ]]. 
 + 
 +===== SVN Structure =====
  
 The **engine** module has the following directory structure: The **engine** module has the following directory structure:
Line 71: Line 84:
 popfile/engine/Devel/ popfile/engine/Devel/
 popfile/engine/languages/ popfile/engine/languages/
-popfile/engine/manual/ 
 popfile/engine/Platform/ popfile/engine/Platform/
 popfile/engine/POPFile/ popfile/engine/POPFile/
 popfile/engine/Proxy/ popfile/engine/Proxy/
 +popfile/engine/Services/
 popfile/engine/skins/ popfile/engine/skins/
 popfile/engine/Test/ popfile/engine/Test/
 
directorystructure.1169631172.txt.gz · Last modified: 2008/02/08 19:49 (external edit)
Old revisions

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.

Recent changes RSS feed Donate Driven by DokuWiki
The content of this wiki is protected by the GNU Fee Documentation License