[gnome-applets] [invest-applet] updated documentation, added section on new currency support
- From: Enrico Minack <eminack src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-applets] [invest-applet] updated documentation, added section on new currency support
- Date: Mon, 2 Aug 2010 14:06:37 +0000 (UTC)
commit c6d7510c33249735b8b5ac2e24440155baa8e833
Author: Enrico Minack <enrico-minack gmx de>
Date: Mon Aug 2 15:41:58 2010 +0200
[invest-applet] updated documentation, added section on new currency support
invest-applet/docs/C/invest-applet.xml | 262 +++++++++++++++++++++++---------
invest-applet/docs/symbol-search.png | Bin 0 -> 44264 bytes
2 files changed, 187 insertions(+), 75 deletions(-)
---
diff --git a/invest-applet/docs/C/invest-applet.xml b/invest-applet/docs/C/invest-applet.xml
index ee10dad..1692070 100644
--- a/invest-applet/docs/C/invest-applet.xml
+++ b/invest-applet/docs/C/invest-applet.xml
@@ -2,9 +2,9 @@
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
<!ENTITY legal SYSTEM "legal.xml">
- <!ENTITY appversion "2.20.0">
+ <!ENTITY appversion "2.32.0">
<!ENTITY manrevision "1.0">
- <!ENTITY date "December 2007">
+ <!ENTITY date "August 2010">
<!ENTITY app "Invest">
<!ENTITY panel-help SYSTEM "/usr/share/gnome/help/user-guide/C/user-guide.xml">
]>
@@ -26,7 +26,6 @@
<title>&app; Manual</title>
<copyright>
-
<year>2004</year>
<year>2005</year>
<holder>Raphael Slinckx</holder>
@@ -35,6 +34,10 @@
<year>2007</year>
<holder>Terrence Hall</holder>
</copyright>
+ <copyright>
+ <year>2010</year>
+ <holder>Enrico Minack</holder>
+ </copyright>
@@ -57,7 +60,6 @@
<authorgroup>
<author>
<firstname></firstname>
-
<surname>GNOME Documentation Team</surname>
</author>
<author>
@@ -65,6 +67,11 @@
<surname>Hall</surname>
<affiliation><address><email>teebob21 gmail com</email></address></affiliation>
</author>
+ <author>
+ <firstname>Enrico</firstname>
+ <surname>Minack</surname>
+ <affiliation><address><email>enrico-minack gmx de</email></address></affiliation>
+ </author>
<!-- This is appropriate place for other contributors: translators,
maintainers, etc. Commented out by default.
@@ -81,19 +88,6 @@
-->
</authorgroup>
- <releaseinfo revision="2.26" role="review"/>
-
- <revhistory>
- <revision>
- <revnumber></revnumber>
- <date></date>
- <revdescription>
- <para role="author">Terrence Hall</para>
- <para role="publisher">Google Highly Open Participation Project</para>
- </revdescription>
- </revision>
- </revhistory>
-
<releaseinfo>This manual describes version &appversion; of &app;.
</releaseinfo>
@@ -128,44 +122,38 @@
<title>Introduction</title>
<para>
- The <application>&app;</application> GNOME panel applet downloads current stock quotes from Yahoo! Finance and displays the quotes in a drop-down list.
+ The <application>&app;</application> GNOME panel applet downloads current quotes for stocks, stock indices, currencies and precious metals. Quotes are downloaded from <ulink url="http://finance.yahoo.com";>Yahoo! Finance</ulink> and are displayed in a drop-down list.
</para>
<para>
- <application>&app;</application> displays the following information for each stock symbol that is defined in the applet preferences:
+ <application>&app;</application> provides the following features:
</para>
-
<itemizedlist>
<listitem>
-
<para>
- The stock symbol that represents a company
+ Retrieve quotes for any stock, stock index, currency or precious metal known by <ulink url="http://finance.yahoo.com";>Yahoo! Finance</ulink>
</para>
</listitem>
<listitem>
<para>
- The current share price quote (delayed 15 minutes)
+ Quotes are automatically updated every 15 minutes
</para>
-
</listitem>
<listitem>
<para>
- The change in the stock price over the last day.
+ The current price, today's change, and a chart of today's changes are displayed
</para>
</listitem>
<listitem>
<para>
- A graph of recent changes
+ The currency of the quote is displayed, and if configured, automatically translated into a target currency
</para>
</listitem>
<listitem>
<para>
- The amount of the increase or decrease in the price
- since purchase
+ The amount of the increase or decrease in the price since purchase, also translatable into the target currency
</para>
-
</listitem>
<listitem>
-
<para>
The percentage increase or decrease in the price since purchase
</para>
@@ -199,83 +187,145 @@
<sect1 id="invest-applet-usage">
<title>Using &app; </title>
-
- <sect2 id="invest-applet-add-stocks">
+ <para>Before the applet can provide you with recent quotes, you have
+ to configure it. Quotes can come from different stock exchange
+ centers around the world, so the prices can have different currencies.
+ The automatic translation of currencies can be configured, as well as the translation
+ of your purchases done in different countries. Finally, charts are
+ available for each of your configured quote.
+ </para>
+
+ <sect2 id="invest-applet-configure-quotes">
+ <title>Configure your Quotes</title>
- <title>Add Company Stock Quotes to the Applet</title>
+ <sect3 id="invest-applet-add-stocks">
+
+ <title>Add New Quotes to the Applet</title>
<para>
- To add stock symbols to <application>&app;</application>, perform the following steps:
+ To add new quotes to <application>&app;</application>, perform the following steps:
</para>
<orderedlist>
<listitem>
<para>
Right-click on the icon, and select <guilabel>Preferences</guilabel>.
</para>
-
</listitem>
<listitem>
<para>
- Click <guilabel>Add</guilabel> to add a stock to <application>&app;</application>.
+ Click <guilabel>Add</guilabel> to add a quote to <application>&app;</application>.
</para>
</listitem>
<listitem>
-
<para>
- The default stock symbol is GOOG. Double-click the stock symbol to change the listing.
+ The default quote is GOOG. It is initially selected for editing so that you can instantly change it.
+ Enter the <guilabel>Symbol</guilabel> of the quote here. If you do not know the symbol
+ of your desired quote, see below.
</para>
</listitem>
<listitem>
<para>
- You can also edit the number of shares you own in the
- stock, the purchase price and the commission.
+ Then, click on the <guilabel>Label</guilabel> of the quote and type its proper name.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ You can also edit the number of shares you own, the purchase price and the commission.
</para>
</listitem>
<listitem>
<para>
- Click <guilabel>Close</guilabel> when you are finished adding stock symbols.
+ Click <guilabel>Close</guilabel> when you are finished adding quotes.
</para>
-
</listitem>
- </orderedlist>
- </sect2>
- <sect2 id="invest-applet-to-view-stocks">
- <title>View Selected Stocks</title>
- <para>To view your selected stocks, click on the <application>&app;</application> icon on the panel. A list of your stocks will appear. To close the list, click the icon again.
+ </orderedlist>
+ <para>
+ If you do not know the actual symbol of your quote, go to <ulink url="http://finance.yahoo.com/";>http://finance.yahoo.com/</ulink>.
+ Enter the name of the quote in the text field in the upper-left corner of the screen. While typing, it will list
+ you matching quotes. The first column depicts the symbol of the quote, the second column shows the name,
+ and in the third column, the stock exchange of the quote is listed. The currency of the quote may vary among
+ different stock exchange centers, depending on their respective countries. Below, you can see a screenshot of
+ searching for the "yahoo" quote.
+ </para>
+
+ <para>
+ <mediaobject><imageobject>
+ <imagedata format="PNG" fileref="../symbol-search.png"/>Screenshot of Yahoo! Finance when searching a quote.
+ </imageobject></mediaobject>
+ </para>
+
+ <para>
+ &app; supports all quotes that can be found at <ulink url="http://finance.yahoo.com/";>Yahoo! Finance</ulink>.
+ In particular, these are of the following type.
+ </para>
+ <formalpara>
+ <title>Stocks, Bonds and Securities</title>
+ <para> These are the majority of quotes that are available. Search or browse on
+ <ulink url="http://finance.yahoo.com/";>Yahoo! Finance</ulink> to find out what is there.
+ </para>
+ </formalpara>
+ <formalpara>
+ <title>Stock Indices</title>
+ <para> All quotes that start with an ^ are actually indices, a quote that represents a number of other quotes' performance.
+ Examples are the Dow Jones Industrial Average (<ulink url="http://finance.yahoo.com/q?s=^DJI";>^DJI</ulink>) and the
+ NASDAQ Composite (<ulink url="http://finance.yahoo.com/q?s=^IXIC";>^IXIC</ulink>).
+ </para>
+ </formalpara>
+ <formalpara>
+ <title>Currencie rates</title>
+ <para> Exchange rates between any two currencies are also available. The respective symbol is constructured as follows.
+ Currency AAA in currency BBB, or in other words, how much does currency AAA cost in currency BBB, has the symbol AAABBB=X.
+ If you want to know how much EUR you get for one USD (how much does one USD cost in EUR),
+ you choose <ulink url="http://finance.yahoo.com/q?s=usdeur%3DX";>USDEUR=X</ulink>.
+ You can find more information at the <ulink url="http://finance.yahoo.com/currency-investing";>currency page of Yahoo! Finance</ulink>.
+ Currencies are represented using their <ulink url="http://en.wikipedia.org/wiki/Currency_code";>ISO 4217 currency code</ulink>.
+ </para>
+ </formalpara>
+ <formalpara>
+ <title>Precious Metals</title>
+ <para>
+ The <ulink url="http://en.wikipedia.org/wiki/Currency_code";>ISO 4217 currency code</ulink> also
+ lists precious metals as currencies. These are Gold, Silver, Palladium and Platinum. Their
+ currency code starts with X, followed by their chemical symbol: XAU, XAG, XPD, and XPT, respectively.
+ With those currency codes, the rate of precious metals in any currency are available via the currency rates described above.
+ To give an example, Gold in USD has the symbol <ulink url="http://finance.yahoo.com/q?s=XAUUSD%3DX";>XAUUSD=X</ulink>.
+ You can even get the reverse (<ulink url="http://finance.yahoo.com/q?s=USDXAU%3DX";>USDXAU=X</ulink>):
+ how much Gold measured in troy ounce do you get for one USD?
+ </para>
+ </formalpara>
+ </sect3>
+ <sect3 id="invest-applet-to-view-stocks">
+ <title>View Configured Quotes</title>
+ <para>To view your configured quotes, click on the <application>&app;</application> icon on the panel. A list of your quotes will appear. To close the list, click the icon again. Notice that quotes are usually 15 minutes delay.
</para>
- </sect2>
+ </sect3>
- <sect2 id="invest-applet-to-refresh-stocks">
+ <sect3 id="invest-applet-to-refresh-stocks">
<title>Update the Display</title>
<para>To immediately update the information that is displayed in the applet, right-click on the applet, then choose <guilabel>Refresh</guilabel>.
</para>
- </sect2>
- <sect2 id="invest-applet-to-remove-stocks">
- <title>Remove Company Stock Quotes from the Applet</title>
-
+ </sect3>
+ <sect3 id="invest-applet-to-remove-stocks">
+ <title>Remove Quotes from the Applet</title>
<para>
-
- To remove stock symbols from <application>&app;</application>, perform the following steps:
+ To remove quotes from <application>&app;</application>, perform the following steps:
</para>
<orderedlist>
<listitem>
<para>
Right-click on the icon, and select <guilabel>Preferences</guilabel>.
</para>
-
</listitem>
-
<listitem>
<para>
- Click the row containing the ticker symbol you wish to remove.
+ Click the row containing the quote you wish to remove.
</para>
</listitem>
<listitem>
<para>
Click <guilabel>Remove</guilabel> to delete the listing.
</para>
-
</listitem>
<listitem>
<para>
@@ -283,44 +333,107 @@
</para>
</listitem>
</orderedlist>
- </sect2>
- <sect2 id="invest-applet-stock-charts-options">
+ </sect3>
+ </sect2>
+
+ <sect2 id="invest-applet-configure-currencies">
+ <title>Setup Currency Translation</title>
+ <para>&app; displays all quotes in their original currency as retrieved from Yahoo! Finance.
+ If you wish to have all quotes being displayed in one target currency, this can be configured
+ in the preferences dialog.
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Right-click on the icon, and select <guilabel>Preferences</guilabel>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Type the target currency into the <guilabel>Currency</guilabel> text field.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ While you type, the text field will suggest currencies that match entered currency.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Choose your target currency.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Notice that in your quote list the new <guilabel>Currency Rate</guilabel> column appears.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ For all purchases where the <guilabel>Price</guilabel> and <guilabel>Commission</guilabel>
+ are given in original currency, the exchange rate at the time of purchase from the origin currency
+ to the target currency has to be given in the <guilabel>Currency Rate</guilabel> field.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click <guilabel>Close</guilabel> when you are finished.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ Lets look at this example: You bought one Yahoo! share (YHOO) for 10.00 USD at a currency rate of
+ 0.75 EUR per USD. In other words, the share cost 7.50 EUR. You further paid 5.00 USD comission,
+ equivalent to 3.75 EUR. When you set the target currency to EUR, you either have to enter the
+ EUR (target currency) values and keep the <guilabel>Currency Rate</guilabel> at 0.00, or you enter
+ the USD (original currency) values and enter the EUR per USD exchange rate
+ (<ulink url="http://finance.yahoo.com/q?s=eurusd%3DX";>USDEUR=X</ulink>).
+ </para>
+ <tip>
+ <para>The <guilabel>Price</guilabel> and <guilabel>Commission</guilabel> both have to be given in the same currency.
+ </para>
+ </tip>
+ <para>If you want to remove the target currency again, simply clear the <guilabel>Currency</guilabel> text field.
+ </para>
+ </sect2>
+ <sect2 id="invest-applet-stock-charts-options">
<title>Chart Options</title>
- <para>To use the financial charts, view the list of selected stocks, and double-click the stock that you wish to chart. The chart parameters can be customized by clicking <guilabel>Options</guilabel>.
+ <para>For each quote in your list, a financial chart is available. To open the financial chart, view the list of configured quotes, and double-click the quote that you wish to chart. The chart parameters can be customized by clicking <guilabel>Options</guilabel>.
</para>
<sect3 id="invest-applet-stock-chart-options-date">
<title>Date Range</title>
<para>
The date range, in the top-right corner of the window,
- selects the length of time to report on. By default it gives one
- day of data, but it can be extended out to three years.
+ selects the length of time to report on. By default, it gives one
+ day of data, but the following ranges can be choosen: <guilabel>Today</guilabel>, <guilabel>5 Days</guilabel>,
+ <guilabel>3 Months</guilabel>, <guilabel>6 Months</guilabel>, <guilabel>1 Year</guilabel>,
+ <guilabel>5 Years</guilabel>, <guilabel>Maximum</guilabel>.
</para>
</sect3>
<sect3 id="invest-applet-stock-chart-options-graph">
<title>Graph Style</title>
<para>
- Historical price information can be graphed in three different ways. You can select a line chart, bar chart, or candlestick chart.
+ Historical price information can be graphed in three different ways.
+ You can select a line chart, bar chart, or candlestick chart.
</para>
<itemizedlist>
<listitem>
<para>
-
- <guilabel>Line Chart</guilabel>
+ <guilabel>Line Chart</guilabel> (<guilabel>l</guilabel>)
</para>
- <para>This is the default option. This graphs the historical price information in a familiar manner, connecting each day's closing price in a with a single line for each stock. Line charts for graphing stock prices are useful if an analyst is interested only in a share's closing price each time.</para>
+ <para>This is the default option. This graphs the historical price information in a familiar manner, connecting each day's closing price with a single line. Line charts for graphing quotes are useful if an analyst is interested only in a closing price each time.</para>
</listitem>
<listitem>
<para>
- <guilabel>Bar Chart</guilabel>
-
+ <guilabel>Bar Chart</guilabel> (<guilabel>b</guilabel>)
</para>
- <para>A bar chart represents a full day's activity with a single vertical bar.The top of the vertical line indicates the highest price a security traded at during the day, and the bottom represents the lowest price. The closing price is displayed on the right side of the bar, and the opening price is shown on the left side of the bar. One bar represents one day of trading.</para>
+ <para>A bar chart represents a full day's activity with a single vertical bar. The top of the vertical line indicates the highest price a security traded during the day, and the bottom represents the lowest price. The closing price is displayed on the right side of the bar, and the opening price is shown on the left side of the bar. One bar represents one day of trading.</para>
</listitem>
<listitem>
<para>
- <guilabel>Candlestick Chart</guilabel>
+ <guilabel>Candlestick Chart</guilabel> (<guilabel>c</guilabel>)
</para>
<para>A candlestick chart in which the open and close prices are represented as the top and bottom of a rectangle surrounding a vertical line connecting the high and low prices. The body of the rectangle is filled if the closing price is lower than the opening price and is left blank if the closing price is higher than the opening price.</para>
@@ -330,7 +443,7 @@
<sect3 id="invest-applet-stock-chart-options-ma">
<title>Moving Average</title>
<para>
- A moving average is a statistical series of a security's closing prices throughout consecutive trading days. It is typically shown in the same graph as a line chart to indicate trends in share prices.
+ A moving average is a statistical series of a security's closing prices throughout consecutive trading days. It is typically shown in the same graph as a line chart to indicate trends in prices.
</para>
</sect3>
@@ -342,9 +455,8 @@
</sect3>
<sect3 id="invest-applet-stock-chart-options-overlays">
<title>Overlays</title>
-
<para>
- Overlays allow you to graph multiple statistical measurements onto a single chart. For example, you can compare the performance of a single stock against that of an index such as the NASDAQ or the DJIA.
+ Overlays allow you to graph multiple statistical measurements onto a single chart. For example, you can compare the performance of a single quote against that of an index such as the NASDAQ or the DJIA.
</para>
</sect3>
<sect3 id="invest-applet-stock-chart-options-indicators">
diff --git a/invest-applet/docs/symbol-search.png b/invest-applet/docs/symbol-search.png
new file mode 100644
index 0000000..80726a3
Binary files /dev/null and b/invest-applet/docs/symbol-search.png differ
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
