From d65a0b591a11abc110bc8c0a4562082fe0d82b8c Mon Sep 17 00:00:00 2001 From: Victor Kareh Date: Wed, 18 Jun 2025 14:12:58 -0400 Subject: invest: Bring back the invest applet The original invest applet was dropped in https://github.com/mate-desktop/mate-applets/commit/41f7b7a2a38ca9f3929fcbd88d228b3815034876 due to a broken API. This brings it back using the modern JSON version of the Yahoo Finance API, a rewrite from Python to C, and a simplified interface (i.e. instead of the full portfolio management app, I simplified it into a stock ticker price tracker). --- invest-applet/docs/C/figures/symbol-search.png | Bin 0 -> 44264 bytes invest-applet/docs/C/index.docbook | 389 +++++++++++++++++++++++++ invest-applet/docs/C/legal.xml | 76 +++++ 3 files changed, 465 insertions(+) create mode 100644 invest-applet/docs/C/figures/symbol-search.png create mode 100644 invest-applet/docs/C/index.docbook create mode 100644 invest-applet/docs/C/legal.xml (limited to 'invest-applet/docs/C') diff --git a/invest-applet/docs/C/figures/symbol-search.png b/invest-applet/docs/C/figures/symbol-search.png new file mode 100644 index 00000000..80726a38 Binary files /dev/null and b/invest-applet/docs/C/figures/symbol-search.png differ diff --git a/invest-applet/docs/C/index.docbook b/invest-applet/docs/C/index.docbook new file mode 100644 index 00000000..d5bfcf0b --- /dev/null +++ b/invest-applet/docs/C/index.docbook @@ -0,0 +1,389 @@ + + + + + + + +]> + + + + + +
+ + + + &app; Manual + + + 2015 + MATE Documentation Project + + + 2004 + 2005 + Raphael Slinckx + + + 2007 + Terrence Hall + + + 2010 + Enrico Minack + + + + + + + + MATE Documentation Project + + + GNOME Documentation Project + + + &legal; + + + + + + MATE Documentation Team + + + + GNOME Documentation Team + + + Terrence + Hall +
teebob21@gmail.com
 + + + Enrico + Minack +
