From 361488b4fefb0581f15160d112139b0fd8f8ed61 Mon Sep 17 00:00:00 2001 From: twanvl Date: Wed, 26 Dec 2007 23:45:39 +0000 Subject: [PATCH] documentation of 'package choice' field type git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@791 0fc631ac-6414-0410-93d0-97cfa31319b6 --- doc/type/field.txt | 8 ++++++++ doc/type/style.txt | 4 ++++ doc/type/value.txt | 1 + 3 files changed, 13 insertions(+) diff --git a/doc/type/field.txt b/doc/type/field.txt index 80e76d68..e2a603a3 100644 --- a/doc/type/field.txt +++ b/doc/type/field.txt @@ -20,6 +20,7 @@ Fields are part of the [[file:style triangle]]: * @text@ * @choice@ * @multiple choice@ + * @package choice@ * @boolean@ * @image@ * @symbol@ @@ -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"@.'' <<< <<< <<< +| @"package choice"@ + @script@ [[type:script]] Script to apply to values of this field after each change.
+ 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.
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). diff --git a/doc/type/style.txt b/doc/type/style.txt index d273d66c..f1738505 100644 --- a/doc/type/style.txt +++ b/doc/type/style.txt @@ -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@. | ^^^ @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. | ^^^ @left width@ [[type:double]] ∞ Draw only this many pixels from the side, creating a box with a hole in it, or a card border. diff --git a/doc/type/value.txt b/doc/type/value.txt index c8ea88ee..50c2f004 100644 --- a/doc/type/value.txt +++ b/doc/type/value.txt @@ -17,6 +17,7 @@ The type of a value depends on the corresponding 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.
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. | @"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.