Z39.88-2004: The OpenURL Framework for Context-Sensitive Services The Key/Encoded-Value (KEV) Format Implementation Guidelines dc:title KEV Implementation Guidelines dc:creator Ann Apps, MIMAS, The University of Manchester, UK. [email protected] dc:description Implementation guidelines for Key/Encoded-Value OpenURL Framework ContextObjects (previously SAP1). dc:created 2003-04-16 dc:modified 2007-06-01; 2004-12-09 version 2007/06/01 Contents CONTENTS............................................................................................................................................ 1 1. INTRODUCTION.......................................................................................................................... 2 2. PURPOSE AND SCOPE ................................................................................................................... 3 2.1 COMMUNITY PROFILES ................................................................................................................... 3 3. THE CONTEXTOBJECT, ITS ENTITIES AND THEIR DESCRIPTORS................................ 3 4 ENTITY DESCRIPTION................................................................................................................... 4 4.1 REFERENT ....................................................................................................................................... 5 4.2 REFERRINGENTITY.......................................................................................................................... 5 4.3 REQUESTER..................................................................................................................................... 6 4.4 SERVICETYPE.................................................................................................................................. 7 4.5 RESOLVER....................................................................................................................................... 7 4.6 REFERRER ....................................................................................................................................... 7 5. REGISTRY SELECTIONS .............................................................................................................. 8 5.1 CONTEXTOBJECT FORMAT.............................................................................................................. 8 5.2 CHARACTER ENCODING .................................................................................................................. 8 5.3 NAMESPACES .................................................................................................................................. 9 5.3.1 Namespaces............................................................................................................................. 9 5.3.2 ‘info’ Namespaces................................................................................................................... 9 5.4 METADATA FORMATS ................................................................................................................... 10 5.4.1 Journal Metadata.................................................................................................................. 10 5.4.2 Book and General Document Metadata................................................................................ 12 5.4.3 Dissertation Metadata........................................................................................................... 13 5.4.4 Patent Metadata.................................................................................................................... 14 5.4.5 Scholarly Service Type Metadata.......................................................................................... 14 5.4.6 Dublin Core Metadata Format ............................................................................................. 15 5.4.7 Non-text and Other Metadata Formats................................................................................. 16 5.5 TRANSPORTS................................................................................................................................. 17 5.6 PROFILES....................................................................................................................................... 17 6 OPENURL TRANSPORT................................................................................................................ 17 6.1 INLINE OPENURL ......................................................................................................................... 18 1 6.2 BY-VALUE OPENURL .................................................................................................................. 18 6.3 BY-REFERENCE OPENURL ........................................................................................................... 19 7 GUIDELINES FOR OPENURL REFERRERS............................................................................. 19 8 GUIDELINES FOR OPENURL RESOLVERS............................................................................. 19 9 GUIDELINES FOR OPENURL ‘LINK-TO’ RESOLVERS........................................................ 20 10 EXAMPLE SCENARIOS ..............................................................................................................20 10.1 JOURNAL ARTICLE,REFERENCED FROM AN ELECTRONIC JOURNAL SERVICE,INLINE OPENURL20 10.2 JOURNAL ARTICLE,REFERENCED FROM AN ELECTRONIC JOURNAL SERVICE,BY-REFERENCE OPENURL........................................................................................................................................... 22 10.3 JOURNAL ARTICLE,REFERENCED FROM AN ABSTRACTS SERVICE,BY-VALUE OPENURL, POST ........................................................................................................................................................... 25 10.4 CONFERENCE PAPER IN A JOURNAL,REFERENCED FROM A TABLE OF CONTENTS SERVICE,INLINE OPENURL........................................................................................................................................... 27 10.5 CONFERENCE PAPER,REFERENCED FROM A TABLE OF CONTENTS SERVICE,BY-REFERENCE OPENURL........................................................................................................................................... 29 10.6 BOOK,REFERENCED FROM A SHOPPING SERVICE,BY-VALUE OPENURL .................................. 30 10.7 JOURNAL,REFERENCED FROM A SERIALS DIRECTORY,INLINE OPENURL ................................. 32 10.8 BOOK,REFERENCED FROM A BOOK,INLINE OPENURL.............................................................. 34 APPENDIX A. UPGRADING TO OPENURL VERSION 1.0 ........................................................ 36 A.1 DIFFERENCE BETWEEN VERSION 1.0 INLINE OPENURL AND VERSION 0.1 OPENURL.................. 36 A.1.1 Non-text Items....................................................................................................................... 37 A.2 HYBRID OPENURLS..................................................................................................................... 37 APPENDIX B. URL CONSIDERATIONS........................................................................................ 38 B.1 LENGTH OF HTTP GET URLS ..................................................................................................... 38 B.2 FOREIGN KEYS ............................................................................................................................. 39 B.3 URL ENCODING ........................................................................................................................... 39 B.4 URL DECODING ........................................................................................................................... 39 B.5 PARSING OF HTTP QUERYSTRINGS.............................................................................................. 39 APPENDIX C. SECURITY CONSIDERATIONS AND PRECAUTIONS.................................... 40 C.1 GENERAL SECURITY CONSIDERATIONS ........................................................................................ 40 C.2 PRECAUTIONS FOR OPENURL RESOLVERS................................................................................... 40 REFERENCES..................................................................................................................................... 40 1. Introduction The OpenURL Framework for Context-Sensitive Services Standard [1] provides a means of describing a referenced resource along with a description of the context of the reference. Additionally it defines methods of transporting these descriptions between networked systems. It is anticipated that it will be used to request services pertaining to the referenced resource and appropriate for the requester. The OpenURL Framework is very general and has the potential to be used in many application domains and by many communities. Concrete instantiations of the various core components within the framework are defined within the OpenURL Registry [2]. The Registry is managed by a Maintenance Agency, as defined in Appendix A of the Standard. During the ballot and public review period of the Standard, the content of the Registry was static and had been pre-defined by the NISO AX Committee. There is also an experimental registry where components under development are held. It is possible to register further items. Initially there were two formats for ContextObject Representations