summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bibarts/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/bibarts/README.txt')
-rw-r--r--macros/latex/contrib/bibarts/README.txt258
1 files changed, 247 insertions, 11 deletions
diff --git a/macros/latex/contrib/bibarts/README.txt b/macros/latex/contrib/bibarts/README.txt
index 701eb35450..9340896db0 100644
--- a/macros/latex/contrib/bibarts/README.txt
+++ b/macros/latex/contrib/bibarts/README.txt
@@ -7,7 +7,7 @@ it requires a program, for which source and Windows executable are provided.
===
-BibArts 2.5 is a LaTeX package to assist in making bibliographical features
+BibArts 2.6 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,
@@ -22,11 +22,11 @@ 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.5 is developed and tested on Windows 10
-with the 2022-06-01 LaTeX 2e distribution, but it should be able to work
+their own C-compiler. BibArts 2.6 is developed and tested on Windows 10
+with the 2022-11-01 LaTeX 2e distribution, but it should be able to work
even with LaTeX 2.09.
- BibArts 2.5 (9 files, 8 dated 2022-10-01):
+ BibArts 2.6 (9 files, 8 dated 2023-06-18):
README.txt This file here: Version history
bibarts.sty The LaTeX style file
ba-short.pdf Short introduction (English)
@@ -64,7 +64,7 @@ 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.5 do *not* change the
+BibArts 2.0 set \footnotesep to 2ex, whereas 2.1 to 2.6 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.
@@ -136,15 +136,16 @@ the homogeneous command \bacorr instead of the four different commands
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
+(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
+was useless with BABEL-German and caused errors with BABEL-French. With
german.sty or ngerman.sty, the use of \originalTeX is still reproduced.
+[... but see BibArts 2.6.]
(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
+- \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 you can use \hyss in all languages;
@@ -208,7 +209,7 @@ utf8enc.dfu from version 2021/01/27 v1.2l to 2021/06/21 v1.2n).
===
-Changes from BibArts version 2.4 (2022[a]) to version 2.5 (now, 2022b):
+Changes from BibArts version 2.4 (2022[a]) to version 2.5 (2022b):
(1) You may now put curly brackets around the \ktit{shortened title}, e.g.:
@@ -262,7 +263,242 @@ changes in utf8enc.dfu from version 2021/06/21 v1.2n to 2022/06/07 v1.3c).
===
+Changes from BibArts version 2.5 (2022b) to version 2.6 (now, 2023):
+
+Version 2.6 improves the use of BibArts with BABEL and UTF-8. For this
+purpose, some commands have been expanded: \baoriginalTeX and \bagermanTeX
+(for reproducing the catcode of " on BibArts' lists), \hy and \fhy (for
+printing a hyphen with a kerning), \abra and \fabra (for editorial additions
+in adjusted square brackets). BibArts 2.6 is checking whether LaTeX
+defines `\inputencodingname' as `utf8'; if not, [f]hy and [f]abra will
+not interpret UTF-8 multi-octets. Commands for compatibility with older
+versions of BibArts are added: \notnewhyko and \notnewabra are downgrading
+BibArts 2.6 to the older interpretation of [f]hy and [f]abra commands.
+
+
+(1) When you print a BibArts list (e.g., if you use \printvli), the list
+items are copies of the arguments of BibArts' commands in your LaTeX text
+file (e.g. \vli{FirstName}{LastName}{Title ...}). If such entries originate
+from environments with *different catcodes* for the double quote [U+0022],
+BibArts will reproduce such changes on its lists (from active " to passive "
+or vice versa). Now, additionally BABEL is supported for this purpose:
+
+(a) BibArts 2.6 tests whether you have loaded BABEL; if NOT, the new BibArts
+estimates (IF the catcode of " changes AND " is USED in a respective entry)
+that german.sty or ngerman.sty is loaded, *and* that the reason is that YOU
+have used \originalTeX, and \germanTeX or \ngermanTeX. So, on BibArts'
+lists, like in older versions, the automatically inserted \baoriginalTeX
+executes \originalTeX, and \bagermanTeX executes \germanTeX or \ngermanTeX.
+
+(b) BABEL's command \originalTeX seems never to change the " catcode, but
+the MEANING of the active double quote: {\originalTeX "`} is printing *two*
+characters. BibArts 2.6 is *not* able to reproduce BABEL's \originalTeX.
+Also BABEL's command \selectlanguage apparently does not change any catcode.
+
+If the catcode of " changes, older BibArts versions since BibArts 2.1 simply
+did nothing when BABEL was loaded. Now, BibArts 2.6 estimates that you have
+used BABEL's commands \shorthandoff{"} respectively \shorthandon{"} in your
+LaTeX file, and BibArts executes both commands on its lists - to reproduce
+the conditions of the place in your text where the entries come from. If
+you have loaded e.g. \usepackage[ngerman]{babel}, or - despite BibArts 2.6
+provides no Dutch captions - \usepackage[dutch]{babel}, you are free to say
+
+ \shorthandoff{"} ... \vli{}{M"uller}{Title} ...
+ \shorthandon{"} ... \vli{}{M"uller}{Title} ...;
+
+and BibArts' sorting program bibsort will detect that: A start of bibsort
+will create two items (instead of one) on the lists (e.g. \printvli); and,
+if you start bibsort with option -g1 to sort [U+00FC] and "u as 'ue', then
+the \shorthandoff{"}-entry is sorted as Muller (BABEL prints a double quote
+character between 'M' an 'u'), whereas the \shorthandon{"}-entry is sorted
+as Mueller (BABEL prints "u as 'ü'): What you see is what is sorted.
+
+(c) Anyway, if it has a different meaning in your LaTeX text file when the
+catcode of " changes, you must still redefine the corresponding BibArts list
+commands. If you have loaded e.g. [n]german.sty, and YOU use \mdqoff and
+\mdqon (instead \originalTeX, and \germanTeX or \ngermanTeX), then define:
+
+ \renewcommand{\baoriginalTeX}{\mdqoff} %No user commands! bibsort inserts
+ \renewcommand{\bagermanTeX}{\mdqon} %\baoriginalTeX and \bagermanTeX.
+
+Such redefinitions, if ordered, will be executed ALWAYS: They OVERWRITE the
+case differentiation between (a) [n]german.sty and (b) BABEL. Together with
+BABEL, \mdqoff and \mdqon are known commands, *if* you have loaded BABEL
+with options [n]german or [n]austrian or [n]swissgerman. Then, \mdqoff and
+\mdqon simply execute \shorthandoff{"} and \shorthandon{"}; and thus all "X
+will be reproduced correctly - with or without both redefinitions.
+
+Commands which are (only) changing catcodes have one problem in common: If
+you place such a command INSIDE THE ARGUMENT of e.g. \footnote{...}, then it
+will not change what footnote text looks like ("u is PRINTED as without the
+command). The decisive catcode is the one which is valid when LaTeX BEGINS
+to read an argument. To achieve an impact, you have to say e.g.:
+
+ \mdqoff ... .\footnote{\vli{}{Harry}{The "Big" Book}[2].}
+ ... .\mdqon \footnote{\vli{}{M"uller}{Title}[3].}
+
+If you, despite, use such commands INSIDE footnote text, then older versions
+reproduced the changed VALUE of the catcode on BibArts' lists (e.g. M"uller
+was printed different on the list than in the footnote). Now, BibArts 2.6
+makes the entry on a BibArts' list look exactly like the arguments of a
+BibArts' command which you use in a footnote. (But there is only a solution
+for active " in BibArts' commands used in footnotes and minipage footnotes.)
+
+(d) The following creates two items on \printvli now instead of three items:
+
+ \shorthandon{"} \vli{}{"`M"'}{}.
+ \shorthandoff{"} \vli{}{"`M"'}{}.
+ \shorthandon{"} \vli{}{"`M"'}{}.
+
+(A use of „M“ = [U+201E]M[U+201C] instead of the German "`M"' creates
+one item; but the distance between M and “ is appropriate in T1, not OT1.)
+
+
+(2) \hy is printing a hyphen ('-') which, in difference to the normal minus
+character, allows to split a following word (word division at the end of a
+line). If \hy is followed by certain characters or letters, there will be a
+kerning additionally. The characters are STILL ` and ', \glq, ), ], \} and
+STILL some Latin letters: A, T, v, V, w, W, x, X, y, Y. That means that
+e.g. \hy T prints -T with a smaller distance between '-' and 'T'. Use \fhy
+instead \hy to prevent a line break between the '-' and following text.
+The kerning is even done when the letter has ONE accent: \", \., \=, \^,
+\', \`, \~, \b, \c, \d, \H, \k, \r, \u, \v, or the ACTIVE ". Now, \t and
+\textcommabelow are new among the accents as well as capital-accents like
+\capitalcedilla; and a kerning is also done in front of \AA, \lq, \grq, \rq,
+and (accent plus) \AE. If \hy or \fhy are in Small Caps, the new BibArts
+2.6 does a kerning in front of \aa as well as (accent plus) \ae, a and t.
+
+\hy and \fhy now accept all equivalent UTF-8 multi-octets, as far as they
+are defined in utf8enc.dfu (2022/06/07 v1.3c); see the list in bibarts.pdf.
+Today, \hy Ärmel [U+00C4] or \hy Ångstrom [U+00C5] etc. are handled in the
+same way as \hy\"Armel or \hy\r{A}ngstrom. Instead of \hy ‘ [U+2018], you
+may also use \hy\textquoteleft or \hy\lq, and instead of \hy ’ [U+2019]
+you may also use \hy\textquoteright or \hy\rq now. Note that there is no
+kerning when \hy is followed by a comma (Ober\fhy, Mittel- und Unter\hy Bau)
+- in difference to \hy\glq Hallo\grq or \hy‚Hallo‘ ([U+201A], [U+2018]).
+
+If ` or ' are ACTIVE, \hy and \fhy, since BibArts 2.6, will insert the same
+kern as in front of the PASSIVE ` or '. With BABEL-activeacute-activegrave-
+catalan, you have to use e.g. \hy\`E or \hy È [U+00C8] instead \hy`E.
+
+It is *not necessary* for you to know whether characters are UTF-8 multi-
+octets: (i) If \hy or \fhy are immediately followed by a letter, then
+braces are never necessary; and if used, such braces simply will switch off
+any kerning. (ii) An accent may always be followed by braces {...}, e.g.
+\hy\"{A}. If you do not know whether you have an UTF-8 multi-octet, it will
+be better to use curly braces, because LaTeX itself WANTS braces in case of
+multi-octets as e.g \b{Ä} [U+00C4] - despite, as mentioned above, \hy and
+\fhy will not perform a kerning if letters have more than one accent.
+
+An error is fixed concerning the hyphenation of a word as e.g. \hy \"Armel
+(with [n]german.sty also \hy "Armel): In *T1*, it now can split at the end
+of a line. (The [n]german-BABEL does not split "Armel, while Ärmel would.)
+
+If you have used older versions of BibArts in one of your existing LaTeX
+text files, you can use BibArts 2.6 and type \notnewhyko. Then \hy and \fhy
+will not handle the new accents and characters; in particular, no kerning is
+done in front of UTF-8 multi-octets; and e.g. \hy\"Armel will not split Är-
+mel at the end of a line: Concerning \hy and \fhy, \notnewhyko starts a
+compatibility mode and any hy-kerning is done as with BibArts 2.5.
+
+\nothyko still switches off the kerning of \hy and \fhy. In *typewriter
+fonts*, where every character (including '-') should have the same width,
+the kerning is switched off automatically since BibArts 2.6. If you use
+\notnewhyko, you still have to set \nothyko in a typewriter environment
+yourself, or you may use the normal minus character there. Also, as in
+older versions, e.g. \hy{}T switches off the kerning between '-' and 'T'.
+
+
+(3) In quotations, you may use e.g. \abra{sic!} for editorial comments and
+for adding characters, which are missing in the text from which you are
+quoting from. On default, BibArts 2.6 CONTINUES to print this additions in
+square brackets, e.g. [sic!]. Use \fabra to prevent a line break between
+the closing bracket and following characters, e.g.: `misspel\fabra{l}ed' =>
+`misspel[l]ed'. Certain arguments automatically are printed in subscript
+or superscript brackets: E.g. ``This is \fabra{`}strange'.'' (where the
+`inner' quotation may represent `...' as well as ``...'' in the original).
+The tiny square brackets cannot be shown here; but size (\tiny) and position
+of those square brackets are adjusted to the size and position of certain
+arguments, e.g.: \abra{.} \abra{,} \abra{-} \abra{...} \abra{\dots}
+
+The new \abra and \fabra also print the corresponding UTF-8 multi-octets in
+such tiny superscript or subscript brackets, e.g. \abra{…} [U+2026].
+Alternatively, you can now use the corresponding LaTeX command, e.g.
+\abra{\textellipsis} - in addition to \abra{\dots}. Today, \abra{“}
+[U+201C] or \abra{\textquotedblleft} - and together with [n]german:
+\abra{"'} or \abra{\grqq} - can be used, each of which prints German right
+quotes in tiny brackets. For more examples see bibarts.pdf (version 2.6):
+"Argumente, bei denen \abra und \fabra angepasste Klammern drucken".
+
+The characters ` ' < > can be active or not; since BibArts 2.6, therefore,
+e.g. \abra{"<} and \abra{">} from [n]german would be accepted with active
+or passive < and > to print French quote characters. BABEL seems to accept
+\glqq, \grqq, \flqq and \frqq as well as \glq, \grq, \flq and \frq ALWAYS;
+so you can use e.g. \abra{\flq} as synonym for \abra{‹} [U+2039] - even if
+\usepackage[UKenglish]{babel} or \usepackage[french]{babel} is loaded.
+
+If you have used older versions of BibArts in your existing LaTeX text files
+before, you can use \notnewabra to avoid a profound change of your existing
+line break: With \notnewabra, only the arguments, which already older
+versions printed in adjusted brackets, will be printed in tiny brackets,
+whereas the `new' arguments will be printed as before (inside normal size
+brackets). But explicit errors will not be reproduced, e.g. concerning
+LaTeX' mathematical mode: In [n]german, BibArts 2.6 prints $\abra{"`}$ and
+$\abra{"'}$ inside normal-sized brackets, whereas BibArts 2.5 did produce an
+error message. In text mode, \abra{"`} and \abra{"'} are STILL printed in
+tiny brackets, but only if both arguments are commands to print double quote
+characters: If BABEL prints "` and "' as two characters, then normal-sized
+brackets [] are printed, regardless of whether you typed \notnewabra or not.
+
+And you now can use e.g. \babbrack{$_{1}$}, $ a\bambrack{\cdot}b=c $, or
+30\batbrack{°} to print the tiny brackets at *b*ottom, *m*edium, or *t*op
+positions directly (but WITHOUT any automatic centring of the argument).
+For symmetry reasons, also \fbatbrack, \fbambrack and \fbabbrack exist.
+
+"french"-BABEL inserts space in front of active two-part punctuation marks.
+If you load \usepackage[french]{babel}, only :;!? are active characters, and
+BibArts will not do anything to reproduce changing catcodes on its lists.
+But BibArts 2.6 now also prints \abra{:}, \abra{;}, \abra{!} and \abra{?}
+with active :;!? as [:], [;], [!] and [?]; also on lists, no extra space is
+inserted (with \notnewabra, still [ :], [ ;], [ !], [ ?] is printed). But
+BibArts 2.6 still does not handle !` and ?`. "french"-BABEL itself has a
+solution, when you can not use \abra{¿} [U+00BF] and \abra{¡} [U+00A1]:
+E.g. {\NoAutoSpacing \abra{?`}}. This seems to work even INSIDE ARGUMENTS.
+
+In difference to e.g. D[a]mpfschifffahrt, LaTeX, at the end of a line, can
+split D\fabra{a}mpfschifffahrt (German word division: D[a]mpf-schiff-fahrt).
+
+In typewriter fonts you can use e.g. \banbrack{.} or \fbanbrack{.} to print
+brackets in *n*ormal size (tiny brackets would have an inappropriate width).
+The arguments of BibArts' ...abra and ...brack commands are always printed
+`upshape', and all, except the `bottom' versions, do an italics correction.
+E.g. \textit{(H.\bahasdot\abra{'})} switches the italics correction off.
+
+If you use BibArts 2.6, you will be able to say \renewcommand{\pabrao}{(}
+and \renewcommand{\pabrac}{)}. This will alter \abra, \fabra, \babbrack,
+\fbabbrack, \bambrack, \fbambrack, \batbrack, \fbatbrack, \banbrack and
+\fbanbrack. Then, e.g. \abra{sic!} will print (sic!) instead of [sic!].
+
+
+(4) bibsort 2.5 with options -g1 and -g2 sorted "i, "I, "e and "E as i, I,
+e and E. In the same case, bibsort 2.6 sorts `active double quote in front
+of letter' as `letter with dieresis' now. Also see NUMGER in bibsort.c.
+
+
+(5) BibArts' support of german.sty 2.4a (1991/04/12, where e.g. ..."'
+expands to ...\active@dq \dq@prtct {'@} in the .toc-file) may end in
+the near future. So, if you have used BibArts together with such very old
+German style files: Keep back a copy of bibarts.sty 2.6. - In difference,
+the support of ngerman.sty v2.5e and german.sty v2.5e (1998/07/08, where
+..."' expands to ...\grmn@active@dq@ ' in the .toc-file) probably
+will continue [[but the support of ...\active@dq \dq@prtct {'} from the
+compatibility mode which is included in v2.5e will probably also END]].
+- Features relating to BABEL will probably be extended.
+
+
+===
+
Published under the terms of the GNU General Public License.
-BibArts 2.5 (2022b):
-(C) Timo Baumann, Versions 2.x (2015-2022)
+BibArts 2.6 (2023):
+(C) Timo Baumann, Versions 2.x (2015-2023)