WebSVN – wimsdev – /trunk/wims/public_html/modules/help/wimsdoc.en/cmd/text.phtml

!! +exec+ +var+ +string+
tit:text
type:$type_both
syntax:!text ``operation'' ``parameter''
mean:This is intended to be a very powerful text manipulation tool,\
allowing very sophisticated processing of long text strings with high speed. \
Many of the ``operations'' accept masks. A mask is a string composed of ``0''s and ``1''s. \
For operations which accept a mask, only characters at positions whose corresponding\
character in the mask is not a ``0'' are processed. (In this sense positions\
corresponding to ``0''s are ``masked''.) Empty mask is considered\
as of being entirely composed of ``1''s. \
A mask which is too short repeats itself, unless it terminates with a ``+'',\
in which case it fills the rest with ``1''s, or with a ``-'', in which case\
it fills the rest with ``0''s. \
For the time being, implemented ``operations'' are as follows.\
<ul>\
<li>!text common ``text1'' and ``text2'' [mask ``maskstring''] \
Extracts characters in ``text1'' one by one, for those identical\
to the corresponding characters in ``text2'' and whose\
positions are not masked by ``maskstring''.\
</li><li>!text compare ``text1'' and ``text2''\
\
Compares the strings ``text1'' and ``text2'' character by character, \
and returns a mask string with ``0''s on positions where the corresponding characters in ``text1''\
and ``text2'' are equal, and ``1''s otherwise.\
</li><li>!text copy ``text'' [mask ``maskstring''] \
Returns non-masked characters in ``text''.\
</li><li>!text count ``charlist'' in ``text'' [mask ``maskstring''] \
Returns the number of characters in ``text'' whose positions\
are not masked by ``maskstring'', and who appear in ``charlist''.\
</li><li>!text diff ``text1'' from ``text2'' [mask ``maskstring''] \
Extracts characters in ``text1'' one by one, for those different to the corresponding \
characters in ``text2'' and whose positions are not masked by ``maskstring''. \
(Synonyme of diff: differ).\
</li><li>!text expand ``text'' using ``maskstring''\
\
Produces a string, where positions corresponding to ``0''s in\
``maskstring'' are filled by `` '' (the space character),\
and where positions corresponding to ``1''s in ``maskstring'' are filled by characters of \
``text''. The characters in ``text'' are used one by one, and the\
resulting string stops when all the characters in ``text'' are exhausted \
(or when the string reaches the length limit).\
</li><li>!text insert ``text1'' into ``text2'' [mask ``maskstring''] \
Returns ``text2'' with non-masked characters replaced by characters ``text1''. \
Characters in ``text1'' are used one by one (without taking into account the masking), and\
the replacement stops when there is no character left in ``text1''.\
</li><li>!text interact ``text1'' and ``text2'' table ``itab'' [mask ``maskstring''] \
Returns a new text which is result of interactions of characters\
in corresponding positions in ``text1'' and ``text2''. The rule of the interaction is defined in\
``itab''. ``itab'' contains n+1 lines, each of n characters.\
The first line defines the characters corresponding to each position\
in the following n lines which defines the multiplication table.\
\
The multiplication table needs not to be symmetric. In this case, the rows correspond \
to characters in ``text1'', and the columns correspond to characters in ``text2''.\
\
If ``text1'' or ``text2'' contains a character not in the first line of ``itab'', \
the interaction at the corresponding position is considered as empty. Also, masked\
positions are ignored. \
If ``text1'' and ``text2'' have different lengths, the longer is cut to fit the shorter.\
</li><li>!text mark ``charlist'' in ``text'' \
Returns a mask string with ``1''s on positions where the corresponding character in ``text'' \
appears in ``charlist'', and with ``0''s on other positions.\
</li><li>!text max ``text1'' and ``text2'' [mask ``maskstring''] \
Returns a string which at each position is the character with highest\
ASCII code between corresponding characters in ``text1'' and ``text2''. \
The length of the result is that of the longest of the two. Masked positions are skipped.\
</li><li>!text min ``text1'' and ``text2'' [mask ``maskstring''] \
Returns a string which at each position is the character with lowest\
ASCII code between corresponding characters in ``text1'' and ``text2''. \
The length of the result is that of the\
shortest of the two. Masked positions are skipped.\
</li><li>!text occur ``charlist'' in ``text'' [mask ``maskstring''] \
Returns characters in ``charlist'' which occur in unmasked positions in ``text''. \
(Synonymes of occur: appear, occurrence).\
</li><li>!text remove ``charlist'' in ``text'' [mask ``maskstring''] \
Returns ``text'' in which masked characters and characters\
appearing in ``charlist'' are removed. (Synonymes of remove: drop, delete).\
</li><li>!text reorder ``text'' by ``orderlist'' \
Returns a reordered ``text'' using the order list ``orderlist''. Reordering is cyclic \
if ``orderlist'' is shorter than ``text''. \
``orderlist'' must be a list of n positive integers, which\
is a permutation of the set {1,...,n}. If ``orderlist'' contains\
items other than integers within the bound, empty string is returned.\
However, unicity check is not performed on items of ``orderlist''.\
</li><li>!text repeat ``text'' to ``len'' \
Repeat the string ``text'' cyclicly, up to length ``len''.\
</li><li>!text reverse ``text'' \
Reverse the order of ``text'', with the last character coming first, etc.\
</li><li>!text select ``charlist'' in ``text'' [mask ``maskstring''] \
Returns ``text'' in which masked characters and characters not appearing in \
``charlist'' are removed. (Synonymes of select: pick, pickup).\
</li></ul>

Subversion Repositories wimsdev

(root)/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/text.phtml – Rev 17228