What does it do?

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.

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.

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

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

Settings and view in both plugin configurations

Data type

array of file paths with stdwrap

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:

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

Data 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:

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

Data type

integer

Default

10

Amount of list entries per page.

Example:

plugin.tx_sfbooks {
   settings {
      itemsPerPage = 10
   }
}

Data type

integer

Default

5

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

Example:

plugin.tx_sfbooks {
   settings {
      numberOfLinks = 3
   }
}

Data type

boolean

Default

1

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

Example:

plugin.tx_sfbooks {
   settings {
      groupAuthors = 1
   }
}

Data type

boolean

Default

1

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

Example:

plugin.tx_sfbooks {
   settings {
      groupSeries = 1
   }
}

Data type

array

Default

1

Combinations of fields with order directions

Example:

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

28. July 2023

13. March 2021

03. May 2020

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.