Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
dev:client_coding:libreoffice_plugin_wire_protocol [2012/07/24 02:20] – [Word Processor Commands] simon | dev:client_coding:libreoffice_plugin_wire_protocol [2020/10/13 03:57] – Add import/export commands and improve/clarify other commands. adomasven | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | < | ||
+ | in the process of updating the documentation for | ||
+ | <a href=" | ||
+ | may be outdated in the meantime. Thanks for your understanding.</ | ||
+ | |||
+ | |||
====== LibreOffice Plugin Wire Protocol ====== | ====== LibreOffice Plugin Wire Protocol ====== | ||
Line 55: | Line 61: | ||
===== Word Processor Commands ==== | ===== Word Processor Commands ==== | ||
- | These commands are sent from Zotero to the word processor. They must always receive a response, although this response is sometimes null. The command payload is always JSON-encoded in the form | + | These commands are sent from Zotero to the word processor. They must always receive a response. The command payload is always JSON-encoded in the form |
< | < | ||
Line 61: | Line 67: | ||
</ | </ | ||
- | If the request is successful, the client must send a response with a JSON-encoded payload. This response is often code>null</ | + | If the request is successful, the client must send a response with a JSON-encoded payload. This response is often null if the command returns no output, but may also be an array, an integer, a string, or a boolean value depending on the command. |
If the request is unsuccessful, | If the request is unsuccessful, | ||
Line 157: | Line 163: | ||
==== Document_getDocumentData ==== | ==== Document_getDocumentData ==== | ||
- | Retrieves data string set by [[# | + | Retrieves data string set by [[# |
=== Parameters === | === Parameters === | ||
Line 165: | Line 171: | ||
=== Returns === | === Returns === | ||
- | (String) The document data string. | + | (String) The document data string |
==== Document_cursorInField ==== | ==== Document_cursorInField ==== | ||
Line 226: | Line 232: | ||
TODO | TODO | ||
+ | |||
+ | |||
+ | ==== Document_importDocument ==== | ||
+ | |||
+ | Called to convert Zotero document transfer format links to fields after Document_getDocumentData returns " | ||
+ | |||
+ | === Parameters === | ||
+ | |||
+ | | 0 | documentID | %%Integer|String%% | The documentID, as originally returned by [[# | ||
+ | | 1 | fieldType | %%String%% | Specifies to what field type the import links should be converted. Should always be " | ||
+ | |||
+ | === Returns === | ||
+ | |||
+ | `true` if field links and document data were found and imported, `false` otherwise | ||
+ | |||
+ | |||
+ | ==== Document_exportDocument ==== | ||
+ | |||
+ | Converts the document to the Zotero transfer document format. The format is: | ||
+ | 1. Insert 4 paragraphs at the beginning of the document, where first one reads " | ||
+ | 2. Convert all citations to links that point to " | ||
+ | 3. At the end of the document insert a link that points to " | ||
+ | |||
+ | === Parameters === | ||
+ | |||
+ | | 0 | documentID | %%Integer|String%% | The documentID, as originally returned by [[# | ||
+ | | 1 | fieldType | %%String%% | The field type that the document stores Zotero citations in. Either " | ||
+ | | 2 | transferDocumentInstructions | %%String%% | A text string to be inserted at the start of the document explaining the document format | | ||
+ | |||
+ | === Returns === | ||
+ | |||
+ | null | ||
==== Document_setBibliographyStyle ==== | ==== Document_setBibliographyStyle ==== | ||
- | TODO | + | Provides parameters for the dedicated bibliography formatting style (usually called " |
+ | |||
+ | === Parameters === | ||
+ | |||
+ | | 0 | documentID | %%Integer|String%% | The documentID, as originally returned by [[# | ||
+ | | 1 | firstLineIndent | %%Integer%% | First line indent in twips | | ||
+ | | 2 | bodyIndent | %%Integer%% | Bibliography body indent in twips. Applies to first line too. First line indent is calculated by < | ||
+ | | 3 | lineSpacing | %%Integer%% | Line spacing in twips | | ||
+ | | 4 | entrySpacing | %%Integer%% | Bibliography entry spacing in twips | | ||
+ | | 5 | tabStops | %%Array(Integer)%% | Tabulator indents | | ||
+ | | 6 | numTabStops | %%Integer%% | Length of tabStops array | | ||
+ | |||
+ | == Example Parameters == | ||
+ | |||
+ | < | ||
+ | [1, -720, 720, 240, 0, [], 0] | ||
+ | [1, -720, 720, 240, 0, [1], 720] | ||
+ | </ | ||
+ | |||
+ | |||
+ | === Returns === | ||
+ | |||
+ | null | ||
==== Document_complete ==== | ==== Document_complete ==== | ||
Line 299: | Line 359: | ||
==== Field_getText ==== | ==== Field_getText ==== | ||
- | Gets the (visible) text of a field. | + | Gets the (visible) text of a field. Note that any RTF information from setText is not returned, just the visible plaintext. |
=== Parameters === | === Parameters === | ||
Line 319: | Line 379: | ||
| fieldID | %%Integer|String%% | The fieldID, as originally returned by [[# | | fieldID | %%Integer|String%% | The fieldID, as originally returned by [[# | ||
| code | %%String%% | The field code| | | code | %%String%% | The field code| | ||
+ | |||
+ | === Returns === | ||
+ | |||
+ | null | ||
+ | |||
+ | ==== Field_convert ==== | ||
+ | |||
+ | Converts a field from one type to another. | ||
+ | |||
+ | === Parameters === | ||
+ | |||
+ | | documentID | %%Integer|String%% | The documentID, as originally returned by [[# | ||
+ | | fieldID | %%Integer|String%% | The fieldID, as originally returned by [[# | ||
+ | | fieldType | %%String%% | The type of field used by the document, either ReferenceMark or Bookmark | | ||
+ | | noteType | %%Integer%% | The type of note specified by the style:< | ||
+ | NOTE_IN_TEXT = 0 | ||
+ | NOTE_FOOTNOTE = 1 | ||
+ | NOTE_ENDNOTE = 2 | ||
+ | </ | ||
=== Returns === | === Returns === | ||
null | null |