summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/mciteplus/README
blob: 7618ccbd14a376e4f888bf3a2064862ee8a70d50 (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


September 13, 2013

The mciteplus LaTeX package is an enhanced reimplementation of
Thorsten Ohl's mcite package:

http://www.ctan.org/tex-archive/macros/latex/contrib/mcite/

which provides support for the grouping of multiple citations together
as is often done in physics journals. An extensive set of features
provide for other applications such as reference sublisting.

Mciteplus offers the following features, many of which are not available
with the original mcite:

 1. Entry punctuation can be controlled by the bibstyle (.bst) as well
    as the user.

 2. No "double periods" when an entry already ends with a period
    (e.g., an abbreviated journal name).

 3. Support for sublists.

 4. Support for multiple bibliographies and/or auxiliary files.

 5. The bibliography sample label width is automatically updated to
    account for the changes in the numbering due to the grouped entries.
    Maximum label width information is available to user.

 6. Compatible with the natbib package. (The bibstyle must support both
    mciteplus as well as natbib.)

 7. Compatible with the REVTeX4 class. (The bibstyle must support both
    mciteplus as well as natbib.)

 8. Support for the optional argument of \cite[]{}.

 9. Provides a means to allow users to use almost any cite command via
    custom command wrappers and the ability to manually disable all
    automatic internal hooks.

10. Mciteplus compatible sorting bibstyles are possible via the use of a
    "mcitetail" field in the BibTeX database entries.


Please note that existing mcite bibstyles (.bst files) are not compatible
with mciteplus. They will have to be remodified as explained in the
mciteplus documentation.

See the mciteplus_doc.pdf user manual for full details.

For helpful tips, answers to frequently asked questions and other support,
visit the Mciteplus home page at my website:

http://www.michaelshell.org/tex/mciteplus/


Enjoy!

Michael Shell


*******
Version 1.2 (2013/09/13) changes:

 1) Add support for \citenum of natbib version 8.0 and later.
    Thanks to Joseph Wright for reporting this.

 2) Corrected bug with cross-referenced entries with backref.sty.
    Thanks to Martin Böttcher for reporting this problem.

********************************** Files **********************************

README              - This file.

changelog.txt       - Version history.

mciteplus.sty       - The mciteplus LaTeX package.

mciteplus_doc.pdf   - The mciteplus user manual.

mciteplus_doc.tex   - LaTeX source code for the user manual.

mciteplus_code.txt  - Selected .bst modification and other code listings.

apsrevM.bst         - An mciteplus compatible version of REVTeX4's 
                      apsrev.bst.

apsrmpM.bst         - An mciteplus compatible version of REVTeX4's 
                      apsrmp.bst. Note: This is a sorting style. For it to
                      work properly, you must set the "mcitetail" BibTeX
                      database field for every tail entry.

IEEEtranM.bst       - An mciteplus compatible version of IEEEtran.bst.

IEEEtranMN.bst      - An mciteplus compatible version of IEEEtranN.bst
                      (natbib compatible).

***************************************************************************
Legal Notice:
This code is offered as-is without any warranty either expressed or
implied; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE!
User assumes all risk.
In no event shall any contributor to this code be liable for any damages or
losses, including, but not limited to, incidental, consequential, or any
other damages, resulting from the use or misuse of any information contained
here.

All comments are the opinions of their respective authors.

This work is distributed under the LaTeX Project Public License (LPPL)
( http://www.latex-project.org/ ) version 1.3, and may be freely used,
distributed and modified. A copy of the LPPL, version 1.3, is included
in the base LaTeX documentation of all distributions of LaTeX released
2003/12/01 or later.
Retain all contribution notices and credits.
** Modified files should be clearly indicated as such, including  **
** renaming them and changing author support contact information. **

File list of work: mciteplus.sty, mciteplus_doc.pdf, mciteplus_doc.tex,
                   mciteplus_code.txt, apsrevM.bst, apsrmpM.bst,
                   IEEEtranM.bst, IEEEtranMN.bst

***************************************************************************