User Manual and Documentation

Jany
Version 1.0
User Manual and Documentation
The software “Jany” is copyrighted by the Swiss Orchid Foundation, www.orchid.unibas.ch. Programmed by Matthias‐M. Christen.
Jany User Manual and Documentation
Table of Contents
1. Searching the Database ....................................................................................................... 3
1.1
Author/Year Search ............................................................................................... 4
1.2 Keyword Search ..................................................................................................... 4
1.3
Taxon Search........................................................................................................... 5
1.4
Free Text Search ..................................................................................................... 5
2.
Detail View ...................................................................................................................... 6
2.1
Printing and Exporting .............................................................................................. 7
2.2
Ordering ...................................................................................................................... 7
2.3
Other Functions .......................................................................................................... 8
2.3.1 Profile....................................................................................................................... 8
2.3.2 Help.......................................................................................................................... 8
2 1. Searching the Database
Jany provides you with four searching domains: there is an Author/Year search, a Keyword, a Taxon and a free text search. These are described below in detail. Jany also provides three different search modes, which you could select in the “Search” panel above the “Search” button. In general, after having specified the search query, select a search mode and initiate the search by clicking the “Search” button. The available search modes are “New search”, “Search in results”, and “Append to results”. The second option only searches the results of your previous search (in stead of the whole database if you use the “New search” option) and therefore narrows your search results. E.g. you have found all the publications on Masdevallia. But then you find that you are actually only interested in the publications on Masdevallia published after 1900. So you would perform a second search on your results. The option “Append to results” operates in the other direction: it adds the results of the current search to the previous search results, i.e. the result set is enlarged. The result list is sortable. Click on one of the captions (“Type”, “Author”, “Year”, or “Title”) to sort the list accordingly. If you click a second time on the same caption the sort order is reversed. 3
Jany User Manual and Documentation
Once you have the desired search result set, you could print or export it. These operations are explained further below. You could also directly manipulate the result set in Jany, i.e. remove the records you don’t need before printing or exporting. To this end, simply select the entries you want to remove (click an entry and drag the mouse if you want to select an entire range, or hold the Control key while selecting single entries) and press the Delete key or select “Remove selected search results” from the popup context menu, which appears after a right mouse click. Note that not all the search results are loaded at once. Jany displays only the first fifty results immediately. More results are reloaded if you reach the end of the list of the currently loaded results. 1.1
Author/Year Search
The Author/Year search is pretty straight forward. You could either enter the author you look for or the year of the publication or both. Use an asterisk (*) to truncate the author name; e.g. “schu*” finds all the publications whose author’s names start with “Schu”. In the year field you could either provide a single year or an entire range, e.g. the search string “1780‐1800” finds all the publications that have published between 1780 and 1800. 1.2
Keyword Search
In Jany, keywords are organised in a hierarchical tree‐like structure. Click on the “Search Keywords” label, and the keywords panel will open, cf. the image below. The upper box contains all the keywords you are searching while the lower part lets you select a particular keyword. To add a keyword to the search list, navigate through the tree and double click the keyword. The “Filter” function lets you access the keywords quickly that match a certain string pattern. Type the keyword you are looking for in the textbox next to the “Filter” label and click the “Find” button (the left one). If, e.g., you enter the string “dendr” only the keywords will be displayed that contain the substring “dendr”, i.e. among others the genera “Dendrobium” and “Epidendrum”. Again, to add the keyword to the search list, double click it. The “clear” button on the right hand side serves to clear the currently active filter. The whole tree structure will reappear. If you are not sure about the meaning of a keyword let the mouse hover over a keyword node for some time. If available, a tool tip will pop up explaining the keyword. You may have noticed the icons next to the keywords in the search list. They indicate the search mode. Three different modes are available: “Keyword must occur”, “Keyword may occur”, and “Keyword must not occur”. Right click a search list entry and choose a mode from the popup menu. If a keyword is in “must occur” mode, only records are found that contain the keyword, whereas in “may occur” mode the existence of the keyword on the record is optional. E.g. if you want to find publications that treat both the genera Dendrobium and Epidendrum, endow both the keywords with the “must occur” mode. If you want to find all the publications that discuss either Dendrobium or Epidendrum (or possibly both), select the “may occur” mode. Obviously, the “Keyword must not occur” 4 mode prevents the records that have the particular keyword attached to them from being shown in the search result. In the example depicted below, all the articles of the journal “Amer. Orchid Soc. Bull.” (American Orchid Society Bulletin) are found that deal with Miltonia, but that are not discussing technical aspects. In order to remove the selected keywords from the list, simply press the “Delete” key or select “Remove selected keywords” from the popup menu appearing after a right click in the keyword list. 1.3
Taxon Search
The taxon search lets you find first descriptions. Enter the taxon you are interested in and select the level in the classification hierarchy the taxon belongs to. E.g., if you are looking for the first description of the genus Ophrys, type “ophrys” and choose “Above species”; if you are looking for the Ophrys species “apifera”, type “ophrys apifera” and select the “Species and below” option. 1.4
Free Text Search
Finally, the free text search lets you search particular fields for strings. You could choose the fields you want to include in the search. If you are looking for a book whose title you (possibly partly) remember, enter the title or only a part of the title and tick the “Title” option. 5
Jany User Manual and Documentation
Don’t use any truncation symbol. I.e. the search query “dactyl” finds titles containing “Dactylorhiza” as well as “Cycnoches pentadactylon”. 2. Detail View
Double clicking on an entry of the search result list opens the detail view. Alternatively you could hit the Enter key, and the selected items will open in detail view; also, choosing the “Open details” command from the context menu (appearing after a right mouse click) has the same effect. The detail page displays the full information about the article or the book. The “Show keywords” link lets you view the keywords associated to the record. Furthermore, if available, an excerpt of the images contained in the book is displayed. The “View image” link below an image opens a large and magnifyable version of the image on the website of the Swiss Orchid Foundation. The “Search” link is used to search more graphical material on the species on the Swiss Orchid Foundation website. Also, if available (i.e. if there are any first descriptions in the publication at all and if the image database of the Swiss Orchid Foundation contains graphical material on the taxon), the genera and species first described in the publication are displayed. Finally, some arbitrary images of the genera mentioned in the publication are displayed. Please note that only the genera are taken into account. I.e. if the publication deals with a specific species, not necessarily an image of the species will be displayed under the “Genera” section. 6 2.1 Printing and Exporting
The search result list and the detail pages can be printed. Click the “Print” icon in the toolbar and a printable view (in PDF format) of the currently active page will open in a new browser window. Use this to get a printed output of the record or list. The search result list could also be exported in various formats. Clicking the “Export” icon in the toolbar launches the export wizard depicted below. It allows you to select the fields you want to export and to choose an exporting format. Currently, three formats are supported: Microsoft Excel Spreadsheet, Comma Separated Values (CSV), and BibTeX, which can be used if you are typesetting a publication in LaTeX. Note that only the items displayed can be exported. I.e. if there are more than fifty records in the result set you need to scroll to the end of the list in order to load the entire result set. (This is not a technical restriction, but a means to prevent data theft.) The export file must also be downloaded from a separated browser window that opens after having gone through the export wizard steps. 2.2 Ordering
Users could order photocopies or copies by fax of publications. To submit an order, place the desired items in the basket by clicking the “Add to basket” button on the detail page of the publication. You will be prompted to enter a note where you could specify more exactly what you need. Possibly you only need a few pages of a book or only the abstract of an article… 7
Jany User Manual and Documentation
The basket window, which is accessible from the “Basket” toolbar button, displays all the items that have been added to the basket so far. It lets you edit the notes and remove items that you have added wrongly. The “Send Order” button places the order. An e‐mail will be sent to the keeper of the library notifying him of your order. You will as well receive a notification e‐mail. The basket is emptied. 2.3 Other Functions
2.3.1 Profile
The “Profile” toolbar button gives access to your user profile. You could correct you data there and view the orders you have sent so far. 2.3.2 Help
The user manual of Jany is accessible through the “Help” toolbar button. Furthermore, the “About…” menu item displays a dialog with information about the programme and the database. 8