summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2024-03-02 21:29:07 +0100
committerChristian Grothoff <christian@grothoff.org>2024-03-02 21:29:07 +0100
commita9270360b6f0d0597a20fe3f9d1afc190b1a51a7 (patch)
tree0060c1e601fdf6d42e0d86952b5a82ab5c65d5ba
parentea4612e9671d4955145a9ca486d2434e5b2e38bd (diff)
downloaddocs-a9270360b6f0d0597a20fe3f9d1afc190b1a51a7.tar.gz
docs-a9270360b6f0d0597a20fe3f9d1afc190b1a51a7.tar.bz2
docs-a9270360b6f0d0597a20fe3f9d1afc190b1a51a7.zip
structural improvments, de-duplication
-rw-r--r--taler-auditor-manual.rst4
-rw-r--r--taler-challenger-manual.rst4
-rw-r--r--taler-exchange-manual.rst9
-rw-r--r--taler-merchant-api-tutorial.rst11
-rw-r--r--taler-merchant-manual.rst19
-rw-r--r--taler-merchant-pos-terminal.rst41
-rw-r--r--taler-user-guide.rst48
-rw-r--r--taler-wallet.rst20
8 files changed, 77 insertions, 79 deletions
diff --git a/taler-auditor-manual.rst b/taler-auditor-manual.rst
index 9f9bf1f7..bb8e7741 100644
--- a/taler-auditor-manual.rst
+++ b/taler-auditor-manual.rst
@@ -17,8 +17,8 @@
@author Christian Grothoff
-GNU Taler Auditor Operator Manual
-#################################
+Auditor Operator Manual
+#######################
Introduction
============
diff --git a/taler-challenger-manual.rst b/taler-challenger-manual.rst
index 3b89615e..3e4871cb 100644
--- a/taler-challenger-manual.rst
+++ b/taler-challenger-manual.rst
@@ -17,8 +17,8 @@
@author Christian Grothoff
@author Florian Dold
-GNU Taler Challenger Operator Manual
-####################################
+Challenger Operator Manual
+##########################
Introduction
============
diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst
index ecb88807..e3d5e745 100644
--- a/taler-exchange-manual.rst
+++ b/taler-exchange-manual.rst
@@ -17,8 +17,8 @@
@author Christian Grothoff
@author Florian Dold
-GNU Taler Exchange Operator Manual
-##################################
+Exchange Operator Manual
+########################
Introduction
============
@@ -35,6 +35,11 @@ About this manual
This manual targets system administrators who want to install and
operate a GNU Taler exchange.
+.. contents:: Table of Contents
+ :maxdepth: 1
+ :glob:
+
+
Organizational prerequisites
----------------------------
diff --git a/taler-merchant-api-tutorial.rst b/taler-merchant-api-tutorial.rst
index 87fee9ca..2bb95457 100644
--- a/taler-merchant-api-tutorial.rst
+++ b/taler-merchant-api-tutorial.rst
@@ -19,8 +19,8 @@
.. _merchant-api-tutorial:
-GNU Taler Merchant API Tutorial
-###############################
+Merchant API Tutorial
+#####################
Introduction
============
@@ -68,8 +68,13 @@ If you want to look at some simple, running examples, check out these:
process.
+.. contents:: Table of Contents
+ :maxdepth: 1
+ :glob:
+
+
Architecture overview
----------------------
+=====================
The Taler software stack for a merchant consists of the following main
components:
diff --git a/taler-merchant-manual.rst b/taler-merchant-manual.rst
index d1520d02..6e130f88 100644
--- a/taler-merchant-manual.rst
+++ b/taler-merchant-manual.rst
@@ -18,8 +18,8 @@
.. _taler-merchant-backend-operator-manual:
-GNU Taler Merchant Backend Operator Manual
-##########################################
+Merchant Backend Operator Manual
+################################
Introduction
============
@@ -42,21 +42,14 @@ We expect some moderate familiarity with the compilation and
installation of Free Software packages. An understanding of cryptography
is not required.
-This first chapter of the manual will give a brief overview of the
-overall Taler architecture, describing the environment in which the
-Taler backend operates. The second chapter then explains how to install
-the software, including key dependencies. The third chapter will explain
-how to configure the backend, including in particular the configuration
-of the bank account details of the merchant.
-
-The last chapter gives some additional information about advanced topics
-which will be useful for system administrators but are not necessary for
-operating a basic backend.
+.. contents:: Table of Contents
+ :maxdepth: 1
+ :glob:
.. _Architecture-overview:
Architecture overview
----------------------
+=====================
.. index:: crypto-currency
.. index:: KUDOS
diff --git a/taler-merchant-pos-terminal.rst b/taler-merchant-pos-terminal.rst
index 0cca1d52..1627cef8 100644
--- a/taler-merchant-pos-terminal.rst
+++ b/taler-merchant-pos-terminal.rst
@@ -17,15 +17,20 @@
.. _taler-merchant-pos-app:
-GNU Taler Merchant POS App
+Merchant Point of Sale App
##########################
-The GNU Taler merchant POS (point of sale) terminal allows sellers to
+The GNU Taler merchant point of sale (POS) App allows sellers to
* process customers' orders by adding or removing products
* calculate the amount owed by the customer
* let the customer make a Taler payment via QR code or NFC
+.. contents:: Table of Contents
+ :maxdepth: 1
+ :glob:
+
+
Android App
===========
@@ -66,38 +71,6 @@ Clicking this opens a menu with these items:
* Settings: Allows you to change the app configuration settings (URL and username/password)
and to forget the password (for locking the app).
-Testing nightly builds
-----------------------
-
-Every change to the app's source code triggers an automatic build
-that gets published in a F-Droid repository.
-If you don't have it already, download the `F-Droid app <https://f-droid.org/>`_
-and then click the following link (on your phone) to add the nightly repository.
-
- `GNU Taler Nightly F-Droid Repository <fdroidrepos://gnu-taler.gitlab.io/fdroid-repo-nightly/fdroid/repo?fingerprint=55F8A24F97FAB7B0960016AF393B7E57E7A0B13C2D2D36BAC50E1205923A7843>`_
-
-.. note::
- Nightly apps can be installed alongside official releases
- and thus are meant **only for testing purposes**.
- Use at your own risk!
-
-While not recommended, APKs can also be
-`downloaded directly <https://gitlab.com/gnu-taler/fdroid-repo-nightly/-/tree/master/fdroid%2Frepo>`__.
-
-Building from source
---------------------
-
-Import in and build with Android Studio or run on the command line:
-
-.. code-block:: console
-
- $ git clone https://git.taler.net/merchant-terminal-android.git
- $ cd merchant-terminal-android
- $ ./gradlew assembleRelease
-
-If you do not have the proprietary Android SDK installed,
-see the :doc:`taler-developer-manual`
-for :ref:`build instructions using free SDK rebuilds <Build-apps-from-source>`.
APIs and Data Formats
=====================
diff --git a/taler-user-guide.rst b/taler-user-guide.rst
index b29f7902..fbc3b1c6 100644
--- a/taler-user-guide.rst
+++ b/taler-user-guide.rst
@@ -16,8 +16,8 @@
@author Christian Grothoff
-GNU Taler User Guide
-####################
+User Guide
+##########
Introduction
============
@@ -38,6 +38,12 @@ an account at the bank. Some operations also require access to the merchant
backend.
+.. contents:: Table of Contents
+ :maxdepth: 1
+ :glob:
+
+
+
Withdrawing from bank accounts
==============================
@@ -179,18 +185,18 @@ A simple way for merchants to accept GNU Taler payments is the use of the
point-of-sale app. The app can be installed on an Android phone or tablet
and is configured via a simple JSON file on a Web site:
- * In the app settings you need to specify the URL of the Web site where
- the app can download the categories, products and prices from which
- orders are to be compiled. You can optionally specify a username and
- password to authenticate to the Web server.
+* In the app settings you need to specify the URL of the Web site where
+ the app can download the categories, products and prices from which
+ orders are to be compiled. You can optionally specify a username and
+ password to authenticate to the Web server.
- * The syntax of the JSON file is described in the point-of-sale app
- manual. However, you may simply want to download the sample JSON
- file from our documentation and use it as a starting point.
+* The syntax of the JSON file is described in the point-of-sale app
+ manual. However, you may simply want to download the sample JSON
+ file from our documentation and use it as a starting point.
- * A key option is the merchant backend with the authorization key
- which must be included in this JSON configuration. You may point
- the point-of-sale app to any instance of a merchant backend.
+* A key option is the merchant backend with the authorization key
+ which must be included in this JSON configuration. You may point
+ the point-of-sale app to any instance of a merchant backend.
Once configured, the point-of-sale app allows the user to select a product
category and then to quickly add products from that category to an order. You
@@ -305,8 +311,8 @@ Pay events
For "pay" events, the backend will provide the following
information to the Mustach templating engine:
- * :ref:`contract_terms <contract-terms>`: the contract terms of the paid order
- * order_id: the ID of the order that received the refund
+* :ref:`contract_terms <contract-terms>`: the contract terms of the paid order
+* order_id: the ID of the order that received the refund
Refund events
@@ -315,10 +321,10 @@ Refund events
For "refund" events, the backend will provide the following information to the
Mustach templating engine:
- * timestamp: time of the refund (in nanoseconds since 1970)
- * order_id: the ID of the order that received the refund
- * :ref:`contract_terms <contract-terms>`: the full JSON of the contract terms of the refunded order
- * refund_amout: the amount that was being refunded
- * reason: the reason entered by the merchant staff for granting the refund;
- be careful, you probably want to inform your staff if a webhook may expose
- this information to the consumer
+* timestamp: time of the refund (in nanoseconds since 1970)
+* order_id: the ID of the order that received the refund
+* :ref:`contract_terms <contract-terms>`: the full JSON of the contract terms of the refunded order
+* refund_amout: the amount that was being refunded
+* reason: the reason entered by the merchant staff for granting the refund;
+ be careful, you probably want to inform your staff if a webhook may expose
+ this information to the consumer
diff --git a/taler-wallet.rst b/taler-wallet.rst
index 62dca80d..5a10adc0 100644
--- a/taler-wallet.rst
+++ b/taler-wallet.rst
@@ -1,5 +1,21 @@
-GNU Taler Wallet Manual
-#######################
+..
+ This file is part of GNU TALER.
+ Copyright (C) 2014-2024 Taler Systems SA
+
+ TALER is free software; you can redistribute it and/or modify it under the
+ terms of the GNU Affero General Public License as published by the Free Software
+ Foundation; either version 2.1, or (at your option) any later version.
+
+ TALER is distributed in the hope that it will be useful, but WITHOUT ANY
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+ A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License along with
+ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
+
+
+Wallet Manual
+#############
The GNU Taler wallet allows customers to withdraw and spend digital cash.