.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ========================================== EXT: Query and List ZORA's Open Repository ========================================== :Author: Christopher :Created: 2010-12-18T19:57:23 :Changed by: Christoph Fuchs :Changed: 2012-07-12T11:13:47.720000000 :Classification: zora :Description: The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) ---- :Keywords: ZORA, University of Zurich, Publications, Eprints, Open Repository, Archive :Author: Christoph Fuchs :Email: Christoph.Fuchs@mnf.uzh.ch :Language: en .. _img-1-img-2-EXT-Query-and-List-ZORA-s-Open-Repository: |img-1| |img-2| EXT: Query and List ZORA's Open Repository ========================================================== Extension Key: zora Language: en Version: 0.0.3 Keywords: ZORA, University of Zurich, Publications, Eprints, Open Repository, Archive Copyright 2006-2012, Author Name, This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml The content of this document is related to TYPO3 \- a GNU/GPL CMS/Framework available from www.typo3.org .. _Table-of-Contents: Table of Contents ----------------- **`EXT: Query and List ZORA's Open Repository 1 <#__RefHeading__5708_1738894311>`_** **`Introduction 3 <#__RefHeading__5710_1738894311>`_** `What does it do? 3 <#__RefHeading__463_413120346>`_ `Screenshots 3 <#__RefHeading__465_413120346>`_ **`Users manual 4 <#__RefHeading__467_413120346>`_** `Create saved search query 4 <#__RefHeading__31507_818911409>`_ `Create an advanced query 4 <#__RefHeading__1559_1686297197>`_ **`Administration 6 <#__RefHeading__31511_818911409>`_** **`Configuration 7 <#__RefHeading__31515_818911409>`_** **`Tutorial 8 <#__RefHeading__31523_818911409>`_** **`Known problems 9 <#__RefHeading__31525_818911409>`_** **`To-Do list 10 <#__RefHeading__477_413120346>`_** **`ChangeLog 11 <#__RefHeading__31623_818911409>`_** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ ZORA (Zurich Open Repository and Archive) provides open and worldwide access to the research and scholarly output of the University of Zurich. It is based upon `Eprints `_ , developed at the University of Southhampton. This extension allows you to create queries (BE) and list the results via the frontend plugin. .. _Screenshots: Screenshots ^^^^^^^^^^^ Frontend listing of a Zora query: |img-3| *Illustration 1: Frontend Listing of a Zora Query* .. _Users-manual: Users manual ------------ First you have to create a query for ZORA's database. This extension does not access the database directly rather it creates an URL-query and accesses ZORA via curl. Depends on the the extensions *extbase* and *fluid* Two types of queries are supported: .. _Create-saved-search-query: Create saved search query ^^^^^^^^^^^^^^^^^^^^^^^^^ |img-4| *Illustration 2: Zora record (saved search)* First you have to log in `http://www.zora.uzh.ch `_ with your account, create your query and make it public. Then click on the created link and look for the string “savedsearchid= “ in the URL. Keep in mind the number after the “=“sign. In Typo3 back end create a folder for your queries and switch to list view. Insert a “Zora” record (illustration 2) and select saved Search in “Zora Query Type”. Enter an appropriate title for your query, a refresh time in seconds and insert the number of the saved search id from above in the field “Zora Search ID”. .. _Create-an-advanced-query: Create an advanced query ^^^^^^^^^^^^^^^^^^^^^^^^ |img-5| *Illustration 3: Advanved Search Query* Create a “Zora” record extension in your folder and select “Advanced Search” in the drop-down “Zora Query Type”. Enter an appropriate title for your query, add a refresh time in seconds. The following search options are available: - Search in title - Search creators ( Name, first letter of first name eg. “Doe, J” - Search in full text - Following item types may be selected: - Journal Article - Book Section - … see Illustration 3 aside. All added search parameters must be fulfilled (“AND” linking). The result is parsed and stored in the table “tx\_zora\_domain\_model\_zora”. Later on queries will access this table instead of querying ZORA again. The caching time of this mechanism can be defined for each query independently. **Frontend plugin** Switch to the page view and select the page you want to display the result of your query. Insert a “General Plugin”, select “Zora Query” in the “Plugin” tab. No queries are selectable yet. You have to tell the plugin where to search for queries: Switch to the “Behaviour” tab and add the folder(s) where your queries are stored to the “Record Storage Page”. Save the plugin and switch to the tab “Plugin” again. Now you should see all your queries. Select the desired query from the drop down list and store your changes. In your frontend you should see a list as in Illustration 1. .. _Administration: Administration -------------- .. _Configuration: Configuration ------------- .. _Tutorial: Tutorial -------- See Users manual .. _Known-problems: Known problems -------------- Saved searches need a valid UZH account. `TYPO3 Forge link to zora `_ .. _To-Do-list: To-Do list ---------- \- let me know `TYPO3 Forge link to zora `_ .. _ChangeLog: ChangeLog --------- Create a file "ChangeLog" (see e.g. the extension "cal") to inform about changes or use this section to document all the changes through the versions. Alternatively to using the following list: `ChangeLog online `_ .. ### BEGIN~OF~TABLE ### .. _0-0-3: 0.0.3 ^^^^^ .. container:: table-row Version 0.0.3 Changes `Forge `_ repository added .. _0-0-2: 0.0.2 ^^^^^ .. container:: table-row Version 0.0.2 Changes Added documentation .. _0-0-1: 0.0.1 ^^^^^ .. container:: table-row Version 0.0.1 Changes First upload .. ###### END~OF~TABLE ###### .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 44 .. :id: graphics5 .. :name: graphics5 .. :vspace: 57 .. :width: 161 .. |img-2| image:: img-2.png .. :align: left .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :name: Zora Listing .. :width: 100% .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :id: graphics1 .. :name: graphics1 .. :width: 100% .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :id: graphics6 .. :name: graphics6 .. :width: 100%