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: Books Library

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:Sebastian Fischer
Changed:2009-08-09T15:28:50.390000000
Classification:sf_books
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) see more: http://wiki.typo3.org/doc_template#tags —-
Keywords:books, listview, singleview
Author:Sebastian Fischer
Email:typo3@fischer.im
Info 4:
Language:en, de, fi, fr, lt, ru

img-1 img-2 EXT: Books Library - sf_books

EXT: Books Library

Extension Key: sf_books

Language: en, de, fi, fr, lt, ru

Keywords: books, listview, singleview

Copyright 2000-2008, Sebastian Fischer, <typo3@fischer.im>

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

EXT: Books Library 1

`Introduction 3 <#1.1.Introduction|outline>`_

What does it do? 3

Screenshots 3

`Users manual 5 <#1.2.Users%20manual|outline>`_

Plugin and Pages 5

Books 5

`Administration 7 <#1.3.Administration|outline>`_

`Configuration 8 <#1.4.Configuration|outline>`_

General plugin configuration 8

listView configuration 8

singleView configuration 8

Adding Items to locations 9

`To-Do list 10 <#1.5.To-Do%20list|outline>`_

`FAQ 11 <#1.6.FAQ|outline>`_

Introduction

What does it do?

Purpose of this extesion is to manage few to a lot of books. There is a list- and a singleview for the frontend. In listview a pagebrowser and a searchfield makes book finding an ease.

Books can have category, serie, number, title, author, ISBN-Number, Description, Cover and Extras.

In listview number, title, author and isbn-number are possible sortfields.

Searching books is done on fields title, author, isbn-number and description.

Screenshots

((generated))
Backend book edit

img-3

Backend book edit Locations

If you use locations for your books two additional fields get avaialable after you changed the first location field.

img-4

Frontend SingleView

img-5

Users manual

Plugin and Pages

You need atleast two pages for managing and displaying the books, one Sysfolder and one standard page which will contain the plugin.

img-6

The plugin must be of type Book Library. In the plugin you need to select the sysfolder as startingpoint and as long as you use only one folder for the books the recursive selectbox could be left empty.

img-7

Books

Books are split in four parts. They consists of books, category, series and extras. Extras has an additional subpart the extraslabel.

img-8

To create a book you need categories and series first. They are for information and sorting purpose. After you selected those and the textfield in the book, you can add additional informations like publisher or translators if its an foreign author that wrote the book.

For these extras you are able to add further lables that get displayed in frontend when extras are rendered. Extras are rendered as continuous text as long as there is no linebreak in these textbox. If a linebreak is found in this box the hole content gets rendered as unordered list.

img-9

Administration

Download the extension from TER (key: sf_books) and install it. If the extensionmanager ask to create tables agree to it.

img-10

In your Typoscript template change to Includes tab and select the Book Library (sf_books) in Include static

img-11

Every extension related setting is found in Typoscript beneath plugin.tx_sfbooks_pi1 {} see Configuration part.

Configuration

There are configurations for listView and singleView and more general parts like templateFile or pidList. In all fields related stdWraps fields from tx_sfbooks_books are available for field and data like uid.

General plugin configuration

templateFile

Property

templateFile

Data type

string

Description

Path to the template file like EXT:sf_books/books_template.html

Default

code

Property

code

Data type

string

Description

Command to choose listView or singleView

Default

storagePid

Property

storagePid

Data type

integer / list of integers

Description

Comma seperated list where the books are stored

Default

empty

recursive

Property

recursive

Data type

integer

Description

Depth of pages to fetch pageids inside the pages given in pidList

Default

[tsref:plugin.tx_sfbooks_pi1]

listView configuration

limit

Property

limit

Data type

integer

Description

Amount of books to display on one page

Default

3

maxPages

Property

maxPages

Data type

integer

Description

Amount of pages to display in pagebrowser

Default

10

editpanel

Property

editpanel

Data type

stdWrap

Description

stdWrap for the Editpanel with all possibilities

Default

headers

Property

headers

Data type

array

Description

Collection of stdWraps for all fieldheaders

Default

fields

Property

fields

Data type

array

Description

Collection of stdWraps for all fields in listrows

Default

[tsref:plugin.tx_sfbooks_pi1.listView]

singleView configuration

fields

Property

fields

Data type

array

Description

Collection of stdWraps for all fields in singleview

Default

fields.cover

Property

fields.cover

Data type

stdWrap/IMAGE

Description

Covers are rendered as image and have all settings like the IMAGE object

Default

fields.description

Property

fields.description

Data type

stdWrap

Description

As an continuous text this fields has as default:

parseFunc < tt_content.text.20.parseFunc

Default

fields.extras

Property

fields.extras

Data type

array/stdWrap

Description

extras could be rendered as unordered list. Therefor there are some extra stdWraps.

fields.extras {
    # wrap around list and continuous text
    wrap = <div>|</div>

    # wrap around the extras label
    label.wrap = <b>|</b>

    # if rendered as list
    list.wrap = <ul>|</ul>
    listitem.wrap = <li>|</li>

    # if renderes as contiuous text
    content.wrap = <p>|</p>
}

Default

[tsref:plugin.tx_sfbooks_pi1.listView]

((generated))
Example

Fields are used like every other stdWrap:

plugin.tx_sfbooks_pi1 {
    listView.fields {
            title.wrap = <div class=”tx_sfbooks_pi1-listview-title”>|</div>
            title.crop = 20 |  | 1
    }
}

Adding Items to locations

Its possible to add items to the locations fields by using pageTS. Remember, that you need to add typoscript with every item that you add for the frontend labels too. There are three locations available (location1, location2, location3).

Location1.addItems.[itemValue]

Property

Location1.addItems.[itemValue]

Data type

string

Description

Label, LS

Default

Location2.addItems.[itemValue]

Property

Location2.addItems.[itemValue]

Data type

string

Description

Label, LS

Default

Location3.addItems.[itemValue]

Property

Location3.addItems.[itemValue]

Data type

string

Description

Label, LS

Default

[TSconfig:TCEFORM.tx_sfbooks_books]

((generated))
Example

Adding items to rooms page TSconfig:

TCEFORM.tx_sfbooks_books.location1.addItems {
        2 = Room 02
        3 = Room 03
}

Adding items to rooms page Tsconfig:

plugin.tx_sfbooks_pi1._LOCAL_LANG {
     default {
           label_location1_I_3 = Room03
        }
   de {
                label_location1_I_3 = Raum 03
       }
}

FAQ

Having books is nice to discuss with others is even nicer. Instead of installing a heavyweight forum you could try comments on book level. To achieve this, there is an extension called comments. Comments serves with a comment form and list. It uses pagebrowse to paginate the comments. To prevent unwanted spam you can configure comments to display only approved user comments. Having comments to books is easy as one two three. Everything else is preconfigured, but I advise you to read the comments documentation carefully if you want to tweak the settings.

img-12 Download and install pagebrowse and comments

img-13 Include both typoscripts (pagebrowse and comments) in include “Include static (from extensions):”

img-14 Insert the plugin on the page with the singleview for books plugin, enter tx_sfbooks_pi1 in “triggering prefix” and select the sysfolder which contains the books ans Stora records at page.

11