summaryrefslogtreecommitdiff
path: root/biblio/bibtex/utils/isi2bibtex/manual.htm
blob: 3e7be5a758aa75052b13eca428980d8a1fdc9d88 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
<HTML>
<HEAD>
<TITLE>isi2bibtex - convert ISI database files to BibTeX format</TITLE>
<LINK REV="made" HREF="mailto:">
</HEAD>

<BODY>

<!-- INDEX BEGIN -->

<UL>

	<LI><A HREF="#NAME">NAME</A></LI>
	<LI><A HREF="#SYNOPSIS">SYNOPSIS</A></LI>
	<LI><A HREF="#DESCRIPTION">DESCRIPTION</A></LI>
	<UL>

		<LI><A HREF="#Options">Options</A></LI>
		<LI><A HREF="#Input_databases">Input databases</A></LI>
		<LI><A HREF="#Input_formats">Input formats</A></LI>
		<LI><A HREF="#Output_fields">Output fields</A></LI>
		<LI><A HREF="#Output_formatting">Output formatting</A></LI>
	</UL>

	<LI><A HREF="#DOESN_T_WORK_">DOESN'T WORK?</A></LI>
	<UL>

		<LI><A HREF="#Unix">Unix</A></LI>
		<LI><A HREF="#Microsoft_Windows">Microsoft Windows</A></LI>
		<LI><A HREF="#Other_platforms">Other platforms</A></LI>
	</UL>

	<LI><A HREF="#KNOWN_PROBLEMS">KNOWN PROBLEMS</A></LI>
	<LI><A HREF="#SEE_ALSO">SEE ALSO</A></LI>
	<LI><A HREF="#COPYRIGHT">COPYRIGHT</A></LI>
	<LI><A HREF="#FILES">FILES</A></LI>
	<LI><A HREF="#VERSION">VERSION</A></LI>
</UL>
<!-- INDEX END -->

<HR>
<P>
<HR>
<H1><A NAME="NAME">NAME</A></H1>
<P>
isi2bibtex - convert ISI database files to BibTeX format

</P>
<P>
<HR>
<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
<P>
<STRONG>isi2bibtex</STRONG> [<STRONG>OPTIONS</STRONG>] <STRONG>inputfile</STRONG> [<STRONG>outputfile</STRONG>]

</P>
<P>
If no output file is specified, inputfile.bib is used.

</P>
<P>
Records are appended if the output file exists.

</P>
<P>
<HR>
<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
<P>
Isi2bibtex converts an ISI (Institute for Scientific Information)
bibliographic database file to a BibTeX file for use in TeX and LaTeX
documents. Both formats hold bibliographic data on scientific and other
academic documents.

</P>
<P>
(In the UK, the ISI databases are commonly known as 'BIDS' or 'MIMAS WoS')

</P>
<P>
Another way to do the same job isi2bibtex does is with bp, which has the
advantage of converting between many different bibliographic formats and
character sets. If you don't want that, isi2bibtex understands BIDS
standard format in addition to the others, and is stand-alone and so
presumably easier to get working.

</P>
<P>
<HR>
<H2><A NAME="Options">Options</A></H2>
<P>
<STRONG>-h</STRONG>, <STRONG>--help</STRONG> display help and exit

</P>
<P>
<STRONG>-v</STRONG>, <STRONG>--version</STRONG> display version information and exit

</P>
<P>
<STRONG>-q</STRONG>, <STRONG>--quiet</STRONG> no informational output

</P>
<P>
<STRONG>-a</STRONG>, <STRONG>--abstract</STRONG> include abstract in output file

</P>
<P>
<STRONG>-c</STRONG>, <STRONG>--check</STRONG> make some checks on field contents (default)

</P>
<P>
<STRONG>-n</STRONG>, <STRONG>--nocheck</STRONG> don't make checks on field contents

</P>
<P>
<HR>
<H2><A NAME="Input_databases">Input databases</A></H2>
<P>
Although isi2bibtex was written for SCI (Science Citation Index), all the
ISI databases should work (SCI, SSCI, A&amp;HCI, ISTP). Isi2bibtex will
probably make a bad job of editing the content of these other databases,
and would have to be changed a bit (not difficult), but you may be lucky.

</P>
<P>
In the UK, probably most of the other databases on BIDS should work either
straight away or with a small amount of modification of the script. BIDS
Pascal for instance works with downloading format, and would work with a
small amount of modification with standard format.

