Create/edit template
Parameters are grouped by categories and it is possible to switch between them using tabs. Four groups of parameters are available:
- Main settings contains main parameters like name and ID.
- Styles settings contains styles parameters like width, height, font, colors and etc.
- Book settings contains parameters which helps to manage features like zoom, fullscreen mode, navigation buttons, slider with pages preview and etc.
See description of each parameter below.
Main settings
- ID is record number in the database. Can be used by a 3rd party extension to manipulate with the entity.
- Name is a name of template.
Styles settings
- Maximum width is used to specify maximum width of the book. Useful if book is responsive and necessary to set maximum width. If you want to use fixed width, set the same value (in pixels) for "Maximum width" and "Minimim width" parameters. Possible values: 100%, 600px and etc.
- Minimum width is used to specify minimum width of the book. Useful if book is responsive and necessary to set minimum width. If you want to use fixed width, set the same value (in pixels) for "Maximum width" and "Minimim width" parameters. Possible values: 20%, 200px and etc.
- Optimum page width if the parameter is defined, the extension will calculate book width and height automatically saving ratio between values of 'Optimum page width' and 'Optimum page height' parameters. For example it is useful if a book contains images with same dimensions and you want to avoid blank space on pages. In this case set the parameter to width of an image from the book and 'Optimum page height' parameter to height of the image from the book. Possible values: 340, 500 and etc.
- Optimum page height if the parameter is defined, the extension will calculate book width and height automatically saving ratio between values of 'Optimum page width' and 'Optimum page height' parameters. For example it is useful if a book contains images with same dimensions and you want to avoid blank space on pages. In this case set the parameter to height of an image from the book and 'Optimum page width' parameter to width of the image from the book. Possible values: 340, 500 and etc.
- Height is used to set book height. Possible values: 500px, 450px and etc.
- Show shadow is used to show/hide shadow around publication.
- Show shadow between pages is used to show/hide shadow between pages.
- Font size is used to define default font size for the books which use the template. Possible values: 16px, 1.5em, 80% and etc.
- Font is used to define default font for the books which use the template. It is possible to use custom fonts, load CSS file which contains definition for a font to <joomla_directory>\media\arismartbook\fonts\ folder. The file should have FONTNAME.css name. Where FONTNAME is name of your font. By default the extension contains Stempel-Garamond-W01-Roman custom in "fonts" folder. If you want to use, set "Font" parameter to the following value:
predefined:Stempel-Garamond-W01-Roman
or
predefined:Stempel-Garamond-W01-Roman,Arial,sans-serif
It is also possible to use Google fonts. For this use the following value:
google:FONTNAME
Where FONTAME is font name which you want to use. For example if you want to use Muli font, use the following value:
google:Muli
or
google:Muli,Tahoma,sans-serif
- Custom styles is used to define custom CSS rules which will be used for books content. It is possible to use {$theme} predefined variable to create specific CSS rules for this template. For example the following code changes text color to red and adds blue background for <H1> element:
.{$theme} .page {
color: #FF0000;
}
.{$theme} .page H1 {
background-color: #0000FF;
}
Book settings
- Text direction is used to specify text direction. It can be "Left to right" or "Right to left" (for example for Arabic languages). If the parameter is set to "Auto", the extension will detect text direction automatically based on currently selected language on the site. When the parameter is set to "Right to left", it changes behaviour of navigation buttons and slider.
- Page image scale is used to specify how should be shown pages with "Image" type. It can stretch image accros page ("Fill page" value) or save image ratio ("Keep scale" value).
- Show gradients is used to specify should be gradients and shadows shown during the transition or not.
- Show cover is used to specify should be the first page be a book cover or book will be without cover.
- Show title is used to specify show or not publications titles.
- Duration is the duration of the transition in milliseconds.
- Elevation is used to define elevation of the page during the transition.
- Keyboard navigation is used to define possible or not use keyboards arrows button to navigate between pages.
- Show page numbers should be shown page numbers or not.
Navigation buttons
- Show 'Next & Prev' buttons show or not navigation buttons from left and right sides of the book.
- 'Next & Prev' show mode is used to specify when the buttons should be shown. Always or only on mouse over.
Slider settings
- Show slider show the slider with pages preview or not.
- Preview mode it is possible to show page numbers or thumbnails as preview.
Hash links
- Hash links enabled if the parameter is enabled, each page will have an unique link and it will be possible to use the link to open the required page.
- Hash links prefix parameter is used when "Hash links enabled" parameter is set to "Yes". The prefix is added to hash links, by default hash link looks like page/PAGE_NUM. For example if prefix is set to mybook/ then link will look like mybook/page/PAGE_NUM. Hash link will cause navigation for all books on a page with same prefix.
Zoom settings
- Zoom enable is used to enable/disable ability to zoom-in/zoom-out book content.
- Max zoom ratio is zoom maximum ratio.
- Min zoom ratio is zoom minimum ratio.
- Zoom step is used to define zoom step size. It will be used when pages are zoomed in or zoomed out. For each call of zoom in or zoom out, the extension will increase/decrease the current zoom ratio on zoom step size.
- Use mousewheel is indicate use mousewheel to zoom in/out content or not.
Fullscreen settings
- Fullscreen enable is used to enable/disable ability switching to fullscreen mode. 'Fullscreen' button will be hidden anyway if user's browser doesn't support ability switch to fullscreen.
Images lazy load
- Enable is used to enable lazy load for images which are used as pages. Images which are used as pages will be loaded only when pages with these images are opened. It is useful if you use a large images.
- Effect duration is used to set duration of fading effect in milliseconds which appears when an image is loaded.
