gnucash-docs maint: Replace "Online Quote Setup" instructions in Guide by links to the manual chapter
Frank H.Ellenberger
fell at code.gnucash.org
Thu Oct 27 02:57:01 EDT 2022
Updated via https://github.com/Gnucash/gnucash-docs/commit/7a108b11 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/2f410033 (commit)
commit 7a108b111e9ccc2516ad621233554406f415ba85
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Tue Oct 25 23:33:15 2022 +0200
Replace "Online Quote Setup" instructions in Guide by links to the
manual chapter
https://lists.gnucash.org/logs/2022/10/14.html#T15:47:06
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index e2ebd417..c0154306 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -792,7 +792,7 @@ Income
<note>
<para>If the <guibutton>Get Online Quotes</guibutton> button is not highlighted, and it is not tickable,
then the &app-fq; package is not installed.
- See the section on <xref linkend="invest-stockprice-auto-install3"/>.
+ See the chapter <ulink url="&url-docs;C/gnucash-help/finance-quote.html">Setting Up the Quote Retrieval</ulink> in the manual.
</para>
</note>
@@ -1267,79 +1267,11 @@ Income
be installed in order to activate this feature.
</para>
- <para>To determine if the <application>Perl</application> module &app-fq;
- is already installed on your system, type <command>perldoc Finance::Quote</command> in a
- terminal window and check to see if there is any documentation available. If you see the
- documentation, then the module is installed, if you do not see the documentation, then it
- has not been installed.
+ <para>See the chapter
+ <ulink url="&url-docs;C/gnucash-help/finance-quote.html">Setting Up the Quote Retrieval</ulink>
+ in the manual.
</para>
- <sect3 id="invest-stockprice-auto-install3">
- <title>Installing &app-fq;</title>
- <para>The process of installing &app-fq; depends on the system. </para>
-
- <procedure>
- <title>Installing &app-fq; on &lin;</title>
- <step><simpara>Close &app;.</simpara></step>
- <step><simpara>Run the command <command>which gnc-fq-update</command> to check <filename>gnc-fq-update</filename> program is in your PATH environment
- variable.<footnote><simpara>If you’ve installed &app; packages provided by your distribution, <filename>gnc-fq-update</filename> must be on your PATH.</simpara></footnote>
- </simpara>
- <substeps><step id="gnc-fq-update-not-found">
- <simpara>If <filename>gnc-fq-update</filename> is not in your PATH, search the folder where &app; is installed.</simpara>
- </step>
- </substeps>
- </step>
- <step><simpara>Run the command <command>sudo gnc-fq-update</command> or <command>su -c gnc-fq-update</command> in order to run it with root privilege.
- It depends on your distribution.
- If <filename>gnc-fq-update</filename> is not in your PATH, specify full path of <filename>gnc-fq-update</filename>
- instead, which is found by <xref linkend="gnc-fq-update-not-found" />.</simpara>
- <para>
- This will launch a <application>Perl</application> <acronym><ulink url="https://www.cpan.org/">CPAN</ulink></acronym><footnote>
- <simpara>See <ulink url="https://www.cpan.org/misc/cpan-faq.html">CPAN Frequently Asked Questions</ulink> for details.</simpara></footnote>
- module internally. When you launch the CPAN module for the first time, you must setup and configure it. However, on the most systems if you accept the default settings
- or answer the first question <computeroutput>Are you ready for manual
- configuration? [yes]</computeroutput> with <userinput>no</userinput>, you will be able to install &app-fq; successfully. </para>
- </step>
-
- <step><simpara>Run <command>gnc-fq-dump</command> to check &app-fq; works properly.</simpara></step>
- </procedure>
-
-
- <procedure>
- <title>Installing &app-fq; on &mac;</title>
- <step><simpara>Close &app;.</simpara></step>
- <step><simpara>Install Xcode if it is not installed.</simpara>
- <simpara>XCode is an optional item from your &mac; distribution DVD.</simpara>
- </step>
- <step><simpara>Run the <emphasis>Update Finance Quote</emphasis> app in the &app; dmg.</simpara> <para>You can run it from the dmg or copy it to the same
- folder to which you copied &app;.
- It will open a Terminal window and run a script for you
- which will ask lots of questions. Accept the default for each unless you know what
- you’re doing.
- </para>
- </step>
- </procedure>
-
- <procedure>
- <title>Installing &app-fq; on &win;</title>
- <step><simpara>Close &app;.</simpara></step>
- <step><simpara>Run <menuchoice>
- <guimenu>Start</guimenu>
- <guisubmenu>&app;</guisubmenu>
- <guimenuitem>Install Online Price Retrieval</guimenuitem></menuchoice>.
- </simpara>
- </step>
- </procedure>
-
- <note>
- <para>If you feel uncomfortable about performing any of these steps, please either email the &app;-user
- mailing list (<email>gnucash-user at gnucash.org</email>) for help or come to the &app; IRC
- channel on irc.gnome.org. You can also leave out this step and manually update your
- stock prices.
- </para>
- </note>
- </sect3>
-
<sect3 id="invest-stockprice-auto-configure3">
<title>Configuring Securities for Online Quotes</title>
@@ -1357,55 +1289,15 @@ Income
to return to the <guilabel>Price Database</guilabel> and click on the <guibutton>Get
Quotes</guibutton> button to update your stock prices on the Internet.
</para>
-
- <para>The command <command>gnucash-cli --quotes get <filename><replaceable>${HOME}/gnucash-filename</replaceable></filename></command><footnote>
- <simpara>The Online Quotes Retrieval command has been changed from &app; 4.0. The old command
- <command>gnucash --add-price-quotes <filename><replaceable>${HOME}/gnucash-filename</replaceable></filename></command> is still available, but it is deprecated and will be removed in the future release.
- If you've upgraded from &app; 3.11 or previous version, it is recommended to use the new command <command>gnucash-cli</command>.</simpara>
- </footnote> can be used to
- fetch the current prices of your stocks. The file specified
- <filename><replaceable>${HOME}/gnucash-filename</replaceable></filename> will depend on the name and
- location of your data file. This can be determined by the name displayed in the top frame
- of the &app; window, before the <quote>-</quote>. The file name can also be found under
- <guimenu>File</guimenu> in the recently opened file list; the first item, numbered 1, is
- the name of the currently open file.
- </para>
-
-
</sect3>
<sect3 id="invest-stockprice-auto-scheduler">
<title>Configuring for Getting Online Quotes Periodically</title>
- <para>You have to register the <command>gnucash-cli</command> with a scheduler in order to get Online Quotes automatically and periodically.
- The method depends on your OS. For example, suppose you want to update
- your file on 16:00 on every Friday.
- </para>
-
- <procedure>
- <title>Register <command>gnucash-cli</command> with <application>cron</application> on &lin; and &mac;</title>
- <step><simpara>Run <command>crontab -e</command>.</simpara></step>
- <step><para>Add the following line to your crontab:
- <informalexample>
- <screen>0 16 * * 5 gnucash-cli --quotes get <replaceable>${HOME}/gnucash-filename</replaceable> > /dev/null 2>&1</screen>
- </informalexample></para>
- </step>
- </procedure>
-
- <procedure>
- <title>Register <command>gnucash-cli</command> with Task Scheduler on &win;</title>
- <step><simpara>Select <menuchoice><guimenu>Start</guimenu><guisubmenu>Windows Administrative Tools</guisubmenu><guimenuitem>Task Scheduler</guimenuitem></menuchoice>.</simpara></step>
- <step><simpara>Select <guimenuitem>Create Task</guimenuitem>.</simpara></step>
- <step><simpara>Enter the appropirate items on <guilabel>Create Task</guilabel> Window.</simpara></step>
- </procedure>
-
- <para>See <ulink url="&url-docs-C;help/acct-create.html#Online-price-setup">GnuCash Help Manual</ulink> and <ulink url="&url-wiki-OQ;#Updating_enabled_Quotes_from_outside_GnuCash">Online Quotes Page on GnuCash Wiki</ulink> for more details.
- </para>
-
- <para>Remember that Mutual Fund <quote>prices</quote> are really <quote>Net Asset Value</quote> and
- require several hours after the exchange closes before being available. If
- <acronym>NAV</acronym>s are downloaded before the current days <acronym>NAV</acronym>s are
- determined, yesterday’s <acronym>NAV</acronym>s are retrieved.
+ <para>After you have verified the proper fetching of Online Quotes for your commodities,
+ you can tell your operating system to fetch the quotes periodically. See the section
+ <ulink url="&url-docs;C/gnucash-help/finance-quote-scheduler.html">Configuring for Getting Quotes Periodically</ulink>
+ in the manual.
</para>
</sect3>
</sect2>
Summary of changes:
guide/C/ch_invest.xml | 124 ++++----------------------------------------------
1 file changed, 8 insertions(+), 116 deletions(-)
More information about the gnucash-changes
mailing list