-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhowto.html
142 lines (142 loc) · 7.12 KB
/
howto.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<!DOCTYPE html>
<html>
<head>
<title>StringUtils howto guide</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<script src="https://code.jquery.com/jquery-1.9.1.min.js"
integrity="sha256-wS9gmOZBqsqWxgIVgA8Y9WcQOa7PgSIX+rPA0VL2rbQ="
crossorigin="anonymous"></script>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"
integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css"
integrity="sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"
integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa"
crossorigin="anonymous"></script>
</head>
<body>
<div class="container">
<h1><span class="glyphicon glyphicon-info-sign"></span> How to use the StringUtils external module</h1>
<div class="panel panel-info">
<div class="panel-heading">
What is it for?
</div>
<div class="panel-body">
This plugin allows you to manipulate text fields using action tags.
</div>
</div>
<div class="panel panel-warning">
<div class="panel-heading">
Limitations
</div>
<div class="panel-body">
<ul>
<li>The field using the StringUtils action tag MUST be on the same instrument as the source field.</li>
<li>A field containing the result of a StringUtils function CANNOT be used as a source field.</li>
<li>By default, the resulting value in a field using the StringUtils action tag can be manually overwritten. If this is not desirable, it is recommended to use the @READONLY action tag.</li>
</ul>
</div>
</div>
<div class="panel panel-success">
<div class="panel-heading">
Using the external module
</div>
<div class="panel-body">
Create a field with one of the following action tags:
<table class="table">
<thead>
<tr>
<th>Action tag</th>
<th>Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td>
@TOLOWER=sourcefieldnamehere
</td>
<td>
Converts the field into its lowercase equivalent.
</td>
</tr>
<tr>
<td>
@TOUPPER=sourcefieldnamehere
</td>
<td>
Converts the field into its uppercase equivalent.
</td>
</tr>
<tr>
<td>
@STRLEN=sourcefieldnamehere
</td>
<td>
Calculates the length of a field.
</td>
</tr>
<tr>
<td>
@TRIM=sourcefieldnamehere
</td>
<td>
Trims the text of a field of whitespaces.
</td>
</tr>
<tr>
<td>
@LTRIM=sourcefieldnamehere
</td>
<td>
Trims the left side of text of a field of whitespaces.
</td>
</tr>
<tr>
<td>
@SUBSTR=sourcefieldnamehere,start,length
</td>
<td>
Takes a part of a string from <code>start</code>, returns the specified number of characters (<code>length</code>). <code>start</code> and <code>length</code> must be valid integers.
</td>
</tr>
<tr>
<td>
@LEFT=sourcefieldnamehere,length
</td>
<td>
Returns the <code>length</code> number of characters from the start of a text string.
</td>
</tr>
<tr>
<tr>
<td>
@RIGHT=sourcefieldnamehere,length
</td>
<td>
Returns the <code>length</code> number of characters from the end of a text string.
</td>
</tr>
<tr>
<td>
@CONCAT=field1, field2, field3,...
</td>
<td>
Concatenates other <b>text</b> fields into one field. The fields must be valid field names. The list can contain any amount of fields.
</td>
</tr>
<tr>
<td>
@REPLACE=sourceDataField, SearchTextField, ReplaceByTextField
</td>
<td>
Searches in the <b>sourceDataField</b> for a specified value defined in <b>SearchTextField</b> and returns a new string where <strong>all</strong> the specified values in <b>ReplaceByTextField</b> are replaced. All parameters are field names.The fields must be valid field names.
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</body>
</html>