Document processHTML

[tolino-api-docs.git] / api / internal-urls.rst

diff --git a/api/internal-urls.rst b/api/internal-urls.rst
index f66adff9844efec0f5bddff21a312d88441e2e8d..156f2dd1be656a558ef0c598a1a9bfb8e81807a2 100644 (file)
--- a/api/internal-urls.rst
+++ b/api/internal-urls.rst
@@ -7,7 +7,7 @@ Internal URLs
   Goes back to the main screen.
 
 ``epublishing://closeshop_skoti``
-  FIXME
+  Close the Skoobe shop
 
 ``epublishing://handshakeCancel``
   FIXME
@@ -16,7 +16,7 @@ Internal URLs
   FIXME
 
 ``epublishing://library``
-  FIXME
+  Open the "my books" library view
 
 ``epublishing://library_skoti``
   FIXME
@@ -25,30 +25,40 @@ Internal URLs
   The ``code`` is optional.
 
 ``epublishing://openbook``
-  FIXME
+  Start the reading mode for the given book
 
   Parameters:
     ``deliverableid``
-      FIXME
+      Book ID to open.
+
+      Example: ``DT0400.9783641267575_A39529579``
 
 ``epublishing://openbook_skoti``
   FIXME
 
 ``epublishing://openextract``
-  FIXME
+  Download the file and start the reading mode for a demo book extract
+  (German: "Leseprobe")
 
   Parameters (all 4 must be passed):
     ``extractcoverurl``
-      FIXME
+      URL of the book cover image.
 
     ``extractdeliverableid``
-      FIXME
+      Book ID
 
     ``extractdownloadurl``
-      FIXME
+      Download URL for the book demo ``.epub`` file.
 
     ``extractpurchaseurl``
-      FIXME
+      Where to buy the book after reading the extract.
+
+      Is used at the "To the shop" button that is shown on top of
+      the reading view for demo books.
+
+  The URL in the web view must not be escaped for this link to work.
+  Escpecially the ``&`` may not be escaped as ``&``
+  (which would be correct HTML), so you are forced to provide invalid HTML.
 
 
 ``epublishing://opensearchresult``
@@ -68,8 +78,8 @@ Internal URLs
   FIXME
 
 ``epublishing://search``
-  FIXME
+  Open the "search books" view.
 
   Parameters:
     ``q``
-      Search term
+      Search term to search the books list for.