</P>
<P>
<HR>
<H2><A NAME="Input_formats">Input formats</A></H2>
<P>
If you use a web interface to ISI, isi2bibtex will only convert text output
(whether emailed or saved directly), not saved web pages or other
bibliography formats such as Procite or Reference Manager. Specifically,
the formats that are understood are:

</P>
<P>
ISI generic output format version 1.0:

</P>
<P>
I presume this is the format used in most of the world. In the UK, this is
output by MIMAS WoS 'save records' or 'email records'.

</P>
<P>
BIDS standard format:

</P>
<P>
(any of: Title only; Title, authors &amp; journal; Full record excluding
citations; Full record)

</P>
<P>
BIDS downloading format:

</P>
<P>
(any of: Title, authors &amp; journal in downloading format; Full record in
downloading format)

</P>
<P>
You can mix and match record formats in one file. Deleting fields and / or
record numbers from records should be okay. Any fields may be present in
any order. Don't change the indentation of records: isi2bibtex will ignore
records if they're too different from the usual layout due to ambiguity of
field labels and field contents.

</P>
<P>
<HR>
<H2><A NAME="Output_fields">Output fields</A></H2>
<P>
For ISI generic format (eg MIMAS WoS output) and BIDS downloading format,
fields other than title (TI), author (AU), source ie journal (SO), page
range (BP, EP), year (PY) and abstract (AB) are ignored.

</P>
<P>
For standard BIDS format, fields other than Title (TI:), author (AU:),
journal (JN:) and abstract (AB:) are ignored (the JN: field contains the
page numbers, volume, date, etc as well as the journal name).

</P>
<P>
At the moment isi2bibtex only outputs the more useful fields, but this may
change in the future (when someone gets round to it). Which fields are
output can be controlled with a configuration file (see below). Those that
don't correspond to the standard BibTeX fields (such as abstract) won't be
recognised by BibTeX by default, but they'll be there if you need to use
them.

</P>
<P>
<HR>
<H2><A NAME="Output_formatting">Output formatting</A></H2>
<P>
Output is tidied up as much as possible, but some editing is still
required.

</P>
<P>
Output formatting defaults can be modified with a configuration file.
/etc/isi2bibtexrc and ~/.isi2bibtexrc (or whatever you set in the
<CODE>@CONFIG</CODE> variable in the script) are looked at in that order
for configuration settings, with the latter overriding the former. See the
example configuration file provided.

