annotate docs/scripts/txt/SDFilesToHTML.txt @ 0:4816e4a8ae95 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:23:18 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 SDFilesToHTML.pl - Generate HTML table file(s) from SDFile(s)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 SDFilesToHTML.pl SDFiles(s)...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 SDFilesToHTML.pl [-a, --align left | center | right,[top | middle |
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8 bottom]] [-b, --border borderwidth] [--cellpadding padding]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 [--cellspacing spacing] [--cmpddatafield
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 "fieldlabel,[label,position,alignment]"] [--datafields
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11 "fieldlabel,[fieldlabel]..." | Common | All] [--footer string] [-d,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 --displaylinks top | bottom | both] [--displaylinksinfo compound | table
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 | both] [-h, --help] [--headeralign left | center | right,[top | middle
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 | bottom]] [--headercolor "#RRGGBB"] [--highlight
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 "fieldlabel,datatype,criterion,value,[fieldlabel,datatype,criterion,valu
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 e,...]"] [--highlightcolor "#RRGGBB,#RRGGBB"] [--highlightstyle text |
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 background] [-m, --mode plain | shade | highlight | shadedhighlight |
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 structuresonly | shadedstructuresonly] [-n, --numcmpds number] [-o,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 --overwrite] [-r, --root rootname] [-s, --structure display | link]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 [--strlinkmode plain | shaded] [--strlinknavigation yes | no]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 [--strlinkshadecolor "#RRGGBB"] [--strlinktitle string]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 [--strlinktitledisplay yes | no] [--strlinktype href | button]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 [--strviewertype Chem3DActiveX | ChemDrawActiveX | ChemDrawPlugIn |
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 Chime | JME | Jmol | MarvinView | ViewerActiveX] [--strviewerconfig
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 codebase[,archive,code]] [--strviewerparams "name=value [name=value
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 ...]"] [--strviewerembed direct | javascript] [--strviewerjsfile
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 javascriptfilename] [--strtablesize "numrows,numcols"] [--stylesheet old
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 | new | none] [--stylesheetname filename] [--shadecolor
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 "#RRGGBB,#RRGGBB"] [-t, --title string] [--titledisplay yes | no] [-w,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 --workingdir dirname] SDFiles(s)...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 Generate HTML file(s) from *SDFile(s)*. The HTML file(s) contain data
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 tables and appropriate navigational links to view other tables;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 navigational links are also provided on compound HTML pages. These files
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 can be generated for local viewing or deployment on a web server. A
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 variety of options are provided to control style and appearance of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 tables. And for viewing structures, options are available to use any one
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 of these viewers: Chem3DActiveX, ChemDrawActiveX, ChemDrawPlugIn, Chime,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 Jmol, JME, MarvinView, or ViewerActiveX. Jmol is the default structure
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 viewer and it is also distributed along with this package; however, to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 use any other supported viewers, make sure it's available in your
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 environment.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 Multiple *SDFile(s)* names are separated by space. The valid file
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 extensions are *.sdf* and *.sd*. All other file names are ignored. All
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 the SD files in a current directory can be specified either by **.sdf*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 or the current directory name.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 OPTIONS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 -a, --align *left | center | right,[top | middle | bottom]*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 Horizontal and vertical alignment for table rows except for header
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 row which is specified using --headeralign option. Possible
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54 horizontal alignment values: *left, center, or right*. Possible
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 vertical alignment values: *top, middle, or bottom*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 Default values: *left,middle*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 -b, --border *borderwidth*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 Table border width. Default value: 1 for *plain* and *highlight*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 mode; 0 for *shade* and *shadedhightlight* mode. Zero indicates no
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 border.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 --cellpadding *padding*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65 Table cell padding. Default value: *2*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 --cellspacing *spacing*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68 Table cell spacing. Default value: *1*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70 --cmpddatafield *fieldlabel,[label,position,alignment]*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 This value is mode specific. It indicates data field value to be
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 displayed with the structure along with its label, position and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73 alignment during *structuresonly | shadedstructuresonly* value of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 -m, --mode option. Possible values: feldlabel - valid data field
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 label; label - yes or no; position - *top or bottom*; alignment -
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 *left, center, or right*. Default: *none,no,bottom,center*. Example:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 MolWt,no,bottom,middle
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80 --cmpddatafield option value is also linked to compound summary
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 page.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 --datafields *"fieldlabel,[fieldlabel]..." | Common | All*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 Data fields to display in HTML table(s). Possible values: list of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 comma separated data field labels, data fields common to all
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 records, or all data fields. Default value: *All*. Examples:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88 ALogP,MolWeight,EC50
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 "MolWeight,PSA"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 --footer *string*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92 Text string to be included at bottom of each HTML file. Default:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93 none.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95 -d --displaylinks *top | bottom | both*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 Specify where to display navigation links in each HTML file for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97 accessing all other HTML files. Possible values: *top, bottom, or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 both*. Default: *both*. This option is only valid during multiple
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99 HTML files generation for an input file.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101 --displaylinksinfo *compound | table | both*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102 Control display of additional information along with navigational
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 links: Showing compound n of m is displyed for compound and showing
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104 table n of m for table. Possible values: *compound | table | both*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105 Default: *both*. This option is only valid during multiple HTML
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 files generation.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108 -h, --help
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 Print this help message.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 --headeralign *left | center | right,[top | middle | bottom*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112 Horizontal and vertical alignment for table header rows. Possible
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113 horizontal alignment values: *left, center, or right*. Possible
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 vertical alignment values: *top, middle, or bottom*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116 Default values: *center,middle*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118 --headercolor *#RRGGBB*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119 Color used to fill background of table header row containing column
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120 labels represented as a hexadecimal string. Default value: None for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
121 -m, --mode option value of *plain* and *#ccccff*, light blue, for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
122 others.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
123
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
124 --highlight
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
125 *"fieldlabel,datatype,criterion,value,[fieldlabel,datatype,criterion,val
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
126 ue,...]"*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
127 Highlighting methodology used to highlight various SDFile(s) data
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
128 field values in HTML file(s). Same set of quartets values are
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
129 applied to all SDFile(s).
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
130
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
131 Input text contains these quartets:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
132 *fieldlabel,datatype,criterion,value,...*. Possible datatype values:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
133 *numeric or text*. Possible criterion values: *le, ge, or eq*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
134 Examples:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
135
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
136 "MolWt,numeric,le,450"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
137 "MolWt,numeric,le,450,LogP,numeric,le,5"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
138 Name,text,eq,Aspirin
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
139
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
140 --highlightcolor *"#RRGGBB,#RRGGBB"*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
141 Colors used to highlight column values during *highlight* and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
142 *shadedhightlight* mode represented as hexadecimal strings.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
143
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
144 For --highlighstyle option values of *text* and *background*, these
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
145 colors represent text or background colors respectively. For a
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
146 specific column, first color string is used for values which meet
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
147 criterion indicated by --highlight option; the second color is used
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
148 for rest of the values.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
149
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
150 Default values for *background* --highlightstyle:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
151 *"#0fff0f,#ff0f0f"*. And default values for *text* --highlightstyle:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
152 *"#0fbb0f,#ff0f0f"*. Hexadecimal strings for both --highlightstyle
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
153 colors correspond to *reddish* and *greenish*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
154
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
155 --highlightstyle *text | background*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
156 This value is mode specific. It indicates highlight style used to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
157 differentiate column values which meet a specified criterion in
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
158 --highlight option. Possible values: *text or background*. Default:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
159 *background*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
160
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
161 -m, --mode *plain | shade | highlight | shadedhighlight | structuresonly
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
162 | shadedstructuresonly*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
163 Specify how to generate HTML table(s): plain tables with line
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
164 borders, background of alternate rows filled with a specified color,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
165 column values highlighted using a specified criteria, combination of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
166 previous two styles, tables containing only structures, or tables
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
167 containing only structures with filled background of alternate rows.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
168
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
169 Possible values: *plain, shade, highlight, shadedhighlight,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
170 structuresonly, or shadedstructuresonly*. Default: *shade*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
171
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
172 -n, --numcmpds *number*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
173 Maximum number of compounds per table. Default value: *15* for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
174 tables with structures and *50* for tables with links to structures.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
175 Use 0 to put all compounds into one table. For SDFile(s) with more
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
176 than maximum number of specified compounds, multiple HTML tables,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
177 with appropriate navigation links, are created.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
178
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
179 -o, --overwrite
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
180 Overwrite existing files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
181
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
182 -r, --root *rootname*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
183 New file or directory name is generated using the root: <root>.html
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
184 or <root>-html. Default new file name: <InitialSDFileName>.html.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
185 Default directory name: <InitialSDFileName>-html.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
186
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
187 For SDFile(s) with more than maximum number of specified compounds
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
188 per table, this directory tree is generated using <Name> where
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
189 <Name> corresponds to <root> or <InitialSDFileName>: Top dir -
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
190 <Name>-html; Sub dirs - html and mols. <Top dir> contains
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
191 <Name>.html and <Name>.css files and <sub dir> html conatins various
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
192 <Name>Lines<Start>To<End>.html files; <sub dir> mols is created as
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
193 needed and contains MOL files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
194
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
195 This option is ignored for multiple input files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
196
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
197 -s, --structure *display | link*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
198 Structure display control: display structures in a table column or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
199 set up a link for each structure which opens up a new HTML page
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
200 containing structure and other appropriate information. Possible
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
201 values: *display or link*. Default value: *display*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
202
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
203 --strlinkmode *plain | shaded*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
204 Specify how to display compound HTML page: plain or background of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
205 data field field labels is filled with a specified color. Possible
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
206 values: *plain or shad*. Default value: *plane*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
207
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
208 Structure viewer background color is white. Use --strviewerparams
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
209 option to change default behavior of structure viewers.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
210
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
211 --strlinknavigation *yes | no*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
212 Display navigation links to other compounds in compound HTML page.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
213 Possible values: *yes or no*. Default value: *yes*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
214
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
215 --strlinkshadecolor *"#RRGGBB"*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
216 This value is --strlinkmode specific. For *shade* value of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
217 --strlinkmode option, it represents colors used to fill background
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
218 of data field labels.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
219
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
220 Default value: *"#e0e9eb"* - it's a very light blue color.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
221
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
222 --strlinktitle *string*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
223 Title for compound HTML page. Default value: *Compound Summary*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
224
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
225 --strlinktitledisplay *yes | no*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
226 Display title for compound HTML page. Possible values: *yes or no*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
227 Default value: *no*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
228
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
229 --strlinktype *href | button*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
230 Type of structure link. Possible values: *href or button*. Default:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
231 *href*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
232
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
233 --strviewertype *Chem3DActiveX | ChemDrawActiveX | ChemDrawPlugIn |
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
234 Chime | JME | Jmol | MarvinView | ViewerActiveX*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
235 Structure viewer supported for viewing structures. Possible values:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
236 *Chem3DActiveX, ChemDrawActiveX, ChemDrawPlugIn, Chime, JME, Jmol,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
237 MarvinView, or ViewerActiveX*. Default value: *Jmol*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
238
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
239 Assuming you have access to one of these viewers on your machine,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
240 you are all set to use this script. Otherwise, visit one of these
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
241 web sites to download and install your favorite viewer:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
242
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
243 accelrys.com: Viewer ActiveX 5.0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
244 cambridgesoft.com: Chem3DActiveX 8.0, ChemDrawActiveX 8.0,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
245 ChemDrawPlugIn
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
246 chemaxon.com: MarvinView applet
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
247 mdli.com: Chime plug-in
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
248 jmol.sourceforge.net: JmolApplet V10
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
249 molinspiration.com: JME applet
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
250
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
251 The default viewer, JmolApplet V10, is distributed with
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
252 MayaChemTools package. Earlier versions of JmolApplet are not
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
253 supported: due to applet security issues related to reading files,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
254 this script uses in-line loading of MOL files and this option
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
255 doesn't exist in earlier version of JmolApplet.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
256
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
257 --strviewerconfig *codebase[,archive,code]*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
258 Configuration information for structure viewers. This option is only
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
259 valid for structure viewers which are applets: Jmol, JME and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
260 MarvinView. For other viewer types available via --strviewertype
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
261 option - MDL Chime, ChemDrawActiveX, ChemDrawPlugIn, and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
262 Chem3DActiveX - this value is ignored.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
263
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
264 Input text format: *codebase[,archive,code]*. For an applet viewer,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
265 *codebase* must be specified; *archive* and *code* values are
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
266 optional. Here are default *archive* and *codebase* values for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
267 various applets: Jmol - JmolApplet, JmolApplet.jar; JME - JME,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
268 JME.jar; MarvinView: MView, marvin.jar
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
269
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
270 For local deployment of HTML files, *codebase* must correspond to a
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
271 complete path to the local directory containing appropriate
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
272 *archive* file and the complete path is converted into appropriate
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
273 relative path during generation of HTML files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
274
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
275 By default, *codebase* value of <this script dir>/../lib/Jmol is
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
276 used for *Jmol* applet viewer, and HTML file(s) are generated for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
277 local deployment; however, you can specify any supported applet
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
278 viewer and generate HTML file(s) for deploying on a web server.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
279
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
280 For deploying the HTML file(s) on a web server, specify a valid
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
281 *codebase* directory name relative to <WWWRootDir>. Example when JME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
282 archive file, JME.jar, is available in */jme* directory on the web
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
283 server:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
284
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
285 /jme
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
286
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
287 For local deployment of HTML file(s), specify a complete *codebase*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
288 directory name. Example when JmolApplet archive file,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
289 JmolApplet.jar, is present in <JMOLROOT> directory:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
290
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
291 <JMOLROOT>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
292
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
293 In addition to *codebase*, you can also specify *archive* file name.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
294 Example for web deployment:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
295
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
296 "/jme,JME.jar"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
297 "/jme"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
298
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
299 Example for local deployment:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
300
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
301 "<JMEROOT>,JME.jar"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
302 "<JMEROOT>"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
303
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
304 --strviewerparams *"name=value [name=value ...]"*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
305 Parameters name and value pairs for structure viewers. These name
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
306 and value pairs are used to control the appearance and behavior of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
307 structure viewers in tables and compound HTML page during *link*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
308 value for -s --structure option.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
309
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
310 The parameter names, along with their values, are just passed to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
311 each structure viewer in appropriate format without checking their
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
312 validity. Check documentation of appropriate structure viewers to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
313 figure out valid parameter names.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
314
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
315 Input text format: *name=value name=value ...* Example:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
316
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
317 "width=250 height=170"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
318
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
319 Default for all structure viewers: *width=250 height=170* for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
320 displaying structures in tables, and *strlinkwidth=500
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
321 strlinkheight=295* for compound HTML page during *link* value for -s
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
322 --structure option.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
323
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
324 Default background color for all structure viewers: same as
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
325 --shadecolor value for displaying structures in tables and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
326 *strlinkbgcolor=#ffffff* for compound HTML page; however, explicit
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
327 specification of background color in this option overrides default
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
328 value. To use black background for structures in tables and compound
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
329 HTML page, specify *bgcolor=#000000* and *strlinkbgcolor=#000000*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
330 respectively. Keep this in mind: Some structure viewers don't appear
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
331 to support background color parameter.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
332
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
333 Additional structure viewer specific default values:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
334
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
335 Chem3DActiveX: "displaytype=Ball&Stick rotationbars=false
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
336 moviecontroller=false"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
337 ChemDrawActiveX: "ViewOnly=1 ShrinkToFit=1 ShowToolsWhenVisible=1"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
338 ChemDrawPlugIn: "type=chemical/x-mdl-molfile ViewOnly=1
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
339 ShrinkToFit=1 ShowToolsWhenVisible=1"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
340 Chime: "display2d=true"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
341 JME: "options=depict"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
342 Jmol: "progressbar=true progresscolor=#0000ff boxbgcolor=#000000
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
343 boxfgcolor=#ffffff script="select *; set frank off;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
344 wireframe on; spacefill off""
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
345 MarvinView: "navmode=zoom"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
346 ViewerActiveX:"Mouse=4 Convert2Dto3D=0"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
347
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
348 Try overriding default values or specify additional valid
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
349 parameter/value pairs to get desired results. Example for using CPK
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
350 rendering scheme with Jmol viewer:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
351
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
352 "script="select *; set frank off; wireframe off; spacefill on""
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
353
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
354 --strviewerembed *direct | javascript*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
355 Specify how to embed structure viewers in HTML pages. Possible
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
356 values: *direct* - use applet/object tags to emded structure viewer;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
357 *javascript* - use vendor supplied java scripts. Default value:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
358 direct.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
359
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
360 This option only applies to these vieweres: *Chem3DActiveX,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
361 ChemDrawActiveX, ChemDrawPlugIn, Jmol, and MarvinView*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
362
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
363 For marvin.js to work correctly on your browser, you may need to set
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
364 *marvin_jvm=builtin* or *marvin_jvm=plugin* using --strviewerparams
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
365 option. Additionally, MarvinView - at least in my hands - also has
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
366 problems during usage of JavaScript for local deployment; however,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
367 it does work via web server.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
368
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
369 As far as I can tell, Jmol.js supplied with Jmol10 release has these
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
370 issues: jmolSetAppletColor doesn't support background color;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
371 jmolInitialize disables relative specification of codebase directroy
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
372 which works okay. So, use Jmol.js supplied with MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
373
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
374 --strviewerjsfile *java script file name*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
375 Name of vendor supplied java script file. Default values:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
376 Chem3DActiveX: *chem3d.js*; ChemDrawActiveX, and ChemDrawPlugIn:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
377 *chemdraw.js*; Jmol: *Jmol.js*, MarvinView: *marvin.js*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
378
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
379 Directory location for these files is specified via *codebase* value
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
380 of --strviewerconfig option.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
381
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
382 --strtablesize *"numrows,numcols"*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
383 This option is only valid for *structuresonly* and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
384 *shadedstructuresonly* modes. And it indicates maximum number of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
385 rows and columns per structure table. Default value:*6,4*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
386
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
387 --stylesheet *old | new | none*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
388 Controls usage of stylesheet for newly generated HTML file(s).
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
389 Possible values: *old, new, or none*. Default value: *new*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
390
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
391 Stylesheet file contains various properties which control appearance
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
392 of HTML pages: type, size, and color of fonts; background color; and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
393 so on.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
394
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
395 For *old* value, an existing stylesheet file specified by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
396 --stylesheetname option is used for each HTML file; no new
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
397 stylesheet file is created. This option is quite handy for deploying
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
398 HTML file(s) on a web server: assuming you specify a valid
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
399 stylesheet file location relative to your WWWRoot, a reference to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
400 this stylesheet is added to each HTML file. For local deployment of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
401 HTML file(s), a complete path to a local stylesheet is fine as well.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
402
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
403 For *create* value, a new stylesheet is created and reference to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
404 this local stylesheet is added to each HTML file. Use option
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
405 --stylesheetname to specify name.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
406
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
407 For *none* value, stylesheet usage is completely ignored.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
408
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
409 --stylesheetname *filename*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
410 Stylesheet file name to be used in conjunction with -s --stylesheet
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
411 option. It is only valid for *old* value of -s --stylesheet option.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
412 Specify a valid stylesheet file location relative to your WWWRoot
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
413 and a reference to this stylesheet is added to each HTML file.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
414 Example: *"/stylesheets/MyStyleSheet.css"*. Or a complete path name
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
415 to a local stylesheet file.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
416
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
417 For *create* value of -s --stylesheet option, a new stylesheet file
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
418 is created using -r --root option. And value of --stylesheetname is
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
419 simply ignored.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
420
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
421 --shadecolor *"#RRGGBB,#RRGGBB"*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
422 Colors used to fill background of rows during *shade* and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
423 *shadedhightlight* mode represented as a pair of hexadecimal string;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
424 the first and second color values are used for odd and even number
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
425 rows respectively.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
426
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
427 Default value: *"#ffffff,#e0e9eb"* - it's white and very light blue
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
428 for odd and even number rows.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
429
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
430 -t, --title *string*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
431 Title for HTML table(s). Default value: *SDFileName*. This option is
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
432 ignored for multiple input files. And -r --root option is used to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
433 generate appropriate titles.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
434
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
435 --titledisplay *yes | no*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
436 Display title for HTML table(s). Possible values: *yes or no*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
437 Default value: *yes*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
438
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
439 -w, --workingdir *dirname*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
440 Location of working directory. Default: current directory.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
441
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
442 EXAMPLES
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
443 HTML table file(s), containing structures, can be used in two different
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
444 ways: browsing on a local machine or deployment via a web server. By
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
445 default, HTML file(s) are created for viewing on a local machine using
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
446 Jmol viewer through a browser; however, you can specify any supported
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
447 applet viewer and generate HTML file(s) for deploying on a web server.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
448
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
449 First two sets of examples show generation of HTML file(s) using
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
450 different applet viewers and a variety of options for local browsing;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
451 last set deals with web deployment.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
452
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
453 Local deployment: Usage of default JMol viewer distributed with
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
454 MayaChemTools:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
455
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
456 To generate HTML tables with structure display using JMol viewer, rows
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
457 background filled with white and light blue colors, navigation links on
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
458 top and botton of each page, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
459
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
460 % SDFilesToHTML.pl -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
461
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
462 To generate HTML tables with structure display using JMol viewer, rows
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
463 background filled with white and light blue colors, navigation links on
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
464 top and botton of each page, and only containing MolWeight and Mol_ID SD
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
465 data fields, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
466
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
467 % SDFilesToHTML.pl --datafields "MolWeight,Mol_ID" -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
468
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
469 To generate HTML tables with CPK structure display using JMol viewer,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
470 rows background filled with white and light blue colors, navigation
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
471 links on top and botton of each page, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
472
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
473 % SDFilesToHTML.pl --strviewerparams "script=\"select *; set frank off;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
474 wireframe off; spacefill on\"" -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
475
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
476 To generate HTML tables with structure display using JMol viewer and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
477 black background, rows background filled with light golden and greyish
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
478 colors, navigation links on top and botton of each page, 10 rows in each
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
479 table, greyish header row color, and cell spacing of 1, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
480
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
481 % SDFilesToHTML.pl -o -n 10 --headeralign "center" --headercolor
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
482 "#a1a1a1" --shadecolor "#fafad2,#d1d1d1" --cellspacing 1
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
483 --strviewerparams "bgcolor=#000000" Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
484
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
485 To highlight molecular weight values using specified highlight criteria
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
486 and fill in default background colors, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
487
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
488 % SDFilesToHTML.pl -n 10 --highlight "MolWeight,numeric,le,450"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
489 --highlightstyle background -m shadedhighlight -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
490
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
491 To highlight molecular weight values using specified highlight criteria,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
492 color the text using default colors, and add a footer message in every
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
493 page, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
494
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
495 % SDFilesToHTML.pl -n 4 --highlight "MolWeight,numeric,le,500"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
496 --highlightstyle text -m shadedhighlight -o
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
497 --footer "Copyright (C) MayaChemTools" --cellspacing 1 Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
498
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
499 To generate tables containing only structures, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
500
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
501 % SDFilesToHTML.pl -d both -m shadedstructuresonly --strtablesize "6,4"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
502 --cellspacing 1 -b 1 -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
503
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
504 To generate tables containing only structures with molecular weight
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
505 displayed above the structure, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
506
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
507 % SDFilesToHTML.pl -d both -m shadedstructuresonly --strtablesize "6,4"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
508 --cmpddatafield "MolWeight,no,top,center" --cellspacing 1 -b 1
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
509 -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
510
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
511 To generate tables containing links to structures and highlight
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
512 molecular weight data field values using specified highlight criteria ,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
513 type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
514
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
515 % SDFilesToHTML.pl -n 4 --footer "Copyright (C) MayaChemTools"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
516 --highlight "MolWeight,numeric,le,450" --highlightstyle background
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
517 -d both -m shadedhighlight -s link --strlinktype button
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
518 -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
519
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
520 Local deployment: Usage of other structure viewers:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
521
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
522 % SDFilesToHTML.pl --strviewertype MarvinView --strviewerconfig
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
523 "<Marvin dir path>" -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
524
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
525 % SDFilesToHTML.pl -o -n 10 --headeralign "center" --headercolor
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
526 "#a1a1a1" --shadecolor "#fafad2,#d1d1d1" --cellspacing 1
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
527 --strviewerparams "bgcolor=#000000" --strviewertype Chime
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
528 Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
529
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
530 % SDFilesToHTML.pl -n 10 --highlight "MolWeight,numeric,le,450"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
531 --highlightstyle background -m shadedhighlight --strviewertype
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
532 Chime -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
533
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
534 % SDFilesToHTML.pl -d both -m shadedstructuresonly --strtablesize "6,4"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
535 --cellspacing 1 -b 1 -strviewertype JME -strviewerconfig "<JME dir
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
536 path>" -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
537
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
538 Web deployment: Usage of different structure viewers and options:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
539
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
540 For deploying HTML file(s) on a web server, specify a valid *codebase*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
541 directory name relative to <WWWRootDir>. In addition to *codebase*, you
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
542 can also specify *archive* file name.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
543
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
544 % SDFilesToHTML.pl -m plain -s display --strviewertype Jmol
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
545 -strviewerconfig "/jmol" -n 5 -d both -r PlainTable -t "Example
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
546 using Jmol: Plain Table" -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
547
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
548 % SDFilesToHTML.pl -n 5 -m shade -s display -strviewertype JME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
549 -strviewerconfig "/jme,JME.jar" -r ShadeTable -t "Example using JME:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
550 Shaded Table" -o Sample.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
551
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
552 % SDFilesToHTML.pl -n 5 --highlight "MolWeight,numeric,le,450"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
553 --highlightstyle background -d both -m shadedhighlight -s display
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
554 -strviewertype MarvinView -strviewerconfig "/marvin" -r
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
555 ShadedHightlightTable -t "Example using MarvinView: Shaded and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
556 Highlighted Table" -o Sample.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
557
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
558 % SDFilesToHTML.pl -n 4 --highlight "MolWeight,numeric,le,450" -s link
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
559 --strlinktype href --strviewertype ChemDrawPlugIn --highlightstyle
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
560 background -m shadedhighlight -t "Example using ChemDrawPlugIn:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
561 Shaded and Highlighted Table" -r ShadedHightlightTable -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
562
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
563 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
564 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
565
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
566 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
567 FilterSDFiles.pl, InfoSDFiles.pl, SplitSDFiles.pl,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
568 MergeTextFilesWithSD.pl
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
569
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
570 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
571 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
572
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
573 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
574
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
575 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
576 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
577 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
578 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
579