Differences

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

--- dev:creating_locate_engines_using_opensearch [2011/02/08 22:35] – simon
+++ dev:creating_locate_engines_using_opensearch [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>
 ====== Creating OpenSearch Descriptions ======
@@ Line 24: / Line 31: @@
 </OpenSearchDescription></code>
-For more details, see the [[OpenSearch documentation http://www.niso.org/kst/reports/standards/kfile_download?id%3Austring%3Aiso-8859-1=Z39-88-2004.pdf&pt=RkGKiXzW643YeUaYUqZ1BFwDhIG4-24RJbcZBWg8uE4vWdpZsJDs4RjLz0t90_d5_ymGsj_IKVaGZww13HuDlZQ8NBt1sTxP_v4iiGqH7rSaAeVDnMfeKJrrJ_JSEGPB]] and the [[OpenSearch documentation http://www.opensearch.org/Specifications/OpenSearch/1.1]].
+Zotero supports most of the fields specified by the OpenURL specification in any of the following namespaces:
+  * info:ofi/fmt:kev:mtx:journal
+  * info:ofi/fmt:kev:mtx:book
+  * info:ofi/fmt:kev:mtx:patent
+  * info:ofi/fmt:kev:mtx:sch_svc
+  * info:ofi/fmt:kev:mtx:dissertation
+These namespaces are treated interchangeably. For a full list of fields, see the [[http://www.niso.org/kst/reports/standards/kfile_download?id%3Austring%3Aiso-8859-1=Z39-88-2004.pdf&pt=RkGKiXzW643YeUaYUqZ1BFwDhIG4-24RJbcZBWg8uE4vWdpZsJDs4RjLz0t90_d5_ymGsj_IKVaGZww13HuDlZQ8NBt1sTxP_v4iiGqH7rSaAeVDnMfeKJrrJ_JSEGPB|OpenURL documentation]].
+Zotero also supports any Zotero field in the Zotero namespace (http://www.zotero.org/namespaces/openSearch#). The following special fields are also supported:
+  * openURL - the full OpenURL 1.0 context object
+  * year - the year extracted from the Zotero date field
+Zotero fields should be used sparingly, as they may not be compatible with other implementations.
+For more general details on the OpenSearch description format, see the [[http://www.opensearch.org/Specifications/OpenSearch/1.1|OpenSearch documentation]].
 ====== Advertising Engines ======
-You can advertise locate engines:
+You can advertise locate engines by adding
+<code><link rel="search" type="application/x-openurl-opensearchdescription+xml" title="Engine Name" href="http://www.example.com/myengine.xml" /></code>
+to the <head> section of any webpage (with the title and href attribute contents modified). The user can then install the locate engine under the locate menu when visiting the webpage.
-<code><link rel="search" type="application/x-openurl-opensearchdescription+xml" title="ENGINE NAME" href="http://www.example.com/myengine.xml" /></code>
+====== Example ========
-to the <head> section of any webpage. The user can then install the locate engine under the locate menu.
+An example OpenSearch description for Amazon.com is available [[http://www.zotero.org/opensearchdemo/opensearch_amazon.html|here]].