diff options
author | Christian Grothoff <christian@grothoff.org> | 2016-11-11 19:15:42 +0100 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2016-11-11 19:15:42 +0100 |
commit | ad9764cb7ac78fcb32ee9de222cd8794e9d63737 (patch) | |
tree | 4498d089293ee029dca5e8f0c42af45edaa3b473 /doc | |
parent | 3bd6135650e57138c0c609703f43ba6c29f00c1d (diff) | |
download | merchant-ad9764cb7ac78fcb32ee9de222cd8794e9d63737.tar.gz merchant-ad9764cb7ac78fcb32ee9de222cd8794e9d63737.tar.bz2 merchant-ad9764cb7ac78fcb32ee9de222cd8794e9d63737.zip |
add larger TODOs from Laurent
Diffstat (limited to 'doc')
-rw-r--r-- | doc/examples/donate_handler.php | 2 | ||||
-rw-r--r-- | doc/manual.texi | 23 |
2 files changed, 21 insertions, 4 deletions
diff --git a/doc/examples/donate_handler.php b/doc/examples/donate_handler.php index 2cdf2de3..32775869 100644 --- a/doc/examples/donate_handler.php +++ b/doc/examples/donate_handler.php @@ -7,6 +7,6 @@ <title>Select payment method</title> </head> <body> - <!-- Put the credit card paywall here --> + Here you should put the HTML for the non-Taler (credit card) payment. </body> </html> diff --git a/doc/manual.texi b/doc/manual.texi index 082d38ad..9406912e 100644 --- a/doc/manual.texi +++ b/doc/manual.texi @@ -75,12 +75,15 @@ Hence, GNU Taler is compatible with anti-money-laundering (AML) and know-your-customer (KYC) regulation, as well as data protection regulation (such as GDPR). + @section About this manual This manual addresses how to integrate GNU Taler with Web shops. It describes how to install a GNU Taler merchant @emph{backend} and how to integrate it with an existing Web shop @emph{frontend}. +@c split manual into two: one for sysadmins (Ch. 1-3,5), one for Web developers (1+4) + The manual is for system administrators and Web developers. We expect some moderate familiarity with the compilation and installation of free software packages and of Web technology, in particular HTML and HTTP. @@ -89,6 +92,8 @@ An understanding of cryptography is not required. You can download all of the code examples given in this tutorial from @url{https://git.taler.net/merchant.git/tree/doc/examples/}. +@c Add section giving an overview of what we will do in the tutorial! + @section Architecture overview @@ -170,7 +175,7 @@ backend: @item libltdl @math{\ge 2.4} @item libunistring @math{\ge 0.9.3} @item libcurl @math{\ge 7.26} (or libgnurl @math{\ge 7.26}) -@item GNU libmicrohttpd @math{\ge 0.9.37} +@item GNU libmicrohttpd @math{\ge 0.9.39} @item GNU libgcrypt @math{\ge 1.6} @item libjansson @math{\ge 2.7} @item Postgres @math{\ge 9.4}, including libpq @@ -630,6 +635,16 @@ to a UNIX domain socket or properly restrict access to the port. +@c Add section describing how to test the backend. +@c For this, we should write some tools that make it +@c EASY to test the backend without going through the +@c full manual frontend setup! +@c NOTE: include explaining wallet installation to sysadmin + + +@c FIXME: this should be a separate manual + + @node Hello-world @chapter Setting up a simple Web shop with GNU Taler @@ -639,6 +654,8 @@ the ``donate'' button is clicked, the customer will receive a Taler contract offering him the opportunity to make a fixed donation, for example to donate 1 KUDOS to the charity operating the shop. +@c NOTE: include explaining wallet installation to Web developer here! + Note that if the customer does not have the Taler wallet installed, they should instead be prompted to proceed with a classic dialog for credit card payments. @@ -652,7 +669,7 @@ to the frontend @code{/donate} URL. For this, the HTML would be as follows: @smallexample -<form action="/donate"> +<form action="/donate_handler"> <input type="submit" value="Donate!"></input> <form> @end smallexample @@ -665,7 +682,7 @@ it will return a HTML page that will take care of: @item fetching a Taler contract and passing it to the wallet if one is found @end itemize -A minimalistic @code{/donate} handler is shown below (in PHP): +A minimalistic @code{/donate_handler} implementation is shown below (in PHP): @smallexample // merchant/doc/examples/donate_handler.php |