More documentation updates - price editor and related changes.

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@4337 57a11ea4-9604-0410-9ed3-97b8803252fd

ChangeLog

@@ -1,3 +1,15 @@
+2001-05-31  Robert Graham Merkel  <rgmerk@mira.net>
+
+	* doc/sgml/C/xacc-ticker.sgml: renamed xacc-price-sources.sgml
+	in preparation for rewriting - some material to be excised.
+
+	* doc/sgml/C/xacc-price-editor.sgml: new file.
+
+	* doc/sgml/C/gnucash.sgml: updated for new/changed file names.
+
+	* doc/sgml/C/*.sgml: change xacc-ticker references to
+	xacc-price-sources, or remove them entirely.
+
 2001-05-30  Dave Peticolas  <dave@krondo.com>
 
 	* src/test/Makefile.am: add missing link lib

doc/sgml/C/Makefile.am

@@ -38,6 +38,8 @@ GNUCASH_SGML_FILES = \
 	xacc-newacctwin.sgml \
 	xacc-pnl.sgml \
 	xacc-portfolio-report.sgml \
+	xacc-price-editor.sgml \
+	xacc-price-sources.sgml \
 	xacc-preferences.sgml \
 	xacc-print-check.sgml \
 	xacc-print.sgml \
@@ -52,7 +54,6 @@ GNUCASH_SGML_FILES = \
 	xacc-scheme.sgml \
 	xacc-stock-price-report.sgml \
 	xacc-tax-report.sgml \
-	xacc-ticker.sgml \
 	xacc-trans-report.sgml \
 	xacc-txf-categories.sgml \
 	xacc-txf-export.sgml \

doc/sgml/C/gnucash.sgml

@@ -31,6 +31,8 @@
 <!entity xaccnetworthbarchart system "xacc-net-worth-barchart.sgml">
 <!entity xaccpnl system "xacc-pnl.sgml">
 <!entity xaccportfolioreport system "xacc-portfolio-report.sgml">
+<!entity xaccpriceeditor system "xacc-price-editor.sgml">
+<!entity xaccpricesources system "xacc-price-sources.sgml">
 <!entity xaccprintcheck system "xacc-print-check.sgml">
 <!entity xaccprint system "xacc-print.sgml">
 <!entity xaccqifimport system "xacc-qif-import.sgml">
@@ -42,7 +44,6 @@
 <!entity xaccreports system "xacc-reports.sgml">
 <!entity xaccrepdev system "xacc-repdev.sgml">
 <!entity xaccstockpricereport system "xacc-stock-price-report.sgml">
-<!entity xaccticker system "xacc-ticker.sgml">
 <!entity xacctaxreport system "xacc-tax-report.sgml">
 <!entity xacctransreport system "xacc-trans-report.sgml">
 <!entity xacctxfcategories system "xacc-txf-categories.sgml">
@@ -90,6 +91,8 @@
 &xaccnetworthbarchart;
 &xaccpnl;
 &xaccportfolioreport;
+&xaccpriceeditor;
+&xaccpricesources;
 &xaccprintcheck;
 &xaccprint;
 &xaccqifimport;
@@ -100,7 +103,6 @@
 &xaccregwinkbd;
 &xaccreports;
 &xacctaxreport;
-&xaccticker;
 &xacctransreport;
 &xacctxfcategories;
 &xacctxfexportanomalies;

doc/sgml/C/xacc-accountedit.sgml

@@ -21,7 +21,7 @@
     account are shown.
 
     </PARA>
-<PARA>The source for <EMPHASIS>Stock Quotes</EMPHASIS> can be selected. See <LINK LINKEND="XACC-TICKER">the ticker</LINK> for more
+<PARA>The source for <EMPHASIS>Stock Quotes</EMPHASIS> can be selected. See <LINK LINKEND="xacc-price-sources">Selecting price sources</LINK> for more
     information.
 
     </PARA>

doc/sgml/C/xacc-acctypes.sgml

@@ -115,7 +115,8 @@ decide.
 </LISTITEM>
 </ITEMIZEDLIST>
       </PARA>
-<PARA>More details may be found in the <LINK LINKEND="XACC-TICKER">Stock Ticker</LINK> section.</PARA>
+<PARA>More details may be found in the <LINK LINKEND="xacc-price-editor">price editor</LINK> and 
+		<link linkend="xacc-price-sources">price sources</link>sections.</PARA>
 </GLOSSDEF>
 </GLOSSENTRY>
 <GLOSSENTRY>

doc/sgml/C/xacc-depreciation.sgml

@@ -77,7 +77,7 @@ case, you must recognize -- for tax purposes -- what are called
     assets, it is difficult to correctly estimate an increase in
     value <EMPHASIS>until you actually sell the asset.</EMPHASIS>
 
-    If you invest in <LINK LINKEND="XACC-TICKER">securities</LINK>
+    If you invest in securities
     traded daily on open markets such as stock
     exchanges, prices are often quite exact, and selling the asset at
     market prices may be as simple as calling a broker and issuing

doc/sgml/C/xacc-features.sgml

@@ -59,7 +59,7 @@
 	  portfolio of accounts (a group of accounts that can be
 	  displayed together).
 	  There are tools to 
-	  <link linkend="xacc-ticker">automatically collect stock quotes.</link>
+	  <link linkend="xacc-price-editor">automatically collect stock quotes.</link>
 	</para>
       </listitem>
       

doc/sgml/C/xacc-price-editor.sgml

@@ -0,0 +1,159 @@
+
+  <article id="xacc-price-editor">
+    <artheader>
+      <title>Updating Share Prices and Currency Values</title>
+    </artheader>
+    <sect1>
+      <title>Introduction</title>
+      <para>When trading currencies, mutual funds, or stocks, and trying to
+	track the growth of your investment, you need to be able to
+	keep track of the value of those things. The <emphasis>price
+	  editor</emphasis> provides a unified  interface for doing
+	just that.
+      </para>
+    </sect1>
+    <sect1>
+      <title>
+	The Price Editor
+      </title>
+      <para>The price editor is available from the "Tools" menu. Selecting
+	it brings up the editor:</para>
+      
+      <para><emphasis>PICTURE NEEDED</emphasis></para>
+      
+      <para>Each entry in the editor shows a record of a price:</para>
+      <itemizedlist>
+	<listitem>
+	  <para><emphasis>Commodity</emphasis>: what the price  is
+	    for.
+	  </para>
+	</listitem>
+	<listitem>
+	  <para>
+	    <emphasis>Currency</emphasis>: what the price is recorded
+	    in.  To take a simple example, IBM stock's commodity is
+	    IBM, and the currency would be USD, as prices are almost
+	    always quoted in US dollars.
+	  </para>
+	</listitem>
+	<listitem>
+	  <para>
+	    <emphasis>Date</emphasis>: when the price is/was
+	    for.
+	  </para>
+	</listitem>
+	<listitem>
+	  <para>
+	    <emphasis>Source</emphasis>: where the price quote
+	  came from.  Typically, this will be either "user:price-editor"
+	    (indicating you entered it directly) or "Finance::Quote",
+	    indicating that it was retrieved from an online source by
+	    the Finance::Quote module that GnuCash uses for this task.
+	  </para>
+	</listitem>
+	<listitem>
+	  <para>
+	    <emphasis>Type</emphasis>: There are several different
+	    types of stock price quotes, and to explain the technicalities
+	    requires a little understanding of the stock market.  Most
+	    stocks, on most markets, have specialist dealers who are 
+	    almost always willing to buy and sell that stock, and
+	    make a little profit along the way by by buying and selling
+	    at slightly different prices.<
+	    </para>
+	  
+	  <itemizedlist>
+	    <listitem>
+	      <para><emphasis>Bid</emphasis> prices indicate what 
+		a specialist  dealer is prepared to pay for a stock.
+	      </para>
+	    </listitem>
+	    <listitem>
+	      <para><emphasis>Ask</emphasis> prices indicates what
+		the dealers are prepared to sell a stock for - naturally,
+		this is slightly higher than the bid price.
+	      <para>
+	    </listitem>
+	    <listitem>
+	      <para><emphasis>Last</emphasis> prices indicate the
+		    price at which the last trade in that stock/security
+		  occurred at.  This is the price most commonly
+		  quoted in the media.
+	      </para>
+	    </listitem>
+	    <listitem>
+	      <para><emphasis>Net Asset Value</emphasis> prices
+		are typically used for mutual funds.  They are calculated
+		on the net value of the fund's assets.
+	      </para>
+	    </listitem>
+	    <listitem>
+	      <para><emphasis>Unknown</emphasis>As the name suggests,
+		use this if the type of price quoted is not known.
+	      </para>
+	    </listitem>
+	  </itemizedlist>
+	</listitem>
+	<listitem>
+	  <para>
+	    <emphasis>Price</emphasis>: the actual price.
+	  </para>
+	</listitem>
+      </itemizedlist>
+      <para>
+	You can choose how you'd like the list of prices sorted by
+	clicking on the appropriate "Sort by . . ." radio button
+	directly below the price list.
+      </para>
+    <sect1>
+      <title>
+	Updating prices manually
+      </title>
+      <para>To add a new price, click on "Add", and enter the details
+	of the price into the dialog box.  Similarly, to edit an
+	existing price, click on the price in the price list, click the
+	"Edit" button, and edit the figures.</para>
+      <para>
+	To remove just one price, just click the "Remove button", 
+	or, if you want to remove all prices older than a certain time,
+	Click on the "Remove Old..." button and use the dialog box.
+	</para>
+    </sect1>
+    
+    <sect1>
+      <title>
+	Getting quotes online
+      </title>
+      <para>
+      GnuCash is able to get quotes online from a variety of sources,
+      through the Finance::Quote module.  To support online quotations
+      for a particular stock or mutual fund account, you must first 
+      enable online price quoting and select a price source.  
+      You can do this in the <link linkend="xacc-accountedit">edit account
+	</link>
+	dialog box.  More details on exactly how to choose a price
+	source can be found in the <link linkend="xacc-price-sources">
+	  price sources</link> help entry.
+      </para>
+      <para>
+      Once that is done, you can update prices for your stocks and 
+      mutual funds by clicking the "get quotes" button.
+      </para>
+
+      <para>
+	If you wish to update price quotes from the command line, 
+	you can do so by the following command
+      </para>
+      <para>
+	gnucash --add-price-quotes &lt;gnucash-file&gt;
+      </para>
+      
+      <para>
+	GnuCash 1.4 had a helper script for getting price quotes,
+	but this is no longer needed.
+      </para>
+</article>
+
+<!-- Local variables: -->
+<!-- sgml-parent-document: "gnucash.sgml" -->
+<!-- End: -->

doc/sgml/C/xacc-price-sources.sgml

@@ -1,13 +1,13 @@
-<ARTICLE ID="XACC-TICKER">
+<ARTICLE ID="xacc-price-sources">
 
 <ARTHEADER>
 <TITLE>Stock Ticker</TITLE>
 </ARTHEADER>
+<sect1>
+<TITLE>Price Sources </TITLE>
 
-<SECT1 ID="XACC-STOCKTICKER">
+<para><emphasis>THIS MATERIAL NEEDS TO BE REWRITTEN FOR 1.6!!!</emphasis
-
+</para>
-<TITLE>Stock Pricing and Ticker Symbols</TITLE>
-
 <PARA>GnuCash provides a somewhat rudimentary automated stock quote
 gathering system.
 If a GnuCash <LINK LINKEND="STOCKACCT">stock account</LINK> is

doc/sgml/C/xacc-userdocs.sgml

@@ -98,11 +98,7 @@
 
   </PARA>
 </LISTITEM>
-<LISTITEM>
-<PARA><LINK LINKEND="XACC-TICKER">Stock Ticker</LINK>
 
-  </PARA>
-</LISTITEM>
 <LISTITEM>
 <PARA><LINK LINKEND="XACC-DOUBLEENTRY">Using Double Entry</LINK>