-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathhelp.html
217 lines (216 loc) · 11.2 KB
/
help.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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<html>
<title>Welcome to Search Big File</title>
<link rel="icon" href="./icons/app-icon.png" type="image/icon type">
<body style="font-family: Calibri">
<a id="top"></a>
<i><font color="red"><b>Note:</b></font> For full feature working, please open help file in browser (See menu 'O' in Controls section)</i>
<center><u><h1>Welcome to Search Big File</h1></u></center>
<h2>Help Contents</h2>
<h2>Index</h2>
<ul>
<li><a href="#author">Author</a></li>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#features">Features</a></li>
<li><a href="#controls">Controls</a></li>
</ul>
<h3><a id="author">Author</a></h3>
<ul>
<li><b>Name:</b> Shailendra Verma</li>
<li><b>Email:</b> <a href="mailto:shailendravermag@gmail.com">shailendravermag@gmail.com</a></li>
<li><b>Blogs:</b> <a href="https://sv-technical.blogspot.com/">https://sv-technical.blogspot.com/</a></li>
</ul>
<h3><a id="introduction">Introduction</a></h3>
<p>This application is Java8 based. UI is designed in Swing.<br>
No third party library is used. <br><br>This program is developed to search big size files
like 400MB or even higher like 1GB.</p>
<h4>Application image</h4>
<img src="./app-images/app-image-29-sep-2021.png" width="800" height="400" title="Application image"/>
<h4>More application images (opens in new tab)</h4>
<table cellpadding="3" cellspacing="3">
<tr>
<td colspan="3"><a href="./app-images/app-image-19-oct-2021.png" target="_blank">Present stage</a></td>
</tr>
<tr>
<td><a href="./app-images/app-test-result-BR.png" target="_blank">Test result on 1GB file with Buffered
Reader</a></td>
<td><a href="./app-images/app-test-1gb-new.png" target="_blank">Test result on 1GB file improved</a></td>
<td><a href="./app-images/app-test-1gb.png" target="_blank">Test result on 1GB old</a></td>
</tr>
<tr>
<td><a href="./app-images/app-image-info.png" target="_blank">Information indicator</a></td>
<td><a href="./app-images/app-image-warn.png" target="_blank">Warning indicator</a></td>
<td><a href="./app-images/app-image-error.png" target="_blank">Error indicator</a></td>
</tr>
<tr>
<td><a href="./app-images/app-image-ac.png" target="_blank">Auto complete</a></td>
<td><a href="./app-images/app-image-no-occr.png" target="_blank">If no occurrence found</a></td>
<td><a href="./app-images/app-image-help.png" target="_blank">Help Tab</a></td>
</tr>
<tr>
<td><a href="./app-images/app-image-colored-7-oct-2021.png" target="_blank">Colored Application</a></td>
<td><a href="./app-images/app-image-fonts-menu.png" target="_blank">Font Menu</a></td>
<td><a href="./app-images/app-image-highlight-color-options.png" target="_blank">Highlight Menu</a></td>
</tr>
<tr>
<td><a href="./app-images/app-image-recent.png" target="_blank">Recent Menu</a></td>
<td><a href="./app-images/app-image-recent-filter.png" target="_blank">Filter recent values</a></td>
<td><a href="./app-images/app-image-controls-19-oct-2021.png" target="_blank">Controls menu</a></td>
</tr>
<tr>
<td colspan="3"><a href="./app-images/app-image-first-cut.png" target="_blank">First cut</a></td>
</tr>
</table>
<h3><a id="features">Features</a></h3>
<ul>
<li>Complete UI can be driven by keyboard. That means all actions has short cuts.</li>
<li>Every control has tooltip that describes more detail about it.</li>
<li>Application has proper validations.</li>
<li>Controls enable/disable as per actions.</li>
<li>Waring/Error bar will change color as per user actions.</li>
<li>"Show/Hide All" button on bar to show/hide all occurrences table</li>
<li>All occurrences table show the number of occurrences and code excerpt</li>
<li>In case of no occurrences, message is displayed</li>
<li>Application stores values last entered by the user.</li>
<li>Components and controls are categorised by title and a border.</li>
</ul>
<h3><a id="controls">Controls</a></h3>
<ul>
<li>File can be choose from:
<ul>
<li>Manually entered by user</li>
<ul>
<li>While manually typing file auto complete is available</li>
</ul>
<li>Select from "Ellipsis" (...) to browse folders</li>
<li>Select from Recent Menu</li>
<li>Select from Recent List Table (using <img src="./icons/recent-icon.png" width="12" height="12"
title="Recent icon"/>)
</li>
</ul>
</li>
<li>Checkbox "Aa" - This can be checked if search is case sensitive</li>
<li>Checkbox "W" - This can be checked if search is meant to look for whole word only</li>
<li>Search Pattern can be:
<ul>
<li>Manually entered by user</li>
<ul>
<li>While manually typing auto complete is available</li>
</ul>
<li>Select from Recent Menu</li>
<li>Select from Recent List Table (using <img src="./icons/recent-icon.png" width="12" height="12"
title="Recent icon"/>)
</li>
</ul>
</li>
<li>User can change case of search pattern text using below
<ul>
<li>Button "U" - Convert text to upper case</li>
<li>Button "L" - Convert text to lower case</li>
<li>Button "T" - Convert text to title case</li>
<li>Button "V" - Invert case of text</li>
</ul>
</li>
<li>Search Button will perform search for pattern in file. This action will display only matching lines in the
file.
</li>
<li>Label and drop down for "Last N" gives option to display last N lines (100 to 5000) from the file.</li>
<li>Read button action display last N lines.</li>
<li>Search and Read button action also highlights with <span style="background-color: #FFFF00">yellow</span>
background to search pattern that matches. More color can be chosen for selection background, selection text and
match. Sample colors will be shown in tooltip.
</li>
<li>Cancel button icon (<img src="./icons/cancel-icon.png" width="12" height="12" title="Cancel icon"/>) to stop
operation while
Search/Read going on
</li>
<ul>
<li>It will be disabled (<img src="./icons/cancel-icon-disabled.png" width="12" height="12"
title="Cancel icon disabled"/>) when unavailable
</li>
</ul>
<li>Toolbar is available with different actions
<ul>
<li>Settings menu '*' can be used for below:
this action will set highlight color immediately
<ul>
<li>To change fonts automatically for information bar by checking checkbox.</li>
<li>Change fonts manually by selecting font from submenu.</li>
<ul>
<li>Each item will be in the font style of mentioned font name</li>
<li>Selected font will be shown in the name of submenu</li>
</ul>
<li>To change highlight colors in search/read automatically by checking checkbox.</li>
<li>Change highlight color manually by selecting color from submenu.</li>
<ul>
<li>Chosen color will be applied as background of the menu</li>
<li>Highlight color will be applied in Results tab and occurrences table</li>
<li>New color will be stored as part of configuration and reapplied on restart</li>
<li>For image see <a href="#introduction">Introduction</a> section</li>
<li>Each menu item has shortcuts. And each item shows sample of:
<ul>
<li>highlight color of matches from search/result</li>
<li>selected text</li>
<li>selected background</li>
</ul>
</li>
</ul>
</ul>
</li>
<li>+ this action will increase font size by 1, maximum allowed size 28</li>
<li>- this action will decrease font size by 1, minimum allowed size 8</li>
<li>N Number indicate present font size of results area and clicking it will reset font size to 12</li>
<li>↑ this action will take result scrollbar to top</li>
<li>↓ this action will take result scrollbar to bottom</li>
<li>< this action will take to previous occurrence of search pattern</li>
<li>> this action will take to next occurrence of search pattern</li>
<li>¤ this action will search new word from Search box in existing results tab contents
- like a find functionality.
</li>
<li>× this action will transfer current results into timestamp based file.</li>
<li>ø this action will clean old export files.</li>
<li>O this action will show help in browser.</li>
<li>? this action will show help. Color of this text changes every 10 sec to different colors</li>
</ul>
</li>
<li>Exit button icon (<img src="./icons/exit-icon.png" width="12" height="12" title="Exit icon"/>) will exit from
application
</li>
<li>Information bar that represent different actions.
<ul>
<li>Font of this bar changes every 10 minutes.</li>
<li><span style="background-color: #FFFFFF; color: #0000FF">White</span> background with blue color to show
information
</li>
<li><span style="background-color: #FFA500; color: #000000">Orange</span> background with black color to
show warning
<ul>
<li>Shows warning if time in search/read is more than 10 seconds</li>
<li>Shows warning if number of occurrences of search-pattern are more than 100</li>
</ul>
</li>
<li><span style="background-color: #FF0000; color: #FFFFFF">Red</span> background with white color to show
error
<ul>
<li>Shows error and cancels operation if time in search/read is more than 50 seconds</li>
<li>Shows error and cancels operation if number of occurrences of search-pattern are more than 500
</li>
</ul>
</li>
<li>Shows font or font size change action.</li>
<li>Shows results.</li>
<li>Shows validations etc.</li>
</ul>
</li>
<li>Button "Show/Hide All" on bar can be used to show/hide all occurrences table</li>
<li>Split Pane is available for user to resize search/read results and occurrences table</li>
<li>Two tabs are present in remaining area.
<ol>
<li>Tab 1 is "Result". It has default font "Calibri". This is used to display search/read results</li>
<li>Tab 2 is "Help". This is used to display application help</li>
</ol>
</li>
</ul>
<br>
<a href="#top">Top</a>
</body>
</html>