fileStructure.doxygen   fileStructure.doxygen 
skipping to change at line 24 skipping to change at line 24
* *
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software * along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, U SA. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, U SA.
*/ */
/*! /*!
@page fileStructure File and Directory Structure @page fileStructure File and Directory Structure
@tableofcontents
@section intro_structire Introduction
This article explains the directory and file layout which Stellarium uses f rom a programmer's perspective, lays out the rationale behind it, and uses examples to illustrate the way things work. This article explains the directory and file layout which Stellarium uses f rom a programmer's perspective, lays out the rationale behind it, and uses examples to illustrate the way things work.
@section directoryStructure Directory Structure @section directoryStructure Directory Structure
Files are broadly separated by the type of data. For @em StelModules which need many data files, there is one directory. e.g. @em StarMgr files are stored in the @c stars directory, @em LandscapeMgr files may be found in th e @c landscapes directory. Files are broadly separated by the type of data. For @em StelModules which need many data files, there is one directory. e.g. @em StarMgr files are stored in the @c stars directory, @em LandscapeMgr files may be found in th e @c landscapes directory.
There are also directories which are shared among modules and other parts o f the program, for example the @c textures directory. There are also directories which are shared among modules and other parts o f the program, for example the @c textures directory.
@section installationDirectories User and Installation directory separatio n @section installationDirectories User and Installation directory separatio n
When Stellarium searches for data, texture and other files it looks in two separate locations: When Stellarium searches for data, texture and other files it looks in two separate locations:
<ul> <ul>
skipping to change at line 63 skipping to change at line 67
<table class="stel"> <table class="stel">
<tr class="header"><td>OS</td><td>Location</td></tr> <tr class="header"><td>OS</td><td>Location</td></tr>
<tr class="stel"><td>Linux / BSD / other POSIX</td><td>It depends on the in stallation prefix used when building Stellarium. If you built from source, and didn't explicitly specify an install prefix, the prefix will be @c /usr /local. Typically, pre-built packages for distros will use the @c /usr pref ix. The <em>Installation Data Directory</em> is <tt>$PREFIX/share/stellariu m</tt></td></tr> <tr class="stel"><td>Linux / BSD / other POSIX</td><td>It depends on the in stallation prefix used when building Stellarium. If you built from source, and didn't explicitly specify an install prefix, the prefix will be @c /usr /local. Typically, pre-built packages for distros will use the @c /usr pref ix. The <em>Installation Data Directory</em> is <tt>$PREFIX/share/stellariu m</tt></td></tr>
<tr class="stel"><td>Windows</td><td>It depends on where Stellarium is inst alled. The main Stellarium installation directory is the <em>Installation D ata Directory</em>. Typically this will be <tt>C:\\Program Files\\Stellariu m\\</tt></td></tr> <tr class="stel"><td>Windows</td><td>It depends on where Stellarium is inst alled. The main Stellarium installation directory is the <em>Installation D ata Directory</em>. Typically this will be <tt>C:\\Program Files\\Stellariu m\\</tt></td></tr>
<tr class="stel"><td>MacOS X</td><td>The Installation Data Directory is fou nd inside the application bundle.</td></tr> <tr class="stel"><td>MacOS X</td><td>The Installation Data Directory is fou nd inside the application bundle.</td></tr>
</table> </table>
Important data files which may be found in the <em>Installation Data Direct ory</em> include: Important data files which may be found in the <em>Installation Data Direct ory</em> include:
<ul> <ul>
<li><tt>data/ssystem.ini</tt>: the solar system bodies description file</li > <li><tt>data/ssystem.ini</tt>: the solar system bodies description file</li >
<li><tt>stars/default/*</tt>: star catalogues</li> <li><tt>stars/default/</tt>: star catalogues</li>
<li><tt>nebulae/default/*</tt>: nebula textures and data files</li> <li><tt>nebulae/default/</tt>: nebula textures and data files</li>
<li><tt>scripts/</tt>: script files</li> <li><tt>scripts/</tt>: script files</li>
<li><tt>textures/</tt>: general purpose texture files (button icons etc)</l i> <li><tt>textures/</tt>: general purpose texture files (button icons etc)</l i>
<li><tt>landscapes/*/*</tt>: landscape textures and data files</li> <li><tt>landscapes/</tt>: landscape textures and data files</li>
</ul> </ul>
</li> </li>
</ul> </ul>
If a file exists in the <em>User Data Directory</em>, it will be used in pr eference to a file with the same name existing in the <em>Installation Data Directory</em>. This allows users to customise data files, textures and so on without modifying the originally installed files. If a file exists in the <em>User Data Directory</em>, it will be used in pr eference to a file with the same name existing in the <em>Installation Data Directory</em>. This allows users to customise data files, textures and so on without modifying the originally installed files.
There are several reasons for doing this: There are several reasons for doing this:
<ul> <ul>
<li>On machines which multiple user accounts, the <em>Installation Data Di rectory</em> will likely not be writable by all users. Without allowing th e <em>User Data Directory</em> files to over-ride <em>Installation Data Dir ectory</em> files such users could not customise the program without doing an entirely separate installation.</li> <li>On machines which multiple user accounts, the <em>Installation Data Di rectory</em> will likely not be writable by all users. Without allowing th e <em>User Data Directory</em> files to over-ride <em>Installation Data Dir ectory</em> files such users could not customise the program without doing an entirely separate installation.</li>
 End of changes. 3 change blocks. 
3 lines changed or deleted 7 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/