amy/MagicSetEditor2
1
0
Fork 0
mirror of https://github.com/amyinspace/MagicSetEditor2.git synced 2026-06-10 04:57:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

documentation of symbol font changes

Browse Source 
git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@843 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
twanvl
2008-04-14 18:18:26 +00:00
parent 34c7a49647
commit e6c5cef498
2 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/type/symbol_font.txt
-9
View File
@@ -48,16 +48,7 @@ Such a package contains a [[file:format|data file]] called <tt>symbol-font</tt>
| @horizontal space@ [[type:double]] @0@ Horizontal spacing between symbols, in pixels. | @horizontal space@ [[type:double]] @0@ Horizontal spacing between symbols, in pixels.
| @vertical space@ [[type:double]] @0@ Vertical spacing between symbols, in pixels. | @vertical space@ [[type:double]] @0@ Vertical spacing between symbols, in pixels.
| @symbols@ [[type:list]] of [[type:symbol font symbol]]s Symbols that make up this font. | @symbols@ [[type:list]] of [[type:symbol font symbol]]s Symbols that make up this font.
| @text font@ [[type:font]] Font to use for drawing text on symbols, only used if there is a default symbol. The font size is in points per point.
| @scale text@ [[type:boolean]] @false@ Should text be scaled down to fit in a symbol? | @scale text@ [[type:boolean]] @false@ Should text be scaled down to fit in a symbol?
| @merge numbers@ [[type:boolean]] @false@ Should a numeric value of multiple digits be rendered as a single symbol?<br/>
Note: @merge numbers@ is deprecated, use @as text: [0-9]+@ instead.
| @as text@ [[type:regex]] @"."@ What should be rendered as a single piece of text?
| @text margin left@ [[type:double]] @0@ Margin on the left of the text in pixels per point.
| @text margin right@ [[type:double]] @0@ Margin on the right of the text in pixels per point.
| @text margin top@ [[type:double]] @0@ Margin on the top of the text in pixels per point.
| @text margin bottom@ [[type:double]] @0@ Margin on the bottom of the text in pixels per point.
| @text alignment@ [[type:alignment]] @"middle center"@ How should text be aligned on symbols?
| @insert symbol menu@ [[type:insert symbol menu|"insert symbol" menu]] ''none'' A description of the menu to insert a symbol into the text. | @insert symbol menu@ [[type:insert symbol menu|"insert symbol" menu]] ''none'' A description of the menu to insert a symbol into the text.
--Examples-- --Examples--
doc/type/symbol_font_symbol.txt
+14 -3
View File
@@ -7,17 +7,28 @@ A single symbol in a [[type:symbol font]].
--Properties-- --Properties--
! Property Type Default Description ! Property Type Default Description
| @image font size@ [[type:double]] value from symbol font To what point size does the images correspond? | @image font size@ [[type:double]] value from symbol font To what point size does the images correspond?
| @code@ [[type:string]] ''required'' Text this symbol matches.<br/> | @code@ [[type:string]] or [[type:regex]] ''required'' Text this symbol matches.
A single symbol can omit the code, this then becomes the ''default symbol'', on which text is drawn. | @regex@ [[type:boolean]] @false@ Is the code a regular expression (as opposed to a string)?
| @image@ [[type:scriptable]] [[type:image]] ''required'' Image of this symbol. | @image@ [[type:scriptable]] [[type:image]] ''required'' Image of this symbol.
| @enabled@ [[type:scriptable]] [[type:boolean]] @true@ Is this symbol actually used?<br/> | @enabled@ [[type:scriptable]] [[type:boolean]] @true@ Is this symbol actually used?<br/>
This can be scripted to optionally disable certain symbols.<br/> This can be scripted to optionally disable certain symbols.<br/>
If multiple symbols with the same code are given disabling the first switches to the second one. If multiple symbols with the same code are given disabling the first switches to the second one.
| @draw text@ [[type:int]] @-1@ The index of the captured regex expression to draw as text, or -1 to not draw text.<br/> For example with the code @"x([a-z])"@ and @draw text: 1@ the text of the symbol @"xb"@ will be @"b"@.
| @text font@ [[type:font]] Font to use for drawing text on symbols. The font size is in font points per text box font point.
| @text alignment@ [[type:alignment]] @"middle center"@ How should text be aligned on the symbol?
| @text margin left@ [[type:double]] @0@ Margin on the left of the text in pixels per point.
| @text margin right@ [[type:double]] @0@ Margin on the right of the text in pixels per point.
| @text margin top@ [[type:double]] @0@ Margin on the top of the text in pixels per point.
| @text margin bottom@ [[type:double]] @0@ Margin on the bottom of the text in pixels per point.
--Examples-- --Examples--
A default symbol: A symbol with text:
>symbol: >symbol:
> image: blank.png > image: blank.png
> code: .
> regex: true
> text font: Arial
Two symbols for the same code, which one is used depends on a function from the [[type:stylesheet]]. Two symbols for the same code, which one is used depends on a function from the [[type:stylesheet]].
It is recommended to only use functions in @enabled@, so each stylesheet can determine how the font should be used. It is recommended to only use functions in @enabled@, so each stylesheet can determine how the font should be used.