Commit e042585b authored by twanvl's avatar twanvl

documentation of 'package choice' field type

parent b9b1279f
...@@ -20,6 +20,7 @@ Fields are part of the [[file:style triangle]]: ...@@ -20,6 +20,7 @@ Fields are part of the [[file:style triangle]]:
* @text@ * @text@
* @choice@ * @choice@
* @multiple choice@ * @multiple choice@
* @package choice@
* @boolean@ * @boolean@
* @image@ * @image@
* @symbol@ * @symbol@
...@@ -78,6 +79,13 @@ Additional properties are available, depending on the type of field: ...@@ -78,6 +79,13 @@ Additional properties are available, depending on the type of field:
| @"boolean"@ ''A boolean field is a choice field with the choices @"yes"@ and @"no"@.'' <<< <<< <<< | @"boolean"@ ''A boolean field is a choice field with the choices @"yes"@ and @"no"@.'' <<< <<< <<<
| @"package choice"@
@script@ [[type:script]] Script to apply to values of this field after each change.<br/>
If the script evaluates to a constant (i.e. doesn't use @value@) then values in this field can effectively not be edited.
| ^^^ @match@ [[type:string]] ''required'' Filenames of the pakcages to match, can include wildcards @"*"@. For example @"magic-mana-*.mse-symbol-font"@.
| ^^^ @initial@ [[type:string]] ''required'' Initial package for new values for this field.
| ^^^ @reqired@ [[type:boolean]] @true@ Must a package always be selected? Or is it allowed to select nothing?
| @"color"@ @script@ [[type:script]] Script to apply to values of this field after each change.<br/> | @"color"@ @script@ [[type:script]] Script to apply to values of this field after each change.<br/>
If the script evaluates to a constant (i.e. doesn't use @value@) then values in this field can effectively not be edited. If the script evaluates to a constant (i.e. doesn't use @value@) then values in this field can effectively not be edited.
| ^^^ @default@ [[type:script]] Script to determine the value when it is in the default state (not edited). | ^^^ @default@ [[type:script]] Script to determine the value when it is in the default state (not edited).
......
...@@ -131,6 +131,10 @@ The rest of the properties depend on the type of [[type:field]] this style is fo ...@@ -131,6 +131,10 @@ The rest of the properties depend on the type of [[type:field]] this style is fo
@direction@ [[type:direction]] @"left to right"@ Direction the items are layed out in, only when @render style@ is @list@. @direction@ [[type:direction]] @"left to right"@ Direction the items are layed out in, only when @render style@ is @list@.
| ^^^ @spacing@ [[type:double]] @0@ Spacing between the items. | ^^^ @spacing@ [[type:double]] @0@ Spacing between the items.
! <<< <<< <<< <<<
| @"package choice"@
| ^^^ @font@ [[type:font]] Font to use for rendering text.
! <<< <<< <<< <<< ! <<< <<< <<< <<<
| @"color"@ @radius@ [[type:script]] @0@ Radius of rounded corners for the box in pixels. | @"color"@ @radius@ [[type:script]] @0@ Radius of rounded corners for the box in pixels.
| ^^^ @left width@ [[type:double]] &infin; Draw only this many pixels from the side, creating a box with a hole in it, or a card border. | ^^^ @left width@ [[type:double]] &infin; Draw only this many pixels from the side, creating a box with a hole in it, or a card border.
......
...@@ -17,6 +17,7 @@ The type of a value depends on the corresponding field: ...@@ -17,6 +17,7 @@ The type of a value depends on the corresponding field:
| @"choice"@ [[type:string]] One of the choices of the field. | @"choice"@ [[type:string]] One of the choices of the field.
| @"multiple choice"@ [[type:string]] A list of choices from the field, separated by commas.<br/> | @"multiple choice"@ [[type:string]] A list of choices from the field, separated by commas.<br/>
For example: @"red, green, blue"@. For example: @"red, green, blue"@.
| @"package choice"@ Name of a package The (file)name of a package, including the extension.
| @"boolean"@ @"yes"@ or @"no"@ This can be directly used as a [[type:boolean]] value in scripts. | @"boolean"@ @"yes"@ or @"no"@ This can be directly used as a [[type:boolean]] value in scripts.
| @"image"@ [[type:filename]] Filename of an image file in the [[type:set]] package. | @"image"@ [[type:filename]] Filename of an image file in the [[type:set]] package.
| @"symbol"@ [[type:filename]] Filename of a [[type:symbol]] file in the [[type:set]] package.<br/> | @"symbol"@ [[type:filename]] Filename of a [[type:symbol]] file in the [[type:set]] package.<br/>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment