documented the split_text script function

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@1255 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
twanvl
2008-12-27 19:39:20 +00:00
parent 81280467d5
commit e423b6956f
4 changed files with 48 additions and 1 deletions
+5 -1
View File
@@ -20,6 +20,10 @@ So for example where @break_text@ returns @["a","b","c"]@, @filter_text@ would r
In fact, @filter_text@ could be implemented as
> filter_text := { for part in break_text() do part }
--Split vs. break--
The function @split_text@ does the opposite of @break_text@, keeping the parts between the regular expression matches, instead of the matching text itself.
--Parameters--
! Parameter Type Description
| @input@ [[type:string]] String to replace in.
@@ -38,4 +42,4 @@ In fact, @filter_text@ could be implemented as
--See also--
| [[fun:filter_text]] Keep only the text matching a regular expression.
| [[fun:split_text]] Split text into parts separated by a regular expression.