Differences

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

--- dev:translators:functions [2011/07/28 13:07] – created list of functions/objects known to exist in sandbox, for future reference. ajlyon
+++ dev:translators:functions [2017/11/12 19:53] (current) – 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>
 ====== Functions and objects in the translator sandbox ======
 This is a list of the functions and objects exposed to translators running in the sandbox. As it was generated from the existing translators, this list is probably not complete, and some of the functions may be deprecated or unavailable in certain types of translators. Most of the below are described in the general [[dev:translators:coding|Translator Coding documentation]], or the [[dev:translators|Translator overview]]. Others are rarely used-- search in the code of existing translators for usage guidance.
@@ Line 8: / Line 14: @@
 === Functions ===
   * Zotero.debug
-  * Zotero.done
+  * <del>Zotero.done</del> [[dev:client_coding:changes_in_zotero_3.0#zoterodone_and_zoterowait_are_deprecated|DEPRECATED since 3.0]]
   * Zotero.getOption
   * Zotero.getXML
   * Zotero.loadTranslator
+  * Zotero.monitorDOMChanges [[https://www.zotero.org/support/4.0_changelog#developer-specific_changesfixes12|NEW since 4.0]]
   * Zotero.nextCollection
   * Zotero.nextItem
@@ Line 18: / Line 25: @@
   * Zotero.setCharacterSet
   * Zotero.setProgress
-  * Zotero.wait
+  * <del>Zotero.wait</del> [[dev:client_coding:changes_in_zotero_3.0#zoterodone_and_zoterowait_are_deprecated|DEPRECATED since 3.0]]
   * Zotero.write
@@ Line 44: / Line 51: @@
   * Zotero.Utilities.processAsync
   * Zotero.Utilities.processDocuments
-  * Zotero.Utilities.retrieveDocument
+  * Zotero.Utilities.removeDiacritics [[dev:client_coding:changes_in_zotero_3.0#zuremovediacritics|NEW since 3.0]]
-  * Zotero.Utilities.retrieveSource
+  * <del>Zotero.Utilities.retrieveDocument</del> [[dev:client_coding:changes_in_zotero_3.0#retrievesource_and_retrievedocument_are_unavailable|unavailable since 3.0]]
+  * <del>Zotero.Utilities.retrieveSource</del> [[dev:client_coding:changes_in_zotero_3.0#retrievesource_and_retrievedocument_are_unavailable|unavailable since 3.0]]
   * Zotero.Utilities.strToDate
+  * Zotero.Utilities.strToISO
   * Zotero.Utilities.superCleanString
-  * Zotero.Utilities.text
+  * Zotero.Utilities.text2html
-  * Zotero.Utilities.trim
+  * <del>Zotero.Utilities.trim</del> DEPRECATED use ".trim()" instead
   * Zotero.Utilities.trimInternal
   * Zotero.Utilities.unescapeHTML
+  * Zotero.Utilities.xpath [[dev:client_coding:changes_in_zotero_2.1#xpath_utility_functions|NEW since 2.1]]
+  * Zotero.Utilities.xpathText [[dev:client_coding:changes_in_zotero_2.1#xpath_utility_functions|NEW since 2.1]]
+The utility functions are defined in [[https://github.com/zotero/zotero/blob/4.0/chrome/content/zotero/xpcom/utilities.js|utilities.js]].
 === RDF functions ===
@@ Line 58: / Line 70: @@
   * Zotero.RDF.addStatement
   * Zotero.RDF.getAllResources
-  * Zotero.RDF.getArcsIn
+  * <del>Zotero.RDF.getArcsIn</del> DEPRECATED since 2.1, use Z.RDF.getStatementsMatching(undefined, undefined, .)
-  * Zotero.RDF.getArcsOut
+  * <del>Zotero.RDF.getArcsOut</del> DEPRECATED since 2.1, use Z.RDF.getStatementsMatching(., undefined, undefined)
   * Zotero.RDF.getContainerElements
   * Zotero.RDF.getResourceURI
-  * Zotero.RDF.getSources
+  * <del>Zotero.RDF.getSources</del> DEPRECATED since 2.1, use Z.RDF.getStatementsMatching(undefined, ., .)
   * Zotero.RDF.getStatementsMatching
-  * Zotero.RDF.getTargets
+  * <del>Zotero.RDF.getTargets</del> DEPRECATED since 2.1, use Z.RDF.getStatementsMatching(., ., undefined)
   * Zotero.RDF.newContainer
   * Zotero.RDF.newResource
+The RDF functions are defined in [[https://github.com/zotero/zotero/blob/4.0/chrome/content/zotero/xpcom/translation/translate.js|translator.js]].
 === XML objects ===
   * DOMParser
   * XML