wsd/reference.txt | 44 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 44 insertions(+)
New commits:
commit 984f74218680a94d23d0469c51297cf328975c90
Author: Pranav Kant <pran...@collabora.co.uk>
Date: Tue Dec 13 20:17:32 2016 +0530
Document WOPI extensions
Combination of following commits:
wsd: Document expanding WOPI extensions
Change-Id: I1c2c510154a0a987095ff1f4c343c033150f8ae6
(cherry picked from commit 1459223c691c6314e1f521a6f9de00e4fa82bc76)
Document owner termination feature
Change-Id: If9e09ba781e0cb53a6a96a6acdaac8995fa8f348
(cherry picked from commit 23ab2202594aca7fd10ade6b95a4c9e6df417fe4)
Reviewed-on: https://gerrit.libreoffice.org/32172
Reviewed-by: Michael Meeks <michael.me...@collabora.com>
Tested-by: Michael Meeks <michael.me...@collabora.com>
diff --git a/wsd/reference.txt b/wsd/reference.txt
index bc0cbe8..4e9f5b4 100644
--- a/wsd/reference.txt
+++ b/wsd/reference.txt
@@ -5,3 +5,47 @@ Document conversion:
- API: HTTP POST to /lool/convert-to
- parameters: format=<format> (see e.g. "png", "pdf" or "txt"), and
the file itself in the payload
- example: curl -F "data=@test.txt" -F "format=pdf"
https://localhost:9980/lool/convert-to
+
+WOPI Extensions
+===============
+
+LibreOffice Online uses WOPI protocol to interact with hosts who wants to
+integrate LibreOffice Online in them.
+
+Refer to WOPI docs[https://wopi.readthedocs.io/en/latest/] for detailed
+information. This documentation only mentions extensions to upstream WOPI
protocol,
+WOPI extensions, that are implemented by LibreOffice-Online backend in
addition to
+upstream WOPI protocol.
+
+(Please note that upstream WOPI implementation is also not 100% complete)
+
+CheckFileInfo response properties
+----------------------------------
+
+HidePrintOption
+ If set to true, hides the print option from the filemenu bar in the UI
+
+HideSaveOption
+ If set to true, hides the save button from the toolbar and file menubar
+ in the UI
+
+HideExportOption
+ Hides 'Download as' option in the file menubar
+
+DisablePrint
+ Disables print functionality in libreoffice online backend. If true,
+ HidePrintOption is assumed to be true
+
+DisableExport
+ Disables export functionality in backend. If set to true,
+ HideExportOption is assumed to be true
+
+DisableCopy
+ Disables copy/paste from/to the document in libreoffice online backend
+
+EnableOwnerTermination
+ If set to true, it allows the document owner (the one with OwnerId =
+ UserId) to send a 'closedocument' message (see protocol.txt)
+
+Note that it is possible to just hide print,save,export options while still
+being able to access them from WOPI hosts using PostMessage API (see
loleaflet/reference.html)
_______________________________________________
Libreoffice-commits mailing list
libreoffice-comm...@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/libreoffice-commits
