Mercurial > repos > deepakjadmin > mayatool3_test3
comparison mayachemtools/docs/modules/html/HTMLUtil.html @ 0:73ae111cf86f draft
Uploaded
author | deepakjadmin |
---|---|
date | Wed, 20 Jan 2016 11:55:01 -0500 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:73ae111cf86f |
---|---|
1 <html> | |
2 <head> | |
3 <title>MayaChemTools:Documentation:HTMLUtil.pm</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="./Graph.html" title="Graph.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./MathUtil.html" title="MathUtil.html">Next</a></td><td width="34%" align="middle"><strong>HTMLUtil.pm</strong></td><td width="33%" align="right"><a href="././code/HTMLUtil.html" title="View source code">Code</a> | <a href="./../pdf/HTMLUtil.pdf" title="PDF US Letter Size">PDF</a> | <a href="./../pdfgreen/HTMLUtil.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a> | <a href="./../pdfa4/HTMLUtil.pdf" title="PDF A4 Size">PDFA4</a> | <a href="./../pdfa4green/HTMLUtil.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>HTMLUtil</p> | |
22 <p> | |
23 </p> | |
24 <h2>SYNOPSIS</h2> | |
25 <p>use HTMLUtil;</p> | |
26 <p>use HTMLUtil qw(:all);</p> | |
27 <p> | |
28 </p> | |
29 <h2>DESCRIPTION</h2> | |
30 <p><strong>HTMLUtil</strong> module provides the following functions:</p> | |
31 <p> <a href="#inserthtmltags">InsertHTMLTags</a>, <a href="#setuphtmlalignmentbegin">SetupHTMLAlignmentBegin</a>, <a href="#setuphtmlalignmentend">SetupHTMLAlignmentEnd</a> | |
32 , <a href="#setuphtmlbuttonref">SetupHTMLButtonRef</a>, <a href="#setuphtmldivbegin">SetupHTMLDivBegin</a>, <a href="#setuphtmldivend">SetupHTMLDivEnd</a>, <a href="#setuphtmlemptylines">SetupHTMLEmptyLines</a> | |
33 , <a href="#setuphtmlhref">SetupHTMLHRef</a>, <a href="#setuphtmlpageend">SetupHTMLPageEnd</a>, <a href="#setuphtmlpageheader">SetupHTMLPageHeader</a>, <a href="#setuphtmlpagetitle">SetupHTMLPageTitle</a> | |
34 , <a href="#setuphtmlstylesheettags">SetupHTMLStyleSheetTags</a>, <a href="#setuphtmltablecolumnend">SetupHTMLTableColumnEnd</a>, <a href="#setuphtmltablecolumnheader">SetupHTMLTableColumnHeader</a> | |
35 , <a href="#setuphtmltableend">SetupHTMLTableEnd</a>, <a href="#setuphtmltableheader">SetupHTMLTableHeader</a>, <a href="#setuphtmltablerowdatavalue">SetupHTMLTableRowDataValue</a> | |
36 , <a href="#setuphtmltablerowend">SetupHTMLTableRowEnd</a>, <a href="#setuphtmltablerowheader">SetupHTMLTableRowHeader</a>, <a href="#setuphtmltablerowheadervalue">SetupHTMLTableRowHeaderValue</a> | |
37 , <a href="#setupjavascriptcmds">SetupJavaScriptCmds</a>, <a href="#setupstrvieweraccelrysactivex">SetupStrViewerAccelrysActiveX</a>, <a href="#setupstrviewerchem3dactivex">SetupStrViewerChem3DActiveX</a> | |
38 , <a href="#setupstrviewerchemdrawactivex">SetupStrViewerChemDrawActiveX</a>, <a href="#setupstrviewerchemdrawplugin">SetupStrViewerChemDrawPlugIn</a> | |
39 , <a href="#setupstrviewerchimeplugin">SetupStrViewerChimePlugIn</a>, <a href="#setupstrviewerjmeapplet">SetupStrViewerJMEApplet</a>, <a href="#setupstrviewerjsinitcmd">SetupStrViewerJSInitCmd</a> | |
40 , <a href="#setupstrviewerjmolapplet">SetupStrViewerJmolApplet</a>, <a href="#setupstrviewermarvinviewapplet">SetupStrViewerMarvinViewApplet</a> | |
41 </p><p> | |
42 </p> | |
43 <h2>FUNCTIONS</h2> | |
44 <dl> | |
45 <dt><strong><a name="inserthtmltags" class="item"><strong>InsertHTMLTags</strong></a></strong></dt> | |
46 <dd> | |
47 <div class="OptionsBox"> | |
48 $NewTag = InsertHTMLTags($Tag, @TagsNameValue);</div> | |
49 <p>Inserts tag name and value pair from <em>TagsNameValue</em> into a exisiting <em>Tag</em> as <em>TagName = "TagValue"</em> | |
50 and returns <strong>NewTag</strong> string.</p> | |
51 </dd> | |
52 <dt><strong><a name="setuphtmlalignmentbegin" class="item"><strong>SetupHTMLAlignmentBegin</strong></a></strong></dt> | |
53 <dd> | |
54 <div class="OptionsBox"> | |
55 $AlignmentTag = SetupHTMLAlignmentBegin([$Alignment]);</div> | |
56 <p>Returns an alignment begin tag string. Possible <em>Alignment</em> values: <em>left, center, or right</em>. | |
57 Default: <em>left</em>.</p> | |
58 </dd> | |
59 <dt><strong><a name="setuphtmlalignmentend" class="item"><strong>SetupHTMLAlignmentEnd</strong></a></strong></dt> | |
60 <dd> | |
61 <div class="OptionsBox"> | |
62 $AlignmentTag = SetupHTMLAlignmentBegin([$Alignment]);</div> | |
63 <p>Returns an alignment end tag string.</p> | |
64 </dd> | |
65 <dt><strong><a name="setuphtmlbuttonref" class="item"><strong>SetupHTMLButtonRef</strong></a></strong></dt> | |
66 <dd> | |
67 <div class="OptionsBox"> | |
68 $ButtonTag = SetupHTMLButtonRef($ButtonLabel, $FileName);</div> | |
69 <p>Returns a button tag string for associating <strong>onClick</strong> button event of a button with label <em>ButtonLabel</em> | |
70 to open a file <em>FileName</em>.</p> | |
71 </dd> | |
72 <dt><strong><a name="setuphtmldivbegin" class="item"><strong>SetupHTMLDivBegin</strong></a></strong></dt> | |
73 <dd> | |
74 <div class="OptionsBox"> | |
75 $DivTag = SetupHTMLDivBegin($ID);</div> | |
76 <p>Returns a div begin tag string for div <em>ID</em>.</p> | |
77 </dd> | |
78 <dt><strong><a name="setuphtmldivend" class="item"><strong>SetupHTMLDivEnd</strong></a></strong></dt> | |
79 <dd> | |
80 <div class="OptionsBox"> | |
81 $DivTag = SetupHTMLDivEnd();</div> | |
82 <p>Returns a div end tag string.</p> | |
83 </dd> | |
84 <dt><strong><a name="setuphtmltableend" class="item"><strong>SetupHTMLTableEnd</strong></a></strong></dt> | |
85 <dd> | |
86 <div class="OptionsBox"> | |
87 $TableEndTag = SetupHTMLTableEnd();</div> | |
88 <p>Returns a table end tag string.</p> | |
89 </dd> | |
90 <dt><strong><a name="setuphtmlemptylines" class="item"><strong>SetupHTMLEmptyLines</strong></a></strong></dt> | |
91 <dd> | |
92 <div class="OptionsBox"> | |
93 $EmptyLineTags = SetupHTMLEmptyLines([$LineCount]);</div> | |
94 <p>Returns an empty lines tag string for empty <em>LineCount</em>. Default line count: <em>1</em>.</p> | |
95 </dd> | |
96 <dt><strong><a name="setuphtmlpageheader" class="item"><strong>SetupHTMLPageHeader</strong></a></strong></dt> | |
97 <dd> | |
98 <div class="OptionsBox"> | |
99 $PageHeaderTag = SetupHTMLPageHeader($HeaderTitle, [$Stylesheet, | |
100 $JavaScript]);</div> | |
101 <p>Returns a page header tag string using <em>HeaderTitle</em> and using optionally specifed | |
102 values for <em>Stylesheet</em> and <em>JavaScript</em>.</p> | |
103 </dd> | |
104 <dt><strong><a name="setuphtmlhref" class="item"><strong>SetupHTMLHRef</strong></a></strong></dt> | |
105 <dd> | |
106 <div class="OptionsBox"> | |
107 $HRef = SetupHTMLHRef($Label, $URL, [$Title]);</div> | |
108 <p>Returns a HRef tag string for setting up a URL with <em>Label</em> and <em>URL</em> with optional <em>Title</em>.</p> | |
109 </dd> | |
110 <dt><strong><a name="setuphtmlpageend" class="item"><strong>SetupHTMLPageEnd</strong></a></strong></dt> | |
111 <dd> | |
112 <div class="OptionsBox"> | |
113 $PageEndTag = SetupHTMLPageEnd([$FooterMsg]);</div> | |
114 <p>Returns a page end tag string conating optional <em>FooterMsg</em>.</p> | |
115 </dd> | |
116 <dt><strong><a name="setuphtmlpagetitle" class="item"><strong>SetupHTMLPageTitle</strong></a></strong></dt> | |
117 <dd> | |
118 <div class="OptionsBox"> | |
119 $PageTitleTag = SetupHTMLPageTitle($Title, [$Alignment]);</div> | |
120 <p>Returns a page title tag string with optional alignment. Valid alignment value: <em>left, center, right</em> | |
121 Default alignment: <em>center</em>.</p> | |
122 </dd> | |
123 <dt><strong><a name="setuphtmlstylesheettags" class="item"><strong>SetupHTMLStyleSheetTags</strong></a></strong></dt> | |
124 <dd> | |
125 <div class="OptionsBox"> | |
126 $StyleSheetTags = SetupHTMLStyleSheetTags();</div> | |
127 <p>Returns a default style sheet tag string to be used for HTML files generated by MayaChemTools.</p> | |
128 </dd> | |
129 <dt><strong><a name="setuphtmltableheader" class="item"><strong>SetupHTMLTableHeader</strong></a></strong></dt> | |
130 <dd> | |
131 <div class="OptionsBox"> | |
132 $TableHeaderTags = SetupHTMLTableHeader([$BorderWidth, | |
133 $CellPadding, $CellSpacing, $Width, $Height]);</div> | |
134 <p>Returns a table header tag string containing specified values for <em>BorderWidth, CellPadding, CellSpacing, | |
135 Width, and Height</em>. Default values: <em>BorderWidth = 1; CellPadding = 2; CellSpacing = 0; Width = NotUsed; | |
136 Height = NotUsed</em>.</p> | |
137 </dd> | |
138 <dt><strong><a name="setuphtmltableend2" class="item"><SetupHTMLTableEnd></a></strong></dt> | |
139 <dd> | |
140 <div class="OptionsBox"> | |
141 $TableEndTag = SetupHTMLTableEnd();</div> | |
142 <p>Returns a table end tag string.</p> | |
143 </dd> | |
144 <dt><strong><a name="setuphtmltablecolumnheader" class="item"><strong>SetupHTMLTableColumnHeader</strong></a></strong></dt> | |
145 <dd> | |
146 <div class="OptionsBox"> | |
147 $ColumnHeaderTag = SetupHTMLTableColumnHeader([$BgColor, $Width]);</div> | |
148 <p>Returns a table column header tag string containing specified values for <em>BgColor, Width</em>. Default | |
149 values: <em>BgColor = NotUsed; Width = NotUsed</em>.</p> | |
150 </dd> | |
151 <dt><strong><a name="setuphtmltablecolumnend" class="item"><strong>SetupHTMLTableColumnEnd</strong></a></strong></dt> | |
152 <dd> | |
153 <div class="OptionsBox"> | |
154 $ColumnEndTag = SetupHTMLTableColumnEnd();</div> | |
155 <p>Returns a table column end tag string.</p> | |
156 </dd> | |
157 <dt><strong><a name="setuphtmltablerowheader" class="item"><strong>SetupHTMLTableRowHeader</strong></a></strong></dt> | |
158 <dd> | |
159 <div class="OptionsBox"> | |
160 $RowHeaderTag = SetupHTMLTableRowHeader([$HAlignment, $BgColor, | |
161 $VAlignment]);</div> | |
162 <p>Returns a table row header tag string containing specified values for <em>HAlignment, BgColor, and VAlignment</em>. | |
163 Default values: <em>HAlignment = center; $BgColor = NotUsed; $VAlignment = top</em>.</p> | |
164 </dd> | |
165 <dt><strong><a name="setuphtmltablerowend" class="item"><strong>SetupHTMLTableRowEnd</strong></a></strong></dt> | |
166 <dd> | |
167 <div class="OptionsBox"> | |
168 $RowEndTag = SetupHTMLTableRowEnd();</div> | |
169 <p>Returns a table row end tag string.</p> | |
170 </dd> | |
171 <dt><strong><a name="setuphtmltablerowheadervalue" class="item"><strong>SetupHTMLTableRowHeaderValue</strong></a></strong></dt> | |
172 <dd> | |
173 <div class="OptionsBox"> | |
174 $HeaderValueTag = SetupHTMLTableRowHeaderValue([$Value]);</div> | |
175 <p>Returns a table header row tag string using specifed <em>Value</em>. Default value: <em>EmptySpace</em>.</p> | |
176 </dd> | |
177 <dt><strong><a name="setuphtmltablerowdatavalue" class="item"><strong>SetupHTMLTableRowDataValue</strong></a></strong></dt> | |
178 <dd> | |
179 <div class="OptionsBox"> | |
180 $RowValueTag = SetupHTMLTableRowDataValue([$Value, $BgColor, | |
181 $FontColor, $FontBold]);</div> | |
182 <p>Returns a table row column value tag string using specified values for <em>Value, BgColor, | |
183 FontColor, and FontBold</em>. Default values: <em>Value = EmptySpace; BgColor = NotUsed; | |
184 FontColor = NotUsed; $FontBold = NotUsed</em>.</p> | |
185 </dd> | |
186 <dt><strong><a name="setupjavascriptcmds" class="item"><strong>SetupJavaScriptCmds</strong></a></strong></dt> | |
187 <dd> | |
188 <div class="OptionsBox"> | |
189 $JSTag = SetupJavaScriptCmds(@JSCmdList);</div> | |
190 <p>Returns a Java script tag string using java script commands specified in <em>JSCmdList</em>.</p> | |
191 </dd> | |
192 <dt><strong><a name="setupstrviewerjsinitcmd" class="item"><strong>SetupStrViewerJSInitCmd</strong></a></strong></dt> | |
193 <dd> | |
194 <div class="OptionsBox"> | |
195 $JSTag = SetupStrViewerJSInitCmd($StrViewerType, $CodeBase);</div> | |
196 <p>Returns a Java script command tag string for intializing structure viewers with specified <em>CodeBase</em> | |
197 location for viewers to be invoked as Java Applets. Supported values for <em>StrViewerType</em>: <em>Jmol, | |
198 ChemDrawPlugIn, ChemDrawActiveX, Chem3DActiveX</em>.</p> | |
199 </dd> | |
200 <dt><strong><a name="setupstrviewerjmeapplet" class="item"><strong>SetupStrViewerJMEApplet</strong></a></strong></dt> | |
201 <dd> | |
202 <div class="OptionsBox"> | |
203 $JMEAppletTag = SetupStrViewerJMEApplet($MolString, $CodeBase, | |
204 [{param => "value"}]);</div> | |
205 <p>Returns a JME tag string for displaying molecule using <em>MolString</em> along with valid optional applet | |
206 parameters specified as name and value pairs. Defaul JME parameter values: <em>name = JME; id = JME; | |
207 width = 250; height = 170</em>.</p> | |
208 </dd> | |
209 <dt><strong><a name="setupstrviewerjmolapplet" class="item"><strong>SetupStrViewerJmolApplet</strong></a></strong></dt> | |
210 <dd> | |
211 <div class="OptionsBox"> | |
212 $JmolAppletTag = SetupStrViewerJmolApplet($MolString, $CodeBase, | |
213 [{param => "value"}]);</div> | |
214 <p>Returns a JMol tag string for displaying molecule using <em>MolString</em> along with valid optional applet | |
215 parameters specified as name and value pairs. Defaul JMol parameter values: <em>name = Jmol; id = Jmol; | |
216 width = 250; height = 170; progressbar = true; progresscolor = 0000ff; bgcolor = 000000; JMolScript = | |
217 select *; set frank off; wireframe on; spacefill off</em>.</p> | |
218 </dd> | |
219 <dt><strong><a name="setupstrviewermarvinviewapplet" class="item"><strong>SetupStrViewerMarvinViewApplet</strong></a></strong></dt> | |
220 <dd> | |
221 <div class="OptionsBox"> | |
222 $MarvinAppletTag = SetupStrViewerMarvinViewApplet($MolString, | |
223 $CodeBase, [{param => "value"}]);</div> | |
224 <p>Returns a MarvinView tag string for displaying molecule using <em>MolString</em> along with valid optional applet | |
225 parameters specified as name and value pairs. Defaul MarvinView parameter values: <em>name = MView; id = MView; | |
226 width = 250; height = 170; navmode = zoom</em>.</p> | |
227 </dd> | |
228 <dt><strong><a name="setupstrviewerchimeplugin" class="item"><strong>SetupStrViewerChimePlugIn</strong></a></strong></dt> | |
229 <dd> | |
230 <div class="OptionsBox"> | |
231 $ChimePlugInTag = SetupStrViewerChimePlugIn($MolFile, | |
232 [{param => "value"}]);</div> | |
233 <p>Returns a MDL Chime tag string for displaying molecule using <em>MolFile</em> along with valid optional | |
234 parameters specified as name and value pairs. Defaul Chime parameter values: <em>width = 250; height = 170; | |
235 display2d = true</em>.</p> | |
236 </dd> | |
237 <dt><strong><a name="setupstrviewerchem3dactivex" class="item"><strong>SetupStrViewerChem3DActiveX</strong></a></strong></dt> | |
238 <dd> | |
239 <div class="OptionsBox"> | |
240 $ChemDraw3DActiveXTags = SetupStrViewerChemDrawActiveX($MolFile, | |
241 [{param => "value"}]);</div> | |
242 <p>Returns a CambridgeSoft Chem3D tag string for displaying molecule using <em>MolFile</em> along with valid optional | |
243 parameters specified as name and value pairs. Defaul Chime parameter values: <em>width = 250; height = 170; | |
244 displaytype = BallAndStick; rotationbars = false; moviecontroller = false</em>.</p> | |
245 </dd> | |
246 <dt><strong><a name="setupstrviewerchemdrawactivex" class="item"><strong>SetupStrViewerChemDrawActiveX</strong></a></strong></dt> | |
247 <dd> | |
248 <div class="OptionsBox"> | |
249 $ChemDrawActiveXTags = SetupStrViewerChem3DActiveX($MolFile, | |
250 [{param => "value"}]);</div> | |
251 <p>Returns a CambridgeSoft ChemDraw ActiveX tag string for displaying molecule using <em>MolFile</em> along with valid optional | |
252 parameters specified as name and value pairs. Defaul ChemDraw ActiveX parameter values: <em>width = 250; height = 170; | |
253 ViewOnly = 1; ShrinkToFit = 1; ShowToolsWhenVisible = 1</em>.</p> | |
254 </dd> | |
255 <dt><strong><a name="setupstrviewerchemdrawplugin" class="item"><strong>SetupStrViewerChemDrawPlugIn</strong></a></strong></dt> | |
256 <dd> | |
257 <div class="OptionsBox"> | |
258 $ChemDrawPlugInTag = SetupStrViewerChemDrawPlugIn($MolFile, | |
259 [{param => "value"}]);</div> | |
260 <p>Returns a CambridgeSoft ChemDraw PlugIn tag string for displaying molecule using <em>MolFile</em> along with valid optional | |
261 parameters specified as name and value pairs. Defaul ChemDraw PlugIn parameter values: <em>width = 250; height = 170; | |
262 ViewOnly = 1; ShrinkToFit = 1; ShowToolsWhenVisible = 1</em>.</p> | |
263 </dd> | |
264 <dt><strong><a name="setupstrvieweraccelrysactivex" class="item"><strong>SetupStrViewerAccelrysActiveX</strong></a></strong></dt> | |
265 <dd> | |
266 <div class="OptionsBox"> | |
267 $AccelrysActiveXTags = SetupStrViewerAccelrysActiveX($MolFile, | |
268 [{param => "value"}]);</div> | |
269 <p>Returns a Accelrys ViewerActiveX tag string for displaying molecule using <em>MolFile</em> along with valid optional | |
270 parameters specified as name and value pairs. Defaul ViewerActiveX parameter values: <em>width = 250; height = 170; | |
271 Convert2Dto3D = 0; Mouse = 4</em>.</p> | |
272 </dd> | |
273 </dl> | |
274 <p> | |
275 </p> | |
276 <h2>AUTHOR</h2> | |
277 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p> | |
278 <p> | |
279 </p> | |
280 <h2>COPYRIGHT</h2> | |
281 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p> | |
282 <p>This file is part of MayaChemTools.</p> | |
283 <p>MayaChemTools is free software; you can redistribute it and/or modify it under | |
284 the terms of the GNU Lesser General Public License as published by the Free | |
285 Software Foundation; either version 3 of the License, or (at your option) | |
286 any later version.</p> | |
287 <p> </p><p> </p><div class="DocNav"> | |
288 <table width="100%" border=0 cellpadding=0 cellspacing=2> | |
289 <tr align="left" valign="top"><td width="33%" align="left"><a href="./Graph.html" title="Graph.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./MathUtil.html" title="MathUtil.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>HTMLUtil.pm</strong></td></tr> | |
290 </table> | |
291 </div> | |
292 <br /> | |
293 <center> | |
294 <img src="../../images/h2o2.png"> | |
295 </center> | |
296 </body> | |
297 </html> |