DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: TAB Media

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed:2006-11-16T08:54:58
Author:TAB GmbH
Email:typo3@tab-gmbh.de
Info 3:
Info 4:

EXT: TAB Media

Extension Key: tab_media

Copyright 2006, TAB GmbH, <typo3@tab-gmbh.de>

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.com

Table of Contents

EXT: TAB Media 1

Introduction 1

Credits 1

What does it do? 1

Screenshots 2

Users manual 3

The Plugins 3

Administration 5

The Backend 5

Configuration 6

Changelog 8

I ntroduction

Credits

The extension tab_media is based on the extension ee_library written by Norman Seibert.

The differences are listed in the changelog.

What does it do?

  • Saving of media data (title, author, publisher, etc.) along with further information like call number, market context, thematic area, keywords and comments.
  • Support during the input of book information by automatic loading of the title, author, publisher, the short description and further data by means of the ISBN (International Standard Book Number)
  • Overview and search function for easy finding of special media and contents
  • Frontend reservation and borrow function
  • List of the own borrowed and reserved media

Screenshots

Output of the plugin Search

img-1

Output of the plugin Add Medium with automatically reserved form fields

img-2

Reservation and borrow function with information on the current status

img-3

FE-output of the plugin Conferred Media

img-4

FE-output of the plugin Prebooked Media

img-5

Users manual

The Plugins

Complete List

Here all stored media is listed, if these are not set up to hide. By default ten items are displayed, however the number can be changed. To reach the detailed single record page of a medium, just use the arrow on the right in the info column.

Search

The search contains the same functions as the complete list, however it extends the plugin by a search function to enable the search for a text or word, the media type, the market context or the status.

Single Record

This view shows more detailed information about the medium.

In addition, you have the possibility to reserve or borrow the medium, to add yourself to the distribution list or to undo these actions again.

Use the link „back to list“ to return to the last visited page.

FE-User: Conferred Media

Here you can see which media is borrowed by yourself at moment. Furthermore you can change the status from here again.

FE-User: Prebooked Media

Here you can see which media you reserved.

FE-User: Distribution List

Here you can see to which distribution lists you subscribed.

Add Medium

This plugin lets you add new books into the database quickly.

After inserting the ISBN, it loads the book information from www.amzon.de and tries to extract the following data: title, subtitle, author, language, publisher, edition, publishing year and the short description.

These are then automatically entered into the form, so that they are still variable and can be extended by the user.

To save media of the types magazine, document and file the plugin can be used too.

Background-Coloring

The current status of a medium is signaled with traffic light colors on the respective table row.

These color settings come from the included default CSS style (tab_media).

img-6

- Red means: conferred

- Yellow means: prebooked

- Green means: available

Administration

The Backend

The first database entries, where to start?

Before a medium can be registered, the basis must be prepared. So at first you have to create some market contexts, call numbers and thematic areas.

Here is an example to create a new call number:

First we create a new record in the SystemFolder (see the configuration section).

img-7

Then we can choose between market context, call number and thematic area:

img-8

Now we enter a name and save the settings.

img-9

Please repeat this process for the other records.

Afterwards the contents of the SystemFolder may look like this:

img-10

Create a medium

Now we can create the first medium:

  • Create a new record in the SystemFolder.
  • Choose the type book.
  • Fill the following form fields like this:
Hide

a

Hide

b

Mark this, if the medium should not be shown in the frontend.

media-type

a

media-type

b

Choose between book, journal, document and file.

title

a

title

b

The title of the medium

Subtitle

a

Subtitle

b

The subtitle

Author

a

Author

b

The author

Publisher

a

Publisher

b

The publisher

Call number

a

Call number

b

Must be saved at first in the SystemFolder.

Publishing Year

a

Publishing Year

b

Edition

a

Edition

b

Market context

a

Market context

b

Must be saved at first in the SystemFolder.

Thematic area

a

Thematic area

b

Must be saved at first in the SystemFolder.

Keywords

a

Keywords

b

Comment:

a

Comment:

b

Here we actual save the short description.

Download

a

Download

b

URL (important for files)

Status

a

Status

b

Must be saved in the SystemFolder (the status prebooked and conferred is set automatically).

Conferred to

a

Conferred to

b

This field is set automatically, if the user borrows about the plugin single record

Conferred on

a

Conferred on

b

See Conferred to

Conferred until

a

Conferred until

b

See Conferred to

Prebooked by

a

Prebooked by

b

This field is set automatically, if the user reserves about the plugin single record

If you change the media type to magazine, then some input fields are dropped out and the following are added: category, frequency, period, distribution list on/out, distribution list, circulating since.

For files the path or a link must be declared.

Configuration

Create a page:

  • Create a usual page named library.
  • Below the library page, we create six more pages with the names: Search, Single Record, Conferred Media, Prebooked Media, Distribution List, Add Medium.
  • Now generate a SystemFolder. There we will later save books, categories etc.

img-11

Insert the plugins for example the complete list:

  • Choose the library page.
  • Create new record of the type Insert Plugin.
  • Select the plugin tab_media.
  • Select Complete List.
  • The SystemFolder has to be the startingpoint.
  • Now save.

img-12

Repeat this process for all pages, so that each page contains the corresponding plugin.

TypoScript Template Settings

  • Create a template on the library page.
  • Switch to the Constant Editor.
  • img-13 Select the category PLUGIN.TX_TABMEDIA_PI1.
  • Enter the PID for the FE-user SystemFolder and Single Record page
  • Open the TypoScript template in the list view
  • Add in Include static (from extension) the item default CSS-styles (tab_media) and save

Changelog

2006-11-03 TAB GmbH (Markus Krause) <typo3@tab-gmbh.de>

Global changes:

- CSS-optimization of the output

- New media type integrated: file

- Buttons for the actions borrow, reserve and add to distribution list

- separate database table for the call number

- enhanced TYPO3-conformity

- t3lib_div::GPvar replaced by t3lib_div::_GP

- MySQL functions replaced by TYPO3-DB-functions

- GET-variables encoded with urlencode()

DB tables:

- added keys

- some TEXT fields converted to CHAR fields

- VARCHAR fields converted to CHAR fields with moderate sizes

- putted down the size of TINYINT fields to one

- removed default values from AUTO_INCREMENT fields

New methods in class.tx_tabmedia_pi1.php:

- change_conferredto()

- change_distributionlist()

- change_reservedby()

- extract_description()

- extract_language()

- extract_publishinginformations()

- extract_title_author()

- get_from_www()

- initCallnumber()

- listallmedia()

- listselectedmedia()

- parse_htmlresults()

- process_data()

- searchWhereCatNotLike()

- setoptions()

- setoutput()

- setsearchform()

- show_sql_error()

Plugin Complete List:

- The status is now shown as text and table row background-color

- Button instead of a text-link to get to the Single Record

- The number of displayed items can be set up by the user

Plugin Search:

- Adjustment of the search fields optimized

- Number of shown search results variable

- New search field: Status (conferred, prebooked, available)

Plugin Single Record:

- Confirmation of succeeded actions (borrow, reserve, add to distribution list and cancel)

Plugin FE-User: Conferred Media:

- Cancel Borrowing directly possible

Plugin FE-User: Prebooked Media:

- Cancel Reservation possible

Plugin FE-User: Distribution List:

- Remove from distribution list possible

Plugin Add Medium:

- Completely new integrated

- Media can be entered from within the frontend

- Book information can be loaded automatically via ISBN from www.amazon.de

img-14 EXT: TAB Media - 9