|
1
|
1 NAME
|
|
|
2 HTMLUtil
|
|
|
3
|
|
|
4 SYNOPSIS
|
|
|
5 use HTMLUtil;
|
|
|
6
|
|
|
7 use HTMLUtil qw(:all);
|
|
|
8
|
|
|
9 DESCRIPTION
|
|
|
10 HTMLUtil module provides the following functions:
|
|
|
11
|
|
|
12 InsertHTMLTags, SetupHTMLAlignmentBegin, SetupHTMLAlignmentEnd,
|
|
|
13 SetupHTMLButtonRef, SetupHTMLDivBegin, SetupHTMLDivEnd,
|
|
|
14 SetupHTMLEmptyLines, SetupHTMLHRef, SetupHTMLPageEnd,
|
|
|
15 SetupHTMLPageHeader, SetupHTMLPageTitle, SetupHTMLStyleSheetTags,
|
|
|
16 SetupHTMLTableColumnEnd, SetupHTMLTableColumnHeader, SetupHTMLTableEnd,
|
|
|
17 SetupHTMLTableHeader, SetupHTMLTableRowDataValue, SetupHTMLTableRowEnd,
|
|
|
18 SetupHTMLTableRowHeader, SetupHTMLTableRowHeaderValue,
|
|
|
19 SetupJavaScriptCmds, SetupStrViewerAccelrysActiveX,
|
|
|
20 SetupStrViewerChem3DActiveX, SetupStrViewerChemDrawActiveX,
|
|
|
21 SetupStrViewerChemDrawPlugIn, SetupStrViewerChimePlugIn,
|
|
|
22 SetupStrViewerJMEApplet, SetupStrViewerJSInitCmd,
|
|
|
23 SetupStrViewerJmolApplet, SetupStrViewerMarvinViewApplet
|
|
|
24
|
|
|
25 FUNCTIONS
|
|
|
26 InsertHTMLTags
|
|
|
27 $NewTag = InsertHTMLTags($Tag, @TagsNameValue);
|
|
|
28
|
|
|
29 Inserts tag name and value pair from *TagsNameValue* into a
|
|
|
30 exisiting *Tag* as *TagName = "TagValue"* and returns NewTag string.
|
|
|
31
|
|
|
32 SetupHTMLAlignmentBegin
|
|
|
33 $AlignmentTag = SetupHTMLAlignmentBegin([$Alignment]);
|
|
|
34
|
|
|
35 Returns an alignment begin tag string. Possible *Alignment* values:
|
|
|
36 *left, center, or right*. Default: *left*.
|
|
|
37
|
|
|
38 SetupHTMLAlignmentEnd
|
|
|
39 $AlignmentTag = SetupHTMLAlignmentBegin([$Alignment]);
|
|
|
40
|
|
|
41 Returns an alignment end tag string.
|
|
|
42
|
|
|
43 SetupHTMLButtonRef
|
|
|
44 $ButtonTag = SetupHTMLButtonRef($ButtonLabel, $FileName);
|
|
|
45
|
|
|
46 Returns a button tag string for associating onClick button event of
|
|
|
47 a button with label *ButtonLabel* to open a file *FileName*.
|
|
|
48
|
|
|
49 SetupHTMLDivBegin
|
|
|
50 $DivTag = SetupHTMLDivBegin($ID);
|
|
|
51
|
|
|
52 Returns a div begin tag string for div *ID*.
|
|
|
53
|
|
|
54 SetupHTMLDivEnd
|
|
|
55 $DivTag = SetupHTMLDivEnd();
|
|
|
56
|
|
|
57 Returns a div end tag string.
|
|
|
58
|
|
|
59 SetupHTMLTableEnd
|
|
|
60 $TableEndTag = SetupHTMLTableEnd();
|
|
|
61
|
|
|
62 Returns a table end tag string.
|
|
|
63
|
|
|
64 SetupHTMLEmptyLines
|
|
|
65 $EmptyLineTags = SetupHTMLEmptyLines([$LineCount]);
|
|
|
66
|
|
|
67 Returns an empty lines tag string for empty *LineCount*. Default
|
|
|
68 line count: *1*.
|
|
|
69
|
|
|
70 SetupHTMLPageHeader
|
|
|
71 $PageHeaderTag = SetupHTMLPageHeader($HeaderTitle, [$Stylesheet,
|
|
|
72 $JavaScript]);
|
|
|
73
|
|
|
74 Returns a page header tag string using *HeaderTitle* and using
|
|
|
75 optionally specifed values for *Stylesheet* and *JavaScript*.
|
|
|
76
|
|
|
77 SetupHTMLHRef
|
|
|
78 $HRef = SetupHTMLHRef($Label, $URL, [$Title]);
|
|
|
79
|
|
|
80 Returns a HRef tag string for setting up a URL with *Label* and
|
|
|
81 *URL* with optional *Title*.
|
|
|
82
|
|
|
83 SetupHTMLPageEnd
|
|
|
84 $PageEndTag = SetupHTMLPageEnd([$FooterMsg]);
|
|
|
85
|
|
|
86 Returns a page end tag string conating optional *FooterMsg*.
|
|
|
87
|
|
|
88 SetupHTMLPageTitle
|
|
|
89 $PageTitleTag = SetupHTMLPageTitle($Title, [$Alignment]);
|
|
|
90
|
|
|
91 Returns a page title tag string with optional alignment. Valid
|
|
|
92 alignment value: *left, center, right* Default alignment: *center*.
|
|
|
93
|
|
|
94 SetupHTMLStyleSheetTags
|
|
|
95 $StyleSheetTags = SetupHTMLStyleSheetTags();
|
|
|
96
|
|
|
97 Returns a default style sheet tag string to be used for HTML files
|
|
|
98 generated by MayaChemTools.
|
|
|
99
|
|
|
100 SetupHTMLTableHeader
|
|
|
101 $TableHeaderTags = SetupHTMLTableHeader([$BorderWidth,
|
|
|
102 $CellPadding, $CellSpacing, $Width, $Height]);
|
|
|
103
|
|
|
104 Returns a table header tag string containing specified values for
|
|
|
105 *BorderWidth, CellPadding, CellSpacing, Width, and Height*. Default
|
|
|
106 values: *BorderWidth = 1; CellPadding = 2; CellSpacing = 0; Width =
|
|
|
107 NotUsed; Height = NotUsed*.
|
|
|
108
|
|
|
109 <SetupHTMLTableEnd>
|
|
|
110 $TableEndTag = SetupHTMLTableEnd();
|
|
|
111
|
|
|
112 Returns a table end tag string.
|
|
|
113
|
|
|
114 SetupHTMLTableColumnHeader
|
|
|
115 $ColumnHeaderTag = SetupHTMLTableColumnHeader([$BgColor, $Width]);
|
|
|
116
|
|
|
117 Returns a table column header tag string containing specified values
|
|
|
118 for *BgColor, Width*. Default values: *BgColor = NotUsed; Width =
|
|
|
119 NotUsed*.
|
|
|
120
|
|
|
121 SetupHTMLTableColumnEnd
|
|
|
122 $ColumnEndTag = SetupHTMLTableColumnEnd();
|
|
|
123
|
|
|
124 Returns a table column end tag string.
|
|
|
125
|
|
|
126 SetupHTMLTableRowHeader
|
|
|
127 $RowHeaderTag = SetupHTMLTableRowHeader([$HAlignment, $BgColor,
|
|
|
128 $VAlignment]);
|
|
|
129
|
|
|
130 Returns a table row header tag string containing specified values
|
|
|
131 for *HAlignment, BgColor, and VAlignment*. Default values:
|
|
|
132 *HAlignment = center; $BgColor = NotUsed; $VAlignment = top*.
|
|
|
133
|
|
|
134 SetupHTMLTableRowEnd
|
|
|
135 $RowEndTag = SetupHTMLTableRowEnd();
|
|
|
136
|
|
|
137 Returns a table row end tag string.
|
|
|
138
|
|
|
139 SetupHTMLTableRowHeaderValue
|
|
|
140 $HeaderValueTag = SetupHTMLTableRowHeaderValue([$Value]);
|
|
|
141
|
|
|
142 Returns a table header row tag string using specifed *Value*.
|
|
|
143 Default value: *EmptySpace*.
|
|
|
144
|
|
|
145 SetupHTMLTableRowDataValue
|
|
|
146 $RowValueTag = SetupHTMLTableRowDataValue([$Value, $BgColor,
|
|
|
147 $FontColor, $FontBold]);
|
|
|
148
|
|
|
149 Returns a table row column value tag string using specified values
|
|
|
150 for *Value, BgColor, FontColor, and FontBold*. Default values:
|
|
|
151 *Value = EmptySpace; BgColor = NotUsed; FontColor = NotUsed;
|
|
|
152 $FontBold = NotUsed*.
|
|
|
153
|
|
|
154 SetupJavaScriptCmds
|
|
|
155 $JSTag = SetupJavaScriptCmds(@JSCmdList);
|
|
|
156
|
|
|
157 Returns a Java script tag string using java script commands
|
|
|
158 specified in *JSCmdList*.
|
|
|
159
|
|
|
160 SetupStrViewerJSInitCmd
|
|
|
161 $JSTag = SetupStrViewerJSInitCmd($StrViewerType, $CodeBase);
|
|
|
162
|
|
|
163 Returns a Java script command tag string for intializing structure
|
|
|
164 viewers with specified *CodeBase* location for viewers to be invoked
|
|
|
165 as Java Applets. Supported values for *StrViewerType*: *Jmol,
|
|
|
166 ChemDrawPlugIn, ChemDrawActiveX, Chem3DActiveX*.
|
|
|
167
|
|
|
168 SetupStrViewerJMEApplet
|
|
|
169 $JMEAppletTag = SetupStrViewerJMEApplet($MolString, $CodeBase,
|
|
|
170 [{param => "value"}]);
|
|
|
171
|
|
|
172 Returns a JME tag string for displaying molecule using *MolString*
|
|
|
173 along with valid optional applet parameters specified as name and
|
|
|
174 value pairs. Defaul JME parameter values: *name = JME; id = JME;
|
|
|
175 width = 250; height = 170*.
|
|
|
176
|
|
|
177 SetupStrViewerJmolApplet
|
|
|
178 $JmolAppletTag = SetupStrViewerJmolApplet($MolString, $CodeBase,
|
|
|
179 [{param => "value"}]);
|
|
|
180
|
|
|
181 Returns a JMol tag string for displaying molecule using *MolString*
|
|
|
182 along with valid optional applet parameters specified as name and
|
|
|
183 value pairs. Defaul JMol parameter values: *name = Jmol; id = Jmol;
|
|
|
184 width = 250; height = 170; progressbar = true; progresscolor =
|
|
|
185 0000ff; bgcolor = 000000; JMolScript = select *; set frank off;
|
|
|
186 wireframe on; spacefill off*.
|
|
|
187
|
|
|
188 SetupStrViewerMarvinViewApplet
|
|
|
189 $MarvinAppletTag = SetupStrViewerMarvinViewApplet($MolString,
|
|
|
190 $CodeBase, [{param => "value"}]);
|
|
|
191
|
|
|
192 Returns a MarvinView tag string for displaying molecule using
|
|
|
193 *MolString* along with valid optional applet parameters specified as
|
|
|
194 name and value pairs. Defaul MarvinView parameter values: *name =
|
|
|
195 MView; id = MView; width = 250; height = 170; navmode = zoom*.
|
|
|
196
|
|
|
197 SetupStrViewerChimePlugIn
|
|
|
198 $ChimePlugInTag = SetupStrViewerChimePlugIn($MolFile,
|
|
|
199 [{param => "value"}]);
|
|
|
200
|
|
|
201 Returns a MDL Chime tag string for displaying molecule using
|
|
|
202 *MolFile* along with valid optional parameters specified as name and
|
|
|
203 value pairs. Defaul Chime parameter values: *width = 250; height =
|
|
|
204 170; display2d = true*.
|
|
|
205
|
|
|
206 SetupStrViewerChem3DActiveX
|
|
|
207 $ChemDraw3DActiveXTags = SetupStrViewerChemDrawActiveX($MolFile,
|
|
|
208 [{param => "value"}]);
|
|
|
209
|
|
|
210 Returns a CambridgeSoft Chem3D tag string for displaying molecule
|
|
|
211 using *MolFile* along with valid optional parameters specified as
|
|
|
212 name and value pairs. Defaul Chime parameter values: *width = 250;
|
|
|
213 height = 170; displaytype = BallAndStick; rotationbars = false;
|
|
|
214 moviecontroller = false*.
|
|
|
215
|
|
|
216 SetupStrViewerChemDrawActiveX
|
|
|
217 $ChemDrawActiveXTags = SetupStrViewerChem3DActiveX($MolFile,
|
|
|
218 [{param => "value"}]);
|
|
|
219
|
|
|
220 Returns a CambridgeSoft ChemDraw ActiveX tag string for displaying
|
|
|
221 molecule using *MolFile* along with valid optional parameters
|
|
|
222 specified as name and value pairs. Defaul ChemDraw ActiveX parameter
|
|
|
223 values: *width = 250; height = 170; ViewOnly = 1; ShrinkToFit = 1;
|
|
|
224 ShowToolsWhenVisible = 1*.
|
|
|
225
|
|
|
226 SetupStrViewerChemDrawPlugIn
|
|
|
227 $ChemDrawPlugInTag = SetupStrViewerChemDrawPlugIn($MolFile,
|
|
|
228 [{param => "value"}]);
|
|
|
229
|
|
|
230 Returns a CambridgeSoft ChemDraw PlugIn tag string for displaying
|
|
|
231 molecule using *MolFile* along with valid optional parameters
|
|
|
232 specified as name and value pairs. Defaul ChemDraw PlugIn parameter
|
|
|
233 values: *width = 250; height = 170; ViewOnly = 1; ShrinkToFit = 1;
|
|
|
234 ShowToolsWhenVisible = 1*.
|
|
|
235
|
|
|
236 SetupStrViewerAccelrysActiveX
|
|
|
237 $AccelrysActiveXTags = SetupStrViewerAccelrysActiveX($MolFile,
|
|
|
238 [{param => "value"}]);
|
|
|
239
|
|
|
240 Returns a Accelrys ViewerActiveX tag string for displaying molecule
|
|
|
241 using *MolFile* along with valid optional parameters specified as
|
|
|
242 name and value pairs. Defaul ViewerActiveX parameter values: *width
|
|
|
243 = 250; height = 170; Convert2Dto3D = 0; Mouse = 4*.
|
|
|
244
|
|
|
245 AUTHOR
|
|
|
246 Manish Sud <msud@san.rr.com>
|
|
|
247
|
|
|
248 COPYRIGHT
|
|
|
249 Copyright (C) 2015 Manish Sud. All rights reserved.
|
|
|
250
|
|
|
251 This file is part of MayaChemTools.
|
|
|
252
|
|
|
253 MayaChemTools is free software; you can redistribute it and/or modify it
|
|
|
254 under the terms of the GNU Lesser General Public License as published by
|
|
|
255 the Free Software Foundation; either version 3 of the License, or (at
|
|
|
256 your option) any later version.
|
|
|
257
|
