|
0
|
1 <html>
|
|
|
2 <head>
|
|
|
3 <title>MayaChemTools:Documentation:TextFilesToHTML.pl</title>
|
|
|
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
|
|
|
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
|
|
|
6 </head>
|
|
|
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
|
|
|
8 <br/>
|
|
|
9 <center>
|
|
|
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
|
|
|
11 </center>
|
|
|
12 <br/>
|
|
|
13 <div class="DocNav">
|
|
|
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
|
|
|
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./SplitTextFiles.html" title="SplitTextFiles.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./TextFilesToSDFiles.html" title="TextFilesToSDFiles.html">Next</a></td><td width="34%" align="middle"><strong>TextFilesToHTML.pl</strong></td><td width="33%" align="right"><a href="././code/TextFilesToHTML.html" title="View source code">Code</a> | <a href="./../pdf/TextFilesToHTML.pdf" title="PDF US Letter Size">PDF</a> | <a href="./../pdfgreen/TextFilesToHTML.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a> | <a href="./../pdfa4/TextFilesToHTML.pdf" title="PDF A4 Size">PDFA4</a> | <a href="./../pdfa4green/TextFilesToHTML.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
|
|
|
16 </table>
|
|
|
17 </div>
|
|
|
18 <p>
|
|
|
19 </p>
|
|
|
20 <h2>NAME</h2>
|
|
|
21 <p>TextFilesToHTML.pl - Generate HTML table file(s) from TextFile(s)</p>
|
|
|
22 <p>
|
|
|
23 </p>
|
|
|
24 <h2>SYNOPSIS</h2>
|
|
|
25 <p>TextFilesToHTML.pl ... TextFile(s)...</p>
|
|
|
26 <p>TextFilesToHTML.pl [<strong>-a, --align</strong> left | center | right,[top | middle | bottom]] [<strong>-b, --border</strong> borderwidth] [<strong>--cellpadding</strong> padding]
|
|
|
27 [<strong>--cellspacing</strong> spacing] [<strong>--footer</strong> string] [<strong>-d, --displaylinks</strong> top | bottom | both]
|
|
|
28 [<strong>--displaylinksinfo</strong> line | table | both] [<strong>-h, --help</strong>]
|
|
|
29 [<strong>--headeralign</strong> left | center | right,[top | middle | bottom]] [<strong>--headercolor</strong> "#RRGGBB"]
|
|
|
30 [<strong>--highlight</strong> "fieldlabel,datatype,criterion,value,[fieldlabel,datatype,criterion,value,]..."]
|
|
|
31 [<strong>--highlightby</strong> colnum | collabel] [<strong>--highlightcolor</strong> "#RRGGBB,#RRGGBB"]
|
|
|
32 [<strong>--highlightstyle</strong> text | background] [<strong>--indelim</strong> comma | semicolon] [<strong>-m, --mode</strong> plain | shade | highlight | shadedhighlight]
|
|
|
33 [<strong>-n, --numrows</strong> number] [<strong>-o, --overwrite</strong>] [<strong>-r, --root</strong> rootname]
|
|
|
34 [<strong>--stylesheet</strong> old | new | none] [<strong>--stylesheetname</strong> filename] [<strong> --shadecolor</strong> "#RRGGBB,#RRGGBB"]
|
|
|
35 [<strong>-t, --title</strong> string] [<strong>--titledisplay</strong> yes | no] [<strong>-w, --workingdir</strong> dirname] TextFile(s)...</p>
|
|
|
36 <p>
|
|
|
37 </p>
|
|
|
38 <h2>DESCRIPTION</h2>
|
|
|
39 <p>Generate HTML file(s) from <em>TextFile(s)</em>. The HTML file(s) contain data tables and appropriate
|
|
|
40 navigational links to view other tables. These files can be generated for local viewing or
|
|
|
41 deployment on a web server. A variety of options are provided to control style and
|
|
|
42 appearence of tables.</p>
|
|
|
43 <p>Multiple <em>TextFile(s)</em> names are separated by spaces. The valid file extensions are <em>.csv</em> and
|
|
|
44 <em>.tsv</em> for comma/semicolon and tab delimited text files respectively. All other file names
|
|
|
45 are ignored. All the text files in a current directory can be specified by <em>*.csv</em>,
|
|
|
46 <em>*.tsv</em>, or the current directory name. The <strong>--indelim</strong> option determines the
|
|
|
47 format of <em>TextFile(s)</em>. Any file which doesn't correspond to the format indicated
|
|
|
48 by <strong>--indelim</strong> option is ignored.</p>
|
|
|
49 <p>
|
|
|
50 </p>
|
|
|
51 <h2>OPTIONS</h2>
|
|
|
52 <dl>
|
|
|
53 <dt><strong><strong>-a, --align</strong> <em>left | center | right,[top | middle | bottom]</em></strong></dt>
|
|
|
54 <dd>
|
|
|
55 <p>Horizontal and vertical alignment for table rows except for header row which is specified
|
|
|
56 using <strong>--headeralign</strong> option. Possible horizontal alignment values: <em>left, center, or right</em>.
|
|
|
57 Possible vertical alignment values: <em>top, middle, or bottom</em>.</p>
|
|
|
58 <p>Default values: <em>left,middle</em></p>
|
|
|
59 </dd>
|
|
|
60 <dt><strong><strong>-b, --border</strong> <em>borderwidth</em></strong></dt>
|
|
|
61 <dd>
|
|
|
62 <p>Table border width. Default value: 1 for <em>plain</em> and <em>highlight</em> mode; 0 for <em>shade</em>
|
|
|
63 and <em>shadedhightlight</em> mode. Zero indicates no border.</p>
|
|
|
64 </dd>
|
|
|
65 <dt><strong><strong>--cellpadding</strong> <em>padding</em></strong></dt>
|
|
|
66 <dd>
|
|
|
67 <p>Table cell padding. Default value: <em>2</em>.</p>
|
|
|
68 </dd>
|
|
|
69 <dt><strong><strong>--cellspacing</strong> <em>spacing</em></strong></dt>
|
|
|
70 <dd>
|
|
|
71 <p>Table cell spacing. Default value: <em>1</em>.</p>
|
|
|
72 </dd>
|
|
|
73 <dt><strong><strong>--footer</strong> <em>string</em></strong></dt>
|
|
|
74 <dd>
|
|
|
75 <p>Text string to be included at bottom of each HTML file. Default: none.</p>
|
|
|
76 </dd>
|
|
|
77 <dt><strong><strong>-d, --displaylinks</strong> <em>top | bottom | both</em></strong></dt>
|
|
|
78 <dd>
|
|
|
79 <p>Specify where to display navigation links in each HTML file for accessing all other HTML
|
|
|
80 files. Possible values: <em>top, bottom, or both</em>. Default value: <em>both</em>. This option is
|
|
|
81 only valid during multiple HTML files generation for an input file.</p>
|
|
|
82 </dd>
|
|
|
83 <dt><strong><strong>--displaylinksinfo</strong> <em>line | table | both</em></strong></dt>
|
|
|
84 <dd>
|
|
|
85 <p>Control display of additional information along with navigational links: Showing line
|
|
|
86 n of m is displyed for line and showing table n of m for table. Possible values: <em>line
|
|
|
87 | table | both</em>. Default: <em>both</em>. This option is only valid during multiple HTML files generation.</p>
|
|
|
88 </dd>
|
|
|
89 <dt><strong><strong>-h, --help</strong></strong></dt>
|
|
|
90 <dd>
|
|
|
91 <p>Print this help message</p>
|
|
|
92 </dd>
|
|
|
93 <dt><strong><strong>--headeralign</strong> <em>left | center | right,[top | middle | bottom]</em></strong></dt>
|
|
|
94 <dd>
|
|
|
95 <p>Horizontal and vertical alignment for table header rows. Possible horizontal alignment
|
|
|
96 values: <em>left, center, or right</em>. Possible vertical alignment values: <em>top, middle, or bottom</em>.</p>
|
|
|
97 <p>Default values: <em>center,middle</em></p>
|
|
|
98 </dd>
|
|
|
99 <dt><strong><strong>--headercolor</strong> <em>"#RRGGBB"</em></strong></dt>
|
|
|
100 <dd>
|
|
|
101 <p>Color used to fill background of table header row containing column labels
|
|
|
102 represented as a hexadecimal string. None for <strong>-m, --mode</strong> option value
|
|
|
103 of <em>plain</em> and <em>#ccccff</em>, light blue, for others.</p>
|
|
|
104 </dd>
|
|
|
105 <dt><strong><strong>--highlight</strong> <em>"fieldlabel,datatype,criterion,value,[fieldlabel,datatype,criterion,value,]..."</em></strong></dt>
|
|
|
106 <dd>
|
|
|
107 <p>This value is mode specific. It specifies how to highlight various column values
|
|
|
108 for each text file. Same set of quartets values are applied to all <em>TextFile(s)</em>.</p>
|
|
|
109 <p>For <em>highlightbycolnum</em> mode, input text format contains these quartets:
|
|
|
110 <em>colnum,datatype,criterion,value,...</em>. Possible datatype values: <em>numeric or text</em>.
|
|
|
111 Possible criterion values: <em>le, ge, or eq</em>. Examples: "1,numeric,le,450>" or
|
|
|
112 "2,numeric,ge,150,6,numeric,le,10".</p>
|
|
|
113 <p>For <em>highlightbycollabel</em> mode, input text format contains these quartets:
|
|
|
114 <em>collabel,datatype,criterion,value,...</em>.</p>
|
|
|
115 </dd>
|
|
|
116 <dt><strong><strong>--highlightby</strong> <em>colnum | collabel</em></strong></dt>
|
|
|
117 <dd>
|
|
|
118 <p>This value is mode specific. It indicates how columns to be highlighted are specified
|
|
|
119 using <strong>--hightlight</strong> option. Possible values: <em>colnum or collabel</em>. Default value: <em>colnum</em>.</p>
|
|
|
120 </dd>
|
|
|
121 <dt><strong><strong>--highlightcolor</strong> <em>"#RRGGBB,#RRGGBB"</em></strong></dt>
|
|
|
122 <dd>
|
|
|
123 <p>Colors used to highlight column values during <em>highlight</em> and <em>shadedhightlight</em>
|
|
|
124 mode represented as hexadecimal strings.</p>
|
|
|
125 <p>For <strong>--highlighstyle</strong> option values of <em>text</em> and <em>background</em>, these colors represent
|
|
|
126 text or background colors respectively. For a specific column, first color string is used for
|
|
|
127 values which meet criterion indicated by <strong>--highlight</strong> option; the second color is used
|
|
|
128 for rest of the values.</p>
|
|
|
129 <p>Default values for <em>background</em> <strong>--highlightstyle</strong>: <em>#0fff0f,#ff0f0f</em>. And default values for
|
|
|
130 <em>text</em> <strong>--highlightstyle</strong>: <em>#0fbb0f,#ff0f0f</em>. Hexadecimal strings for both <strong>--highlightstyle</strong>
|
|
|
131 colors correspond to <em>reddish</em> and <em>greenish</em>.</p>
|
|
|
132 </dd>
|
|
|
133 <dt><strong><strong>--highlightstyle</strong> <em>text | background</em></strong></dt>
|
|
|
134 <dd>
|
|
|
135 <p>This value is mode specific. It indicates highlight style used to differentiate column
|
|
|
136 values which pass a specified criterion from others. Possible values: <em>text or
|
|
|
137 background</em>. Default: <em>background</em>.</p>
|
|
|
138 </dd>
|
|
|
139 <dt><strong><strong>--indelim</strong> <em>comma | semicolon</em></strong></dt>
|
|
|
140 <dd>
|
|
|
141 <p>Input delimiter for CSV <em>TextFile(s)</em>. Possible values: <em>comma or semicolon</em>.
|
|
|
142 Default value: <em>comma</em>. For TSV files, this option is ignored and <em>tab</em> is used as a
|
|
|
143 delimiter.</p>
|
|
|
144 </dd>
|
|
|
145 <dt><strong><strong>-m, --mode</strong> <em>plain | shade | highlight | shadedhighlight</em></strong></dt>
|
|
|
146 <dd>
|
|
|
147 <p>Specify how to generate HTML table(s): plain tables with line borders, background of
|
|
|
148 alternate rows filled with a specified color, column values hightlighted using a specified
|
|
|
149 criteria, or combination of previous two styles.</p>
|
|
|
150 <p>Possible values: <em>plain, shade, highlight, or shadedhighlight</em>. Default: <em>shade</em>.</p>
|
|
|
151 </dd>
|
|
|
152 <dt><strong><strong>-n, --numrows</strong> <em>number</em></strong></dt>
|
|
|
153 <dd>
|
|
|
154 <p>Maximum number of rows per table. Default value: <em>100</em>. Use 0 to put all rows into
|
|
|
155 one table. For <em>TextFile(s)</em> with more than maximum number of specified rows,
|
|
|
156 multiple HTML tables, with appropriate navigation links, are created.</p>
|
|
|
157 </dd>
|
|
|
158 <dt><strong><strong>-o, --overwrite</strong></strong></dt>
|
|
|
159 <dd>
|
|
|
160 <p>Overwrite existing files.</p>
|
|
|
161 </dd>
|
|
|
162 <dt><strong><strong>-r, --root</strong> <em>rootname</em></strong></dt>
|
|
|
163 <dd>
|
|
|
164 <p>New file or directory name is generated using the root: <root>.html or <root>-html.
|
|
|
165 Default new file name: <InitialTextFileName>.html. Default directory name:
|
|
|
166 <InitialTextFileName>-html.</p>
|
|
|
167 <p>For <em>TextFile(s)</em> with more than maximum number of rows specified per table,
|
|
|
168 this directory tree is generated using <Name> where <Name> corresponds to <root>
|
|
|
169 or <InitialTextFileName>:Top dir - <Name>-html; Sub dirs - html and mols. <Top dir> contains
|
|
|
170 <Name>.html and <Name>.css files and <sub dir> html conatins various
|
|
|
171 <Name>Lines<Start>To<End>.html files; <sub dir> mols is created as needed and contains</p>
|
|
|
172 <p>This option is ignored for multiple input files.</p>
|
|
|
173 </dd>
|
|
|
174 <dt><strong><strong>--stylesheet</strong> <em>old | new | none</em></strong></dt>
|
|
|
175 <dd>
|
|
|
176 <p>Controls usage of stylesheet for newly generated HTML file(s). Possible values: <em>old,
|
|
|
177 new, or none</em>. Default value: <em>new</em>.</p>
|
|
|
178 <p>Stylesheet file contains various properties which control apperance of HTML pages:
|
|
|
179 type, size, and color of fonts; background color; and so on.</p>
|
|
|
180 <p>For <em>old</em> value, an existing stylesheet file specified by <strong>--stylesheetname</strong> option is
|
|
|
181 used for each HTML file; no new stylesheet file is created. This option is quite handy
|
|
|
182 for deploying HTML file(s) on a web server: assuming you specify a valid stylesheet
|
|
|
183 file location relative to your WWWRoot, a reference to this stylesheet is added to each
|
|
|
184 HTML file. For local deployment of HTML file(s), a complete path to a local stylesheet
|
|
|
185 is fine as well.</p>
|
|
|
186 <p>For <em>create</em> value, a new stylesheet is created and reference to this local stylesheet
|
|
|
187 is added to each HTML file. Use option <strong>--stylesheetname</strong> to specify name.</p>
|
|
|
188 <p>For <em>none</em> value, stylesheet usage is completely ignored.</p>
|
|
|
189 </dd>
|
|
|
190 <dt><strong><strong>--stylesheetname</strong> <em>filename</em></strong></dt>
|
|
|
191 <dd>
|
|
|
192 <p>Stylesheet file name to be used in conjunction with <strong>-s --stylesheet</strong> option. It is only
|
|
|
193 valid for <em>old</em> value of <strong>-s --stylesheet</strong> option. Specify a valid stylesheet file location
|
|
|
194 relative to your WWWRoot and a reference to this stylesheet is added to each HTML
|
|
|
195 file. Example: "/stylesheets/MyStyleSheet.css". Or a complete path name to a local
|
|
|
196 stylesheet file.</p>
|
|
|
197 <p>For <em>create</em> value of <strong>-s --stylesheet</strong> option, a new stylesheet file is created using
|
|
|
198 <strong>-r --root</strong> option. And value of <strong>--stylesheetname</strong> is simply ignored.</p>
|
|
|
199 </dd>
|
|
|
200 <dt><strong><strong> --shadecolor</strong> <em>"#RRGGBB,#RRGGBB"</em></strong></dt>
|
|
|
201 <dd>
|
|
|
202 <p>Colors used to fill background of rows during <em>shade</em> and <em>shadedhightlight</em> mode
|
|
|
203 represented as a pair of hexadecimal string; the first and second color values
|
|
|
204 are used for odd and even number rows respectively.</p>
|
|
|
205 <p>Default value: <em>"#ffffff,#e0e9eb"</em> - it's white and very light blue for odd and even number rows.</p>
|
|
|
206 </dd>
|
|
|
207 <dt><strong><strong>-t, --title</strong> <em>string</em></strong></dt>
|
|
|
208 <dd>
|
|
|
209 <p>Title for HTML table(s). Default value: <TextFileName>. For multiple input files,
|
|
|
210 <strong>-r --root</strong> option is used to generate appropriate titles.</p>
|
|
|
211 </dd>
|
|
|
212 <dt><strong><strong>--titledisplay</strong> <em>yes | no</em></strong></dt>
|
|
|
213 <dd>
|
|
|
214 <p>Display title for HTML table(s). Possible values: <em>yes or no</em>. Default value: <em>yes</em>.</p>
|
|
|
215 </dd>
|
|
|
216 <dt><strong><strong>-w, --workingdir</strong> <em>dirname</em></strong></dt>
|
|
|
217 <dd>
|
|
|
218 <p>Location of working directory. Default: current directory.</p>
|
|
|
219 </dd>
|
|
|
220 </dl>
|
|
|
221 <p>
|
|
|
222 </p>
|
|
|
223 <h2>EXAMPLES</h2>
|
|
|
224 <p>To generate HTML tables with rows background filled with white and greyish colors and
|
|
|
225 navigation links on top and botton of each page, type:</p>
|
|
|
226 <div class="ExampleBox">
|
|
|
227 % TextFilesToHTML.pl -o Sample1.csv</div>
|
|
|
228 <p>To generate HTML tables with rows background filled with golden and greyish colors,
|
|
|
229 navigation links on top and botton of each page, 10 rows in each table, greyish header
|
|
|
230 row color, and cell spacing of 1, type:</p>
|
|
|
231 <div class="ExampleBox">
|
|
|
232 % TextFilesToHTML.pl -o -n 10 --headeralign "center" --headercolor
|
|
|
233 "#a1a1a1" --shadecolor "#ddd700,#d1d1d1" --cellspacing 1
|
|
|
234 Sample1.csv</div>
|
|
|
235 <p>To generate plain HTML tables with 10 rows in each table and navigation links only at
|
|
|
236 the bottom, type:</p>
|
|
|
237 <div class="ExampleBox">
|
|
|
238 % TextFilesToHTML.pl -o -n 10 --displaylinks bottom -m plain
|
|
|
239 Sample1.csv</div>
|
|
|
240 <p>To highlight values in column 3 using specified highlight criteria and fill in default background
|
|
|
241 colors, type:</p>
|
|
|
242 <div class="ExampleBox">
|
|
|
243 % TextFilesToHTML.pl -n 10 --highlight "3,numeric,le,450"
|
|
|
244 --highlightby colnum --highlightstyle background -m
|
|
|
245 shadedhighlight -o Sample1.csv</div>
|
|
|
246 <p>To highlight values in column MolWeight using specified highlight criteria, color the text using
|
|
|
247 default colors, and add a footer message in every page, type:</p>
|
|
|
248 <div class="ExampleBox">
|
|
|
249 % TextFilesToHTML.pl -n 4 --highlight "MolWeight,numeric,le,500"
|
|
|
250 --highlightby collabel --highlightstyle text -m shadedhighlight -o
|
|
|
251 --footer "Copyright (C) MayaChemTools" --cellspacing 1 Sample1.csv</div>
|
|
|
252 <p>
|
|
|
253 </p>
|
|
|
254 <h2>AUTHOR</h2>
|
|
|
255 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
|
|
|
256 <p>
|
|
|
257 </p>
|
|
|
258 <h2>SEE ALSO</h2>
|
|
|
259 <p><a href="./JoinTextFiles.html">JoinTextFiles.pl</a>, <a href="./MergeTextFilesWithSD.html">MergeTextFilesWithSD.pl</a>, <a href="./ModifyTextFilesFormat.html">ModifyTextFilesFormat.pl</a>, <a href="./SplitTextFiles.html">SplitTextFiles.pl</a>, <a href="./SortTextFiles.html">SortTextFiles.pl</a>
|
|
|
260 </p>
|
|
|
261 <p>
|
|
|
262 </p>
|
|
|
263 <h2>COPYRIGHT</h2>
|
|
|
264 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
|
|
|
265 <p>This file is part of MayaChemTools.</p>
|
|
|
266 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
|
|
|
267 the terms of the GNU Lesser General Public License as published by the Free
|
|
|
268 Software Foundation; either version 3 of the License, or (at your option)
|
|
|
269 any later version.</p>
|
|
|
270 <p> </p><p> </p><div class="DocNav">
|
|
|
271 <table width="100%" border=0 cellpadding=0 cellspacing=2>
|
|
|
272 <tr align="left" valign="top"><td width="33%" align="left"><a href="./SplitTextFiles.html" title="SplitTextFiles.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./TextFilesToSDFiles.html" title="TextFilesToSDFiles.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>TextFilesToHTML.pl</strong></td></tr>
|
|
|
273 </table>
|
|
|
274 </div>
|
|
|
275 <br />
|
|
|
276 <center>
|
|
|
277 <img src="../../images/h2o2.png">
|
|
|
278 </center>
|
|
|
279 </body>
|
|
|
280 </html>
|
