gnucash-docs maint: Finish updates of report-create
Frank H.Ellenberger
fell at code.gnucash.org
Mon Feb 1 15:00:43 EST 2021
Updated via https://github.com/Gnucash/gnucash-docs/commit/bf41d179 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/2701314a (commit)
commit bf41d179e6f608bb17ba174a3951f1ddca3de69b
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Mon Feb 1 21:00:15 2021 +0100
Finish updates of report-create
diff --git a/help/C/Help_ch_Reports.xml b/help/C/Help_ch_Reports.xml
index 5aacc9d..877d430 100644
--- a/help/C/Help_ch_Reports.xml
+++ b/help/C/Help_ch_Reports.xml
@@ -1702,14 +1702,15 @@ Income (type INCOME)
</sect1>
<sect1 id="report-create">
- <title>Creating Reports and Charts</title>
+ <title>Creating or Modifying Reports and Charts</title>
- <para>It is possible to write reports if the current ones are not suitable. To do this
- you will need to know Scheme (a LISP-like programming language), and it is an
- excellent idea to have a copy of the &app; source code available.</para>
+ <para>It is possible to modify existing or write own reports, if the available ones are not suitable.
+ To do this you will need to know <application>Guile</application>, GNOME's implementation of
+ <emphasis>Scheme</emphasis>, which again is a <acronym>LISP</acronym>-like programming language,
+ and it is an excellent idea to have a copy of the &app; source code available.</para>
<itemizedlist>
- <title>Important files in the source code</title>
+ <title>Introductory files in the source code</title>
<listitem><para><ulink url="&url-gh-gc-maint;gnucash/report/doc/report-html.txt">gnucash/report/doc/report-html.txt</ulink>
documents the <emphasis>reporting interface</emphasis>.</para></listitem>
<listitem><para><ulink url="&url-gh-gc-maint;gnucash/report/reports/example/hello-world.scm">gnucash/report/reports/example/hello-world.scm</ulink>
@@ -1717,26 +1718,24 @@ Income (type INCOME)
</itemizedlist>
<sect2 id="report-api">
- <title>Accessing the &app; application programming interface (<acronym>API</acronym>)</title>
+ <title>Accessing the &app; Application Programming Interface (<acronym>API</acronym>)</title>
- <note><para>This section may need updating !!!</para></note>
+ <para>To get informations from your &app; book for your report it is also
+ necessary to access data from the &app; engine. This binding is
+ generated by <application>Swig</application>
+ and based on a set of Scheme wrapper functions in
+ <ulink url="&url-gh-gc-maint;bindings/guile"><filename class='directory'>bindings/guile</filename></ulink>.
+ <footnote><para><emphasis>Up to version 2.0.5</emphasis> <application>G-Wrap</application> was used and the file was
+ <filename>src/g-wrap/gnc.html</filename>.</para></footnote></para>
- <para>It is also necessary to access data from the engine to get
- information for your report. This is
- <emphasis>since version 2.1.x</emphasis> performed by a set of
- Scheme wrapper functions that are documented in the file
- <filename>src/engine/swig-engine.c</filename>.
- <footnote><para>This file does not exist in Version 4.</para></footnote>
- <footnote><para><emphasis>Up to version 2.0.5</emphasis> it was
- <filename>src/g-wrap/gnc.html</filename>.</para></footnote>
- Examine some of the other reports in src/scm/report for an indication of how they are used.</para>
-
- <para>Some users started a table in <ulink url="&url-wiki-api-custom;" />.</para>
+ <tip><para>Examine some of the other reports in <ulink url="&url-gh-gc-maint;gnucash/report/"><filename class='directory'>gnucash/report/</filename></ulink> for an indication of how they are used.</para>
+ <para>Some users started a table in <ulink url="&url-wiki-api-custom;" />.</para></tip>
<para>Because the above file only contains the syntax of the function
- you can use the <application>Doxygen</application> source documentation online
- <ulink url="&url-doc-api-main;" /> or
- <ulink url="&url-doc-api-mast;" />
+ you can use the nightly <application>Doxygen</application> generated
+ <acronym>API</acronym> documentation online for the
+ <ulink url="&url-doc-api-main;">bugfix branch</ulink> or
+ <ulink url="&url-doc-api-mast;">feature branch</ulink>
to get more information about the functions.
</para>
<para>After <ulink url="&url-wiki;Building">setting up a build environment</ulink>
@@ -1758,6 +1757,7 @@ ninja doc
a dialect of <acronym>HTML</acronym> and rendering this with a <acronym>HTML</acronym> widget. This has limitations,
particularly when trying to align objects precisely, as might be necessary for
printing onto pre-printed invoices for example.</para>
+ <para>See also <xref linkend="report-print"/>.</para>
</sect2>
</sect1>
Summary of changes:
help/C/Help_ch_Reports.xml | 42 +++++++++++++++++++++---------------------
1 file changed, 21 insertions(+), 21 deletions(-)
More information about the gnucash-changes
mailing list