From 36065707ab562d50feb06f40854fd2cfca17684d Mon Sep 17 00:00:00 2001 From: twanvl Date: Thu, 7 Aug 2008 01:47:28 +0000 Subject: [PATCH] documented expand_keywords changes git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@1079 0fc631ac-6414-0410-93d0-97cfa31319b6 --- doc/function/expand_keywords.txt | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/doc/function/expand_keywords.txt b/doc/function/expand_keywords.txt index 3e254650..65d8f024 100644 --- a/doc/function/expand_keywords.txt +++ b/doc/function/expand_keywords.txt @@ -30,13 +30,35 @@ is used. This shows reminder text by default based on a [[type:set]] option, and --Parameters-- ! Parameter Type Description | @input@ [[type:tagged string]] String to expand keywords in. +| @condition@ [[type:function]] DOC_MSE_VERSION: since 0.3.7 + When should a keyword be recognized at all? | @default_expand@ [[type:function]] Should reminder text be shown by default? | @combine@ [[type:function]] How to combine keywords with the reminder text? +--Arguments-- + +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. +| @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? +| @correct_case@ [[type:boolean]] DOC_MSE_VERSION: since 0.3.7 + Is the keyword matched exactly, with the same case? +| @keyword@ [[type:tagged string]] In @combine@ only: The full keyword text including parameters +| @reminder@ [[type:string]] In @combine@ only: The expanded reminder text. + + --Examples-- Assuming a keyword @"mse"@ exists with reminder text @"Magic Set Editor"@ exists. -> expand_keywords(default_expand: {true}, combine: { keyword + " = " + reminder }, "mse is cool") -> == "mse = Magic Set Editor is cool" +> expand_keywords(default_expand: {true}, combine: { keyword + " (= " + reminder + ")" }, "mse is cool") +> == "mse (= Magic Set Editor) is cool" > -> f := expand_keywords@(default_expand: {true}, combine: { keyword+"="+reminder }) -> f("mse is cool") == "mse = Magic Set Editor is cool" +> f := expand_keywords@(default_expand: {true}, combine: { keyword+" (= "+reminder+")" }) +> f("mse is cool") == "mse (= Magic Set Editor) is cool" + +DOC_MSE_VERSION: since 0.3.7 +Keyword matching is case insensitive, to get case sensitive matching use a @condition@ that check for the @correct case@: +> expand_keywords(..., condition: { correct_case }) +In prior MSE versions matching was always case sensitive.