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 revision | ||
en:user:gs3_list_of_format_options [2019/09/24 02:05] – [Options] kjdon | en:user:gs3_list_of_format_options [2024/03/11 20:16] (current) – [Collection/Interface Text Strings] kjdon | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | |||
+ | |||
+ | |||
====== List of Greenstone3 Format Items ====== | ====== List of Greenstone3 Format Items ====== | ||
- | This page describes all the things that can go into the < | + | This page describes all the things that can go into the < |
+ | |||
+ | Format | ||
+ | |||
+ | ''< | ||
+ | |||
+ | |||
See also the description of [[en: | See also the description of [[en: | ||
- | ''< | ||
- | ===== Options ===== | + | ===== Top Level Elements ===== |
+ | |||
+ | There are three main types of format items: options, parameter defaults, and templates. | ||
+ | |||
+ | ==== Options | ||
- | There are a few options available. They are specified by adding < | + | There are a few options available. They are specified by adding |
^Option name^Values^Format^Description^ | ^Option name^Values^Format^Description^ | ||
Line 33: | Line 46: | ||
|[[en: | |[[en: | ||
- | ===== Parameter Defaults | + | ==== Parameter Defaults ==== |
Inside a format element you can set default values for parameters, using the following syntax | Inside a format element you can set default values for parameters, using the following syntax | ||
Line 46: | Line 59: | ||
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. | 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 < | + | These can be added inside the < |
- | ===== Templates ===== | + | |
- | ^Format Element^Greenstone2 equivalent^Description^ | + | ==== Templates ==== |
- | | ||| | + | |
- | |''< | + | Templates are the containers that hold all format statements. The value of '' |
+ | ''< | ||
- | ===== Links ===== | + | ===== What can go inside a template? |
+ | ==== Links ==== | ||
^Format Element^Greenstone2 equivalent^Description^ | ^Format Element^Greenstone2 equivalent^Description^ | ||
Line 72: | Line 86: | ||
|''< | |''< | ||
- | ===== Icons and Images | + | ==== Icons and Images ==== |
^Format Element^Greenstone2 equivalent^Description^ | ^Format Element^Greenstone2 equivalent^Description^ | ||
| ||| | | ||| | ||
Line 88: | Line 102: | ||
|''< | |''< | ||
|''< | |''< | ||
- | ===== Text and Metadata | + | |
+ | ==== Text and Metadata ==== | ||
^Format Element^Greenstone2 equivalent^Description^ | ^Format Element^Greenstone2 equivalent^Description^ | ||
| ||| | | ||| | ||
Line 106: | Line 121: | ||
|''< | |''< | ||
- | ==== gsf: | + | === gsf: |
By default, gsf: | By default, gsf: | ||
Line 146: | Line 161: | ||
- | ===== Miscellaneous Things | + | ==== Collection/ |
+ | |||
+ | These will be displayed in the current interface language (if available), otherwise in the default language. | ||
+ | |||
+ | ^Format Element^Greenstone2 equivalent^Description^ | ||
+ | | ||| | ||
+ | |''< | ||
+ | |''< | ||
+ | |''< | ||
+ | |''< | ||
+ | |''< | ||
+ | |''< | ||
+ | |||
+ | ==== Miscellaneous Things ==== | ||
^Format Element^Greenstone2 equivalent^Description^ | ^Format Element^Greenstone2 equivalent^Description^ | ||
| ||| | | ||| | ||
|''< | |''< | ||
- | |''< | ||
- | |''< | ||
- | |''< | ||
- | |''< | ||
- | |''< | ||
|''< | |''< | ||
+ | |''< | ||
+ | |||
- | ===== Conditional | + | ==== Conditional ==== |
^Format Element^Greenstone2 equivalent^Description^ | ^Format Element^Greenstone2 equivalent^Description^ | ||
| ||| | | ||| | ||
Line 166: | Line 191: | ||
- | ====Preprocess Options | + | ===Preprocess Options === |
The preprocess attribute specifies something to do to the metadata value before performing the test. For example, you may want to lower case the value before comparing it to your text string. That way you don't need to worry about handling case variation in the metadata value. | The preprocess attribute specifies something to do to the metadata value before performing the test. For example, you may want to lower case the value before comparing it to your text string. That way you don't need to worry about handling case variation in the metadata value. | ||
Line 180: | Line 205: | ||
- | ==== Test options | + | === Test options === |
Sometimes you may want to output different things depending on the value of the metadata element. There are many tests you can make on the metadata value, listed below, which are specified using the test attribute. They all take a second parameter, specified using the test-value attribute, which is the value to compare to (with the exception of exists, which needs no test value). The preprocessing | Sometimes you may want to output different things depending on the value of the metadata element. There are many tests you can make on the metadata value, listed below, which are specified using the test attribute. They all take a second parameter, specified using the test-value attribute, which is the value to compare to (with the exception of exists, which needs no test value). The preprocessing | ||
option, if specified, is carried out first, before performing the test. | option, if specified, is carried out first, before performing the test. | ||
Line 200: | Line 225: | ||
- | ===== Iteration | + | ==== Iteration ==== |
^Format Element^Greenstone2 equivalent^Description^ | ^Format Element^Greenstone2 equivalent^Description^ | ||
| ||| | | ||| | ||
Line 207: | Line 232: | ||
- | ==== gsf: | + | === gsf: |
^gsf: | ^gsf: | ||
Line 221: | Line 246: | ||
|sort|true|Sort the metadata values (alphabetically, | |sort|true|Sort the metadata values (alphabetically, | ||
- | ==== gsf:sort attributes | + | === gsf:sort attributes === |
^gsf:sort Attribute^Possible Values^Description^ | ^gsf:sort Attribute^Possible Values^Description^ | ||
Line 230: | Line 255: | ||
|data-type|text/ | |data-type|text/ | ||
- | ===== Additional Notes ===== | + | ==== Utility Functions ==== |
+ | |||
+ | There are many utility functions defined in src/ | ||
+ | |||
+ | They can be called explicitly using | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | args is a comma separated list of args. They can be XSLT variables, numbers, strings, XSLT elements/ | ||
+ | |||
+ | For example: | ||
+ | < | ||
+ | < | ||
+ | The collection was last built on < | ||
+ | </ | ||
+ | |||
+ | This code is getting the buildDate timestamp from collection metadata. Then it is formatting it using the formatTimeStamp function. | ||
+ | This function takes 4 arguments: | ||
+ | * the timestamp - here we use the raw_date variable we have just made | ||
+ | * an integer for timestamp type - 0 is seconds, 1 is milliseconds | ||
+ | * an integer for output format tupe - 0 is date, 1 is time, 2 is date and time, 3 is days ago | ||
+ | * the language code for which language you want the output in - here we use the attribute from the page element. | ||
+ | |||
+ | We could change this output to days ago: | ||
+ | The collection was last built < | ||
+ | |||
+ | ==== Additional Notes ==== | ||
Some of these options (< | Some of these options (< |
en/user/gs3_list_of_format_options.1569290750.txt.gz · Last modified: 2019/09/24 02:05 by kjdon