</P>
<P>
If they are switched on, things like journal title abbreviations and
acronym capitalisations can be added and removed at the end of the script
(very easy to do by looking at what's there already). Newer ISI entries
have lower case as well as upper, and isi2bibtex always leaves the
capitalization as-is for those records.

</P>
<P>
<HR>
<H1><A NAME="DOESN_T_WORK_">DOESN'T WORK?</A></H1>
<P>
Remember to:

</P>
<P>
<HR>
<H2><A NAME="Unix">Unix</A></H2>
<P>
set the first line of this script to point to your copy of perl (eg.
/usr/bin/perl or /usr/local/bin/perl)

</P>
<P>
make it executable (eg. chmod +x ./isi2bibtex)

</P>
<P>
put it somewhere your OS can find it (eg ~/bin or /usr/local/bin): you may
need to change your PATH environment variable

</P>
<P>
<HR>
<H2><A NAME="Microsoft_Windows">Microsoft Windows</A></H2>
<P>
change the name of this script to isi2bibtex.pl (you'll have to use it as

</P>
<P>
isi2bibtex.pl [OPTIONS] inputfile.txt outputfile.bib

</P>
<P>
rather than

</P>
<P>
isi2bibtex [OPTIONS] inputfile.txt outputfile.bib

</P>
<P>
because the windows DOS shell doesn't know about the #! line)

</P>
<P>
put it in your Perl bin directory, eg C:\Perl\bin (obviously if you don't
have perl installed, you need to do that first: see below)

</P>
<P>
if that doesn't work check the PATH environment variable contains your perl
bin directory, and as a last resort try

</P>
<P>
<PRE>    perl C:\Perl\bin\isi2bibtex.pl inputfile.txt
</PRE>
</P>
<P>
<HR>
<H2><A NAME="Other_platforms">Other platforms</A></H2>
<P>
I have no idea, but it should work on any platform that runs Perl 5,
perhaps with a few small modifications. Isi2bibtex has been tested on
Windows (95 and NT) and Unix. Please send me any portability changes.

</P>
<P>
Email &lt;<A HREF="mailto:jjl@pobox.com" jjl@pobox.com</A>&gt;
if it still doesn't work.

</P>
<P>
<HR>
<H1><A NAME="KNOWN_PROBLEMS">KNOWN PROBLEMS</A></H1>
<P>
It only does articles, not books, proceedings etc, and won't notice if a
record isn't an article.

</P>
<P>
It ignores some fields (mostly those that don't correspond to the standard
BibTeX 'article' fields).

</P>
<P>
ISI access providers' output other than BIDS and MIMAS WOS haven't been
tested. Send me an output file and I'll make it work with that format (for
SCI).

</P>
<P>
Please tell me about any bugs you find, at &lt;<A
HREF="mailto:jjl@pobox.com">jjl@pobox.com</A>&gt;

</P>
<P>
<HR>
<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
<P>
If you don't have Perl installed, it can be got (free) from <A
HREF="http://www.perl.com/">http://www.perl.com/</A> . LaTeX, BibTeX and
everything else TeX can be downloaded from <A
HREF="http://www.CTAN.org/">http://www.CTAN.org/</A> .

</P>
<P>
bp converts between many bibliography database formats (including
conversion from BIDS downloading and ISI generic formats to BibTeX), and
many character sets.

</P>
<P>
Ben Bolker (author of the BIDS / MIMAS WOS specification for bp) has a page
describing his modifications to bp:

</P>
<P>
<A
HREF="http://www.zoo.ufl.edu/bolker/bp.html">http://www.zoo.ufl.edu/bolker/bp.html</A>


</P>
<P>
Dana Jacobsen (author of bp) has a web page with lots of bibliography
software information and details of his bp package:

</P>
<P>
<A
HREF="http://www.ecst.csuchico.edu/~jacobsd/bib/index.html">http://www.ecst.csuchico.edu/~jacobsd/bib/index.html</A>


</P>
<P>
Some other BibTeX utilities that may or may not be useful (these are just
the ones I've got round to looking at):

</P>
<P>
bibclean checks and formats BibTeX databases

</P>
<P>
bibsort sorts BibTeX databases

</P>
<P>
bib2dvi converts BibTeX databases to DVI files (DVI files are output by
LaTeX and are DeVice Independent typeset documents, a bit like postscript
or pdf -- you can read them on most computer systems)

</P>
<P>
bibextract, citefind and citetags respectively extract BibTeX records from
a BibTeX database, extract LaTeX references from a LaTeX document, and look
up LaTeX references in a BibTeX database.

</P>
<P>
bibindex makes an index for fast lookup by biblook, if you have a huge
database that needs it I suppose

</P>
<P>
BibTool is an all-singing all-dancing general purpose BibTeX management
utility

</P>
<P>
bibview is a simple interactive searching utility for BibTeX files

</P>
<P>
findbib gets BibTeX records corresponding to references in a LaTeX file
from a preprint server (don't know if it still works)

</P>
<P>
both refer2bibtex and r2bib convert refer files (whatever they are) to
BibTeX files

</P>
<P>
tkbibtex is a graphical tool for editing and searching BibTeX databases

</P>
<P>
Text::BibTeX is a Perl module for doing things to BibTeX databases.

</P>
<P>
<HR>
<H1><A NAME="COPYRIGHT">COPYRIGHT</A></H1>
<P>
Copyright (C) 2000 Jonathan Swinton, Ben Bolker, Anthony Stone, John J. Lee

</P>
<P>
Isi2bibtex replaces and is derived from bids.to.bibtex (as of 29 Jan 1998)
and isi2bib 0.1.

</P>
<P>
bids.to.bibtex was based on a perl script written by Jonathan Swinton, and
subsequently modified by Ben Bolker and Anthony Stone.

</P>
<P>
isi2bib 0.1 was written by John J. Lee &lt;<A
HREF="mailto:jjl@pobox.com">jjl@pobox.com</A>&gt;

</P>
<P>
This script is covered by the GPL. See the script for copyright
information.

</P>
<P>
<HR>
<H1><A NAME="FILES">FILES</A></H1>
<P>
/etc/isi2bibtexrc, ~/.isi2bibtexrc (or whatever you set in the
<CODE>@CONFIG</CODE> variable) are looked at in that order for default
configuration settings, with the latter overriding the former. See the
example configuration file provided.

</P>
<P>
<HR>
<H1><A NAME="VERSION">VERSION</A></H1>
<P>
0.40

</P>

</BODY>

</HTML>