This document describes the file locations of all files used by TW.
1. Program is installed by default under “c:\Program Files\The Word” by
default (called PROGRAM folder from now on). This folder is used for all
versions of the software (from version 0.99).
2. The main executable file is called “theword.exe”.
3. All installable modules should be located under “CSIDL_COMMON_APPDATA\The
Word” folder (called COMMONS folder from now on). The permissions on this
subfolder are changed when TW is installed so write access is provided for
all users of the PC.
Notice that the subfolder “Templates” is excluded: no modules in this subfolder will be used (there is a special usage for this folder, see below).
4. All user-configuration and data (config.ini, verse lists, bible-highlights,
modules created from within the program, etc) are saved in CSIDL_APPDATA
\The Word\ (or in CSIDL_LOCAL_APPDATA\The Word\), called USER folder from
now on.
By default, if none of these folders exists, the program/installer will
use the CSIDL_APPDATA location. If one manually moves the data under
CSIDL_LOCAL_APPDATA then the program will continue using this folder. This
is very useful to manually change whether personal data should roam or not.
5. The default config.ini file that is used is located in USER folder.
Folder locations
Window
s 9x
Window
s ME
Window
s 2000
XP
Vista
CSIDL_COMMON_APPD
ATA
<empty>:INSTFOLDE
R
<empty>:INSTFOLDE
R
c:\Documents and
Settings\All
Users\Application
Data\
c:\Documents and
Settings\All
Users\Application
Data\
CSIDL_PROFILE
CSIDL_APPDATA
CSIDL_APPDATA_LOCAL
C:\Documents and
Settings\<user>\Applicat
ion Data
C:\Documents and
Settings\<user>\Local
Settings\Application Data
c:\Documents
and
Settings\<user>
\
C:\Documents and
Settings\<user>\Applicat
ion Data
C:\Documents and
Settings\<user>\Local
Settings\Application Data
c:\Program Data\
c:\Users\<user>
\
C:\Users\<user>\AppData\
Roaming
C:\Users\<user>\AppData\L
ocal
<empty>:INSTFOL
DER
<empty>:INSTFOL
DER
Case 1: default installation
a. PROGRAM folder: theword.exe, *.lng, sqlite3.dll
b. COMMONS folder: all downloadable modules. Under ‘Templates’ subfolder, all
per-user data (initial config.ini, xrefs, etc)
c. USER folder: nothing on installation: upon first run, the content of
COMMONS\Template folder are copied here.
The program reads modules from the following locations:
COMMONS, USER (any subdirectory with the name ‘Templates’ or with a name that
starts with ‘.’ or ‘-‘ is excluded).
If modules are found in the PROGRAM, then they are used ONLY if the program has
write-access to this folder. If not, it displays a warning message and marks
these modules as ‘disabled’. A list of disabled modules can be found in the
‘About’ box.
Case 2: compact installation (single dir for memory stick, etc)
All files in a single writeable folder (from now on COMPACT folder). In that
case:
PROGRAM = COMPACT
COMMONS as before
USER = COMPACT
2 ways to identify this:
1. Startup parameter –compact
2. Existence of a file “compact”
3. If one of the above cases is true, then the current dir should be
writeable. If not, no compact mode is used.
Even in that case, modules will continue to be read from the other locations,
if present (to allow for portable installations).
No trace should is left on computers. No writes in no place on the target
computer exist. For this reason, the current dir should be writeable.
Subfolders:
The following subfolder may exists in USER or/and COMMONS folder
 Bibles\
 Books\
 Commentaries\
All dictionaries, maps and books are stored in ‘Books\’. Others are obvious.
These directories are optional since the program reads all modules under the
USER and COMMONS folders. They are only used:
1. By the installer, when installing new modules. If they exist, modules will
be stored there
2. By the ‘New module’ function from within the program.
3. For human organization.