gnucash-docs maint: F::Q Even more improvements
Frank H.Ellenberger
fell at code.gnucash.org
Sun Jan 9 20:26:02 EST 2022
Updated via https://github.com/Gnucash/gnucash-docs/commit/f84d3705 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/9c30b015 (commit)
commit f84d3705e95bc349bdc008450af9330772867078
Author: Christian Wehling <christian.wehling at web.de>
Date: Sat Jan 8 15:35:50 2022 +0100
F::Q Even more improvements
* insert note on NAV
* insert Entity for Data file
diff --git a/docbook/gnc-docbookx.dtd b/docbook/gnc-docbookx.dtd
index 19fc02f5..13fd006a 100644
--- a/docbook/gnc-docbookx.dtd
+++ b/docbook/gnc-docbookx.dtd
@@ -75,6 +75,7 @@ own entity definitions to use across all of our DocBook pages. -->
<!ENTITY dir-data "~/.local/share/gnucash/">
<!ENTITY dir-old "~/.gnucash/"> <!-- Up to 2.6.21 common for conf & data -->
<!ENTITY file-finc "libgnucash/app-utils/calculation/fin.c">
+<!ENTITY user-datafile "<filename><replaceable>${HOME}/gnucash-filename</replaceable></filename>">
<!--
4. Other formatting instructions -->
diff --git a/manual/C/ch_Finance-Quote.xml b/manual/C/ch_Finance-Quote.xml
index 2310aee1..79ea62d9 100644
--- a/manual/C/ch_Finance-Quote.xml
+++ b/manual/C/ch_Finance-Quote.xml
@@ -183,24 +183,27 @@ SYNOPSIS
<sect1 id="finance-quote-scheduler">
<title>Configuring for Getting Online Quotes Periodically</title>
- <para>The command <command>gnucash-cli --quotes get
- <filename><replaceable>${HOME}/gnucash-filename</replaceable></filename></command>
+ <para>The command <command>gnucash-cli --quotes get &user-datafile;</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 --add-price-quotes &user-datafile;</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 quotes of your stocks and write them directly into your
- &app;-data file.
+ &app;-data file without starting the GUI. Thus an automatic, regular updating of the
+ price database is possible.
+ <warning>
+ <para>Please note that the data file should not be open in another instance of &app; at the same time!
+ </para>
+ </warning>
</para>
- <para>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>.
+ <para>The file specified &user-datafile; 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>.
<tip>
<para>The file name can also be found under <guimenu>File</guimenu> in the recently opened file list. If
you place the mouse over the menu item with the number 1 in the list of recently opened
@@ -210,67 +213,79 @@ SYNOPSIS
</para>
<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.
+ Quotes automatically and periodically. The method depends on your OS.
</para>
- <procedure>
- <title>Automated quote retrieval on &lin; and &mac;</title>
+ <example>
+ <title>Automated quote retrieval every Friday at 4:00 p.m.</title>
- <para>Register <command>gnucash-cli</command> with <application>cron</application>.
- </para>
+ <procedure>
+ <title>On &lin; and &mac;</title>
- <step>
- <simpara>Run <command>crontab -e</command>.
- </simpara>
- </step>
+ <para>Register <command>gnucash-cli</command> with <application>cron</application>.
+ </para>
- <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>
- <warning>
- <para>If there is no graphic session that has already started the dbus, running on your computer at the
- time of the quote request, you must do the entry as follows instead:
+ <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 &user-datafile; > /dev/null 2>&1</screen>
+ </informalexample>
+
+ <warning>
+ <para>If there is no graphic session that has already started the dbus, running on your computer at the
+ time of the quote request, you must do the entry as follows instead:
+ <informalexample>
<screen>0 16 * * 5 env `dbus-launch` sh -c 'trap "kill $DBUS_SESSION_BUS_PID" EXIT;
-gnucash-cli --quotes get <replaceable>${HOME}/gnucash-filename</replaceable> > /dev/null 2>&1</screen>
- (Do not copy the line breaks into the crontab, they were inserted here only for the
- purpose of readability).
- </para>
- </warning>
+gnucash-cli --quotes get &user-datafile; > /dev/null 2>&1</screen>
+ </informalexample>
+ (Do not copy the line breaks into the crontab, they were inserted here only for the
+ purpose of readability).
+ </para>
+ </warning>
+ </para>
+ </step>
+ </procedure>
+
+ <procedure>
+ <title>On &win;</title>
+
+ <para>Register <command>gnucash-cli</command> with Task Scheduler.
</para>
- </step>
- </procedure>
- <procedure>
- <title>Automated quote retrieval on &win;</title>
-
- <para>Register <command>gnucash-cli</command> with Task Scheduler.
- </para>
+ <step>
+ <simpara>Select
+ <menuchoice>
+ <guimenu>Start</guimenu><guisubmenu>Windows Administrative
+ Tools</guisubmenu><guimenuitem>Task Scheduler</guimenuitem>
+ </menuchoice>
+ .
+ </simpara>
+ </step>
- <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>Select <guimenuitem>Create Task</guimenuitem>.
- </simpara>
- </step>
+ <step>
+ <simpara>Enter the appropirate items on <guilabel>Create Task</guilabel> Window.
+ </simpara>
+ </step>
+ </procedure>
- <step>
- <simpara>Enter the appropirate items on <guilabel>Create Task</guilabel> Window.
- </simpara>
- </step>
- </procedure>
+ <para>Adjust the time to the close of the stock exchange and consider <emphasis>fund quotes</emphasis>,
+ that the net asset value (NAV) is determined well after the markets closed. The types have
+ their description in <xref linkend="tool-price" />.
+<!-- FIXME: aadjust the link to a proper ID -->
+ </para>
+ </example>
- <para>For more information, see the wiki at
+ <para>Some users have made additions to the wiki and shared their experiences on the
<ulink url="&url-wiki-OQ;#Updating_enabled_Quotes_from_outside_GnuCash">Online Quotes Page on
GnuCash Wiki</ulink>.
</para>
diff --git a/manual/de/ch_Finance-Quote.xml b/manual/de/ch_Finance-Quote.xml
index b6322644..a25e79ce 100644
--- a/manual/de/ch_Finance-Quote.xml
+++ b/manual/de/ch_Finance-Quote.xml
@@ -189,26 +189,27 @@ SYNOPSIS
<sect1 id="finance-quote-scheduler">
<title>Automatisierte Abfrage von Online-Kursen</title>
- <para>Mit dem Kommando <command>gnucash-cli --quotes get
- <filename><replaceable>${HOME}/gnucash-filename</replaceable></filename></command>
+ <para>Mit dem Kommando <command>gnucash-cli --quotes get &user-datafile;</command>
<footnote>
<simpara>Der Befehl für den Online-Kursabruf wurde ab &app; 4.0 geändert. Der alte Befehl <command>gnucash
- --add-price-quotes
- <filename><replaceable>${HOME}/gnucash-filename</replaceable></filename></command> ist
- immer noch verfügbar, aber er ist veraltet und wird in einer zukünftigen Version
- entfernt werden. Wenn Sie ein Upgrade von &app; 3.11 oder einer früheren Version
- durchgeführt haben, wird empfohlen, den neuen Befehl <command>gnucash-cli</command> zu
- verwenden.
+ --add-price-quotes &user-datafile;</command> ist immer noch verfügbar, aber er ist
+ veraltet und wird in einer zukünftigen Version entfernt werden. Wenn Sie ein Upgrade von
+ &app; 3.11 oder einer früheren Version durchgeführt haben, wird empfohlen, den neuen
+ Befehl <command>gnucash-cli</command> zu verwenden.
</simpara>
</footnote>
können Sie die aktuellen Kurse Ihrer Devisen und Wertpapiere abrufen und direkt in ihre
- &app;-Datendatei schreiben.
+ &app;-Datendatei schreiben ohne die Benutzeroberfläche zu starten. Somit ist eine automatische,
+ regelmäßige Aktualisierung der Kursdatenbank möglich.
+ <warning>
+ <para>Beachten Sie bitte, dass die Datendatei nicht gleichzeitig in einer anderen Instanz von &app; geöffnet sein darf!
+ </para>
+ </warning>
</para>
- <para>Die angegebene Datei <filename><replaceable>${HOME}/gnucash-filename</replaceable></filename> ist
- abhängig von dem Namen und dem Speicherort Ihrer Datendatei. Dies lässt sich anhand des
- Namens feststellen, der im oberen Rahmen des &app; Fensters vor dem <quote>-</quote> angezeigt
- wird.
+ <para>Die angegebene Datei &user-datafile; ist abhängig von dem Namen und dem Speicherort Ihrer
+ Datendatei. Dies lässt sich anhand des Namens feststellen, der im oberen Rahmen des &app;
+ Fensters vor dem <quote>-</quote> angezeigt wird.
<tip>
<para>Der Dateiname ist auch in der Liste der zuletzt geöffneten Dateien im
<guimenu>Datei</guimenu>-Menü zu finden. Wenn Sie den Mauszeiger über dem Menüeintrag
@@ -220,72 +221,83 @@ SYNOPSIS
<para>Sie müssen den Befehl <command>gnucash-cli</command> bei einem Scheduler (Zeitplaner) eintragen, um
die Onlinekurse automatisch und regelmäßig zu erhalten. Die Methode hängt von Ihrem
- Betriebssystem ab. Nehmen wir zum Beispiel an Sie möchten Ihre Datei jeden Freitag um 16:00
- Uhr aktualisieren. (Passen Sie die Zeit an den Börsenschluss an.)
+ Betriebssystem ab.
</para>
- <procedure>
- <title>Automatisierter Kursabruf unter &lin; und &mac;</title>
+ <example>
+ <title>Automatischer Kursabruf jeden Freitag um 16:00 Uhr</title>
- <para>Eintragen des Befehls zum Kursabruf per <command>gnucash-cli</command> mittels
- <application>cron</application>.
- </para>
+ <procedure>
+ <title>Unter &lin; und &mac;</title>
- <step>
- <simpara>Führen Sie das Kommando <command>crontab -e</command> aus.
- </simpara>
- </step>
+ <para>Eintragen des Befehls zum Kursabruf per <command>gnucash-cli</command> mittels
+ <application>cron</application>.
+ </para>
- <step>
- <para>Fügen Sie die folgende Zeile in Ihre crontab ein:
- <informalexample>
-<screen>0 16 * * 5 gnucash-cli --quotes get <replaceable>${HOME}/gnucash-filename</replaceable> > /dev/null 2>&1</screen>
- </informalexample>
- <warning>
- <para>Läuft auf Ihrem Rechner zu dem Zeitpunkt des Kursabrufs keine graphische Benutzeroberfläche, die
- bereits den dbus gestartet hat, so müssen Sie den Eintrag stattdessen wie folgt
- vornehmen:
+ <step>
+ <simpara>Führen Sie das Kommando <command>crontab -e</command> aus.
+ </simpara>
+ </step>
+
+ <step>
+ <para>Fügen Sie die folgende Zeile in Ihre crontab ein:
+ <informalexample>
+<screen>0 16 * * 5 gnucash-cli --quotes get &user-datafile; > /dev/null 2>&1</screen>
+ </informalexample>
+
+ <warning>
+ <para>Läuft auf Ihrem Rechner zu dem Zeitpunkt des Kursabrufs keine graphische Benutzeroberfläche, die
+ bereits den dbus gestartet hat, so müssen Sie den Eintrag stattdessen wie folgt
+ vornehmen:
+ <informalexample>
<screen>0 16 * * 5 env `dbus-launch` sh -c 'trap "kill $DBUS_SESSION_BUS_PID" EXIT;
-gnucash-cli --quotes get <replaceable>${HOME}/gnucash-filename</replaceable> > /dev/null 2>&1</screen>
- (Die Zeilenumbrüche nicht in die crontab übernehmen, die wurden hier nur zum Zwecke
- der Lesbarkeit eingefügt.)
- </para>
- </warning>
+gnucash-cli --quotes get &user-datafile; > /dev/null 2>&1</screen>
+ </informalexample>
+ (Die Zeilenumbrüche nicht in die crontab übernehmen, die wurden hier nur zum
+ Zwecke der Lesbarkeit eingefügt.)
+ </para>
+ </warning>
+ </para>
+ </step>
+ </procedure>
+
+ <procedure>
+ <title>Unter &win;</title>
+
+ <para>Anlegen des Kursabrufs per <command>gnucash-cli</command> mit der Aufgabenplanung.
</para>
- </step>
- </procedure>
-
- <procedure>
- <title>Automatisierter Kursabruf unter &win;</title>
-
- <para>Anlegen des Kursabrufs per <command>gnucash-cli</command> mit der Aufgabenplanung.
- </para>
- <step>
- <simpara>Wählen Sie
- <menuchoice>
- <guimenu>Start</guimenu><guisubmenu>Systemsteuerung</guisubmenu><guimenuitem>Aufgabenplanung</guimenuitem>
- </menuchoice>
- .
- </simpara>
- </step>
+ <step>
+ <simpara>Wählen Sie
+ <menuchoice>
+ <guimenu>Start</guimenu><guisubmenu>Systemsteuerung</guisubmenu><guimenuitem>Aufgabenplanung</guimenuitem>
+ </menuchoice>
+ .
+ </simpara>
+ </step>
- <step>
- <simpara>Klicken Sie auf <guimenuitem>Aufgabe erstellen</guimenuitem>.
- </simpara>
- </step>
+ <step>
+ <simpara>Klicken Sie auf <guimenuitem>Aufgabe erstellen</guimenuitem>.
+ </simpara>
+ </step>
- <step>
- <simpara>Geben Sie die entsprechenden Angaben im Fenster <guilabel>Aufgabe erstellen</guilabel> ein.
- </simpara>
- </step>
- </procedure>
+ <step>
+ <simpara>Geben Sie die entsprechenden Angaben im Fenster <guilabel>Aufgabe erstellen</guilabel> ein.
+ </simpara>
+ </step>
+ </procedure>
+
+ <para>Passen Sie die Zeit an den Börsenschluss an und bedenken Sie, dass bei
+ <emphasis>Fondskursen</emphasis> das Netto-Anlagevermögen (NAV) deutlich nach
+ Börsenschluss ermittlet wird. Eine Beschreibung zu den Typen finden Sie unter
+ <xref linkend="tool-price" />.
+<!-- FIXME: adjust the link to a proper ID -->
+ </para>
+ </example>
- <para>Weitere Informationen finden Sie im Wiki unter
- <ulink url="&url-wiki-de;Aktienhandel#Automatisierter_Kursabruf_mittels_cron">Automatisierter
- Kursabruf mittels cron</ulink> und auf
+ <para>Einige Benutzer haben im englischsprachigen Wiki Ergänzungen und ihre Erfahrungen auf der
<ulink url="&url-wiki-OQ;#Updating_enabled_Quotes_from_outside_GnuCash">Online Quotes Page on
- GnuCash Wiki</ulink>.
+ GnuCash Wiki</ulink> zusammengestellt.
</para>
</sect1>
</chapter>
Summary of changes:
docbook/gnc-docbookx.dtd | 1 +
manual/C/ch_Finance-Quote.xml | 133 ++++++++++++++++++++-----------------
manual/de/ch_Finance-Quote.xml | 146 ++++++++++++++++++++++-------------------
3 files changed, 154 insertions(+), 126 deletions(-)
More information about the gnucash-changes
mailing list