#!/usr/bin/perl
#############################################################################
#
# orders.cgi -- help on FXTP orders syntax.
#
# $License:
#
# Copyright (C) Kenneth A. Kittlitz, All Rights Reserved.
# 
# Unless explicitly acquired and licensed from Licensor under a
# separate arrangement, the contents of this file are subject to the 
# Idea Futures Public License ("IFPL") Version 1.0, or subsequent
# versions as allowed by the IFPL, and You may not copy or use this file
# in either source code or executable form, except in compliance with the
# terms and conditions of the IFPL.
# 
# The IFPL V1.0 is identical to the Reciprocal Public License V1.1 as
# published at <http://www.opensource.org/licenses/rpl.php>, with the
# following two changes to term 13.8:
# 
# [start of changes]
# Change 1) Replace:
#    "This License shall be governed by Colorado law provisions..." 
# with:
#    "This License shall be governed by Alberta law provisions...".
# 
# Change 2) Replace:
#    "You further agree that Adams County, Colorado USA is proper venue..."
# with:
#    "You further agree that Alberta, Canada is proper venue...".
# [end of changes]
# 
# All software distributed under the License is provided strictly on
# an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
# IMPLIED, AND KENNETH A. KITTLITZ HEREBY DISCLAIMS ALL SUCH
# WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT,
# OR NON-INFRINGEMENT. See the License for specific language
# governing rights and limitations under the License.
#
# :License$
#
#############################################################################

use strict;
use CGI;
require "Common.pl";

my (@content,$data);
my $query = new CGI;
print $query->header;

my $title = "FXTP Order Syntax";

my $header = "FXTP Order Syntax";

$data = <<EOT;
<h5><i>last updated on 08/01/1996</i></h5>
The full FXTP syntax for placing/editing orders is:
<pre>
     orders uid,pword,action claim (B|S)quan(Y|N)\@price,action ... , ...

where:
     uid:     your UID
     pword:   your password
     action:  'new', 'del', 'inc', 'dec'
     (B|S):   'B' (buy) or 'S' (sell)
     (Y|N):   'Y' (Yes) or 'N' (No)

</pre>
Case is irrelevant for keywords -- e.g., 'b10n\@40' is a valid order fragment.
<h2>Adding and Deleting Orders</h2>
<p>A brand new order is entered using 'new':
<pre>
     orders uid,pword,new FooBar S10\@30
</pre>
places an order to sell 10 FooBar coupons at 30 'cents' (hundredths of a
credibill) each on the book.
<p>Deleting an existing order is done with 'del':
<pre>
     orders uid,pword,del FooBar S10\@30
</pre>
deletes the order to sell 10 FooBar coupons at 30. If you don't have
such an order, an error is returned.
<h2>Incrementing and Decrementing Orders</h2>
The quantity of an existing order at a given price may be incremented or
decremented using 'inc' and 'del', respectively:
<pre>
     orders uid,pword,inc FooBar S5\@30
</pre>
increases by 5 coupons your order to sell FooBar at 30.  If you don't
have such an order, an error is returned.
<h1>Account Page Shortcuts</h1>
<p>When using the order edit boxes on the Account page, you don't need
to specify the
word 'orders', your uid or password, or the claim symbol, since these
are all determined by context (your uid and password should be specified
in the edit boxes at the top of the page).  If you don't specify an
action for an order, the action of the previous order (if any) in that
edit box will be used, or 'new' if there was no previous order.
<p>For example, the text:
<pre>
     B100\@61,s10\@90,del 3\@20,10\@40
</pre>
entered in the order edit box for claim FooBar will be sent to the
server as:
<pre>
     orders uid,pword,new FooBar B100\@61,new FooBar S10\@90
                     ,del FooBar B3\@20,del FooBar B10\@40
</pre>
<h1>Claim Page Shortcuts</h1>
The detailed Claim Page has buttons to specify the order action ('new',
'inc', etc.). It also does not require you to specify the keyword
'orders', your uid or password (specified elsewhere on the page) or the
claim symbol.
<br><p><i>end</i>
EOT
push(@content,$data);
&showHtml(8,$title,$header,undef,undef,@content);