[Webfunds-commits] html/guide custom.html

Tue, 5 Dec 2000 16:50:49 -0400 (AST)

iang        00/12/05 16:50:49

  Added:       guide    custom.html
  Log:
  written to describe how to customise the distribution

Revision  Changes    Path
1.1                  html/guide/custom.html

Index: custom.html
===================================================================
<html><head>
<title>Customisation Options</title>
</head>
<body>

<h1> Customisation Options </h1>

WebFunds can be customised to a limited degree.

<h2><a name="startup_contracts">Default Contracts on Startup</a></h2>

Contracts placed in the directory
<code>defaults/contracts</code>
will be added automatically to the
contract browser when WebFunds starts
up for the first time only.

Without this option, the user has to
manually add the contracts to the contract
browser. For this reason, WebFunds is normally
distributed with some test and play contracts
in the defaults directory. More commercial
distributions are encouraged to change these.

<h2><a name="trader_contracts">Trader Contracts</a></h2>

The Systemics Trader plugin has a similar
additional feature. When an account is
created, within the Trader wallet, a list
of contracts is read from the
<code>market.loc</code>
contract file. This latter is located
within the plugin directory.

<p>
This file can specifiy the default "money"
contract, and any traded contracts that are
traded against that money.  For example,
</p>
<pre>
      [market]

      # set the money here
      money += Glitter
      # set the subaccounts here, as many as you need
      Glitter += pints of beer
</pre>

For each money
(<code>Glitter</code> in the above example)
there would be a new section, named after that money,
that would list the currently active books
(<code>pints of beer</code>). So, when the
account is first created, Trader will automatically
add <code>Glitter</code> as the first (money) Contract,
and <code>pints of beer</code> as the traded Contracts.

Note however, that the contracts added automatically
by Trader have to be already present in the Contracts Browser.
If not, default processing stops at that point. So, effectively,
a distribution of both products together has to integrate
this default feature with the above
<a href="#startup_contracts">Startup Contracts</a>
feature.

Note also that Systemics Trader is a 3rd party product,
and might change arbitrarily. I.e., the doco is only
here because they haven't done it in a better place,
but don't rely on this document for accuracy.

<h2><a name="names">Naming</a></h2>

It is possible to change the name of WebFunds,
but it is not really coded in nor well tested.
The names are currently hard-coded in various
places. Especially, the names of the Wallets
cannot be changed arbitrarily as they are used
to determine the directories where data is
stored.

</body></html>