dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 892
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Mon 2013-12-23 17:34:22 +0100
message:
  Svg conversion docs
modified:
  src/docbkx/en/dhis2_user_man_web_api.xml


--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs

Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription

=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml	2013-12-22 09:17:15 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2013-12-23 16:34:22 +0000
@@ -3381,6 +3381,21 @@
       to the URL similar to the one used above for retrieval.</para>
   </section>
   <section>
+    <title>SVG conversion</title>
+    <para>The Web API provides a resource which can be used to convert SVG content into more widely
+      used formats such as PNG and PDF. It works by sending the SVG content as the body of a HTTP
+      request to the <emphasis role="italic">svg</emphasis> resource. Ideally this conversion should
+      happen on the client side, but not all client side technologies are capable of performing this
+      task. Currently PNG and PDF output formats are supported. An optional query parameter
+        <emphasis role="italic">filename</emphasis> can be used to specify the filename of the
+      response attachment file. Note that the file extension should be omitted. For PNG you can send
+      a <emphasis role="italic">POST</emphasis> request with the SVG content as body like
+      this:</para>
+    <screen>api/svg.png?filename=myfile</screen>
+    <para>For PDF you can send a POST request with the SVG content as body like this:</para>
+    <screen>api/svg.pdf?filename=myfile</screen>
+  </section>
+  <section>
     <title>Person management</title>
     <para>Persons have full CRUD (create, read, update, delete) support in the Web-API. Together
       with the API for enrollment most operations needed for working with persons and programs are