Skip to content
This repository was archived by the owner on Feb 19, 2025. It is now read-only.

Commit b5ea899

Browse files
committed
Update howto.html
1 parent 4620840 commit b5ea899

File tree

1 file changed

+103
-99
lines changed

1 file changed

+103
-99
lines changed

howto.html

Lines changed: 103 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,109 @@
11
<!DOCTYPE html>
22
<html>
3-
<head>
4-
<title>StringUtils howto guide.</title>
5-
<meta charset="UTF-8">
6-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7-
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"
8-
integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
9-
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css"
10-
integrity="sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp" crossorigin="anonymous">
11-
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"
3+
<head>
4+
<title>StringUtils howto guide</title>
5+
<meta charset="UTF-8">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<script src="https://code.jquery.com/jquery-1.9.1.min.js"
8+
integrity="sha256-wS9gmOZBqsqWxgIVgA8Y9WcQOa7PgSIX+rPA0VL2rbQ="
9+
crossorigin="anonymous"></script>
10+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"
11+
integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
12+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css"
13+
integrity="sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp" crossorigin="anonymous">
14+
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"
1215
integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa"
1316
crossorigin="anonymous"></script>
14-
</head>
15-
<body>
16-
<div class="container">
17-
<h1><span class="glyphicon glyphicon-info-sign"></span> How to use the StringUtils hook:</h1>
18-
<div class="panel panel-info">
19-
<div class="alert alert-info">
20-
What is it for?
21-
</div>
22-
<div class="panel-body">
23-
<ul>
24-
<li>This plugin allows you to manipulate text fields using hooks.</li>
25-
</ul>
26-
</div>
27-
</div>
28-
<div>
29-
<div class="alert alert-warning">
30-
Limitations
31-
</div>
32-
<div class="panel-body">
33-
<ul>
34-
<li>The hook field MUST be on the same instrument as the source field.</li>
35-
</ul>
36-
</div>
37-
</div>
38-
<div class="panel panel-success">
39-
<div class="panel-heading">
40-
Using the hook
41-
</div>
42-
<div class="panel-body">
43-
Create a field with one of the following hooks:
44-
<table class="table">
45-
<thead>
46-
<tr>
47-
<td>Hook</td>
48-
<td>Usage</td>
49-
</tr>
50-
</thead>
51-
<tbody>
52-
<tr>
53-
<td>
54-
@TOLOWER={sourcefieldnamehere}
55-
</td>
56-
<td>
57-
Converts the field in to its lowercase equivalent.
58-
</td>
59-
</tr>
60-
<tr>
61-
<td>
62-
@TOUPPER={sourcefieldnamehere}
63-
</td>
64-
<td>
65-
Converts the field in to its uppercase equivalent.
66-
</td>
67-
</tr>
68-
<tr>
69-
<td>
70-
@STRLEN={sourcefieldnamehere}
71-
</td>
72-
<td>
73-
Calculated the length of a field.
74-
</td>
75-
</tr>
76-
<tr>
77-
<td>
78-
@TRIM={sourcefieldnamehere}
79-
</td>
80-
<td>
81-
Trims the text of a field of whitespaces.
82-
</td>
83-
</tr>
84-
<tr>
85-
<td>
86-
@LTRIM={sourcefieldnamehere}
87-
</td>
88-
<td>
89-
Trims the left side of text of a field of whitespaces.
90-
</td>
91-
</tr>
92-
<tr>
93-
<td>
94-
@SUBSTR={sourcefieldnamehere1},start,end
95-
</td>
96-
<td>
97-
Takes a part of a string from start to end. Start and end must be valid integers.
98-
</td>
99-
</tr>
100-
</tbody>
101-
</table>
17+
</head>
18+
<body>
19+
<div class="container">
20+
<h1><span class="glyphicon glyphicon-info-sign"></span> How to use the StringUtils external module</h1>
21+
<div class="panel panel-info">
22+
<div class="panel-heading">
23+
What is it for?
24+
</div>
25+
<div class="panel-body">
26+
This plugin allows you to manipulate text fields using action tags.
27+
</div>
28+
</div>
29+
<div class="panel panel-warning">
30+
<div class="panel-heading">
31+
Limitations
32+
</div>
33+
<div class="panel-body">
34+
<ul>
35+
<li>The field using the StringUtils action tag MUST be on the same instrument as the source field.</li>
36+
<li>A field containing the result of a StringUtils function CANNOT be used as a source field.</li>
37+
<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>
38+
</ul>
39+
</div>
40+
</div>
41+
<div class="panel panel-success">
42+
<div class="panel-heading">
43+
Using the external module
44+
</div>
45+
<div class="panel-body">
46+
Create a field with one of the following action tags:
47+
<table class="table">
48+
<thead>
49+
<tr>
50+
<th>Action tag</th>
51+
<th>Usage</th>
52+
</tr>
53+
</thead>
54+
<tbody>
55+
<tr>
56+
<td>
57+
@TOLOWER=sourcefieldnamehere
58+
</td>
59+
<td>
60+
Converts the field into its lowercase equivalent.
61+
</td>
62+
</tr>
63+
<tr>
64+
<td>
65+
@TOUPPER=sourcefieldnamehere
66+
</td>
67+
<td>
68+
Converts the field into its uppercase equivalent.
69+
</td>
70+
</tr>
71+
<tr>
72+
<td>
73+
@STRLEN=sourcefieldnamehere
74+
</td>
75+
<td>
76+
Calculates the length of a field.
77+
</td>
78+
</tr>
79+
<tr>
80+
<td>
81+
@TRIM=sourcefieldnamehere
82+
</td>
83+
<td>
84+
Trims the text of a field of whitespaces.
85+
</td>
86+
</tr>
87+
<tr>
88+
<td>
89+
@LTRIM=sourcefieldnamehere
90+
</td>
91+
<td>
92+
Trims the left side of text of a field of whitespaces.
93+
</td>
94+
</tr>
95+
<tr>
96+
<td>
97+
@SUBSTR=sourcefieldnamehere,start,length
98+
</td>
99+
<td>
100+
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.
101+
</td>
102+
</tr>
103+
</tbody>
104+
</table>
105+
</div>
106+
</div>
102107
</div>
103-
</div>
104-
</body>
108+
</body>
105109
</html>

0 commit comments

Comments
 (0)