2. User Documentation¶
The following sections describe functionalities of mediaTUM for which registration and login of the user is not necessary.
2.2. Search¶
There are two different types of search modalities in mediaTUM: general and advanced search. General search is possible throughout all mediaTUM collections. Advanced search must be specified by the owner of the collection.
For general search, enter your search term in the input field on the top left of the page. When performing a search on mediaTUM start page, the entire mediaTUM content is searched. If you switch to a collection or a subdirectory, only their content will be searched. If an advanced search is available in the collection, follow the link “Advanced search”. Here you can search specifically for content in individual fields. In addition to entering search terms, a selection from index lists is possible. The owner of the collection can determine which fields are searchable: see Setting up Search. Setting up Search.
2.3. Displaying content¶
2.3.1. Customizing view¶
After having carried out a search or clicking on a directory, multiple datasets may be seen on the screen. It is possible to customize the view of results presentation:
List view, text only: Compact display, as no thumbnails are shown
List view with thumbnails: Compact display, requires some space as small thumbnails are visible.
Thumbnail view: Similar to list view with thumbnails. But more compact, because several documents are in one line.
Thumbnail view (large): Only thumbnails are displayed. Takes up the most space, as thumbnails are displayed larger than in other views. No metadata is displayed.
2.3.2. Full Display¶
To see the entire content of a single item in the hitlist, click on it. The metadata of the document is displayed, which can also be exported into BibTeX format. If a full text is available, it can be accessed by clicking on the thumbnail.
Access to a full text can be managed via IP addresses (e.g. campus-wide) or user groups. A full text is not always available, e.g. for copyright reasons.
2.4. Permalinks¶
A permalink - i.e. a permanent link - to a called dataset is obtained via the link “Permanent link for displayed object”.
The permalink with a scheme https://mediatum.ub.tum.de/<DocumentID> is displayed in the address line of the browser.
2.5. Publication lists¶
Publication lists are lists that reflect the content in mediaTUM and can be used for representation of that content on the personal homepage. By using queries you can determine which content to show and how to show it in a publication list. Queries can output the content of collections, directories or specific areas. Read Chapter to learn how to determine a query. The only requirement is that datasets in mediaTUM must be publicly visible. Lists can be generated with JavaScript or the Typo3 plugin CurlContent.
2.5.1. JavaScript¶
With the JavaScript export you can create publication lists on your own homepage. The prerequisite is that JavaScript is allowed to be executed at the corresponding location.
This is how you determine the ID of your directory:
Call up a directory via the browser. The ID is in the address line of the browser. In the example below, the ID is 604223 (directory of the university library).
Alternatively, select your directory. Then find the ID in the Edit area.
A simple code example:
<script src="https://mediatum.ub.tum.de/static/js/export.js"> </script>
<script>
mediatum_config = {
};
</script>
<script>
mediatum_load(615843, 0, '-year','', '', 'de');
</script>
Copy the text into an HTML page and replace the ID 615843 with the ID of the desired directory.
A publication list is then displayed on the web page:
2.5.1.1. Anpassungen der Publikationsliste¶
mediatum_load With mediatum_load you can determine which content will be displayed in the publication list. The line mediatum_load is structured this way: mediatum_load (id, limit, sort, query, format, language);
Syntax: mediatum_load(id, limit,’ sort’, ‘query’, ‘format’, ‘language’);
Commas separate the individual values from each other. Field definitions are described in the following table:
id |
ID of the directory whose content is to be displayed |
limit |
Limits the number of displayed documents; 0 means that all documents are to be displayed |
sort |
Sorts the hit list according to the content of a specific field. A minus sign in front of the field name reverses the order. Example: year. Descending sort: -year Ascending sort: year |
query |
Determines a search that restricts the search result (e.g. an author name, so that the publication list of the specified author will be displayed) e.g. year<=2013 or author-contrib=Meier |
format |
Remains empty |
language |
Defines language (ge or en) |
mediatum_config
You can specify further settings with mediatum_config. In the example above, mediatum_config is empty. This means basic settings will be implemented.
Determine the output format by using output. Choose default for a standard format. For the APA format, choose apa.
'output': 'default'
'output': 'apa'
- Displaying field content
You can determine which fields will be displayed. You can also specify how to display the fields.
<script src="https://mediatum.ub.tum.de/static/js/export.js"> </script> <script> mediatum_config = { 'fields0':['<small style="color:red">[att:pos]</small>', '[att:author-contrib]', '<b>[att:title-contrib]</b>', '[att:year|substring:0,4]' ], }; </script> <script> mediatum_load(615843, 0, '-year','', '', 'de'); </script>
Results:
Specify the field display with fields0. After att: enter the field name of content that is to be displayed. HTML tags can be used to additionally mark up the content, e.g. <b></b> for bold formatting. The general structure of fields is:
'fields0':['<HTML-Tag>[att:Name des Feldes]</HTML-Tag>', '<HTML-Tag>[att:Name des Feldes]</HTML-Tag>', '<HTML-Tag>[att:Name des Feldes]</HTML-Tag>' ],
Several publication lists can be displayed on a web page. Define different displays with fields0, fields1, fields2 etc. fields0 identifies the first list, fields1 the second list and so on. To define displays, you need to know names of the fields in mediaTUM.
Note
Für Admins: field names depend on the Metadatentyp / Metadatenschema.
If you want to include further fields in the publication list, the easiest way to identify these field names is to call up individual documents in XML format. You need to enter the ID of the document: Example:
https://mediatum.ub.tum.de/services/export/node/1225127You will find the field names in each case behind the designation<attribute name=...
Navigation elements
A navigation and a search field can be integrated with the help of type. The subdirectories of the directory appear in the navigation. With asc and desc they can be sorted alphabetically (forwards and backwards). search integrates a search field.
The general structure of type is:
'type0':['struct','search','asc'],Example:
<script src="https://mediatum.ub.tum.de/static/js/export.js"> </script> <script> mediatum_config = { 'fields0':['<small style="color:red">[att:pos]</small>', '[att:author-contrib]', '<b>[att:title-contrib]</b>', '[att:year|substring:0,4]' ], 'type0':['struct','search','asc'], }; </script> <script> mediatum_load(615843, 0, '-year','', '', 'de'); </script>
Field separator: by default, field contents are separated from each other by a line break.
Additional definitions
<script src="https://mediatum.ub.tum.de/static/js/export.js"> </script> <script> mediatum_config = { 'fields0':['<small style="color:red">[att:pos]</small>', '[att:author-contrib]', '<b>[att:title-contrib]</b>', '[att:year|substring:0,4]' ], 'type0':['struct','search','asc'], 'target':'internal', 'style':'0', 'output':'apa', 'groupby':'year', }; </script> <script> mediatum_load(615843, 0, '-year','', '', 'de'); </script>
Target: Internal: open in the same window / External: open in another window
Style “1” (default): display hits with frames.
Style “0”: display hits without frames.
Output: desired format will be displayed: APA, BibTex, etc. It depends on which masks are available for the output.
Groupby: Freely selectable groupings can be set up, e.g. by year:
'groupby': 'year|substring:0,4',
The predefined sorting of mediatum_load is of importance:
mediatum_load(615843, 0, 'year','', '', '');
year: new publications at the top, year: oldest entries at the top and new publications at the bottom.
The following should be also considered:
The JavaScript export provides CSS instructions.
<style type="text/css"> .mediatum #item{padding:2px; margin:2px; border: 1px solid silver;} .mediatum #item_link{text-decoration:none; color:black;} </style>
They can be overwritten with your own CSS instructions.
Example:
<style> .mediatum__{font-family: arial,verdana,sans-serif; font-size: 12px; padding:0 40px} .mediatum #item__{padding:2px; margin:2px; border-width:0 !important} .mediatum #item_link__{text-decoration:none; color:black} h1{font-size:14px} .navigation{padding:5px} .search{font-size:12px;padding:5px} .content{height:400px;overflow:auto} .dl{position:absolute;bottom:0} .mediatum #item{padding:2px; margin:2px; border:0 solid black !important} #groupby_header{font-weight: bold;} span.journal{font-style:italic} span.volume{font-style:italic} span.booktitle{font-style:italic} span.reporttitle{font-style:italic} span.casetitle{font-style:italic} span.patentnumber{font-style:italic} </style>
Please note that only publicly available entries/datasets are included in mediaTUM publication lists.
2.5.1.2. Umlaut search¶
We recommend saving the HTML file with the UTF-8 without BOM encoding. You can then write terms with umlauts both with ‘ü’ (e. g. Müller) and with ‘ue’ (e.g. Mueller). Both spellings will be found.
Errors may occur in the umlaut search when using a different encoding.
In order to avoid this, specify in the file header:
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta charset="utf-8">
In the mediatum_load line, the query is specified as follows:
unescape(encodeURIComponent('Feldname=SuchbegriffMitUmlaut')),
Example: mediatum_load(603843, 55, 'author.surname', unescape(encodeURIComponent('author.surname=Müller')), '', '');
2.5.2. Curl Content¶
2.6. Exporting hit lists¶
2.6.1. General Information¶
The export link is structured in the following way:
https://mediatum.ub.tum.de/services/export/node/ID/HIERARCHIE?format=FORMATANGABE
ID: D of the directory whose content will be exported. To identify the ID: with the help of navigation tree, go to the desired directory. Find the ID in the browser address field. For example:
https://mediatum.ub.tum.de/604223Hierarchy: What will be displayed?
No specification: the ID itself
parents: the parent element
children: direct child elements (without content of subfolders)
allchildren: all child elements (with content of subfolders)
Format specification: data can be output in different formats. By default, XML is used. JSON, CSV and RSS can be chosen.
Restricting for file types is possible with:
type=[...]?type=directory: lists only subfolders of an element?type=document: lists only documents?type=dt-buchbeitrag: lists only book contributions; in this case a name of the metadata schema will be searched for
Number of displayed elements can be specified with
limit=[...]:?limit=5: limit of 5 elements
Restricting result of the search with
q=[...]?q=regen: the search item will be looked for in both metadata and full text?q=year=2016: search item will be looked for in a metadata field (in this case: yearOperators => (greater than or equal to) and <= (less than or equal to) can be used for numerical searches. The operators > and < cannot be implemented.
Search with regular expressions:
attrreg=[...], faster than search withq=[...]?attrreg=author-contrib=.*Lei[ß|s].*: Search for Leiß or Leis in author field
Sorting with
sortfield=[...]?sortfield=-year: descending sorting according to content of field “year”?sortfield=year: ascending sorting according to content of field “year”
Output of content via specified export masks in field <mask> with
mask=[...], name of the export mask is definedmask=none: no outputmask=defaultormask=nodesmall: short display (nodesmall)mask=bibtex: output in BibTeX -Formatmask=apa: output in APA-format
Specify displayed fields (for JSON format) with
attrspec=[...]andattrlist=[...]attrspec=none: display no fieldsattrspec=all: display all fields (default)attrspec=none&attrlist=year,author-contrib: only display fields “year” and “author-contrib”
Further detailed information:
List of publications with mediaTUM as a source: https://www.typo3.tum.de/index.php?id=144
2.6.2. Download as Excel File¶
An export in Excel format can be reached via the link:
https://mediatum.ub.tum.de/services/export/node/<ID>/allchildren?format=csv&sep=;&delimiter=dquote&bom&mimetype=application/vnd.ms-excel
In case of allchildren all child elements will be displayed (refer to Exporting hit lists). A restriction with search queries is possible. All fields of a specified result will be displayed. A restriction of columns is not possible.
Example of the search restriction:
https://mediatum.ub.tum.de/services/export/node/1175037/allchildren?format=csv&sep=;&delimiter=dquote&bom&mimetype=application/vnd.ms-excel&sortfield=author&attrreg=author=.*sch.*&q=schema=dt-report
2.6.3. BibTeX-Export¶
2.6.3.1. Export in BibTeX-Format¶
Export for a BibTeX format has the following structure:
https://mediatum.ub.tum.de/services/export/node/ID/allchildren/?format=template_test&mask=bibtex&lang=de&template=$$[defaultexport]$$\n\n&mimetype=text/plain
If necessary ID and allchildren can be changed. Refer to Exporting hit lists: Exporting hit lists
2.6.4. Print-Function¶
The print function can be activated by clicking on the printer symbol in the upper right corner of the page. This function generates a list of all entries within a collection. The list is exported in a PDF format.