Menu
▾
▴
[csms-cvs] csms-core/src/documentation/xdocs/downloadAndInstall configuration.xml,NONE,1.1 book.xml,1.1,1.2
|
From: <rga...@us...> - 2002-10-28 13:04:54
|
Update of /cvsroot/csms/csms-core/src/documentation/xdocs/downloadAndInstall
In directory usw-pr-cvs1:/tmp/cvs-serv12091
Modified Files:
book.xml
Added Files:
configuration.xml
Log Message:
Added info about configuring the application (unfortunately this doesn't work on Linux yet, untested on WIndows)
--- NEW FILE: configuration.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
"./dtd/document-v11.dtd">
<document>
<header>
<title>CSMS - Configuration</title>
<authors>
<person id="rdg" name="Ross D. Gardler" email="ro...@sa..." />
</authors>
</header>
<body>
<section>
<title>Introduction</title>
<p>Currently the Community Sports Management System consists
of the very beginnings of one of the sports modules. This module
provides facilites to manage a fantasy Football (that's Soccer to
our American friends), However, this module can easily be adapted
to provide other Fantasy Sports games by providing additional
configuration files that define the rules for the game.</p>
<p>These configuration files are, in the default installation,
loaded from the internet, however, you can configure the locations they
are loaded from in the configuraiton dialog of the GUI interface as described below. Example
configuration files (the same ones available on the Internet are avilable in
the <code>src/resources/conf</code> directory of the source distributions. If you
wish to fix any bugs found in the online config files, please configure your
application to use these local files, edit them and supply patches to us
via the <link href="http://sourceforge.net/tracker/?atid=509510&group_id=65029&func=browse">patch tracking system</link>. In fact, changing the settings
to the local versions of the files will make the system run faster since it will not
have to download the files from the Internet, however, you will not automatically
benifit from fixes in the files.</p>
<fixme author="rdg">Move all docs about the config files to here from the wiki site. In the
meantime, visitors can view the docs on <link href="http://www.fanfoot.com/wiki/Wiki.jsp?page=AutomatedScoring">our Wkii</link></fixme>
</section>
<section>
<title>Configuring The Fantasy Sports Module</title>
<p>The following preferneces will define where the configuration files will be loaded from.
You can change the default settings by selecting the <code>Preferences</code> option in the
<code>Configuration</code> menu.</p>
<table>
<caption>Config File Load Paths</caption>
<tr>
<th>Preference Name</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>EventConfigurationFile</td>
<td>The URL from which the Event configuration file should be loaded.
This file defines a set of regular expression patterns that are used to extract
events from an information source concerning a real sports game. This file
is used to generate Events.xml a file that describes all the events in a real game
that may result in a scoring opportunity in the fantasy game.</td>
<td>http://www.fanfoot.com/test/footballEvents.xml</td>
</tr>
<tr>
<td>ScoringConfigurationFile</td>
<td>The URL from which to load the Scoring Configuration file will be loaded.
This file defines how events in real games are converted nto scores in the fantasy game.
It is an XSL file that processes the Events.xml file. When Events.xml is processed
with this stylesheet it should produce Scores.xml, a file representing all the
scoring events in a game.</td>
<td>http://www.fanfoot.com/test/ScoringConfig.xsl</td>
</tr>
<tr>
<td>Scores2HTMLStylsheet</td>
<td>The URL from which to download an XSL file used to convert the Scores.xml file
to an HTML file for display in the application.</td>
<td>http://www.fanfoot.com/test/Scores2HTML.xsl</td>
</tr>
</table>
<section>
<title>Misc Config Options</title>
<table>
<caption>Misc Config Options</caption>
<tr>
<th>Preference Name</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>debug</td>
<td>Defines whether the appliation runs in debug mode or not.</td>
<td>true</td>
</tr>
</table>
</section>
</section>
</body>
</document>
Index: book.xml
===================================================================
RCS file: /cvsroot/csms/csms-core/src/documentation/xdocs/downloadAndInstall/book.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** book.xml 22 Oct 2002 14:45:28 -0000 1.1
--- book.xml 28 Oct 2002 13:04:51 -0000 1.2
***************
*** 16,19 ****
--- 16,20 ----
<menu-item label="Introduction" href="../index.html"/>
<menu-item label="Download/Install" href="index.html"/>
+ <menu-item label="Configuration" href="configuration.html"/>
</menu>
|
