summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bibarts/README.txt
blob: 8fbb2c100f5d25abc26ffc129efddfbe040fab50 (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

BibArts is a package to administer bibliographical references in footnotes,
and for creating a bibliography from these references simultaneously;
it requires a program, for which source and Windows executable are provided. 
(A summary of contents is in English; the full documentation is in German.)


===

BibArts 2.4 is a LaTeX package to assist in making bibliographical features
common in the arts and humanities (history, political science, etc.).
bibarts.sty provides commands for quotation, register keywords, 
abbreviations, and especially for a formatted citation of literature, 
journals (periodicals), published documents, and unpublished archive 
documents.

BibArts will also copy the arguments of all those commands into lists for an
automatically generated appendix.  These lists are optionally referring to
page and footnote numbers in your text (index).  BibArts has nothing to do
with BibTeX, and it does not use any data bank except your own LaTeX text.

The lists are created by bibsort.  A file bibsort.exe is part of the package
( CTAN mirrors > BibArts > bibarts.zip ) and runs on newer Windows systems.
Other users first have to create a binary file from bibsort.c (ANSI-C) with
their own C-compiler.  BibArts 2.4 is developed and tested on Windows 10
with the 2021-11-22 LaTeX 2e distribution, but it should be able to work
even with LaTeX 2.09.

 BibArts 2.4 (9 files, 8 dated 2022-01-10):
  README.txt     This file here
  bibarts.sty    The LaTeX style file
  ba-short.pdf   Short introduction (English)
  ba-short.tex   Source of ba-short.pdf
  bibarts.pdf    Full documentation (German)
  bibarts.tex    Source of bibarts.pdf
  bibsort.exe    Binary to create the lists
  bibsort.c      Source of bibsort.exe
  COPYING        License (dated 1993-11-28)


===

Changes from BibArts versions 1.x (1990s) to versions 2.x:

Version 2.0 was a completely new package with massive extensions.  Since,
bibarts.sty helps to use slanted fonts (italics), and is able to set ibidem
automatically in footnotes.  Therefore, it is now possible to add volume and
page numbers e.g. to the \vli command (\vli did also exist in 1.x for full
references to literature), and the new \kli command (shortened references).
Pre-defined text elements (captions) are provided as \bacaptionsenglish,
\bacaptionsfrench, and \bacaptionsgerman (default).

bibsort 2.x creates the index numbers (BibArts 2.x does not use MakeIndex).

bibarts.sty 2.x starts an emulation for 1.3 texts, when you type \makebar,
but you better keep copies of the package files of a BibArts 1.x, if you
wrote texts with it.  BibArts 2.x uses .aux files instead of a .bar file.
Even if you set \makebar, any changes to commands \schrift, \barschrift, and
\indschrift will be ignored.  \verw and \punctuation do not exist any more;
see examples for the new commands \frompagesep and \ntsep in bibarts.pdf.


===

Changes from BibArts version 2.0 (2015) to version 2.1 (2016):

BibArts 2.0 set \footnotesep to 2ex, whereas 2.1 to 2.4 do *not* change the
pre-set value.  If you want to continue with the 2.0-distance between two
footnotes, you will have to type \setlength{\footnotesep}{2ex} in your text.

Some of the pre-defined text elements (captions) have been modernized.  The 
\evkctitlename changed from {Short Titles} to {Shortened References}.  And
\gannouncektitname changed to "... im Folgenden".  To restore its 2.0 def.:
\renewcommand{\gannouncektitname}{ (\kern 0.015em im folgenden \baupcorr}

bibarts.sty will even be loaded, if ~":;!?'`<> are active (catcode 13); and
bibsort -g1, and  bibsort -g2  are sorting "z (with an active ") as \ss now.

You now may choose your own order of page and footnote numbers in the index
(roman--arabic, arabic--roman, etc.).  Type  bibsort -s2 xxxx  for page and
... -f2 xxxx  for footnote numbers.  xxxx  are permutations of 4 letters
out of  nRrAas  (a=alph, A=Alph, n=arabic, R=Roman, r=roman, s=fnsymbol);
you always have to set n and s, and to choose R *or* A, and r *or* a.  E.g.
srnR  means, that you can use \Roman in your text, but you do not have to.

bibsort is able to evaluate the new fnsymbols (which expand to \TextOrMath).

If bibsort should write into files with a different prefix as the .aux input
file, you have to use -o <outfile> now.  And you may type  bibsort <infile>,
*or*  bibsort -i <infile>  (e.g. when the input file name begins with '-').

bibsort sorts the 'official' $Greek variables$ since version 2.0.  To write
single words in Old Greek, BibArts 2.1 also provides \Alpha [A], \Beta [B],
\Epsilon [E], \Zeta [Z], \Eta [H=sort=>E], \Iota [I], \Kappa [K], \Mu [M], 
\Nu [N], \Rho [P==>R], \Tau [T], \Chi [X==>Ch], \Omicron [O], \omicron [o].


===

Changes from BibArts version 2.1 (2016) to version 2.2 (2019):

(1)  bibsort, the sorting program of the package, has 3 new options:

Use   bibsort -h [...]   to sort hyphens  ( - \hy \fhy "= "~ )  as spaces.

Use   bibsort -b [...]   to begin the sorting of the title at \bago, e.g.:
       \vli{J.}{Smith}{The \bago \ktit{Book}, London 2005}

      bibsort -n1 [...]   will create blocks of footnote numbers only, if
the entries are from footnotes on the same page, e.g.:  10^{3-6}, 11^{7-9}
instead of 10^{3}--11^{9}.

(2)  If there are two entries of  \kli{Smith}{Book}  from two successive
pages, but with *the same* footnote number, bibsort will print out
e.g.  10^{3}, 11^{3} .  bibsort 2.0 and 2.1 ignored  11^{3}  in that case.

(3)  bibsort checks your input concerning the \ktit{Shortened Title}.
You will find warnings on the screen and as comments in the created files.

(4)    \vli{J.}{Smith}{The \ktit{\onlyvoll{r}\onlykurz{R}ed Book}, 2006}
has to be used (for index and ibidem), if the shortened title is not just
a part of the full title ("red" and "Red").  In some cases, bibsort 2.1
printed out wrong only-arguments on the lists.  This error has been fixed.
And errors in the sorting of entries with only-commands were eliminated.

(5)  You may say now  \renewcommand{\ntsep}{\bapoint\ }  to print out a
full stop between name and title; BibArts is avoiding e.g. "Smith, J..".

(6)  If you '\renewcommand' a pre-defined text element (caption), you
sometimes will have to adapt the italic correction.  Bibarts provides
the homogenous command  \bacorr  instead of the four different commands
\bakxxcorr, \baabkcorr, \balistcorr, and \bakntsepcorr  (but those old
commands are still valid).  To print the lists, you may say now e.g.:
       \renewcommand{\frompagesep}{\bacorr ; } \printnumvli \printnumvkc

(7)  If you use babel, BibArts will not execute \originalTeX between
list items (that's prepared by bibsort, if the catcode of " changes):  It
was useless with germanb-babel and caused errors with french-babel.  With
german.sty or ngerman.sty, the use of \originalTeX is still reproduced.

(8)  bibarts.sty provides new commands for the hyphenation in German:
- \oldhyss to set a \ss, which is splitted s-s (to be used between vovels,
  e.g. au\oldhyss er; you have to use your sharp S else, e.g. da{\ss});
- \newhyss to set a \ss, which is splitted s-s only in small caps, and
  else is printing a sharp S, which is splitted as \language says (-\ss);
- \hyss to execute \oldhyss, if \language is \l@german, and \newhyss else
  (e.g. if \language is \l@ngerman --- so, \hyss can be used *always*);
- commands for the handling of "tripple consonant before vovel" in German:
  E.g. Sto\hyf figur, Scha\hyl leistung, Sta\hym mutter, Ke\hyn nummer,
  Ste\hyp pullover, Sta\hyr rahmen, and Schri\hyt tempo:  If \language is
  \l@german, BibArts will PRINT AND SORT \hyf as f, and ELSE as ff, etc.
+ All commands are ready to be used in \MakeUppercase (also Dru\hyc ker).

(9)  If you \conferize, e.g. \kli{A}{B} will print a cross-reference to
\vli{}{A}{\ktit{B}}.  The INTERNAL KEYWORD is created from the letters,
and some accents you use in {A} and {B}.  The accents are REPRESENTED as
\`=[  \'=]  \"=*  \ss=(ss  \l=(l  \L=(L  \o=(o  \O=(O  \^=)  \~=-  \c=+
in the keyword.  The active " and \= \. \b \d are not represented any more.


===

Changes from BibArts version 2.2 (2019) to version 2.3 (2021):

There have been two new options for bibsort:


 -utf8  sorts UTF8 characters as definded in utf8enc.dfu 2021/01/27 v1.2l,
        except \cyr...- and \CYR...-commands, which bibsort still ignores.
        bibsort is able to sort the accent \textcommabelow (parallel to
        U+0218 to U+021B).  The internal representation of accents did
        change (two instead of one ASCII 1 to 31).  For numerous smaller
        changes see /* 2.3 comments */ in bibsort.c.


        Like in earlier versions, you can introduce e.g. a book in your text
          \xvli{John}{Smith} *{\vauthor{Peter}{Young}} {... [Title] ...}
        with Peter Young as co-author.  (For further co-authors, use
          \midvauthor{FirstName}{LastName}
        in front of \vauthor.)  Please always TYPE the FirstName first.
        If you start bibsort without -e, \printvli will still print lists as:
          Smith, John / Peter Young: ... [Title] ...

    -e  exchanges the PRINT ORDER of the args of \vauthor (and \midvauthor).
        In your text, \printvli then will PRINT the List of Literature as:
          Smith, John / Young, Peter: ... [Title] ...

        The SORT ORDER in *both* cases is (that did/does *not* change):
          Smith John Young Peter


===

Changes from BibArts version 2.3 (2021) to version 2.4 (now, 2022):

An error was fixed concerning "inner v-commands" on the List of Literature,
and the List of Published Documents:  In shortened "inner" references, 
BibArts 2.3 -- together with bibsort -e ... -- printed the first names of
co-authors.  Now, such shortened references only print the family names.

bibsort now knows ten new utf8-characters (parallel to the changes in
utf8enc.dfu from version 2021/01/27 v1.2l to 2021/06/21 v1.2n).


===

Published under the terms of the GNU General Public License. 

BibArts 2.4 (2022):
(C) Timo Baumann, Versions 2.x (2022, 2021, 2019, 2016, 2015)