gnucash-docs maint: Multiple changes pushed
Frank H.Ellenberger
fell at code.gnucash.org
Tue Aug 23 16:42:35 EDT 2022
Updated via https://github.com/Gnucash/gnucash-docs/commit/e9c1ba53 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/f46bcae4 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/02e0073f (commit)
via https://github.com/Gnucash/gnucash-docs/commit/c2ad2a29 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/414840da (commit)
commit e9c1ba53adce3440ac337379870140e0d20f2c6f
Author: Christian Wehling <christian.wehling at web.de>
Date: Sat Aug 6 15:32:13 2022 +0200
L10N:de: manual ch_Finance-Quote: Hilfsskripte
ein neuer Abschnitt mit der Beschreibung der gnc-fq-*- Perl-Skripte.
diff --git a/manual/de/ch_Finance-Quote.xml b/manual/de/ch_Finance-Quote.xml
index 0ff46a14..6475c8a4 100644
--- a/manual/de/ch_Finance-Quote.xml
+++ b/manual/de/ch_Finance-Quote.xml
@@ -14,13 +14,15 @@ Translators:
-->
<chapter id="finance-quote"
xmlns:xi="http://www.w3.org/2001/XInclude">
- <title>Einrichtung der Kursaktualisierung</title>
+ <title>Einrichten der Kursabfrage</title>
- <para>Wenn Sie mehr als ein paar Devisen und Wertpapiere besitzen, werden Sie es vielleicht bald leid
- sein, die Kurse ständig per Hand aktualisieren zu müssen. &app; bietet Ihnen die Möglichkeit,
- automatisch den aktuellsten Kurs für Ihre Devisen und Wertpapiere über das Internet
- herunterzuladen. Hierfür wird das &app-perl;-Modul &app-fq; verwendet.
- </para>
+ <abstract>
+ <para>Wenn Sie mehr als ein paar Devisen und Wertpapiere besitzen, werden Sie es vielleicht bald leid
+ sein, die Kurse ständig per Hand aktualisieren zu müssen. &app; bietet Ihnen die Möglichkeit,
+ automatisch den aktuellsten Kurs für Ihre Devisen und Wertpapiere über das Internet
+ herunterzuladen. Hierfür wird das &app-perl;-Modul &app-fq; verwendet.
+ </para>
+ </abstract>
<itemizedlist>
<title>Die Vorraussetzungen für eine Online-Kursabfrage mit &app-fq; sind</title>
@@ -49,16 +51,19 @@ Translators:
<sect1 id="finance-quote-perl-install">
<title>Installieren von &app-perl;</title>
- <para>Die Installation von &app-perl; ist im wesentlichen von dem verwendeten Betriebssystem abhängig.
- Der Aufwand zur Installation ist gering und wird in diesem Abschnitt beschrieben.
- </para>
+ <abstract>
+ <para>Abhängig von dem verwendeten Betriebssystem ist der Aufwand für die Installation von &app-perl;
+ schnell erledigt und wird in diesem Abschnitt beschrieben.
+ </para>
+ </abstract>
- <para>Um zu überprüfen ob auf Ihrem System &app-perl; schon bereits installiert ist, rufen Sie den Befehl
- <informalexample>
-<screen>perl -v</screen>
- </informalexample>
- im Terminal auf. Wird Ihnen die Versionsnummer des &app-perl;-Interpreters angezeigt, dann
- machen Sie mit <xref linkend="finance-quote-install" /> weiter.
+ <para>Um zu überprüfen ob auf Ihrem System &app-perl; bereits installiert ist, rufen Sie den Befehl
+ <userinput>perl -v</userinput> im Terminal auf.
+<screen language="console">$ perl -v
+This is perl 5, version 30, subversion 0 (v5.30.0) built for x86_64-linux-gnu-thread-multi
+</screen>
+ Wird Ihnen die Versionsnummer des &app-perl;-Interpreters angezeigt, dann überspringen Sie
+ die nächsten Angaben und fahren Sie stattdessen mit <xref linkend="finance-quote-install" /> fort.
</para>
<procedure>
@@ -120,15 +125,26 @@ Translators:
</para>
</step>
</procedure>
+
+ <tip>
+ <para>Es empfiehlt sich anschließend, das Verzeichnis in dem &app; installiert ist, unter &win;
+ z.B. <userinput>c:\Programme<replaceable> (x86)</replaceable>\gnucash\bin</userinput>, zu Ihrer
+ <envar>PATH</envar>-Umgebungsvariable hinzuzufügen. Auf diese Weise ist es für einfacher, bei Bedarf die
+ <xref linkend="finance-quote-helper" /> zu nutzen. Hierzu informieren Sie sich bitte in
+ den Unterlagen zu Ihrem Betriebssystem.
+ </para>
+ </tip>
</sect1>
<sect1 id="finance-quote-install">
<title>Installieren von &app-fq;</title>
- <para>Um festzustellen, ob das &app-perl;-Modul &app-fq; bereits auf Ihrem System installiert ist, geben
- Sie <command>perldoc Finance::Quote</command> in einem Terminalfenster ein. Wird Ihnen jetzt
+ <para>Um festzustellen, ob das &app-perl;-Modul &app-fq; bereits auf Ihrem System verfügbar ist, geben
+ Sie <userinput>perldoc Finance::Quote</userinput> in einem Terminalfenster ein. Wird Ihnen jetzt
eine Dokumentation in dieser Form
-<screen>NAME
+<screen language="console">
+$ perldoc Finance::Quote
+NAME
Finance::Quote - Get stock and mutual fund quotes from various exchanges
SYNOPSIS
@@ -152,33 +168,23 @@ SYNOPSIS
</step>
<step>
- <simpara>Führen Sie den Befehl <command>gnc-fq-check</command> aus, um zu überprüfen, ob das Programm
- bereits in einem Verzeichnis liegt, welches in der Umgebungsvariable PATH eingetragen ist.
+ <simpara>Führen Sie den Befehl <userinput>gnc-fq-check</userinput> aus, um zu überprüfen, ob das Programm
+ bereits in einem Verzeichnis liegt, welches in der Umgebungsvariable <envar>PATH</envar> eingetragen ist.
<footnote>
<simpara>Wenn Sie die von Ihrer Distribution bereitgestellten &app; Pakete installiert haben, sollte
- <filename>gnc-fq-check</filename> bereits in Ihrem PATH sein. Die Aktualität ihrer
+ <filename>gnc-fq-check</filename> bereits in Ihrem <envar>PATH</envar> sein. Die Aktualität ihrer
Distribution können Sie unter
<ulink url="&url-repo;perl:finance-quote/versions"><citetitle>&app-fq;-
Versionen</citetitle></ulink> nachlesen.
</simpara>
</footnote>
</simpara>
-
- <tip>
- <simpara>Wenn <command>gnc-fq-check</command> nicht in Ihrem PATH ist, vielleicht weil Sie die Anwendung
- selbst gebaut und dabei ungewöhnliche Pfade verwendet haben, suchen Sie den Ordner in
- dem &app; installiert ist, z.B. mit dem Befehl <command>which gnc-fq-check</command>,
- und wechseln in dieses Verzeichnis. Es bietet sich an, das aktuelle Verzeichnis in der
- PATH-Umgebungsvariable aufzunehmen. Hierzu informieren Sie sich bitte in den Unterlagen
- zu Ihrer Distribution.
- </simpara>
- </tip>
</step>
<step>
- <simpara>Als nächstes aktualisieren Sie mit <command>sudo gnc-fq-update</command> oder <command>su -c
- gnc-fq-update</command> mit Root-Rechten &app-fq;. Die richtige Syntax ist von der
- jeweiligen Distribution abhängig.
+ <simpara>Als nächstes aktualisieren Sie mit <userinput>sudo gnc-fq-update</userinput> oder
+ <userinput>su -c gnc-fq-update</userinput> mit Root-Rechten &app-fq;. Die richtige Syntax
+ ist von der jeweiligen Distribution abhängig.
</simpara>
<para>Dadurch wird ein internes &app-perl; <acronym><ulink url="&url-cpan;">CPAN</ulink></acronym>
@@ -188,15 +194,15 @@ SYNOPSIS
</simpara>
</footnote>
Modul gestartet um die Installation vorzunehmen. Wenn Sie das CPAN zum ersten Mal starten,
- müssen Sie es einrichten und konfigurieren. Auf den meisten Systemen können Sie jedoch
+ müssen Sie es konfigurieren, wobei Sie auf den meisten Systemen jedoch
die Standardvorgaben akzeptieren und die erste Frage <computeroutput>Are you ready for
- manual configuration? [yes]</computeroutput> mit <userinput>no</userinput> beantworten
+ manual configuration? [yes]</computeroutput> mit <userinput>no</userinput> beantworten können,
damit &app-fq; erfolgreich installiert wird.
</para>
</step>
<step>
- <simpara>Führen Sie <command>gnc-fq-check</command> aus, um zu prüfen, ob &app-fq; richtig installiert ist.
+ <simpara>Führen Sie <userinput>gnc-fq-check</userinput> aus, um zu prüfen, ob &app-fq; richtig installiert ist.
Wenn dies so ist, dann werden die Versionsnummer sowie die von &app-fq; verwendbaren
Quellen für eine Kursabfrage aufgelistet. Bei Problemen mit der Installation von &app-fq;
wird eventuell eine Lösung vorgeschlagen.
@@ -213,10 +219,12 @@ SYNOPSIS
</step>
<step>
- <simpara>Installieren Sie XCode, falls noch nicht geschehen.
- </simpara>
-
- <simpara>XCode ist ein optionales Element auf Ihrer &mac; Distributions-DVD.
+ <simpara>Installieren Sie &app-xcode;
+ <footnote>
+ <para>&app-xcode; ist ein optionales Element auf Ihrer &mac; Distributions-DVD, aber auch unter
+ <ulink url="&url-ap-dev;xcode/" /> ist das Werkzeug erhältlich.
+ </para>
+ </footnote>, falls noch nicht geschehen.
</simpara>
</step>
@@ -248,6 +256,205 @@ SYNOPSIS
</procedure>
</sect1>
+ <sect1 id="finance-quote-helper">
+ <title>Hilfsprogramme zur Symbolsuche und Aktualisierung</title>
+
+ <abstract>
+ <para>&app; stellt mehrere Hilfsprogramme zur Verfügung, die Sie bei der täglichen
+ Arbeit mit &app-fq; unterstützen. So gibt es ein Skript, mit dem Sie Ihre Symbole
+ für die Wertpapiere überprüfen können. Weitere Skripte führen die erstmalige
+ Installation durch oder halten &app-fq; auf einem aktuellen Stand.
+ Diese Programme haben Namen, die mit gnc-fq-* beginnen, und sind in der
+ Programmiersprache &app-perl; geschrieben.
+ </para>
+ </abstract>
+
+ <procedure>
+ <title>&app-perl; Skripts unter &win; ausführen</title>
+
+ <step>
+ <simpara>Öffnen Sie ein <application>CMD</application>- oder <application>Powershell
+ </application>-Fenster: Klicken Sie auf <guimenu>Start</guimenu>
+ und geben Sie entweder <userinput>cmd</userinput> oder <userinput>powershell</userinput>
+ ein und wählen Sie den entsprechenden Menüpunkt. Das muss nicht als Administrator ausgeführt werden.
+ </simpara>
+ </step>
+
+ <step>
+ <simpara>Wechseln Sie zu dem Laufwerk, das die &app; Programmdateien enthält —normalerweise das
+ Laufwerk C— wenn dies nicht bereits das aktuelle Laufwerk ist.
+ </simpara>
+ </step>
+
+ <step>
+ <simpara>Da, wie zuvor empfohlen, das &app;-Verzeichnis in die <envar>PATH</envar>
+ Umgebungsvariable eingetragen wurde, müssen Sie jetzt nur noch jedem gnc-fq-xxx
+ &app-perl; Skriptbefehl <quote>Perl</quote> und ein Leerzeichen voranstellen,
+ z.B. <userinput>perl gnc-fq-check</userinput>.
+ Andernfalls müssen Sie den Befehl in der Form <userinput>perl c:\Programme
+ <replaceable> (x86)</replaceable>\gnucash\bin\gnc-fq-check</userinput> ausführen.
+ </simpara>
+ </step>
+ </procedure>
+
+ <sect2 id="gnc-fq-check">
+ <title>gnc-fq-check</title>
+
+ <abstract>
+ <para>Dieses Programm liefert die Versionsnummer des derzeit installierten &app-fq; Moduls
+ sowie eine Liste der über &app-fq; verfügbaren Quellen. Es informiert Sie auch, wenn es ein Problem
+ mit Ihrer Installation gibt und schlägt eventuell eine Lösung vor.
+ </para>
+ </abstract>
+
+ <formalpara>
+ <title>Beispiel mit defekten Abhängigkeit zu weiteren Softwarepaketen</title>
+
+ <para>
+<screen language="console">
+$ gnc-fq-check
+Can't locate Mozilla/CA.pm in @INC (you may need to install the Mozilla::CA module) (@INC contains:
+/usr/lib/perl5/site_perl/5.30.1/x86_64-linux-thread-multi /usr/lib/perl5/site_perl/5.30.1
+/usr/lib/perl5/vendor_perl/5.30.1/x86_64-linux-thread-multi /usr/lib/perl5/vendor_perl/5.30.1
+/usr/lib/perl5/5.30.1/x86_64-linux-thread-multi /usr/lib/perl5/5.30.1 /usr/lib/perl5/site_perl)
+at /usr/lib/perl5/vendor_perl/5.30.1/Finance/Quote/Tiaacref.pm line 33.
+Compilation failed in require at (eval 303) line 1.
+BEGIN failed--compilation aborted at (eval 303) line 1.
+ at /usr/local/bin/gnc-fq-check line 91.
+("1.47" "adig" "aex" "aiahk" "alphavantage" "amfiindia" "asegr" "asia" "asx" "australia" "bamosz"
+"bet" "bmonesbittburns" "bourso" "brasil" "bse" "bsero" "canada" "canadamutual" "citywire" "cominvest"
+"cse" "deka" "dutch" "dwsfunds" "europe" "fetch_live_currencies" "fidelity" "fidelity_direct"
+"fidelityfixed" "financecanada" "finanzpartner" "finland" "fool" "france" "ftfunds" "ftportfolios"
+"ftportfolios_direct" "fundlibrary" "goldmoney" "greece" "hex" "hu" "hufund" "hungary" "hustock"
+"indiamutual" "known_currencies" "lerevenu" "maninv" "morningstar" "morningstarjp" "mstaruk" "nasdaq"
+"nyse" "nz" "nzx" "platinum" "romania" "seb_funds" "sixfunds" "sixshares" "stockhousecanada_fund"
+"tdefunds" "tdwaterhouse" "tiaacref" "tnetuk" "troweprice" "troweprice_direct" "trustnet" "tsp" "tsx"
+"uk_unit_trusts" "ukfunds" "unionfunds" "usa" "usfedbonds" "vanguard" "vwd" "yahoo" "yahoo_asia"
+"yahoo_australia" "yahoo_brasil" "yahoo_europe" "yahoo_json" "yahoo_nz" "yahoo_yql" "za" "za_unittrusts")
+</screen>
+ </para>
+ </formalpara>
+
+ <para>Der erste Teil ist die Fehlermeldung über ein fehlendes &app-perl;-Modul Mozilla/CA.pm. Am Ende in
+ Klammern steht die normale Ausgabe der aktuell installierten &app-fq;-Version<footnote>
+ <para>Die neueste &app-fq; Version ist &app-fq-vers;.</para>
+ </footnote>
+ und eine Liste der verfügbaren Kursdaten-Quellen.
+ </para>
+
+ <tip>
+ <para>Wenn ein Fehler angezeigt wird, lesen Sie den nächsten Abschnitt <xref linkend="gnc-fq-update" />.
+ Ansonsten fahren Sie mit <xref linkend="gnc-fq-dump" /> fort.
+ </para>
+ </tip>
+ </sect2>
+
+ <sect2 id="gnc-fq-update">
+ <title>gnc-fq-update</title>
+
+ <abstract>
+ <para>Dieses Programm installiert oder aktualisiert das &app-fq; Softwaremodul und löst bei Bedarf
+ die Abhängigkeiten zu weiteren Softwarepaketen auf.
+ <note>
+ <para>Windows-Benutzer sind im Allgemeinen besser beraten, wenn sie das Update-Tool
+ &mc.start.win-install-fq; ausführen.
+ </para>
+ </note>
+
+ </para>
+ </abstract>
+
+ <note>
+ <para>Dieses Programm erfordert für eine Installation unter &lin; oder &mac; Superuser-
+ oder Administratorrechte, aber nicht in &win;.
+ </para>
+ </note>
+ </sect2>
+
+ <sect2 id="gnc-fq-dump">
+ <title>gnc-fq-dump</title>
+<!-- Todo: insert link to wiki and/or guide -->
+ <abstract>
+ <para>Dieses Programm liefert Kursdaten für eine Quelle und eine Liste von Symbolen in einem Format,
+ das für Menschen leicht zu lesen ist. Es ist nützlich, um zu überprüfen, ob eine bestimmte
+ Online-Kursquelle erreichbar ist und funktioniert.
+ </para>
+ </abstract>
+
+ <para>Mit Hilfe diesen Befehls können Sie überprüfen, ob das <xref linkend="tool-ge-Symbol" />,
+ welches Sie für Ihr Wertpapier zum Online-Kursabruf verwenden möchten, bei der
+ gewünschten <xref linkend="tool-ge-TypeQuoteSource" /> funktioniert.
+ </para>
+
+ <tip>
+ <para>Mit <userinput>gnc-fq-dump</userinput> können Sie Symbole schneller als aus &app; heraus
+ überprüfen, wenn während des Abrufs mit &app; ein Fehler auftritt, weil sich die Ausgabe
+ des Skripts besser zur Analyse eignet und nicht jedesmal alle funktionierenden Symbole
+ ebenfalls mit abgerufen werden, falls man <xref linkend="tool-ge-pricedb-getQuotes" />
+ in der <xref linkend="tool-price" /> verwendet.
+ </para>
+ </tip>
+
+ <itemizedlist>
+ <listitem>
+ <para>Um ausführliche Inforamtionen zu einem Wertpapier zu erhalten, führen Sie in
+ der Befehlszeile einen Befehl in dieser Form aus:
+ <cmdsynopsis>
+ <command>gnc-fq-dump</command>
+ <arg choice="opt">-v</arg>
+ <arg choice="plain"><replaceable>Quelle</replaceable></arg>
+ <arg choice="plain" rep="repeat"><replaceable>Symbol</replaceable></arg>
+ </cmdsynopsis>
+ zum Beispiel <command>gnc-fq-dump -v yahoo_json IBM</command>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Zum Abrufen eines Wechselkurses führen Sie folgenden Befehl aus:
+ <command>gnc-fq-dump <optional>-v</optional> currency USD EUR</command>
+ <footnote>
+ <para>Seit &app-fq; 1.41 ist die Standardquelle für Währungen <quote>Alpha Vantage</quote>.
+ Lesen Sie auch die Hinweise zu <xref linkend="gnc-tbl-fq-currency-source" />.
+ </para>
+ </footnote>
+ <footnote>
+ <para>Die alten Yahoo-Währungen sind immer noch verfügbar als
+ <command>gnc-fq-dump yahoo_json USDEUR=X</command>.
+ </para>
+ </footnote>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Um zu testen, ob &app-fq; für Währungen innerhalb von &app; funktioniert,
+ <orderedlist numeration="arabic">
+ <listitem>
+ <para>nehmen Sie eine Buchung zwischen dem gewünschtem Handelsgut und der Buchwährung,</para>
+ </listitem>
+ <listitem>
+ <para>machen einen Rechtsklick darauf, und dann</para>
+ </listitem>
+ <listitem>
+ <para>wählen Sie im Kontextmenü die Option &gmi.ac.ed-ex;.</para>
+ </listitem>
+ </orderedlist>
+ Der <xref linkend="trans-win-enter" /> wird angezeigt. Klicken Sie auf die Schaltfläche
+ <guilabel>Wechselkurs abrufen</guilabel>, und wenn alles gut läuft, wird der aktuelle
+ Kurs in das Feld für den Wechselkurs eingetragen.
+ </para>
+ </sect2>
+
+ <sect2 id="gnc-fq-helper">
+ <title>gnc-fq-helper</title>
+
+ <para>Dies ist ein Skript, das &app; zum Abrufen von Kursen verwendet und musss nicht
+ vom Benutzer bedient werden. Sollte der Abruf eines Kurses in &app; zu einem
+ Fehlverhalten führen, kann mit diesem Skript eine Diagnose durchgeführt werden und
+ hilft Entwicklern bei der Entscheidung, ob der Fehler in &app; oder &app-fq; liegt.
+ </para>
+ </sect2>
+ </sect1>
+
<sect1 id="finance-quote-scheduler">
<title>Automatisierte Abfrage von Kursen</title>
commit f46bcae4d4efe5273f973c3d7dcfa0abb1d0d73b
Author: Christian Wehling <christian.wehling at web.de>
Date: Tue Aug 16 21:18:00 2022 +0200
L10N:de: manual ch_Tools_Assistants: id for glossentry "Get Quotes"
in the price-db
diff --git a/manual/de/ch_Tools_Assistants.xml b/manual/de/ch_Tools_Assistants.xml
index 92a65d73..c77ffa48 100644
--- a/manual/de/ch_Tools_Assistants.xml
+++ b/manual/de/ch_Tools_Assistants.xml
@@ -5350,7 +5350,7 @@
</glossdef>
</glossentry>
- <glossentry>
+ <glossentry id="tool-ge-pricedb-getQuotes">
<glossterm>Kurse abrufen</glossterm>
<glossdef>
<para>Ist &app-fq; installiert und eine Online-Quelle für die Kurse ausgewählt, werden mit
commit 02e0073f3011fdb81602c617f3e02e77f9629ad1
Author: Christian Wehling <christian.wehling at web.de>
Date: Tue Jul 26 21:39:58 2022 +0200
manual ch_Finance-Quote: Helper Scripts
a new section with the description of the gnc-fq-*- Perl-scripts. The
content of this section is taken from the wiki
https://wiki.gnucash.org/wiki/Online_Quotes
diff --git a/manual/C/ch_Finance-Quote.xml b/manual/C/ch_Finance-Quote.xml
index 8f477d7e..1e0ba3cc 100644
--- a/manual/C/ch_Finance-Quote.xml
+++ b/manual/C/ch_Finance-Quote.xml
@@ -14,13 +14,15 @@ Translators:
-->
<chapter id="finance-quote"
xmlns:xi="http://www.w3.org/2001/XInclude">
- <title>Setting up the Quote update</title>
+ <title>Setting Up the Quote Retrieval</title>
- <para>If you have more than a couple of commodities, you will tire of having to update their quotes
- constantly. &app; has the ability to automatically download the most recent quote for your
- commodities using the Internet. This is accomplished through the &app-perl; module &app-fq;,
- which must be installed in order to activate this feature.
- </para>
+ <abstract>
+ <para>If you have more than a couple of commodities, you will tire of having to update their quotes
+ constantly. &app; has the ability to automatically download the most recent quote for your
+ commodities using the Internet. This is accomplished through the &app-perl; module &app-fq;,
+ which must be installed in order to activate this feature.
+ </para>
+ </abstract>
<itemizedlist>
<title>Prerequisites for an Online Quote update with &app-fq; are</title>
@@ -48,16 +50,19 @@ Translators:
<sect1 id="finance-quote-perl-install">
<title>Installing &app-perl;</title>
- <para>The installation of &app-perl; is essentially dependent on the operating system used. The effort for
- installation is low and is described in this section.
- </para>
+ <abstract>
+ <para>The installation of &app-perl; is essentially dependent on the operating system used. The effort for
+ installation is low and is described in this section.
+ </para>
+ </abstract>
<para>To check if &app-perl; is already installed on your system, call the command
- <informalexample>
-<screen>perl -v</screen>
- </informalexample>
- in the terminal. If you are shown the version number of the &app-perl; interpreter, then
- continue with <xref linkend="finance-quote-install" />.
+ <userinput>perl -v</userinput> in the terminal.
+<screen language="console">$ perl -v
+This is perl 5, version 30, subversion 0 (v5.30.0) built for x86_64-linux-gnu-thread-multi
+</screen>
+ If you are shown the version number of the &app-perl; interpreter, skip the next details
+ and continue instead with <xref linkend="finance-quote-install" />.
</para>
<procedure>
@@ -117,15 +122,26 @@ Translators:
</para>
</step>
</procedure>
+
+ <tip>
+ <para>Afterwards it’s a good idea to include the folder where &app; is installed,
+ under &win; e.g. <userinput>c:\Programme<replaceable> (x86)</replaceable>gnucash\bin</userinput>,
+ to your <envar>PATH</envar> environment variable.
+ This way it’s easier for you to use some <xref linkend="finance-quote-helper" /> when needed.
+ Please refer to the documentation for your operating system for more information.
+ </para>
+ </tip>
</sect1>
<sect1 id="finance-quote-install">
<title>Installing &app-fq;</title>
<para>To determine if the &app-perl; 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
+ <userinput>perldoc Finance::Quote</userinput> in a terminal window and check to see if there is
any documentation
-<screen>NAME
+<screen language="console">
+$ perldoc Finance::Quote
+NAME
Finance::Quote - Get stock and mutual fund quotes from various exchanges
SYNOPSIS
@@ -149,30 +165,21 @@ SYNOPSIS
</step>
<step>
- <simpara>Run the <command>gnc-fq-check</command> command to verify that the program is already in a directory
- that is entered in the PATH environment variable.
+ <simpara>Run the <userinput>gnc-fq-check</userinput> command to verify that the program is already in a directory
+ that is entered in the <envar>PATH</envar> environment variable.
<footnote>
<simpara>If you’ve installed &app; packages provided by your distribution,
- <filename>gnc-fq-check</filename> must be on your PATH. The currentness of your
+ <filename>gnc-fq-check</filename> must be on your <envar>PATH</envar>. The currentness of your
distribution can be checked under
<ulink url="&url-repo;perl:finance-quote/versions"><citetitle>&app-fq;-
versions</citetitle></ulink>.
</simpara>
</footnote>
</simpara>
-
- <tip>
- <simpara>If <filename>gnc-fq-check</filename> is not in your PATH, perhaps because you built the application
- yourself using unusual paths, search the folder where &app; is installed, e.g. with the
- command <command>which gnc-fq-check</command>, and change to that directory. It is a
- good idea to include the current directory in the PATH environment variable. Please
- refer to the documentation for your distribution for more information.
- </simpara>
- </tip>
</step>
<step>
- <simpara>Next, update with <command>sudo gnc-fq-update</command> or <command>su -c gnc-fq-update</command>
+ <simpara>Next, update with <userinput>sudo gnc-fq-update</userinput> or <userinput>su -c gnc-fq-update</userinput>
with root privileges &app-fq; It depends on your distribution.
</simpara>
@@ -190,7 +197,7 @@ SYNOPSIS
</step>
<step>
- <simpara>Run <command>gnc-fq-dump</command> to check &app-fq; works properly. This program returns the
+ <simpara>Run <userinput>gnc-fq-dump</userinput> to check &app-fq; works properly. This program returns the
version number of &app-fq; module currently installed as well as a list of sources
available via the &app-fq; module. It will also inform you if there is a problem with your
installation or if it is missing, and may suggest a fix.
@@ -207,10 +214,14 @@ SYNOPSIS
</step>
<step>
- <simpara>Install Xcode if it is not installed.
- </simpara>
-
- <simpara>XCode is an optional item from your &mac; distribution DVD.
+ <simpara>Install &app-xcode;
+ <footnote>
+ <para>&app-xcode; is an optional tool from your
+ &mac; distribution DVD, but also at <ulink url="&url-ap-dev;xcode/" />
+ the application is also available.
+ </para>
+ </footnote>
+ if it is not installed.
</simpara>
</step>
@@ -240,6 +251,199 @@ SYNOPSIS
</procedure>
</sect1>
+ <sect1 id="finance-quote-helper">
+ <title>Helper Scripts for Update and Diagnostics</title>
+
+ <abstract>
+ <para>&app; provides several utilities that support you in your daily work with &app-fq;.
+ So there is a script with which you can check your symbols for the securities. Other
+ scripts perform the initial installation or keep &app-fq; up to date.
+ &app-fq; software module. These programs have names that begin with gnc-fq-*, and are
+ themselves written in the &app-perl; programming language.
+ </para>
+ </abstract>
+
+ <procedure>
+ <title>Running &app-perl; Scripts Under &win;</title>
+
+ <step>
+ <simpara>Open a <application>CMD</application> or <application>Powershell</application>
+ window: Click <guimenu>Start</guimenu> and type either
+ <userinput>cmd</userinput> or <userinput>powershell</userinput>
+ then select the resulting menu item. You don't need to run as administrator.
+ </simpara>
+ </step>
+
+ <step>
+ <simpara>Change to the drive containing the &app; program files —usually C drive—
+ if that is not already the current drive.
+ </simpara>
+ </step>
+
+ <step>
+ <simpara>Since, as previously recommended, the GnuCash directory was entered in the <envar>PATH</envar>
+ envinronment variable, prefix any gnc-fq-xxx &app-perl; script command with
+ <quote>Perl</quote> and a space, e.g. <userinput>perl gnc-fq-check</userinput>.
+ Otherweise you have to execute the command e.g. <userinput>perl c:\Program Files
+ <replaceable> (x86)</replaceable>\gnucash\bin\gnc-fq-check</userinput>.
+ </simpara>
+ </step>
+ </procedure>
+
+ <sect2 id="gnc-fq-check">
+ <title>gnc-fq-check</title>
+
+ <abstract>
+ <para>This program returns the version number of &app-fq; module currently installed as well
+ as a list of sources available via &app-fq;. It will also inform you if there is a problem
+ with your installation and may suggest a fix.
+ </para>
+ </abstract>
+
+ <formalpara>
+ <title>Example with broken dependency</title>
+
+ <para>
+<screen language="console">
+$ gnc-fq-check
+Can't locate Mozilla/CA.pm in @INC (you may need to install the Mozilla::CA module) (@INC contains:
+/usr/lib/perl5/site_perl/5.30.1/x86_64-linux-thread-multi /usr/lib/perl5/site_perl/5.30.1
+/usr/lib/perl5/vendor_perl/5.30.1/x86_64-linux-thread-multi /usr/lib/perl5/vendor_perl/5.30.1
+/usr/lib/perl5/5.30.1/x86_64-linux-thread-multi /usr/lib/perl5/5.30.1 /usr/lib/perl5/site_perl)
+at /usr/lib/perl5/vendor_perl/5.30.1/Finance/Quote/Tiaacref.pm line 33.
+Compilation failed in require at (eval 303) line 1.
+BEGIN failed--compilation aborted at (eval 303) line 1.
+ at /usr/local/bin/gnc-fq-check line 91.
+("1.47" "adig" "aex" "aiahk" "alphavantage" "amfiindia" "asegr" "asia" "asx" "australia" "bamosz"
+"bet" "bmonesbittburns" "bourso" "brasil" "bse" "bsero" "canada" "canadamutual" "citywire" "cominvest"
+"cse" "deka" "dutch" "dwsfunds" "europe" "fetch_live_currencies" "fidelity" "fidelity_direct"
+"fidelityfixed" "financecanada" "finanzpartner" "finland" "fool" "france" "ftfunds" "ftportfolios"
+"ftportfolios_direct" "fundlibrary" "goldmoney" "greece" "hex" "hu" "hufund" "hungary" "hustock"
+"indiamutual" "known_currencies" "lerevenu" "maninv" "morningstar" "morningstarjp" "mstaruk" "nasdaq"
+"nyse" "nz" "nzx" "platinum" "romania" "seb_funds" "sixfunds" "sixshares" "stockhousecanada_fund"
+"tdefunds" "tdwaterhouse" "tiaacref" "tnetuk" "troweprice" "troweprice_direct" "trustnet" "tsp" "tsx"
+"uk_unit_trusts" "ukfunds" "unionfunds" "usa" "usfedbonds" "vanguard" "vwd" "yahoo" "yahoo_asia"
+"yahoo_australia" "yahoo_brasil" "yahoo_europe" "yahoo_json" "yahoo_nz" "yahoo_yql" "za" "za_unittrusts")
+</screen>
+ </para>
+ </formalpara>
+
+ <para>The first part is the error message about a missing &app-perl;-modul Mozilla/CA.pm. At the end in
+ parentheses is the normal output of the currently installed &app-fq; version<footnote>
+ <para>The most recent &app-fq; version is &app-fq-vers;.</para>
+ </footnote>
+ and a list of available sources.
+ </para>
+
+ <tip>
+ <para>If an error is displayed, see the next section <xref linkend="gnc-fq-update" />.
+ Otherwise, continue with <xref linkend="gnc-fq-dump" />.
+ </para>
+ </tip>
+ </sect2>
+
+ <sect2 id="gnc-fq-update">
+ <title>gnc-fq-update</title>
+
+ <abstract>
+ <para>This program installs or updates the &app-fq; software module along with its dependencies.
+ <note>
+ <para>Windows users are generally better off using the update-tool &mc.start.win-install-fq;.
+ </para>
+ </note>
+ </para>
+ </abstract>
+
+ <note>
+ <para>This program needs superuser or administrative privileges to succeed in &lin; or &mac; but not in &win;.
+ </para>
+ </note>
+ </sect2>
+
+ <sect2 id="gnc-fq-dump">
+ <title>gnc-fq-dump</title>
+<!-- Todo: insert link to wiki and/or guide -->
+ <abstract>
+ <para>This program returns quote data for a source and a list of symbols in a
+ format which is easy to read for humans. It is useful for checking that a
+ given online quote source is up and functional.
+ </para>
+ </abstract>
+
+ <para>You can use this command to verify that the symbol <!-- <xref linkend="tool-ge-symbol" /> -->,
+ which you want to use for your security for online quote retrieval, works for the
+ desired qoute source. <!-- <xref linkend="tool-ge-TypeQuoteSource" /> -->.
+ </para>
+
+ <tip>
+ <para>With <userinput>gnc-fq-dump</userinput> you can check symbols faster than from &app;
+ if an error occurs during the retrieval with &app;, because the output of the script
+ is better suited for analysis and not all working symbols are retrieved each time,
+ if you use <guibutton>Get Quotes</guibutton> in the <xref linkend="tool-price" />.
+ </para>
+ </tip>
+
+ <itemizedlist>
+ <listitem>
+ <para>To get verbose information about a security, run a command from the
+ command line of the form:
+ <cmdsynopsis>
+ <command>gnc-fq-dump</command>
+ <arg choice="opt">-v</arg>
+ <arg choice="plain"><replaceable>Source</replaceable></arg>
+ <arg choice="plain" rep="repeat"><replaceable>Symbol</replaceable></arg>
+ </cmdsynopsis>
+ e.g. <command>gnc-fq-dump -v yahoo_json IBM</command>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>To retrieve currency exchange rate run the following command:
+ <command>gnc-fq-dump <optional>-v</optional> currency USD EUR</command>
+ <footnote>
+ <para>Since &app-fq; 1.41 the default source for currencies is
+ hardcoded to be <quote>Alpha Vantage</quote>. Also read the
+ notes on <xref linkend="gnc-tbl-fq-currency-source" />.
+ </para>
+ </footnote>
+ <footnote>
+ <para>The old yahoo currencies are still available as
+ <command>gnc-fq-dump yahoo_json USDEUR=X</command>.
+ </para>
+ </footnote>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>To test that &app-fq; is working for currencies within &app;,
+ <orderedlist numeration="arabic">
+ <listitem>
+ <para>find a transaction between the desired commodity and the book currency and</para>
+ </listitem>
+ <listitem>
+ <para>right-click on it, then</para>
+ </listitem>
+ <listitem>
+ <para>select &gmi.ac.ed-ex; in the context menu.</para>
+ </listitem>
+ </orderedlist>
+ The <xref linkend="trans-win-enter" /> will appear. Click the
+ <guilabel>Fetch Rate</guilabel> button and if everything is
+ behaving itself the current rate will fill in the exchange rate box.
+ </para>
+ </sect2>
+
+ <sect2 id="gnc-fq-helper">
+ <title>gnc-fq-helper</title>
+
+ <para>This is a script that is used to retrieve quotes and does not need to be
+ operated by the user. Should the retrieval of a course in &app; result in
+ failures, this script can be used to perform diagnostics and help developers
+ decide if the error is in &app; or &app-fq;.
+ </para>
+ </sect2>
+ </sect1>
+
<sect1 id="finance-quote-scheduler">
<title>Configuring for Getting Quotes Periodically</title>
commit c2ad2a29f0f81520ed1fd2392819e15592222cd1
Author: Christian Wehling <christian.wehling at web.de>
Date: Tue Aug 16 18:05:45 2022 +0200
docbook: some new entities
* the F::Q versionsnumber
* link to XCode-download
* XCode markup as application
diff --git a/docbook/gnc-docbookx.dtd b/docbook/gnc-docbookx.dtd
index dc45092d..1d874715 100644
--- a/docbook/gnc-docbookx.dtd
+++ b/docbook/gnc-docbookx.dtd
@@ -38,6 +38,7 @@ https://www.w3.org/2003/entities/2007/w3centities-f.ent
<!ENTITY vers-stable "&series-stable;.11">
<!ENTITY series-unstable "master">
<!ENTITY vers-unstable "">
+<!ENTITY app-fq-vers "1.52">
<!ENTITY manrevision "&vers-stable;">
<!ENTITY date "26 June 2022">
@@ -64,6 +65,7 @@ https://www.w3.org/2003/entities/2007/w3centities-f.ent
<!ENTITY app-perl "<application>Perl</application>">
<!ENTITY app-py "<application>Python</application>">
<!ENTITY app-gfa "<application>Gnucash for Android</application>">
+<!ENTITY app-xcode "<application>Xcode</application>">
<!-- Operating Systems (3 letters), Bundles: -->
<!ENTITY lin "<systemitem class='osname'>Linux</systemitem>">
@@ -154,6 +156,7 @@ https://www.w3.org/2003/entities/2007/w3centities-f.ent
<!-- b) Third party URLs: -->
<!ENTITY url-av "https://www.alphavantage.co/"> <!-- A F::Q source, which requires registration -->
+<!ENTITY url-ap-dev "https://developer.apple.com/">
<!ENTITY url-cpan "https://www.cpan.org/"> <!-- Comprehensive Perl Archive Network -->
<!ENTITY url-gh "https://github.com/"> <!-- we want to reference our libs, too. -->
<!ENTITY url-gh-we "https://github.com/Gnucash/"> <!-- Our project page -->
Summary of changes:
docbook/gnc-docbookx.dtd | 3 +
manual/C/ch_Finance-Quote.xml | 272 ++++++++++++++++++++++++++++++-----
manual/de/ch_Finance-Quote.xml | 289 ++++++++++++++++++++++++++++++++------
manual/de/ch_Tools_Assistants.xml | 2 +-
4 files changed, 490 insertions(+), 76 deletions(-)
More information about the gnucash-changes
mailing list