Changeset 20881

Show
Ignore:
Timestamp:
10/21/07 11:38:15 (11 months ago)
Author:
patrick
Message:

Document and reference VJ_DATA_DIR. Fixed a few typos.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • juggler/branches/2.2/modules/vrjuggler/doc/getting.started.guide/getting.started.guide.xml

    r20841 r20881  
    735735               <listitem> 
    736736                  <para>The environment variable <envar>VJ_BASE_DIR</envar> 
    737                   plays identifiers where VR Juggler is installed. This 
    738                   information is used for the following purposes:</para> 
     737                  identifies where VR Juggler is installed. This information 
     738                  is used for the following purposes:</para> 
    739739 
    740740                  <itemizedlist> 
    …… 
    756756                        <envar>VJ_BASE_DIR</envar> has been diminished 
    757757                        greatly. The remainder of the description of 
    758                         <envar>Vj_BASE_DIR</envar> explains when it may need 
     758                        <envar>VJ_BASE_DIR</envar> explains when it may need 
    759759                        to be set and when the default will be more than 
    760760                        sufficient.</para> 
    …… 
    821821 
    822822                  <screen>% VJ_BASE_DIR = $HOME/juggler/my_build_dir/instlinks</screen> 
    823  
    824                   <important> 
    825                      <para>When working from withing the build tree and using 
    826                      <filename>instlinks</filename>, 
    827                      <envar>VJ_BASE_DIR</envar> is 
    828                      <emphasis>required</emphasis>.</para> 
    829                   </important> 
     823               </listitem> 
     824            </varlistentry> 
     825 
     826            <varlistentry> 
     827               <term>VJ_DATA_DIR</term> 
     828 
     829               <listitem> 
     830                  <para>On non-<productname 
     831                  class="registered">Windows</productname> platforms, VR 
     832                  Juggler 2.2 and beyond used versioned directories to allow 
     833                  for parallel installations of different versions of VR 
     834                  Juggler. The directories that are versioned are those 
     835                  containing the header files (needed for compiling VR Juggler 
     836                  applications), those containing plug-ins, and those 
     837                  containing data files (needed for running VR Juggler 
     838                  applications) and sample programs. For example, we will 
     839                  refer later to the MPApp sample application. Its source code 
     840                  can be found in 
     841                  <filename>$VJ_BASE_DIR/share/vrjuggler-2.2/samples/OGL/simple/MPApp</filename>. 
     842                  The value of <envar>VJ_DATA_DIR</envar> for VR Juggler 2.2 
     843                  ought to be 
     844                  <filename>$VJ_BASE_DIR/share/vrjuggler-2.2</filename>. In VR 
     845                  Juggler configuration files, there is sometimes a need to 
     846                  refer to files in the VR Juggler data directories. In order 
     847                  to allow a configuration to be used with multiple VR Juggler 
     848                  versions (which may or may not be possible depending on the 
     849                  config elements in use) or between <productname 
     850                  class="registered">Windows</productname> and 
     851                  non-<productname class="registered">Windows</productname> 
     852                  platforms, users can reference the 
     853                  <envar>VJ_DATA_DIR</envar> environment variable.</para> 
     854 
     855                  <para>This environment variable is new in VR Juggler 2.2.1. 
     856                  If the environment variable is not set when an application 
     857                  is launched, it will be set automatically relative to the 
     858                  value of <envar>VJ_BASE_DIR</envar>. In general, users 
     859                  should not set <envar>VJ_DATA_DIR</envar> unless they know 
     860                  that the default value is inappropriate.</para> 
    830861               </listitem> 
    831862            </varlistentry> 
    …… 
    939970                  be set on all of these platforms. If not set, the default 
    940971                  search path for configuration files is 
    941                   <filename>$VJ_BASE_DIR/share/vrjuggler/data/configFiles</filename>.</para> 
     972                  <filename>$VJ_DATA_DIR/data/configFiles</filename>.</para> 
    942973 
    943974                  <note> 
    …… 
    966997 
    967998                  <para>The default search path for configuration files is 
    968                   always 
    969                   <filename>$VJ_BASE_DIR/share/vrjuggler/data/definitions</filename>. 
     999                  always <filename>$VJ_DATA_DIR/data/definitions</filename>. 
    9701000                  Setting the environment variable 
    9711001                  <envar>JCCL_DEFINITION_PATH</envar> appends directories to 
    …… 
    11401170         <para>Some sample applications designed for getting started with VR 
    11411171         Juggler are found in 
    1142          <filename>$VJ_BASE_DIR/share/vrjuggler/samples/OGL/simple</filename>. 
    1143          All of these applications were designed to be used as part of courses 
    1144          teaching people how to write VR Juggler applications using OpenGL. 
    1145          They contain clear comments explaining what the code is doing, and 
    1146          they are intended to be as simple as possible. These tutorials are as 
     1172         <filename>$VJ_DATA_DIR/samples/OGL/simple</filename>. All of these 
     1173         applications were designed to be used as part of courses teaching 
     1174         people how to write VR Juggler applications using OpenGL. They 
     1175         contain clear comments explaining what the code is doing, and they 
     1176         are intended to be as simple as possible. These tutorials are as 
    11471177         follows:</para> 
    11481178 
    …… 
    11961226 
    11971227         <para>Examples of OpenGL Performer applications can be found in 
    1198          <filename>$VJ_BASE_DIR/share/vrjuggler/samples/Pf/advanced</filename>. 
    1199          These are for more advanced developers who are familiar with 
    1200          Performer and some of the more complicated aspects of VR Juggler. 
    1201          There are two main programs to be found there:</para> 
     1228         <filename>$VJ_DATA_DIR/samples/Pf/advanced</filename>. These are for 
     1229         more advanced developers who are familiar with Performer and some of 
     1230         the more complicated aspects of VR Juggler. There are two main 
     1231         programs to be found there:</para> 
    12021232 
    12031233         <itemizedlist> 
    …… 
    12301260      and that is the whole point, right? This chapter explains how to compile 
    12311261      the applications provided in the directory 
    1232       <filename>$VJ_BASE_DIR/share/vrjuggler/samples/OGL/simple</filename>.</para> 
     1262      <filename>$VJ_DATA_DIR/samples/OGL/simple</filename>.</para> 
    12331263 
    12341264      <section> 
    …… 
    12621292 
    12631293            <para>All the sample programs in 
    1264             <filename>$VJ_BASE_DIR/share/vrjuggler/samples</filename> use the 
    1265             same basic steps to compile unless otherwise noted. Always refer 
    1266             to the top of the sample application's 
    1267             <filename>Makefile</filename> for information that may be specific 
    1268             to building that application. In general, though, all 
    1269             applications' makefiles require the GNU version of the 
     1294            <filename>$VJ_DATA_DIR/samples</filename> use the same basic steps 
     1295            to compile unless otherwise noted. Always refer to the top of the 
     1296            sample application's <filename>Makefile</filename> for information 
     1297            that may be specific to building that application. In general, 
     1298            though, all applications' makefiles require the GNU version of the 
    12701299            <command>make</command>(1) utility, sometimes installed as 
    12711300            <command>gmake</command>.</para> 
    …… 
    12731302            <para>The example used here will be the MPApp tutorial application 
    12741303            found in 
    1275             <filename>$VJ_BASE_DIR/share/vrjuggler/samples/OGL/simple/MPApp</filename>. 
    1276             It is an OpenGL-based application that will compile and run on all 
     1304            <filename>$VJ_DATA_DIR/samples/OGL/simple/MPApp</filename>. It is 
     1305            an OpenGL-based application that will compile and run on all 
    12771306            platforms supported by VR Juggler. Begin by changing into the 
    12781307            directory 
    1279             <filename>$VJ_BASE_DIR/share/vrjuggler/samples/OGL/simple/MPApp</filename> 
    1280             in a command shell.</para> 
     1308            <filename>$VJ_DATA_DIR/samples/OGL/simple/MPApp</filename> in a 
     1309            command shell.</para> 
    12811310 
    12821311            <para>To compile MPApp, simply enter the following:</para> 
    …… 
    14101439      modifications. What does change is the configuration files used when 
    14111440      starting the program. In 
    1412       <filename>$VJ_BASE_DIR/share/vrjuggler/data/configFiles</filename>, you 
    1413       can find many basic configuration files including those for running in 
    1414       simulator using a mouse and keyboard to simulate VR input devices and 
    1415       some example files based on those used for the VRAC C4 system. In the 
    1416       directory, you will see some files with names containing 
    1417       <quote>mixin</quote>. These are special files that provide a specific 
    1418       capability not necessarily needed by all applications. They can be mixed 
    1419       in (hence the name) with other configuration files as needed. The 
    1420       configuration files found in the <filename>configFiles</filename> 
    1421       directory will be referenced in the examples provided, so be sure you 
    1422       know where they are.</para> 
     1441      <filename>$VJ_DATA_DIR/data/configFiles</filename>, you can find many 
     1442      basic configuration files including those for running in simulator using 
     1443      a mouse and keyboard to simulate VR input devices and some example files 
     1444      based on those used for the VRAC C4 system. In the directory, you will 
     1445      see some files with names containing <quote>mixin</quote>. These are 
     1446      special files that provide a specific capability not necessarily needed 
     1447      by all applications. They can be mixed in (hence the name) with other 
     1448      configuration files as needed. The configuration files found in the 
     1449      <filename>configFiles</filename> directory will be referenced in the 
     1450      examples provided, so be sure you know where they are.</para> 
    14231451 
    14241452      <section id="section.required.reading"> 
    …… 
    17491777               any VR Juggler application whose build is based on Doozer 2.1.4 
    17501778               and newer. For builds that are not using Doozer, see the files 
    1751                in 
    1752                <filename>$VJ_BASE_DIR/share/vrjuggler-2.2/data/bundle</filename> 
    1753                for a starting point.</para> 
     1779               in <filename>$VJ_DATA_DIR/data/bundle</filename> for a starting 
     1780               point.</para> 
    17541781 
    17551782               <para>The use of application bundles offers several different 
    …… 
    22972324            <quote>training file</quote> for the simulated glove device. The 
    22982325            default training file is 
    2299             <filename>$VJ_BASE_DIR/share/vrjuggler/data/gesture/simpleSimGestures.dat</filename>.</para> 
     2326            <filename>$VJ_DATA_DIR/data/gesture/simpleSimGestures.dat</filename>.</para> 
    23002327         </section> 
    23012328 
    …… 
    24152442 
    24162443            <para>The example configuration files in the directory 
    2417             <filename>$VJ_BASE_DIR/share/vrjuggler/data/configFiles</filename> 
    2418             modeled after those used for VRAC's Onyx-powered C4 system are as 
     2444            <filename>$VJ_DATA_DIR/data/configFiles</filename> modeled after 
     2445            those used for VRAC's Onyx-powered C4 system are as 
    24192446            follows:</para> 
    24202447