more documentation spellchecking,

in documentation: @<tag>@ now highlights as a tag

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@1279 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
twanvl
2009-01-01 21:22:45 +00:00
parent bd2edc947f
commit 6afbbe986c
8 changed files with 48 additions and 37 deletions
+5 -5
View File
@@ -2,12 +2,12 @@ Function: combined_editor
--Usage--
> forward_editor(field: some_text_value)
> combined_editor(field1: some_text_value, field2: some_text_value, ..., separtor1: some_string, ...)
> combined_editor(field1: some_text_value, field2: some_text_value, ..., separator1: some_string, ...)
Use one text field to edit one or more others.
This function must be used in the @script@ of a [[type:field#text|text field]].
This field will then contain the combined values of the given fields, separated by the separtors in <tt>&lt;sep></tt> tags.
This field will then contain the combined values of the given fields, separated by the separators in @<sep>@ tags.
When the field changes the underlying values are updated and vice versa.
Note: @forward_editor@ and @combined_editor@ are the same function.
@@ -20,10 +20,10 @@ Note: @forward_editor@ and @combined_editor@ are the same function.
| @separator@ [[type:string]] Separator between field 1 and 2
| @separator1@ [[type:string]] Multiple separators
| @separator2@ [[type:string]] Next separator, ''etc.''
| @prefix@ [[type:string]] ''optional'' Prefix before the combined editor; like a separtor between the start and the first field.
| @suffix@ [[type:string]] ''optional'' Suffix after the combined editor; like a separtor between the last field and the end.
| @prefix@ [[type:string]] ''optional'' Prefix before the combined editor; like a separator between the start and the first field.
| @suffix@ [[type:string]] ''optional'' Suffix after the combined editor; like a separator between the last field and the end.
| @hide when empty@ [[type:boolean]] @false@ Don't include separators if the entire value is empty.
| @soft before empty@ [[type:boolean]] @false@ Make separators 'soft' when the value folowing it is empty.
| @soft before empty@ [[type:boolean]] @false@ Make separators 'soft' when the value following it is empty.
Soft separators are hidden by default and shown grayed when the field is selected.
--Examples--
+5 -5
View File
@@ -13,10 +13,10 @@ The it is determined whether the reminder text should be shown.
This is either because the user explicitly selected it, or when @default_expand(mode: keyword.mode)@ returns true.
Whether reminder text is shown is stored in a @<kw->@ tag around the keyword.
! Tag Reminder text Changed by user
| @"<kw-a>"@ hidden no
| @"<kw-A>"@ shown no
| @"<kw-0>"@ hidden yes
| @"<kw-1>"@ shown yes
| @<kw-a>@ hidden no
| @<kw-A>@ shown no
| @<kw-0>@ hidden yes
| @<kw-1>@ shown yes
If the reminder text is shown the function @combine@ is called which should combine the reminder text with (in the variable @reminder@) with the keyword and its parameters (in the variable @keyword@).
@@ -40,7 +40,7 @@ is used. This shows reminder text by default based on a [[type:set]] option, and
The @condition@, @default_expand@ and @combine@ functions will be called for each potential keyword match in the input.
! Parameter Type Description
| @param1@, @param2@, ... [[type:tagged string]]* The parameter values.
| @param1@, @param2@, ... [[type:tagged string]]s The parameter values.
| @mode@ [[type:string]] The @mode@ of the keyword.
| @used_placeholders@ [[type:boolean]] DOC_MSE_VERSION: since 0.3.7
Is a placeholder used for any of the parameters?
+5
View File
@@ -1,5 +1,7 @@
Function: format
DOC_MSE_VERSION: deprecated in 0.3.7, use to_string
--Usage--
> format(some_number, format: format_specification)
@@ -18,3 +20,6 @@ Format a number or other string as a string, [[http://www.cplusplus.com/referenc
>
> f := format@(format: "%03d")
> f(1) == "001"
--See also--
| [[fun:to_string]] Convert any value to a [[type:string]]
+1 -1
View File
@@ -4,7 +4,7 @@ Function: symbol_variation
> symbol_variation(symbol: symbol_value, variation: name_of_variation)
Render a [[type:symbol variation|variation]] of a symbol.
The variation name refers to one of the varations declared in the [[type:style]] of the symbol field.
The variation name refers to one of the variations declared in the [[type:style]] of the symbol field.
> symbol_variation(symbol: symbol_value, border_radius: .., fill_type: .., ...)