annotate mayachemtools/docs/scripts/man1/SDFilesToHTML.1 @ 0:73ae111cf86f draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 .\" Standard preamble:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 .\" ========================================================================
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 .de Sp \" Vertical space (when we can't use .PP)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 .if t .sp .5v
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 .if n .sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 .de Vb \" Begin verbatim text
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 .ft CW
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 .nf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 .ne \\$1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 .de Ve \" End verbatim text
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 .ft R
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 .fi
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 .\" Set up some character translations and predefined strings. \*(-- will
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 .\" nothing in troff, for use with C<>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 .tr \(*W-
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 .ie n \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 . ds -- \(*W-
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 . ds PI pi
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 . ds L" ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 . ds R" ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 . ds C` ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 . ds C' ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 'br\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 .el\{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 . ds -- \|\(em\|
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 . ds PI \(*p
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 . ds L" ``
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 . ds R" ''
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 'br\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 .ie \n(.g .ds Aq \(aq
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 .el .ds Aq '
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 .\" If the F register is turned on, we'll generate index entries on stderr for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 .\" output yourself in some meaningful fashion.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 .ie \nF \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 . de IX
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 . tm Index:\\$1\t\\n%\t"\\$2"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 . nr % 0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 . rr F
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 .el \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 . de IX
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 . \" fudge factors for nroff and troff
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 .if n \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 . ds #H 0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 . ds #V .8m
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 . ds #F .3m
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 . ds #[ \f1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 . ds #] \fP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 .if t \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 . ds #V .6m
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 . ds #F 0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 . ds #[ \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 . ds #] \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 . \" simple accents for nroff and troff
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 .if n \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 . ds ' \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 . ds ` \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 . ds ^ \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 . ds , \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 . ds ~ ~
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 . ds /
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 .if t \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 . \" troff and (daisy-wheel) nroff accents
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 .ds ae a\h'-(\w'a'u*4/10)'e
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 .ds Ae A\h'-(\w'A'u*4/10)'E
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 . \" corrections for vroff
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 . \" for low resolution devices (crt and lpr)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 .if \n(.H>23 .if \n(.V>19 \
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 . ds : e
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 . ds 8 ss
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 . ds o a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 . ds d- d\h'-1'\(ga
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 . ds D- D\h'-1'\(hy
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 . ds th \o'bp'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 . ds Th \o'LP'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 . ds ae ae
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 . ds Ae AE
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 .rm #[ #] #H #V #F C
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 .\" ========================================================================
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 .IX Title "SDFILESTOHTML 1"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 .TH SDFILESTOHTML 1 "2015-03-29" "perl v5.14.2" "MayaChemTools"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 .\" way too many mistakes in technical documents.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 .if n .ad l
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 .nh
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 .SH "NAME"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 SDFilesToHTML.pl \- Generate HTML table file(s) from SDFile(s)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 .SH "SYNOPSIS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 .IX Header "SYNOPSIS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 SDFilesToHTML.pl SDFiles(s)...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 SDFilesToHTML.pl [\fB\-a, \-\-align\fR left | center | right,[top | middle | bottom]] [\fB\-b, \-\-border\fR borderwidth] [\fB\-\-cellpadding\fR padding]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 [\fB\-\-cellspacing\fR spacing] [\fB\-\-cmpddatafield\fR \*(L"fieldlabel,[label,position,alignment]\*(R"] [\fB\-\-datafields\fR \*(L"fieldlabel,[fieldlabel]...\*(R" | Common | All]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 [\fB\-\-footer\fR string] [\fB\-d, \-\-displaylinks\fR top | bottom | both] [\fB\-\-displaylinksinfo\fR compound | table | both] [\fB\-h, \-\-help\fR]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 [\fB\-\-headeralign\fR left | center | right,[top | middle | bottom]] [\fB\-\-headercolor\fR \*(L"#RRGGBB\*(R"]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 [\fB\-\-highlight\fR \*(L"fieldlabel,datatype,criterion,value,[fieldlabel,datatype,criterion,value,...]\*(R"]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 [\fB\-\-highlightcolor\fR \*(L"#RRGGBB,#RRGGBB\*(R"] [\fB\-\-highlightstyle\fR text | background]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 [\fB\-m, \-\-mode\fR plain | shade | highlight | shadedhighlight | structuresonly | shadedstructuresonly]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 [\fB\-n, \-\-numcmpds\fR number] [\fB\-o, \-\-overwrite\fR] [\fB\-r, \-\-root\fR rootname] [\fB\-s, \-\-structure\fR display | link]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 [\fB\-\-strlinkmode\fR plain | shaded] [\fB\-\-strlinknavigation\fR yes | no]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 [\fB\-\-strlinkshadecolor\fR \*(L"#RRGGBB\*(R"] [\fB\-\-strlinktitle\fR string] [\fB\-\-strlinktitledisplay\fR yes | no] [\fB\-\-strlinktype\fR href | button]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 [\fB\-\-strviewertype\fR Chem3DActiveX | ChemDrawActiveX | ChemDrawPlugIn | Chime | \s-1JME\s0 | Jmol | MarvinView | ViewerActiveX]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 [\fB\-\-strviewerconfig\fR codebase[,archive,code]] [\fB\-\-strviewerparams\fR \*(L"name=value [name=value ...]\*(R"]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 [\fB\-\-strviewerembed\fR direct | javascript] [\fB\-\-strviewerjsfile\fR javascriptfilename]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 [\fB\-\-strtablesize\fR \*(L"numrows,numcols\*(R"] [\fB\-\-stylesheet\fR old | new | none]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 [\fB\-\-stylesheetname\fR filename] [\fB\-\-shadecolor\fR \*(L"#RRGGBB,#RRGGBB\*(R"] [\fB\-t, \-\-title\fR string] [\fB\-\-titledisplay\fR yes | no]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 [\fB\-w, \-\-workingdir\fR dirname] SDFiles(s)...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 .SH "DESCRIPTION"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155 .IX Header "DESCRIPTION"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156 Generate \s-1HTML\s0 file(s) from \fISDFile(s)\fR. The \s-1HTML\s0 file(s) contain data tables
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157 and appropriate navigational links to view other tables; navigational links are also
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158 provided on compound \s-1HTML\s0 pages. These files can be generated for local viewing or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 deployment on a web server. A variety of options are provided to control style and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
160 appearance of tables. And for viewing structures, options are available to use any one of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
161 these viewers: Chem3DActiveX, ChemDrawActiveX, ChemDrawPlugIn, Chime, Jmol, \s-1JME\s0,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
162 MarvinView, or ViewerActiveX. Jmol is the default structure viewer and it is also distributed
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
163 along with this package; however, to use any other supported viewers, make sure it's available
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
164 in your environment.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
165 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
166 Multiple \fISDFile(s)\fR names are separated by space. The valid file extensions are
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
167 \&\fI.sdf\fR and \fI.sd\fR. All other file names are ignored. All the \s-1SD\s0 files in a current directory can
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
168 be specified either by \fI*.sdf\fR or the current directory name.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
169 .SH "OPTIONS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
170 .IX Header "OPTIONS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
171 .IP "\fB\-a, \-\-align\fR \fIleft | center | right,[top | middle | bottom]\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
172 .IX Item "-a, --align left | center | right,[top | middle | bottom]"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
173 Horizontal and vertical alignment for table rows except for header row which is specified
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
174 using \fB\-\-headeralign\fR option. Possible horizontal alignment values: \fIleft, center, or right\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
175 Possible vertical alignment values: \fItop, middle, or bottom\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
176 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
177 Default values: \fIleft,middle\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
178 .IP "\fB\-b, \-\-border\fR \fIborderwidth\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
179 .IX Item "-b, --border borderwidth"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
180 Table border width. Default value: 1 for \fIplain\fR and \fIhighlight\fR mode; 0 for \fIshade\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
181 and \fIshadedhightlight\fR mode. Zero indicates no border.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
182 .IP "\fB\-\-cellpadding\fR \fIpadding\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
183 .IX Item "--cellpadding padding"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
184 Table cell padding. Default value: \fI2\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
185 .IP "\fB\-\-cellspacing\fR \fIspacing\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
186 .IX Item "--cellspacing spacing"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
187 Table cell spacing. Default value: \fI1\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
188 .IP "\fB\-\-cmpddatafield\fR \fIfieldlabel,[label,position,alignment]\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
189 .IX Item "--cmpddatafield fieldlabel,[label,position,alignment]"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
190 This value is mode specific. It indicates data field value to be displayed with the structure along
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
191 with its label, position and alignment during \fIstructuresonly | shadedstructuresonly\fR value of \fB\-m, \-\-mode\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
192 option. Possible values: feldlabel \- valid data field label; label \- yes or no; position \- \fItop or bottom\fR; alignment
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
193 \&\- \fIleft, center, or right\fR. Default: \fInone,no,bottom,center\fR. Example:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
194 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
195 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
196 \& MolWt,no,bottom,middle
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
197 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
198 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
199 \&\fB\-\-cmpddatafield\fR option value is also linked to compound summary page.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
200 .ie n .IP "\fB\-\-datafields\fR \fI""fieldlabel,[fieldlabel]..."" | Common | All\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
201 .el .IP "\fB\-\-datafields\fR \fI``fieldlabel,[fieldlabel]...'' | Common | All\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
202 .IX Item "--datafields fieldlabel,[fieldlabel]... | Common | All"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
203 Data fields to display in \s-1HTML\s0 table(s). Possible values: list of comma separated data field
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
204 labels, data fields common to all records, or all data fields. Default value: \fIAll\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
205 Examples:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
206 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
207 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
208 \& ALogP,MolWeight,EC50
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
209 \& "MolWeight,PSA"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
210 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
211 .IP "\fB\-\-footer\fR \fIstring\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
212 .IX Item "--footer string"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
213 Text string to be included at bottom of each \s-1HTML\s0 file. Default: none.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
214 .IP "\fB\-d \-\-displaylinks\fR \fItop | bottom | both\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
215 .IX Item "-d --displaylinks top | bottom | both"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
216 Specify where to display navigation links in each \s-1HTML\s0 file for accessing all other \s-1HTML\s0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
217 files. Possible values: \fItop, bottom, or both\fR. Default: \fIboth\fR. This option is
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
218 only valid during multiple \s-1HTML\s0 files generation for an input file.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
219 .IP "\fB\-\-displaylinksinfo\fR \fIcompound | table | both\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
220 .IX Item "--displaylinksinfo compound | table | both"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
221 Control display of additional information along with navigational links: Showing compound
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
222 n of m is displyed for compound and showing table n of m for table. Possible values: \fIcompound
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
223 | table | both\fR. Default: \fIboth\fR. This option is only valid during multiple \s-1HTML\s0 files generation.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
224 .IP "\fB\-h, \-\-help\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
225 .IX Item "-h, --help"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
226 Print this help message.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
227 .IP "\fB\-\-headeralign\fR \fIleft | center | right,[top | middle | bottom\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
228 .IX Item "--headeralign left | center | right,[top | middle | bottom"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
229 Horizontal and vertical alignment for table header rows. Possible horizontal alignment
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
230 values: \fIleft, center, or right\fR. Possible vertical alignment values: \fItop, middle, or bottom\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
231 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
232 Default values: \fIcenter,middle\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
233 .IP "\fB\-\-headercolor\fR \fI#RRGGBB\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
234 .IX Item "--headercolor #RRGGBB"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
235 Color used to fill background of table header row containing column labels
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
236 represented as a hexadecimal string. Default value: None for \fB\-m, \-\-mode\fR option
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
237 value of \fIplain\fR and \fI#ccccff\fR, light blue, for others.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
238 .ie n .IP "\fB\-\-highlight\fR \fI""fieldlabel,datatype,criterion,value,[fieldlabel,datatype,criterion,value,...]""\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
239 .el .IP "\fB\-\-highlight\fR \fI``fieldlabel,datatype,criterion,value,[fieldlabel,datatype,criterion,value,...]''\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
240 .IX Item "--highlight fieldlabel,datatype,criterion,value,[fieldlabel,datatype,criterion,value,...]"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
241 Highlighting methodology used to highlight various SDFile(s) data field values in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
242 \&\s-1HTML\s0 file(s). Same set of quartets values are applied to all SDFile(s).
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
243 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
244 Input text contains these quartets: \fIfieldlabel,datatype,criterion,value,...\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
245 Possible datatype values: \fInumeric or text\fR. Possible criterion values: \fIle, ge, or eq\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
246 Examples:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
247 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
248 .Vb 3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
249 \& "MolWt,numeric,le,450"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
250 \& "MolWt,numeric,le,450,LogP,numeric,le,5"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
251 \& Name,text,eq,Aspirin
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
252 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
253 .ie n .IP "\fB\-\-highlightcolor\fR \fI""#RRGGBB,#RRGGBB""\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
254 .el .IP "\fB\-\-highlightcolor\fR \fI``#RRGGBB,#RRGGBB''\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
255 .IX Item "--highlightcolor #RRGGBB,#RRGGBB"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
256 Colors used to highlight column values during \fIhighlight\fR and \fIshadedhightlight\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
257 mode represented as hexadecimal strings.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
258 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
259 For \fB\-\-highlighstyle\fR option values of \fItext\fR and \fIbackground\fR, these colors represent
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
260 text or background colors respectively. For a specific column, first color string is used for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
261 values which meet criterion indicated by \fB\-\-highlight\fR option; the second color is used for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
262 rest of the values.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
263 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
264 Default values for \fIbackground\fR \fB\-\-highlightstyle\fR: \fI\*(L"#0fff0f,#ff0f0f\*(R"\fR. And default values for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
265 \&\fItext\fR \fB\-\-highlightstyle\fR: \fI\*(L"#0fbb0f,#ff0f0f\*(R"\fR. Hexadecimal strings for both \fB\-\-highlightstyle\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
266 colors correspond to \fIreddish\fR and \fIgreenish\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
267 .IP "\fB\-\-highlightstyle\fR \fItext | background\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
268 .IX Item "--highlightstyle text | background"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
269 This value is mode specific. It indicates highlight style used to differentiate column
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
270 values which meet a specified criterion in \fB\-\-highlight\fR option. Possible values: \fItext or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
271 background\fR. Default: \fIbackground\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
272 .IP "\fB\-m, \-\-mode\fR \fIplain | shade | highlight | shadedhighlight | structuresonly | shadedstructuresonly\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
273 .IX Item "-m, --mode plain | shade | highlight | shadedhighlight | structuresonly | shadedstructuresonly"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
274 Specify how to generate \s-1HTML\s0 table(s): plain tables with line borders, background of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
275 alternate rows filled with a specified color, column values highlighted using a specified
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
276 criteria, combination of previous two styles, tables containing only structures, or tables
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
277 containing only structures with filled background of alternate rows.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
278 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
279 Possible values: \fIplain, shade, highlight, shadedhighlight, structuresonly, or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
280 shadedstructuresonly\fR. Default: \fIshade\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
281 .IP "\fB\-n, \-\-numcmpds\fR \fInumber\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
282 .IX Item "-n, --numcmpds number"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
283 Maximum number of compounds per table. Default value: \fI15\fR for tables with structures and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
284 \&\fI50\fR for tables with links to structures. Use 0 to put all compounds into one table. For SDFile(s)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
285 with more than maximum number of specified compounds, multiple \s-1HTML\s0 tables, with appropriate
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
286 navigation links, are created.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
287 .IP "\fB\-o, \-\-overwrite\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
288 .IX Item "-o, --overwrite"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
289 Overwrite existing files.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
290 .IP "\fB\-r, \-\-root\fR \fIrootname\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
291 .IX Item "-r, --root rootname"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
292 New file or directory name is generated using the root: <root>.html or <root>\-html.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
293 Default new file name: <InitialSDFileName>.html. Default directory name:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
294 <InitialSDFileName>\-html.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
295 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
296 For SDFile(s) with more than maximum number of specified compounds per table,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
297 this directory tree is generated using <Name> where <Name> corresponds to <root>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
298 or <InitialSDFileName>: Top dir \- <Name>\-html; Sub dirs \- html and mols. <Top dir> contains
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
299 <Name>.html and <Name>.css files and <sub dir> html conatins various
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
300 <Name>Lines<Start>To<End>.html files; <sub dir> mols is created as needed and contains
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
301 \&\s-1MOL\s0 files.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
302 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
303 This option is ignored for multiple input files.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
304 .IP "\fB\-s, \-\-structure\fR \fIdisplay | link\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
305 .IX Item "-s, --structure display | link"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
306 Structure display control: display structures in a table column or set up a link for each
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
307 structure which opens up a new \s-1HTML\s0 page containing structure and other appropriate
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
308 information. Possible values: \fIdisplay or link\fR. Default value: \fIdisplay\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
309 .IP "\fB\-\-strlinkmode\fR \fIplain | shaded\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
310 .IX Item "--strlinkmode plain | shaded"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
311 Specify how to display compound \s-1HTML\s0 page: plain or background of data field
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
312 field labels is filled with a specified color. Possible values: \fIplain or shad\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
313 Default value: \fIplane\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
314 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
315 Structure viewer background color is white. Use \fB\-\-strviewerparams\fR option to change
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
316 default behavior of structure viewers.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
317 .IP "\fB\-\-strlinknavigation\fR \fIyes | no\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
318 .IX Item "--strlinknavigation yes | no"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
319 Display navigation links to other compounds in compound \s-1HTML\s0 page. Possible values:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
320 \&\fIyes or no\fR. Default value: \fIyes\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
321 .ie n .IP "\fB\-\-strlinkshadecolor\fR \fI""#RRGGBB""\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
322 .el .IP "\fB\-\-strlinkshadecolor\fR \fI``#RRGGBB''\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
323 .IX Item "--strlinkshadecolor #RRGGBB"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
324 This value is \fB\-\-strlinkmode\fR specific. For \fIshade\fR value of \fB\-\-strlinkmode\fR option, it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
325 represents colors used to fill background of data field labels.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
326 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
327 Default value: \fI\*(L"#e0e9eb\*(R"\fR \- it's a very light blue color.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
328 .IP "\fB\-\-strlinktitle\fR \fIstring\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
329 .IX Item "--strlinktitle string"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
330 Title for compound \s-1HTML\s0 page. Default value: \fICompound Summary\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
331 .IP "\fB\-\-strlinktitledisplay\fR \fIyes | no\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
332 .IX Item "--strlinktitledisplay yes | no"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
333 Display title for compound \s-1HTML\s0 page. Possible values: \fIyes or no\fR. Default value: \fIno\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
334 .IP "\fB\-\-strlinktype\fR \fIhref | button\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
335 .IX Item "--strlinktype href | button"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
336 Type of structure link. Possible values: \fIhref or button\fR. Default: \fIhref\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
337 .IP "\fB\-\-strviewertype\fR \fIChem3DActiveX | ChemDrawActiveX | ChemDrawPlugIn | Chime | \s-1JME\s0 | Jmol | MarvinView | ViewerActiveX\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
338 .IX Item "--strviewertype Chem3DActiveX | ChemDrawActiveX | ChemDrawPlugIn | Chime | JME | Jmol | MarvinView | ViewerActiveX"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
339 Structure viewer supported for viewing structures. Possible values: \fIChem3DActiveX,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
340 ChemDrawActiveX, ChemDrawPlugIn, Chime, \s-1JME\s0, Jmol, MarvinView, or ViewerActiveX\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
341 Default value: \fIJmol\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
342 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
343 Assuming you have access to one of these viewers on your machine, you are all set
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
344 to use this script. Otherwise, visit one of these web sites to download and install
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
345 your favorite viewer:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
346 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
347 .Vb 7
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
348 \& accelrys.com: Viewer ActiveX 5.0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
349 \& cambridgesoft.com: Chem3DActiveX 8.0, ChemDrawActiveX 8.0,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
350 \& ChemDrawPlugIn
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
351 \& chemaxon.com: MarvinView applet
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
352 \& mdli.com: Chime plug\-in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
353 \& jmol.sourceforge.net: JmolApplet V10
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
354 \& molinspiration.com: JME applet
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
355 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
356 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
357 The default viewer, JmolApplet V10, is distributed with MayaChemTools package.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
358 Earlier versions of JmolApplet are not supported: due to applet security issues related to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
359 reading files, this script uses in-line loading of \s-1MOL\s0 files and this option doesn't exist in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
360 earlier version of JmolApplet.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
361 .IP "\fB\-\-strviewerconfig\fR \fIcodebase[,archive,code]\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
362 .IX Item "--strviewerconfig codebase[,archive,code]"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
363 Configuration information for structure viewers. This option is only valid for structure
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
364 viewers which are applets: Jmol, \s-1JME\s0 and MarvinView. For other viewer types available via
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
365 \&\fB\-\-strviewertype\fR option \- \s-1MDL\s0 Chime, ChemDrawActiveX, ChemDrawPlugIn, and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
366 Chem3DActiveX \- this value is ignored.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
367 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
368 Input text format: \fIcodebase[,archive,code]\fR. For an applet viewer, \fIcodebase\fR must be
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
369 specified; \fIarchive\fR and \fIcode\fR values are optional. Here are default \fIarchive\fR and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
370 \&\fIcodebase\fR values for various applets: Jmol \- JmolApplet, JmolApplet.jar; \s-1JME\s0 \- \s-1JME\s0, \s-1JME\s0.jar;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
371 MarvinView: MView, marvin.jar
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
372 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
373 For local deployment of \s-1HTML\s0 files, \fIcodebase\fR must correspond to a complete path to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
374 the local directory containing appropriate \fIarchive\fR file and the complete path is converted
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
375 into appropriate relative path during generation of \s-1HTML\s0 files.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
376 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
377 By default, \fIcodebase\fR value of <this script dir>/../lib/Jmol is used for \fIJmol\fR applet viewer, and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
378 \&\s-1HTML\s0 file(s) are generated for local deployment; however, you can specify any supported
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
379 applet viewer and generate \s-1HTML\s0 file(s) for deploying on a web server.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
380 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
381 For deploying the \s-1HTML\s0 file(s) on a web server, specify a valid \fIcodebase\fR directory name
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
382 relative to <WWWRootDir>. Example when \s-1JME\s0 archive file, \s-1JME\s0.jar, is available in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
383 \&\fI/jme\fR directory on the web server:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
384 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
385 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
386 \& /jme
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
387 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
388 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
389 For local deployment of \s-1HTML\s0 file(s), specify a complete \fIcodebase\fR directory name.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
390 Example when JmolApplet archive file, JmolApplet.jar, is present in <\s-1JMOLROOT\s0> directory:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
391 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
392 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
393 \& <JMOLROOT>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
394 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
395 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
396 In addition to \fIcodebase\fR, you can also specify \fIarchive\fR file name. Example for web
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
397 deployment:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
398 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
399 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
400 \& "/jme,JME.jar"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
401 \& "/jme"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
402 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
403 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
404 Example for local deployment:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
405 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
406 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
407 \& "<JMEROOT>,JME.jar"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
408 \& "<JMEROOT>"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
409 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
410 .ie n .IP "\fB\-\-strviewerparams\fR \fI""name=value [name=value ...]""\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
411 .el .IP "\fB\-\-strviewerparams\fR \fI``name=value [name=value ...]''\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
412 .IX Item "--strviewerparams name=value [name=value ...]"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
413 Parameters name and value pairs for structure viewers. These name and value pairs
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
414 are used to control the appearance and behavior of structure viewers in tables and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
415 compound \s-1HTML\s0 page during \fIlink\fR value for \fB\-s \-\-structure\fR option.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
416 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
417 The parameter names, along with their values, are just passed to each structure viewer
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
418 in appropriate format without checking their validity. Check documentation of appropriate
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
419 structure viewers to figure out valid parameter names.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
420 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
421 Input text format: \fIname=value name=value ...\fR Example:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
422 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
423 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
424 \& "width=250 height=170"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
425 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
426 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
427 Default for all structure viewers: \fIwidth=250 height=170\fR for displaying structures in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
428 tables, and \fIstrlinkwidth=500 strlinkheight=295\fR for compound \s-1HTML\s0 page during \fIlink\fR value
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
429 for \fB\-s \-\-structure\fR option.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
430 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
431 Default background color for all structure viewers: same as \fB\-\-shadecolor\fR value for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
432 displaying structures in tables and \fIstrlinkbgcolor=#ffffff\fR for compound \s-1HTML\s0 page;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
433 however, explicit specification of background color in this option overrides default value.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
434 To use black background for structures in tables and compound \s-1HTML\s0 page, specify \fIbgcolor=#000000\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
435 and \fIstrlinkbgcolor=#000000\fR respectively. Keep this in mind: Some structure viewers
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
436 don't appear to support background color parameter.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
437 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
438 Additional structure viewer specific default values:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
439 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
440 .Vb 12
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
441 \& Chem3DActiveX: "displaytype=Ball&Stick rotationbars=false
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
442 \& moviecontroller=false"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
443 \& ChemDrawActiveX: "ViewOnly=1 ShrinkToFit=1 ShowToolsWhenVisible=1"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
444 \& ChemDrawPlugIn: "type=chemical/x\-mdl\-molfile ViewOnly=1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
445 \& ShrinkToFit=1 ShowToolsWhenVisible=1"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
446 \& Chime: "display2d=true"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
447 \& JME: "options=depict"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
448 \& Jmol: "progressbar=true progresscolor=#0000ff boxbgcolor=#000000
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
449 \& boxfgcolor=#ffffff script="select *; set frank off;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
450 \& wireframe on; spacefill off""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
451 \& MarvinView: "navmode=zoom"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
452 \& ViewerActiveX:"Mouse=4 Convert2Dto3D=0"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
453 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
454 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
455 Try overriding default values or specify additional valid parameter/value pairs to get desired
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
456 results. Example for using \s-1CPK\s0 rendering scheme with Jmol viewer:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
457 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
458 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
459 \& "script="select *; set frank off; wireframe off; spacefill on""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
460 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
461 .IP "\fB\-\-strviewerembed\fR \fIdirect | javascript\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
462 .IX Item "--strviewerembed direct | javascript"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
463 Specify how to embed structure viewers in \s-1HTML\s0 pages. Possible values: \fIdirect\fR \- use applet/object
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
464 tags to emded structure viewer; \fIjavascript\fR \- use vendor supplied java scripts. Default value:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
465 direct.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
466 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
467 This option only applies to these vieweres: \fIChem3DActiveX, ChemDrawActiveX, ChemDrawPlugIn,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
468 Jmol, and MarvinView\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
469 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
470 For marvin.js to work correctly on your browser, you may need to set \fImarvin_jvm=builtin\fR or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
471 \&\fImarvin_jvm=plugin\fR using \fB\-\-strviewerparams\fR option. Additionally, MarvinView \- at least
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
472 in my hands \- also has problems during usage of JavaScript for local deployment; however, it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
473 does work via web server.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
474 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
475 As far as I can tell, Jmol.js supplied with Jmol10 release has these issues: jmolSetAppletColor
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
476 doesn't support background color; jmolInitialize disables relative specification of codebase
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
477 directroy which works okay. So, use Jmol.js supplied with MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
478 .IP "\fB\-\-strviewerjsfile\fR \fIjava script file name\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
479 .IX Item "--strviewerjsfile java script file name"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
480 Name of vendor supplied java script file. Default values: Chem3DActiveX: \fIchem3d.js\fR; ChemDrawActiveX,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
481 and ChemDrawPlugIn: \fIchemdraw.js\fR; Jmol: \fIJmol.js\fR, MarvinView: \fImarvin.js\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
482 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
483 Directory location for these files is specified via \fIcodebase\fR value of \fB\-\-strviewerconfig\fR option.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
484 .ie n .IP "\fB\-\-strtablesize\fR \fI""numrows,numcols""\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
485 .el .IP "\fB\-\-strtablesize\fR \fI``numrows,numcols''\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
486 .IX Item "--strtablesize numrows,numcols"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
487 This option is only valid for \fIstructuresonly\fR and \fIshadedstructuresonly\fR modes. And it indicates
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
488 maximum number of rows and columns per structure table. Default value:\fI6,4\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
489 .IP "\fB\-\-stylesheet\fR \fIold | new | none\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
490 .IX Item "--stylesheet old | new | none"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
491 Controls usage of stylesheet for newly generated \s-1HTML\s0 file(s). Possible values: \fIold,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
492 new, or none\fR. Default value: \fInew\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
493 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
494 Stylesheet file contains various properties which control appearance of \s-1HTML\s0 pages:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
495 type, size, and color of fonts; background color; and so on.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
496 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
497 For \fIold\fR value, an existing stylesheet file specified by \fB\-\-stylesheetname\fR option is
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
498 used for each \s-1HTML\s0 file; no new stylesheet file is created. This option is quite handy
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
499 for deploying \s-1HTML\s0 file(s) on a web server: assuming you specify a valid stylesheet
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
500 file location relative to your WWWRoot, a reference to this stylesheet is added to each
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
501 \&\s-1HTML\s0 file. For local deployment of \s-1HTML\s0 file(s), a complete path to a local stylesheet
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
502 is fine as well.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
503 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
504 For \fIcreate\fR value, a new stylesheet is created and reference to this local stylesheet
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
505 is added to each \s-1HTML\s0 file. Use option \fB\-\-stylesheetname\fR to specify name.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
506 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
507 For \fInone\fR value, stylesheet usage is completely ignored.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
508 .IP "\fB\-\-stylesheetname\fR \fIfilename\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
509 .IX Item "--stylesheetname filename"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
510 Stylesheet file name to be used in conjunction with \fB\-s \-\-stylesheet\fR option. It is only
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
511 valid for \fIold\fR value of \fB\-s \-\-stylesheet\fR option. Specify a valid stylesheet file location
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
512 relative to your WWWRoot and a reference to this stylesheet is added to each \s-1HTML\s0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
513 file. Example: \fI\*(L"/stylesheets/MyStyleSheet.css\*(R"\fR. Or a complete path name to a local
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
514 stylesheet file.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
515 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
516 For \fIcreate\fR value of \fB\-s \-\-stylesheet\fR option, a new stylesheet file is created using
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
517 \&\fB\-r \-\-root\fR option. And value of \fB\-\-stylesheetname\fR is simply ignored.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
518 .ie n .IP "\fB\-\-shadecolor\fR \fI""#RRGGBB,#RRGGBB""\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
519 .el .IP "\fB\-\-shadecolor\fR \fI``#RRGGBB,#RRGGBB''\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
520 .IX Item "--shadecolor #RRGGBB,#RRGGBB"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
521 Colors used to fill background of rows during \fIshade\fR and \fIshadedhightlight\fR mode
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
522 represented as a pair of hexadecimal string; the first and second color values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
523 are used for odd and even number rows respectively.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
524 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
525 Default value: \fI\*(L"#ffffff,#e0e9eb\*(R"\fR \- it's white and very light blue for odd and even number rows.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
526 .IP "\fB\-t, \-\-title\fR \fIstring\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
527 .IX Item "-t, --title string"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
528 Title for \s-1HTML\s0 table(s). Default value: \fISDFileName\fR. This option is ignored for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
529 multiple input files. And \fB\-r \-\-root\fR option is used to generate appropriate
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
530 titles.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
531 .IP "\fB\-\-titledisplay\fR \fIyes | no\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
532 .IX Item "--titledisplay yes | no"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
533 Display title for \s-1HTML\s0 table(s). Possible values: \fIyes or no\fR. Default value: \fIyes\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
534 .IP "\fB\-w, \-\-workingdir\fR \fIdirname\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
535 .IX Item "-w, --workingdir dirname"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
536 Location of working directory. Default: current directory.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
537 .SH "EXAMPLES"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
538 .IX Header "EXAMPLES"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
539 \&\s-1HTML\s0 table file(s), containing structures, can be used in two different ways: browsing on a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
540 local machine or deployment via a web server. By default, \s-1HTML\s0 file(s) are created for viewing
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
541 on a local machine using Jmol viewer through a browser; however, you can specify any
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
542 supported applet viewer and generate \s-1HTML\s0 file(s) for deploying on a web server.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
543 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
544 First two sets of examples show generation of \s-1HTML\s0 file(s) using different applet viewers
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
545 and a variety of options for local browsing; last set deals with web deployment.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
546 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
547 \&\fBLocal deployment: Usage of default JMol viewer distributed with MayaChemTools:\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
548 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
549 To generate \s-1HTML\s0 tables with structure display using JMol viewer, rows background filled
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
550 with white and light blue colors, navigation links on top and botton of each page, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
551 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
552 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
553 \& % SDFilesToHTML.pl \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
554 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
555 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
556 To generate \s-1HTML\s0 tables with structure display using JMol viewer, rows background filled
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
557 with white and light blue colors, navigation links on top and botton of each page, and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
558 only containing MolWeight and Mol_ID \s-1SD\s0 data fields, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
559 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
560 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
561 \& % SDFilesToHTML.pl \-\-datafields "MolWeight,Mol_ID" \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
562 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
563 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
564 To generate \s-1HTML\s0 tables with \s-1CPK\s0 structure display using JMol viewer, rows
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
565 background filled with white and light blue colors, navigation links on top and botton of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
566 each page, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
567 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
568 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
569 \& % SDFilesToHTML.pl \-\-strviewerparams "script=\e"select *; set frank off;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
570 \& wireframe off; spacefill on\e"" \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
571 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
572 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
573 To generate \s-1HTML\s0 tables with structure display using JMol viewer and black background, rows
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
574 background filled with light golden and greyish colors, navigation links on top and botton of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
575 each page, 10 rows in each table, greyish header row color, and cell spacing of 1, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
576 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
577 .Vb 3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
578 \& % SDFilesToHTML.pl \-o \-n 10 \-\-headeralign "center" \-\-headercolor
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
579 \& "#a1a1a1" \-\-shadecolor "#fafad2,#d1d1d1" \-\-cellspacing 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
580 \& \-\-strviewerparams "bgcolor=#000000" Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
581 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
582 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
583 To highlight molecular weight values using specified highlight criteria and fill in default background
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
584 colors, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
585 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
586 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
587 \& % SDFilesToHTML.pl \-n 10 \-\-highlight "MolWeight,numeric,le,450"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
588 \& \-\-highlightstyle background \-m shadedhighlight \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
589 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
590 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
591 To highlight molecular weight values using specified highlight criteria, color the text using
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
592 default colors, and add a footer message in every page, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
593 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
594 .Vb 3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
595 \& % SDFilesToHTML.pl \-n 4 \-\-highlight "MolWeight,numeric,le,500"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
596 \& \-\-highlightstyle text \-m shadedhighlight \-o
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
597 \& \-\-footer "Copyright (C) MayaChemTools" \-\-cellspacing 1 Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
598 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
599 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
600 To generate tables containing only structures, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
601 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
602 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
603 \& % SDFilesToHTML.pl \-d both \-m shadedstructuresonly \-\-strtablesize "6,4"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
604 \& \-\-cellspacing 1 \-b 1 \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
605 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
606 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
607 To generate tables containing only structures with molecular weight displayed above the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
608 structure, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
609 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
610 .Vb 3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
611 \& % SDFilesToHTML.pl \-d both \-m shadedstructuresonly \-\-strtablesize "6,4"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
612 \& \-\-cmpddatafield "MolWeight,no,top,center" \-\-cellspacing 1 \-b 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
613 \& \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
614 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
615 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
616 To generate tables containing links to structures and highlight molecular weight data field values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
617 using specified highlight criteria , type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
618 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
619 .Vb 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
620 \& % SDFilesToHTML.pl \-n 4 \-\-footer "Copyright (C) MayaChemTools"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
621 \& \-\-highlight "MolWeight,numeric,le,450" \-\-highlightstyle background
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
622 \& \-d both \-m shadedhighlight \-s link \-\-strlinktype button
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
623 \& \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
624 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
625 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
626 \&\fBLocal deployment: Usage of other structure viewers:\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
627 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
628 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
629 \& % SDFilesToHTML.pl \-\-strviewertype MarvinView \-\-strviewerconfig
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
630 \& "<Marvin dir path>" \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
631 \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
632 \& % SDFilesToHTML.pl \-o \-n 10 \-\-headeralign "center" \-\-headercolor
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
633 \& "#a1a1a1" \-\-shadecolor "#fafad2,#d1d1d1" \-\-cellspacing 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
634 \& \-\-strviewerparams "bgcolor=#000000" \-\-strviewertype Chime
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
635 \& Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
636 \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
637 \& % SDFilesToHTML.pl \-n 10 \-\-highlight "MolWeight,numeric,le,450"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
638 \& \-\-highlightstyle background \-m shadedhighlight \-\-strviewertype
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
639 \& Chime \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
640 \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
641 \& % SDFilesToHTML.pl \-d both \-m shadedstructuresonly \-\-strtablesize "6,4"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
642 \& \-\-cellspacing 1 \-b 1 \-strviewertype JME \-strviewerconfig "<JME dir
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
643 \& path>" \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
644 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
645 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
646 \&\fBWeb deployment: Usage of different structure viewers and options:\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
647 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
648 For deploying \s-1HTML\s0 file(s) on a web server, specify a valid \fIcodebase\fR directory name
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
649 relative to <WWWRootDir>. In addition to \fIcodebase\fR, you can also specify \fIarchive\fR file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
650 name.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
651 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
652 .Vb 3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
653 \& % SDFilesToHTML.pl \-m plain \-s display \-\-strviewertype Jmol
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
654 \& \-strviewerconfig "/jmol" \-n 5 \-d both \-r PlainTable \-t "Example
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
655 \& using Jmol: Plain Table" \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
656 \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
657 \& % SDFilesToHTML.pl \-n 5 \-m shade \-s display \-strviewertype JME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
658 \& \-strviewerconfig "/jme,JME.jar" \-r ShadeTable \-t "Example using JME:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
659 \& Shaded Table" \-o Sample.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
660 \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
661 \& % SDFilesToHTML.pl \-n 5 \-\-highlight "MolWeight,numeric,le,450"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
662 \& \-\-highlightstyle background \-d both \-m shadedhighlight \-s display
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
663 \& \-strviewertype MarvinView \-strviewerconfig "/marvin" \-r
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
664 \& ShadedHightlightTable \-t "Example using MarvinView: Shaded and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
665 \& Highlighted Table" \-o Sample.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
666 \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
667 \& % SDFilesToHTML.pl \-n 4 \-\-highlight "MolWeight,numeric,le,450" \-s link
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
668 \& \-\-strlinktype href \-\-strviewertype ChemDrawPlugIn \-\-highlightstyle
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
669 \& background \-m shadedhighlight \-t "Example using ChemDrawPlugIn:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
670 \& Shaded and Highlighted Table" \-r ShadedHightlightTable \-o Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
671 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
672 .SH "AUTHOR"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
673 .IX Header "AUTHOR"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
674 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
675 .SH "SEE ALSO"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
676 .IX Header "SEE ALSO"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
677 FilterSDFiles.pl, InfoSDFiles.pl, SplitSDFiles.pl, MergeTextFilesWithSD.pl
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
678 .SH "COPYRIGHT"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
679 .IX Header "COPYRIGHT"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
680 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
681 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
682 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
683 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
684 MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
685 the terms of the \s-1GNU\s0 Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
686 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
687 any later version.