Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
dev:client_coding:libreoffice_plugin_wire_protocol [2012/07/24 02:20] – [Word Processor Commands] simondev:client_coding:libreoffice_plugin_wire_protocol [2017/11/12 19:53] – external edit 127.0.0.1
Line 1: Line 1:
 +<html><p id="zotero-5-update-warning" style="color: red; font-weight: bold">We’re
 +in the process of updating the documentation for
 +<a href="https://www.zotero.org/blog/zotero-5-0">Zotero 5.0</a>. Some documentation
 +may be outdated in the meantime. Thanks for your understanding.</p></html>
 +
 +
 ====== 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
  
 <code> <code>
Line 61: Line 67:
 </code> </code>
  
-If the request is successful, the client must send a response with a JSON-encoded payload. This response is often code>null</code> 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 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, the client must send a response with the payload: If the request is unsuccessful, the client must send a response with the payload:
Line 319: Line 325:
 | fieldID | %%Integer|String%% | The fieldID, as originally returned by [[#Document_cursorInField]], [[#Document_insertField]], or [[#Document_getFields]]| | fieldID | %%Integer|String%% | The fieldID, as originally returned by [[#Document_cursorInField]], [[#Document_insertField]], or [[#Document_getFields]]|
 | 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 [[#Application_getActiveDocument]]|
 +| fieldID | %%Integer|String%% | The fieldID, as originally returned by [[#Document_cursorInField]], [[#Document_insertField]], or [[#Document_getFields]]|
 +| fieldType | %%String%% | The type of field used by the document, either ReferenceMark or Bookmark |
 +| noteType | %%Integer%% | The type of note specified by the style:<code>
 +NOTE_IN_TEXT = 0
 +NOTE_FOOTNOTE = 1
 +NOTE_ENDNOTE = 2
 +</code> |
  
 === Returns === === Returns ===
  
 null null
dev/client_coding/libreoffice_plugin_wire_protocol.txt · Last modified: 2022/07/20 09:44 by adomasven