enrico-minack@gmx.de
 + + + + + + + + &app; V&manrevision; + &date; + + MATE Documentation Team + MATE Documentation Project + + + + + This manual describes version &appversion; of &app;. + + + + Feedback + + + To report a bug or make a suggestion regarding the &app; application or this manual, follow the directions in the MATE Feedback Page. + + + + + + + User manual for &app; + + + + + + + Invest + + + invest-applet + + + + + + + Introduction + + + The &app; MATE panel applet downloads current quotes for stocks, stock indices, currencies and precious metals. Quotes are downloaded from Yahoo! Finance and are displayed directly in the panel with automatic cycling through multiple stocks. + + + &app; provides the following features: + + + + + Retrieve quotes for any stock, stock index, currency or precious metal known by Yahoo! Finance + + + + + Quotes are automatically updated every 15 minutes (configurable from 1-60 minutes) + + + + + Current stock symbol, price, and percentage change are displayed directly in the panel + + + + + Direction indicator icons show whether stocks are up, down, or neutral + + + + + Multiple stocks automatically cycle through the display every 5 seconds (configurable from 1-60 seconds) + + + + + Click on the applet to manually cycle to the next configured stock + + + + + Tooltip shows summary of all configured stocks with current prices and changes + + + + + + + + Getting Started + + + + + Add &app; to a Panel + To add &app; to a MATE panel, right-click on the panel, then choose Add to Panel. Select &app; in the Add to Panel dialog, then click OK. Click Close when finished. + + + Remove &app; From a Panel + To remove &app; from a MATE panel, right-click on the icon, then choose Remove From Panel. + + + More Information + More information about the MATE panel can be found in the MATE Panel documentation. + + + + + + + + + Using &app; + Before the applet can provide you with recent quotes, you have + to configure it with stock symbols. Once configured, the applet will + display stock information directly in the panel and automatically cycle + through multiple stocks. You can click on the applet to manually advance + to the next stock, or right-click for options to refresh data and configure preferences. + + + + Configure your Quotes + + + + Add New Quotes to the Applet + + + To add new quotes to &app;, perform the following steps: + + + + + Right-click on the applet icon, and select Preferences. + + + + + In the Stock symbols field, enter the symbols of the stocks you want to track, separated by commas. For example: AAPL,GOOGL,MSFT + + + + + Optionally, configure the Refresh interval (how often to download new quotes, in seconds). + + + + + Optionally, configure the Cycle interval (how often to cycle through different stocks in the display, in seconds). + + + + + Click OK when you are finished configuring. + + + + + If you do not know the actual symbol of your quote, go to http://finance.yahoo.com/. + 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. + + + + + + + Screenshot of Yahoo! Finance when searching a quote. + + + + &app; supports all quotes that can be found at Yahoo! Finance. + In particular, these are of the following type. + + + Stocks, Bonds and Securities + These are the majority of quotes that are available. Search or browse on + Yahoo! Finance to find out what is there. + + + + Stock Indices + 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 (^DJI) and the + NASDAQ Composite (^IXIC). + + + + Currencie rates + 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 USDEUR=X. + You can find more information at the currency page of Yahoo! Finance. + Currencies are represented using their ISO 4217 currency code. + + + + Precious Metals + + The ISO 4217 currency code 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 XAUUSD=X. + You can even get the reverse (USDXAU=X): + how much Gold measured in troy ounce do you get for one USD? + + + + + View Configured Quotes + Your configured quotes are displayed directly in the panel next to the direction indicator icon. The display shows the current stock symbol and price (e.g., "AAPL: $150.25"). If you have multiple stocks configured, they will automatically cycle through the display. You can also click on the applet to manually advance to the next stock. Hover over the applet to see a tooltip with all configured stocks and their current prices and changes. + + + + + + Update the Display + To immediately update the information that is displayed in the applet, right-click on the applet, then choose Refresh. + + + + Remove Quotes from the Applet + + To remove quotes from &app;, perform the following steps: + + + + + Right-click on the applet icon, and select Preferences. + + + + + In the Stock symbols field, edit the comma-separated list to remove the symbols you no longer want to track. + + + + + Click OK when you are finished. + + + + + + + + Display Behavior + &app; displays quotes directly in the panel and automatically cycles through multiple stocks if configured. The applet shows: + + + + + Direction Icon - Shows an up arrow (green) for positive change, down arrow (red) for negative change, or neutral icon for no change + + + + + Stock Information - Displays the current stock symbol and price (e.g., "AAPL: $150.25") + + + + + Automatic Cycling - If multiple stocks are configured, the display automatically cycles through them every few seconds + + + + + Manual Cycling - Click on the applet to manually advance to the next stock + + + + + Tooltip Summary - Hover over the applet to see a tooltip with all configured stocks, their current prices, and percentage changes + + + + Quotes are displayed in their original currency as retrieved from Yahoo! Finance. The current version does not support currency conversion or portfolio tracking features. + + +
+ diff --git a/invest-applet/docs/C/legal.xml b/invest-applet/docs/C/legal.xml new file mode 100644 index 00000000..9c4e2480 --- /dev/null +++ b/invest-applet/docs/C/legal.xml @@ -0,0 +1,76 @@ + + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation + License (GFDL), Version 1.1 or any later version published + by the Free Software Foundation with no Invariant Sections, + no Front-Cover Texts, and no Back-Cover Texts. You can find + a copy of the GFDL at this link or in the file COPYING-DOCS + distributed with this manual. + + This manual is part of a collection of MATE manuals + distributed under the GFDL. If you want to distribute this + manual separately from the collection, you can do so by + adding a copy of the license to the manual, as described in + section 6 of the license. + + + + Many of the names used by companies to distinguish their + products and services are claimed as trademarks. Where those + names appear in any MATE documentation, and the members of + the MATE Documentation Project are made aware of those + trademarks, then the names are in capital letters or initial + capital letters. + + + + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED + UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE + WITH THE FURTHER UNDERSTANDING THAT: + + + + DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR + IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES + THAT THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR + A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE + RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE + OF THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR + MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, + YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY + CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY + SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER + OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS + LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED + VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER + EXCEPT UNDER THIS DISCLAIMER; AND + + + + UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL + THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), + CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, + INITIAL WRITER, ANY CONTRIBUTOR, OR ANY + DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION + OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH + PARTIES, BE LIABLE TO ANY PERSON FOR ANY + DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR + CONSEQUENTIAL DAMAGES OF ANY CHARACTER + INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS + OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR + MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR + LOSSES ARISING OUT OF OR RELATING TO USE OF THE + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, + EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF + THE POSSIBILITY OF SUCH DAMAGES. + + + + + + -- cgit v1.2.1