sf_books: Managing books the easy way

Extension key: sf_books
Package name: evoweb/sf-books
Version: main
Language: en
Author: Sebastian Fischer
License: This document is published under the Open Publication. license.
Rendered: Sun, 30 Nov 2025 14:05:53 +0000
Copyright: 2004-2024

Helps managing books in your library by providing organization options

The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from http://typo3.org

Table of Contents

Introduction

This Documentation was written for version 5.0.x of the extension.

What does it do?

Managing your books

Purpose of this extension is to manage few to a lot of books. There is a list- and a singleview for the frontend. In listview a page browser and a search field 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.

Installation

Download via Extension Manager

In the TYPO3 Backend go to Admin Tools > Extensions. Change in the dropdown on the top left to 'Get Extensions', enter the extension key 'sf_books' in the text field below the headline 'Get Extensions' and hit go. In the result list install the extension by hitting the action for that.

Download via Composer

Add evoweb/sf-books to the require in your composer.json.

Enter on shell

composer require evoweb/sf-books

Include TypoScript

Include static file "Book Library" in your typoscript record or import in your sitepackage and modify the constants to match the page setup you have added.

Include Routing configuration

To have speaking urls you need to add the following import in your site config. This allows each of the plugins to render seo friendly urls.

config/sites/[main]/config.yaml

imports:
    - { resource: "EXT:sf_books/Configuration/Routes/Default.yaml" }

Configuration

Introduction

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.

plugin.tx_sfbooks

Settings for all plugins

plugin.tx_sfbooks_[book|author|category|series|search]

Settings specifically for each single plugins

Name	Type	Default
templateRootPaths	array of path	none
pagination	string	none
itemsPerPage	integer	10
numberOfLinks	integer	5
groupAuthors	boolean	1
groupSeries	boolean	1
orderings	array	1

templateRootPaths

Type: array of path
Default: none

Used to define several paths for templates, which will be tried in reversed order (the paths are searched from bottom to top). The first folder where the desired layout is found, is used. If the array keys are numeric, they are first sorted and then tried in reversed order.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript

plugin.tx_sfbooks {
   view {
      templateRootPaths {
         10 = EXT:sitedesign/Resources/Private/Templates
         20 = EXT:sitemodification/Resources/Private/Templates
      }
   }
}

pagination

Type: string
Default: none

Allows to configure what pagination class should be used. If no class name is given or the given class does not implement the PaginationInterface, the default SimplePagination gets used.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript

plugin.tx_sfbooks {
   settings {
      pagination = TYPO3\CMS\Core\Pagination\SlidingWindowPagination
   }
}

itemsPerPage

Type: integer
Default: 10

Amount of list entries per page.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript

plugin.tx_sfbooks {
   settings {
      itemsPerPage = 10
   }
}

numberOfLinks

Type: integer
Default: 5

If a SlidingWindowPagination or compatible pagination is used, this defines the amount of pages in the pagination list.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript

plugin.tx_sfbooks {
   settings {
      numberOfLinks = 3
   }
}

groupAuthors

Type: boolean
Default: 1

Choose weather to group the author list by first letter or not.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript

plugin.tx_sfbooks {
   settings {
      groupAuthors = 1
   }
}

groupSeries

Type: boolean
Default: 1

Choose weather to group the series list by first letter or not.

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript

plugin.tx_sfbooks {
   settings {
      groupSeries = 1
   }
}

orderings

Type: array
Default: 1

Combinations of fields with order directions

Example:

EXT:site_package/Configuration/TypoScript/setup.typoscript

plugin.tx_sfbooks {
   settings {
      orderings {
        title = ASC
      }
   }
}

Breaking Changes

01. November 2024

Content registration

Plugins are now registered with CType and not list_type anymore. Migration for existing content elements is provided.

28. July 2023

Change typoscript parameter

Rename TypoScript parameter settings.limit into settings.itemsPerPage. This also relates to the plugin settings where limit is renamed into itemsPerPage to.

Drop ViewHelper

As of version 8.x the SortViewHelper is dropped because its never used.

13. March 2021

Replace pagination widget by pagination API

Usage of f:widget.paginate is replaced with paginator and pagination objects with usage of Paginator.html partials.

Routes configuration

Routes configuration files are moved from /Configuration/Yaml to /Configuration/Routes

03. May 2020

Cleanup of plugins

Due to a more restricted handling of resolving controllers and actions in links every plugin is reduced to it's main data models. The following plugins are modified:

Plugin	Controller before change	after change
Book	BookController, CategoryController	BookController
Category	CategoryController, BookController	CategoryController
Series	SeriesController, BookController	SeriesController
Search	SearchController, BookController, AuthorController	SearchController

In consequence you need to check whether your pages are still displaying all information after upgrade.

There are settings for the link generation authorPageId, bookPageId, categoryPageId, seriesPageId to compensate reduced flexibility. Have a look into the TypoScript constants editor.

Cleanup of flexforms

The field settings.templatePath got removed with view.templateRootPaths.200. By this no extra handling for overriding templates is necessary anymore. But the new field needs to be filled to get it working again.

27. April 2017

Remove ViewHelper

In favor of the core the widget ViewHelper was dropped. Please replace 'sfb:widget.paginate' with 'f:widget.paginate' and check if configuration still works.

Template behaviour

Only valid template file type since version 4 are html files. Every other template file needs to be reuploaded.

Updating

Add path_segment information

Since version 6.0 of sf_books the extension support route generation.

There in the tables author, books, categories and series got path_segment fields added. These fields need to be filled for the url generation. To automatize this process there are four upgrade wizards available, which can be executed in the Admin Tools > Upgrade > Upgrade Wizard.

Testing

Setting up configuration for Functional Testing in PhpStorm

Sitemap