gnucash-docs maint: Python Bindings: link examples in API docs
Frank H.Ellenberger
fell at code.gnucash.org
Wed Jul 14 23:54:28 EDT 2021
Updated via https://github.com/Gnucash/gnucash-docs/commit/d33a0610 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/6094099d (commit)
commit d33a0610eedea32cb9cc7dac8608701014d41206
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Mon Jul 12 04:55:40 2021 +0200
Python Bindings: link examples in API docs
One step for Bug 585901 - Integration with other systems.
Translation got tags updated, but no new text.
diff --git a/docbook/gnc-docbookx.dtd b/docbook/gnc-docbookx.dtd
index 3f5a934b..bfec6d2d 100644
--- a/docbook/gnc-docbookx.dtd
+++ b/docbook/gnc-docbookx.dtd
@@ -49,6 +49,7 @@ own entity definitions to use across all of our DocBook pages. -->
<!ENTITY appname "GnuCash"> <!-- This should be used, where no further markup is desired, e.g. in GUI elements, URLs -->
<!ENTITY app "<application>GnuCash</application>"> <!-- This should be used in normal text -->
<!ENTITY app-fq "<application>Finance::Quote</application>">
+<!ENTITY app-py "<application>Python</application>">
<!-- Operating Systems (3 letters), Bundles: -->
<!ENTITY lin "<systemitem class='osname'>Linux</systemitem>">
@@ -77,7 +78,15 @@ own entity definitions to use across all of our DocBook pages. -->
a) Own URLs:
-->
<!ENTITY url-www "https://www.gnucash.org/">
+
+<!ENTITY url-bug-wiki "https://wiki.gnucash.org/wiki/Bugzilla"> <!-- The wiki page explaining the usage of bugzilla -->
+<!ENTITY url-bug-start "https://bugs.gnucash.org/">
+<!ENTITY url-bug-search "https://bugs.gnucash.org/query.cgi">
+<!ENTITY url-bug-browse "https://bugs.gnucash.org/describecomponents.cgi">
+
<!ENTITY url-docs "https://www.gnucash.org/docs/">
+<!ENTITY url-doc-api-main "https://code.gnucash.org/docs/MAINT/">
+<!ENTITY url-doc-api-mast "https://code.gnucash.org/docs/MASTER/">
<!-- Fixme: a dirty hack to reference the other document
Replace them after olink setup
append {guide|help}/<html-page> -->
@@ -87,21 +96,18 @@ own entity definitions to use across all of our DocBook pages. -->
<!ENTITY url-docs-build-ja "https://code.gnucash.org/docs/ja/gnucash-">
<!ENTITY url-docs-build-pt "https://code.gnucash.org/docs/pt/gnucash-">
<!ENTITY url-docs-build-ru "https://code.gnucash.org/docs/ru/gnucash-">
-<!ENTITY url-doc-api-main "https://code.gnucash.org/docs/MAINT/">
-<!ENTITY url-doc-api-mast "https://code.gnucash.org/docs/MASTER/">
-<!ENTITY url-bug-wiki "https://wiki.gnucash.org/wiki/Bugzilla"> <!-- The wiki page explaining the usage of bugzilla -->
-<!ENTITY url-bug-start "https://bugs.gnucash.org/">
-<!ENTITY url-bug-search "https://bugs.gnucash.org/query.cgi">
-<!ENTITY url-bug-browse "https://bugs.gnucash.org/describecomponents.cgi">
<!ENTITY url-irc "irc://irc.gnome.org/gnucash">
<!ENTITY url-logs-irc "https://lists.gnucash.org/logs/"> <!-- for IRC. If someone needs build logs, scan https://code.gnucash.org/builds/ -->
+
<!ENTITY url-mail-ar "https://lists.gnucash.org/pipermail/"> <!-- Append <list>/<Year>-<Monthname>/<Number>.html -->
<!ENTITY url-mail-li "https://lists.gnucash.org/mailman/listinfo/"> <!-- Append the desired list -->
<!ENTITY url-mail-nabble "http://gnucash.1415818.n4.nabble.com/GnuCash-f1415818.subapps.html">
<!ENTITY url-mail-gmane "nntp://news.gmane.org/gmane.comp.gnome.apps.gnucash.user">
+
<!ENTITY url-src "https://github.com/Gnucash/gnucash/">
<!ENTITY url-src-maint "https://github.com/Gnucash/gnucash/tree/maint/"> <!-- Append the desired topic -->
+
<!ENTITY url-wiki "https://wiki.gnucash.org/wiki/"> <!-- You could append the desired topic, but better create a separate entity. -->
<!ENTITY url-wiki-de "https://wiki.gnucash.org/wiki/De/"> <!-- German root -->
<!ENTITY url-wiki-api-custom "https://wiki.gnucash.org/wiki/Custom_Reports#The_GnuCash_API">
@@ -124,6 +130,7 @@ own entity definitions to use across all of our DocBook pages. -->
<!-- wiki Special: translation is done by mediawiki: -->
<!ENTITY url-wiki-category "https://wiki.gnucash.org/wiki/Special:Categories">
<!ENTITY url-wiki-search "https://wiki.gnucash.org/wiki/Special:Search">
+
<!-- b) Third party URLs: -->
<!ENTITY url-av "https://www.alphavantage.co/"> <!-- A F::Q source, which requires registration -->
<!ENTITY url-gh "https://github.com/"> <!-- we want to reference our libs, too. -->
@@ -140,6 +147,7 @@ own entity definitions to use across all of our DocBook pages. -->
<!ENTITY url-wp-ru "https://ru.wikipedia.org/wiki/"> <!-- Append the desired topic -->
<!ENTITY url-yh-fin "https://finance.yahoo.com/"> <!-- Append the desired topic -->
<!ENTITY url-yh-hlp "https://help.yahoo.com/"> <!-- Append the desired topic -->
+
<!-- c) URLs of Authors -->
<!ENTITY url-selinger "https://www.mathstat.dal.ca/~selinger/">
<!ENTITY tit-sel-tut "Tutorial on multiple currency accounting">
diff --git a/guide/C/ch_python_bindings.xml b/guide/C/ch_python_bindings.xml
index c7ffec99..34d8ddfe 100644
--- a/guide/C/ch_python_bindings.xml
+++ b/guide/C/ch_python_bindings.xml
@@ -1,18 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter SYSTEM "gnc-docbookx.dtd">
<!-- (Do not remove this comment block.)
-
Version: 2.4.0
Last modified: 2011-01-01
-
Maintainers:
-
Author:
- Mike Evans <mikee at saxicola.co.uk>
-
- Translators:
- (translators put your name and email here)
+Mike Evans <mikee at saxicola.co.uk>
+Translators:
+(translators put your name and email here)
-->
+<!-- Todo: Database backends offer read access;
+ Guile is also a sripting language perhaps its stand alone use should be explained here, too? -->
+<!-- Todo: after adding a procedure convert this page into a https://tdg.docbook.org/tdg/4.5/task.html -->
<chapter id="ch_python_bindings">
<title>Python Bindings</title>
@@ -28,25 +27,31 @@ Author:
the other scripting language.
</para>
- <para>Starting with &app; version 2.4 you can write <application>Python</application> scripts to
- manipulate your financial data.
+ <para>Starting with &app; version 2.4 you can write
+ <ulink url="&url-wp-en;Python_(programming_language)">&app-py;</ulink> scripts to manipulate
+ your financial data.
</para>
- <note>
- <para>The <application>Python</application> extensions are an optional feature in the source code. To be
- able to use <application>Python</application> scripts, &app; must have been compiled with this
- option enabled, otherwise all what follows won’t work. At present this option is not
- enabled by default, so if you need this, you may have to compile &app; from source yourself.
+ <important>
+ <para>The &app-py; extensions are an optional feature which creates additional dependencies. To be able to
+ use &app-py; scripts, &app; must have been built with the <code language="sh">cmake
+ -DWITH_PYTHON=ON â¦</code> option enabled, otherwise all what follows won’t work. At
+ present this option is not enabled by default, so if you need this, you may have to compile
+ &app; from source yourself. But some distributions offer it also as a separate package with a
+ name like<package>
+ python[<replaceable>version</replaceable>]-&appname;
+ </package>
</para>
- </note>
+ </important>
- <para>The <application>Python</application> extensions come with a couple of ready to use scripts. This
- chapter will show you how to use some of these.
+ <para>The &app-py; extensions come with a couple of ready to use scripts. This chapter will show you how
+ to <emphasis>use</emphasis> some of them.
</para>
- <note>
- <para>This chapter is not about how to write your own <application>Python</application> scripts. Refer to
- the developer documentation for that instead.
+ <tip>
+ <para>This chapter is not about how to write your own &app-py; scripts. Refer to the
+ <ulink url="&url-doc-api-main;python_bindings_page.html">developer documentation</ulink> for
+ that instead.
</para>
- </note>
+ </tip>
</chapter>
diff --git a/guide/de/ch_python_bindings.xml b/guide/de/ch_python_bindings.xml
index 6b13b6a6..eb2417ab 100644
--- a/guide/de/ch_python_bindings.xml
+++ b/guide/de/ch_python_bindings.xml
@@ -1,58 +1,61 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter SYSTEM "gnc-docbookx.dtd">
<!-- (Do not remove this comment block.)
-
Version: 2.4.0
Last modified: 2011-01-01
-
Maintainers:
-
Author:
- Mike Evans <mikee at saxicola.co.uk>
-
- Translators:
- (translators put your name and email here)
+Mike Evans <mikee at saxicola.co.uk>
+Translators:
+(translators put your name and email here)
-->
+<!-- Todo: Database backends offer read access;
+ Guile is also a sripting language perhaps its stand alone use should be explained here, too? -->
+<!-- Todo: after adding a procedure convert this page into a https://tdg.docbook.org/tdg/4.5/task.html -->
<chapter id="ch_python_bindings">
<title>Python Bindings</title>
<para>&untranslated-de;
</para>
<!--
- <para>
- &app; historically has always been a
- traditional application in the sense that you open it, use it to
- manipulate your financial data via the windows it presents, save your
- data and close the windows again. This has the inherent limitation that
- you can only do whatever the windows, menus and toolbars allow you to do.
+ <para>&app; historically has always been a traditional application in the sense that you open it, use it
+ to manipulate your financial data via the windows it presents, save your data and close the
+ windows again. This has the inherent limitation that you can only do whatever the windows, menus
+ and toolbars allow you to do.
</para>
- <para>
- Sometimes you might need a little more flexibility. For example, you
- need a report with just a little different information than what the
- built-in reports provide, or you want to automate a frequently recurring
- action. Such custom manipulations are ideal candidates to write in one
- or the other scripting language.
+
+ <para>Sometimes you might need a little more flexibility. For example, you need a report with just a
+ little different information than what the built-in reports provide, or you want to automate a
+ frequently recurring action. Such custom manipulations are ideal candidates to write in one or
+ the other scripting language.
</para>
- <para>
- Starting with &app; version 2.4 you can
- write <application>Python</application> scripts to manipulate your financial data.
+
+ <para>Starting with &app; version 2.4 you can write
+ <ulink url="&url-wp-en;Python_(programming_language)">&app-py;</ulink> scripts to manipulate
+ your financial data.
</para>
- <note>
- <para>The <application>Python</application> extensions are an optional feature in the source code.
- To be able to use <application>Python</application> scripts, &app; must
- have been compiled with this option enabled, otherwise all what follows
- won’t work. At present this option is not enabled by default, so if you
- need this, you may have to compile &app; from
- source yourself.
+
+ <important>
+ <para>The &app-py; extensions are an optional feature which creates additional dependencies. To be able to
+ use &app-py; scripts, &app; must have been built with the <code language="sh">cmake
+ -DWITH_PYTHON=ON â¦</code> option enabled, otherwise all what follows won’t work. At
+ present this option is not enabled by default, so if you need this, you may have to compile
+ &app; from source yourself. But some distributions offer it also as a separate package with a
+ name like<package>
+ python[<replaceable>version</replaceable>]-&appname;
+ </package>
</para>
- </note>
- <para>The <application>Python</application> extensions come with a couple of ready to use scripts. This
- chapter will show you how to use some of these.
+ </important>
+
+ <para>The &app-py; extensions come with a couple of ready to use scripts. This chapter will show you how
+ to <emphasis>use</emphasis> some of them.
</para>
- <note>
- <para>This chapter is not about how to write your own <application>Python</application> scripts.
- Refer to the developer documentation for that instead.
+
+ <tip>
+ <para>This chapter is not about how to write your own &app-py; scripts. Refer to the
+ <ulink url="&url-doc-api-main;python_bindings_page.html">developer documentation</ulink> for
+ that instead.
</para>
- </note>
+ </tip>
-->
</chapter>
diff --git a/guide/it/gnucash-guide.xml b/guide/it/gnucash-guide.xml
index afb0ca63..bb636fae 100644
--- a/guide/it/gnucash-guide.xml
+++ b/guide/it/gnucash-guide.xml
@@ -17935,18 +17935,18 @@ Translators:
</sect1>
</chapter>
<!-- (Do not remove this comment block.)
-
Version: 2.4.0
Last modified: 2011-01-01
-
Maintainers:
-
Author:
- Mike Evans <mikee at saxicola.co.uk>
+Mike Evans <mikee at saxicola.co.uk>
- Translators:
- (translators put your name and email here)
+Translators:
+(translators put your name and email here)
-->
+<!-- Todo: Database backends offer read access;
+ Guile is also a sripting language perhaps its stand alone use should be explained here, too? -->
+<!-- Todo: after adding a procedure convert this page into a https://tdg.docbook.org/tdg/4.5/task.html -->
<chapter id="ch_python_bindings">
<title>Python Bindings</title>
@@ -17964,27 +17964,27 @@ Author:
</para>
<para>A partire dalla versione 2.4 di &app; è possibile utilizzare degli script di
- <application>Python</application> per manipolare i propri dati finanziari.
+ &app-py; per manipolare i propri dati finanziari.
</para>
- <note>
- <para>Le estensioni di <application>Python</application> sono una caratteristica opzionale del codice
- sorgente. Per poter utilizzare gli script di <application>Python</application>, &app; deve
- essere stato compilato con questa opzione abilitata. Al momento questa opzione non è
+ <important>
+ <para>Le estensioni di &app-py; sono una caratteristica opzionale del codice
+ sorgente. Per poter utilizzare gli script di &app-py;, &app; deve essere stato
+ compilato con questa <code language="sh">cmake-DWITH_PYTHON=ON â¦</code> opzione abilitata. Al momento questa opzione non è
abilitata di default, quindi per poter utilizzare questa funzionalità , è necessario
compilare &app; da sorgente.
</para>
- </note>
+ </important>
- <para>Le estensioni <application>Python</application> sono fornite con un paio di script già pronti per
- l’utilizzo. Questo capitolo illustra come utilizzarli.
+ <para>Le estensioni &app-py; sono fornite con un paio di script già pronti per
+ l’utilizzo. Questo capitolo illustra come <emphasis>utilizzarli</emphasis>.
</para>
- <note>
- <para>Questo capitolo non spiega come scrivere il proprio script di <application>Python</application>. Per
- questo fare riferimento alla documentazione per gli sviluppatori.
+ <tip>
+ <para>Questo capitolo non spiega come scrivere il proprio script di &app-py;. Per
+ questo fare riferimento alla <ulink url="&url-doc-api-main;python_bindings_page.html">documentazione per gli sviluppatori</ulink>.
</para>
- </note>
+ </tip>
</chapter>
<!-- (Do not remove this comment block.)
@@ -18022,7 +18022,7 @@ Author:
</para>
<para>Perchè l’importatore funzioni correttamente, i dati devono essere in formato a lunghezza
- fissa di campo, o separati da virgole. Uno script di <application>Python</application> è
+ fissa di campo, o separati da virgole. Uno script di &app-py; è
fornito di seguito come esempio.
</para>
@@ -18068,7 +18068,7 @@ line number,product code,quantity,availability,product description,unit price,di
</programlisting>
</para>
- <para>Un file simile dopo essere stato processato con lo script di <application>Python</application>.
+ <para>Un file simile dopo essere stato processato con lo script di &app-py;.
</para>
<para><programlisting language="python">
@@ -18159,17 +18159,17 @@ MEC-0071,,000013,,,,VAT,tax,Expenses:VAT,1,4.35,,,,no,,,,,,,
</para>
<note>
- <para>Se non si ha dimestichezza con <application>Python</application> (esistono altri linguaggi), è
+ <para>Se non si ha dimestichezza con &app-py; (esistono altri linguaggi), è
possibile inviare una richiesta alla
<ulink url="&url-mail-li;gnucash-user"><citetitle>lista dell’utente di
&appname;</citetitle>, con un esempio del proprio file <acronym>CSV</acronym> scaricato,
e probabilmente qualcuno si preoccuperà di scrivere uno script di
- <application>Python</application> per la sua traduzione.</ulink>
+ &app-py; per la sua traduzione.</ulink>
</para>
</note>
<sect2 id="python-author-notes">
- <title>Note per gli autori <application>Python</application></title>
+ <title>Note per gli autori &app-py;</title>
<para>Per poter completare con successo il processo di importazione, il numero di campi deve essere
rispettato, quindi le virgole sono importanti.
diff --git a/guide/ja/ch_python_bindings.xml b/guide/ja/ch_python_bindings.xml
index 4f04acd0..3a2c8358 100644
--- a/guide/ja/ch_python_bindings.xml
+++ b/guide/ja/ch_python_bindings.xml
@@ -1,19 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter SYSTEM "gnc-docbookx.dtd">
<!-- (Do not remove this comment block.)
-
Version: 2.4.0
Last modified: 2011-01-01
-
Maintainers:
-
Author:
- Mike Evans <mikee at saxicola.co.uk>
-
-
- Translators:
- (translators put your name and email here)
+Mike Evans <mikee at saxicola.co.uk>
+Translators:
+(translators put your name and email here)
-->
+<!-- Todo: Database backends offer read access;
+ Guile is also a sripting language perhaps its stand alone use should be explained here, too? -->
+<!-- Todo: after adding a procedure convert this page into a https://tdg.docbook.org/tdg/4.5/task.html -->
<chapter id="ch_python_bindigs">
<title>Pythonæ¡å¼µ</title>
@@ -27,31 +25,31 @@ Author:
</para>
<para>&app;ãã¼ã¸ã§ã³2.4
- ããã¯è²¡åãã¼ã¿ãæä½ããããã«<application>Python</application>ã¹ã¯ãªãããæ¸ããã¨ãã§ããããã«ãªãã¾ããã
+ ããã¯è²¡åãã¼ã¿ãæä½ããããã«<ulink url="&url-wp-en;Python_(programming_language)">&app-py;</ulink>ã¹ã¯ãªãããæ¸ããã¨ãã§ããããã«ãªãã¾ããã
</para>
- <note>
- <para><application>Python</application>æ¡å¼µã¯ã½ã¼ã¹ã³ã¼ãã§ã®ãªãã·ã§ã³æ©è½ã§ãã
- <application>Python</application>ã¹ã¯ãªãããæå¹ã«ããããã«ã¯ã<application>Python</application>æ¡å¼µãæå¹ã«ãã¦&app;ãã³ã³ãã¤ã«ããªããã°ããã¾ãããããã§ãªãå ´åã¯åä½ãã¾ããã
+ <important>
+ <para>&app-py;æ¡å¼µã¯ã½ã¼ã¹ã³ã¼ãã§ã®ãªãã·ã§ã³æ©è½ã§ãã
+ &app-py;ã¹ã¯ãªãããæå¹ã«ããããã«ã¯ã&app-py;æ¡å¼µãæå¹ã«ãã¦&app;ãã³ã³ãã¤ã«ããªããã°ããã¾ãããããã§ãªãå ´åã¯åä½ãã¾ããã
ç¾å¨ã®ã¨ãããã®ãªãã·ã§ã³ã¯ããã©ã«ãã§ç¡å¹ã§ããå¿
è¦ãªå ´åã¯&app;ãèªåã§ã³ã³ãã¤ã«ããªããã°ãããªãããããã¾ããã
</para>
- </note>
+ </important>
- <para><application>Python</application>æ¡å¼µã使ç¨ããããã«ã¯äºã¤ã®æºåãã§ãã¦ããªããã°ããã¾ããã
+ <para>&app-py;æ¡å¼µã使ç¨ããããã«ã¯äºã¤ã®æºåãã§ãã¦ããªããã°ããã¾ããã
æ¬ç« ã§ã¯ã©ã®ããã«ä½¿ç¨ãããã«ã¤ãã¦èª¬æãã¾ãã
</para>
- <note>
- <para>æ¬ç« ã§ã¯ã©ã®ããã«<application>Python</application>ã¹ã¯ãªãããæ¸ããã«é¢ãã¦ã¯èª¬æãã¾ããã
+ <tip>
+ <para>æ¬ç« ã§ã¯ã©ã®ããã«&app-py;ã¹ã¯ãªãããæ¸ããã«é¢ãã¦ã¯èª¬æãã¾ããã
代ããã«éçºè
åãææ¸ãåç
§ãã¦ãã ããã
</para>
- </note>
+ </tip>
<sect1 id="python-import-invoices">
<title>徿å
è«æ±æ¸ã¾ãã¯ä»å
¥å
è«æ±æ¸ã®ã¤ã³ãã¼ã</title>
<para>ã¤ã³ãã¼ããåä½ãããã«ã¯ããã¼ã¿ãåºå®ãã£ã¼ã«ããã³ã³ãåºåãã®ãã¼ã¿ã§ãªããã°ããã¾ããã
- ãã¦ã³ãã¼ãããæ³¨æã夿ãã<application>Python</application>ã¹ã¯ãªããä¾ã次ã«ç¤ºãã¾ãã
+ ãã¦ã³ãã¼ãããæ³¨æã夿ãã&app-py;ã¹ã¯ãªããä¾ã次ã«ç¤ºãã¾ãã
</para>
<para><programlisting language="python" linenumbering="unnumbered">
@@ -96,7 +94,7 @@ line number,product code,quantity,availability,product description,unit price,di
</programlisting>
</para>
- <para><application>Python</application>ã¹ã¯ãªããã§å¦çããå¾ã®åããã¡ã¤ã«ã¯æ¬¡ã®ããã«ãªãã¾ãã
+ <para>&app-py;ã¹ã¯ãªããã§å¦çããå¾ã®åããã¡ã¤ã«ã¯æ¬¡ã®ããã«ãªãã¾ãã
</para>
<para><programlisting language="python">
@@ -179,14 +177,14 @@ MEC-0071,,000013,,,,VAT,tax,Expenses:VAT,1,4.35,,,,no,,,,,,,,
</para>
<note>
- <para><application>Python</application> (ã¾ãã¯ä»ã®å©ç¨å¯è½ãªè¨èª)
+ <para>&app-py; (ã¾ãã¯ä»ã®å©ç¨å¯è½ãªè¨èª)
ãåãããªãå ´åã<ulink
-url="&url-mail-li;gnucash-user"><citetitle>&appname;å©ç¨è
ã¡ã¼ãªã³ã°ãªã¹ã</citetitle></ulink>ã«ãã¦ã³ãã¼ããã<acronym>CSV</acronym>ã®ä¾ã¨ä½µãã¦è¦æãæç¨¿ãã¦ãã ããã誰ãã夿ç¨ã®<application>Python</application>ã¹ã¯ãªãããæ¸ãã¦ãããããããã¾ããã
+url="&url-mail-li;gnucash-user"><citetitle>&appname;å©ç¨è
ã¡ã¼ãªã³ã°ãªã¹ã</citetitle></ulink>ã«ãã¦ã³ãã¼ããã<acronym>CSV</acronym>ã®ä¾ã¨ä½µãã¦è¦æãæç¨¿ãã¦ãã ããã誰ãã夿ç¨ã®&app-py;ã¹ã¯ãªãããæ¸ãã¦ãããããããã¾ããã
</para>
</note>
<sect2 id="python-author-notes">
- <title><application>Python</application>ä½è
ã¸ã®åè</title>
+ <title>&app-py;ä½è
ã¸ã®åè</title>
<para>ã¤ã³ãã¼ããæåãããã«ã¯ããã£ã¼ã«ãæ°ãå®ããªããã°ããã¾ããããã£ã¦è¡æ«ã«ããã³ã³ãã®æ°ãéè¦ã§ãã
</para>
diff --git a/guide/pt/ch_python_bindings.xml b/guide/pt/ch_python_bindings.xml
index c7ffec99..2c0f2836 100644
--- a/guide/pt/ch_python_bindings.xml
+++ b/guide/pt/ch_python_bindings.xml
@@ -1,18 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter SYSTEM "gnc-docbookx.dtd">
<!-- (Do not remove this comment block.)
-
Version: 2.4.0
Last modified: 2011-01-01
-
Maintainers:
-
Author:
- Mike Evans <mikee at saxicola.co.uk>
-
- Translators:
- (translators put your name and email here)
+Mike Evans <mikee at saxicola.co.uk>
+Translators:
+(translators put your name and email here)
-->
+<!-- Todo: Database backends offer read access;
+ Guile is also a sripting language perhaps its stand alone use should be explained here, too? -->
+<!-- Todo: after adding a procedure convert this page into a https://tdg.docbook.org/tdg/4.5/task.html -->
<chapter id="ch_python_bindings">
<title>Python Bindings</title>
@@ -28,20 +27,25 @@ Author:
the other scripting language.
</para>
- <para>Starting with &app; version 2.4 you can write <application>Python</application> scripts to
- manipulate your financial data.
+ <para>Starting with &app; version 2.4 you can write
+ <ulink url="&url-wp-en;Python_(programming_language)">&app-py;</ulink> scripts to manipulate
+ your financial data.
</para>
- <note>
- <para>The <application>Python</application> extensions are an optional feature in the source code. To be
- able to use <application>Python</application> scripts, &app; must have been compiled with this
- option enabled, otherwise all what follows won’t work. At present this option is not
- enabled by default, so if you need this, you may have to compile &app; from source yourself.
+ <important>
+ <para>The &app-py; extensions are an optional feature which creates additional dependencies. To be able to
+ use &app-py; scripts, &app; must have been built with the <code language="sh">cmake
+ -DWITH_PYTHON=ON â¦</code> option enabled, otherwise all what follows won’t work. At
+ present this option is not enabled by default, so if you need this, you may have to compile
+ &app; from source yourself. But some distributions offer it also as a separate package with a
+ name like<package>
+ python[<replaceable>version</replaceable>]-&appname;
+ </package>
</para>
- </note>
+ </important>
- <para>The <application>Python</application> extensions come with a couple of ready to use scripts. This
- chapter will show you how to use some of these.
+ <para>The &app-py; extensions come with a couple of ready to use scripts. This chapter will show you how
+ to <emphasis>use</emphasis> some of them.
</para>
<note>
diff --git a/guide/ru/ch_python_bindings.xml b/guide/ru/ch_python_bindings.xml
index c7ffec99..34d8ddfe 100644
--- a/guide/ru/ch_python_bindings.xml
+++ b/guide/ru/ch_python_bindings.xml
@@ -1,18 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter SYSTEM "gnc-docbookx.dtd">
<!-- (Do not remove this comment block.)
-
Version: 2.4.0
Last modified: 2011-01-01
-
Maintainers:
-
Author:
- Mike Evans <mikee at saxicola.co.uk>
-
- Translators:
- (translators put your name and email here)
+Mike Evans <mikee at saxicola.co.uk>
+Translators:
+(translators put your name and email here)
-->
+<!-- Todo: Database backends offer read access;
+ Guile is also a sripting language perhaps its stand alone use should be explained here, too? -->
+<!-- Todo: after adding a procedure convert this page into a https://tdg.docbook.org/tdg/4.5/task.html -->
<chapter id="ch_python_bindings">
<title>Python Bindings</title>
@@ -28,25 +27,31 @@ Author:
the other scripting language.
</para>
- <para>Starting with &app; version 2.4 you can write <application>Python</application> scripts to
- manipulate your financial data.
+ <para>Starting with &app; version 2.4 you can write
+ <ulink url="&url-wp-en;Python_(programming_language)">&app-py;</ulink> scripts to manipulate
+ your financial data.
</para>
- <note>
- <para>The <application>Python</application> extensions are an optional feature in the source code. To be
- able to use <application>Python</application> scripts, &app; must have been compiled with this
- option enabled, otherwise all what follows won’t work. At present this option is not
- enabled by default, so if you need this, you may have to compile &app; from source yourself.
+ <important>
+ <para>The &app-py; extensions are an optional feature which creates additional dependencies. To be able to
+ use &app-py; scripts, &app; must have been built with the <code language="sh">cmake
+ -DWITH_PYTHON=ON â¦</code> option enabled, otherwise all what follows won’t work. At
+ present this option is not enabled by default, so if you need this, you may have to compile
+ &app; from source yourself. But some distributions offer it also as a separate package with a
+ name like<package>
+ python[<replaceable>version</replaceable>]-&appname;
+ </package>
</para>
- </note>
+ </important>
- <para>The <application>Python</application> extensions come with a couple of ready to use scripts. This
- chapter will show you how to use some of these.
+ <para>The &app-py; extensions come with a couple of ready to use scripts. This chapter will show you how
+ to <emphasis>use</emphasis> some of them.
</para>
- <note>
- <para>This chapter is not about how to write your own <application>Python</application> scripts. Refer to
- the developer documentation for that instead.
+ <tip>
+ <para>This chapter is not about how to write your own &app-py; scripts. Refer to the
+ <ulink url="&url-doc-api-main;python_bindings_page.html">developer documentation</ulink> for
+ that instead.
</para>
- </note>
+ </tip>
</chapter>
Summary of changes:
docbook/gnc-docbookx.dtd | 20 +++++++----
guide/C/ch_python_bindings.xml | 47 ++++++++++++++------------
guide/de/ch_python_bindings.xml | 75 +++++++++++++++++++++--------------------
guide/it/gnucash-guide.xml | 46 ++++++++++++-------------
guide/ja/ch_python_bindings.xml | 42 +++++++++++------------
guide/pt/ch_python_bindings.xml | 38 +++++++++++----------
guide/ru/ch_python_bindings.xml | 47 ++++++++++++++------------
7 files changed, 169 insertions(+), 146 deletions(-)
More information about the gnucash-changes
mailing list