en:user:gs3_list_of_format_options
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
en:user:gs3_list_of_format_options [2017/05/01 02:32] – [gsf:metadata modifiers] kjdon | en:user:gs3_list_of_format_options [2019/09/24 02:05] – [Options] kjdon | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== List of Greenstone3 Format Items ====== | ====== List of Greenstone3 Format Items ====== | ||
- | The full list of formatting items is shown here. There are two main types of format items: options and templates. Options give you a switch to turn something on/off or change the look, while templates let you describe what output you want. | + | This page describes all the things that can go into the < |
See also the description of [[en: | See also the description of [[en: | ||
Line 22: | Line 22: | ||
|sectionExpandCollapse|true|display|? | |sectionExpandCollapse|true|display|? | ||
|backToTopLinks| |display|?| | |backToTopLinks| |display|?| | ||
- | |sideBar| |display| | | + | |sideBar|false |display|If false will not display any of the right side bar features, including cover image, search term highlighting checkbox, table of contents etc | |
|disableZoom|true|display| | | |disableZoom|true|display| | | ||
|disableSearchTermHighlighting|true|display|If set to true, will not highlight search terms in the text, and will not display the on/off button for highlighting| | |disableSearchTermHighlighting|true|display|If set to true, will not highlight search terms in the text, and will not display the on/off button for highlighting| | ||
|coverImage|true|display| | | |coverImage|true|display| | | ||
|TOC|true|display| | | |TOC|true|display| | | ||
- | |viewSelection|true|display| | | + | |viewSelection|false|display|If false, will not show the text/ |
- | |slideShow|true|display| | | + | |slideShow|false|display|If false, will not display the slideshow option for paged image documents |
- | |[[user_comments|AllowUserComments]]|true|display|If set to true, will allow users to add comments to public collections. Users need not have editing permissions for a collection they wish to add comments to. They just need to have an account on that Greenstone Digital Library.| | + | |[[user_comments|allowUserComments]]|true|display|If set to true, will allow users to add comments to public collections. Users need not have editing permissions for a collection they wish to add comments to. They just need to have an account on that Greenstone Digital Library. |
+ | |[[en: | ||
+ | |[[en: | ||
+ | ===== Parameter Defaults ===== | ||
+ | Inside a format element you can set default values for parameters, using the following syntax | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | You can use this to set things like: | ||
+ | * turn stemming on by default for mgpp collections: | ||
+ | * return all hits in one page instead of paging the results: < | ||
+ | |||
+ | To see what parameters you have that you can change, you can look at the page source for a query page and see what names and values the form elements have. | ||
+ | |||
+ | These can be added inside the < | ||
===== Templates ===== | ===== Templates ===== | ||
Line 141: | Line 155: | ||
|''< | |''< | ||
|''< | |''< | ||
+ | |''< | ||
===== Conditional ===== | ===== Conditional ===== |
en/user/gs3_list_of_format_options.txt · Last modified: 2024/06/03 23:50 by kjdon