lib/citeengines/biblatex-natbib.citeengine

   1 # \DeclareLyXCiteEngine[biblatex.sty]{Biblatex (natbib mode)}
   2 # DescriptionBegin
   3 #   This Biblatex variety emulates the Natbib citation commands and
   4 #   thus is best suited for switching from Natbib (or the pre-LyX 2.3
   5 #   Biblatex workaround) to Biblatex.
   6 #   The natbib mode supports slightly different and a few more styles
   7 #   than normal Biblatex. As with normal Biblatex, the use of 'biber'
   8 #   as Bibliography processor is advised.
   9 # DescriptionEnd
  10
  11 # Author: Jürgen Spitzmüller <spitz@lyx.org>
  12
  13 Format 64
  14
  15 Requires biblatex
  16
  17 PackageOptions biblatex natbib=true
  18
  19 # The framework (biblatex|bibtex)
  20 CiteFramework biblatex
  21
  22 # Cite style variants (default|authoryear|natbib)
  23 # We provide both authoryear and numerical citations
  24 CiteEngineType authoryear|numerical
  25
  26 # Default style files for either engine type
  27 DefaultBiblio  authoryear:authoryear|numerical:numeric
  28
  29 # Maximum number of names before "et al." chimes in
  30 MaxCiteNames 3
  31
  32
  33 # The syntax of the cite command definitions below is:
  34 # LyXName|alias*<!_stardesc!_stardesctooltip>[][]=latexcmd
  35 #
  36 # * LyXName:  The LyX name as output in the LyX file. For
  37 #             portability reasons, we try to use the same
  38 #             name for same-formatted commands in the
  39 #             different engines (thus many names stem from
  40 #             natbib).
  41 # * Alias:    A (comma-separated) list of commands that fall
  42 #             back to the given LyX name in the current engine.
  43 #             This is a bit like "ObsoletedBy" in the layouts.
  44 # * latexcmd: The actual LaTeX command that is output.
  45 #
  46 # Alias and latexcmd are optional. If no latexcmd is given, the
  47 # LyXName will be output to LaTeX.
  48 #
  49 # Note further:
  50 #
  51 # * The LyXName "keyonly" has a special meaning: only the citation key,
  52 #   without any latex command, is output.
  53 # * Capitalization indicates that the command also has a capitalized
  54 #   form (\Latexcmd vs. \latexcmd). These usually enforce upcasing of
  55 #   name prefixes (von Goethe => Von Goethe).
  56 # * Brackets [] indicate the number of optional arguments (0, 1, 2).
  57 # * The star * indicates there is a starred version of the command
  58 #   (\latexcmd* vs. \latexcmd). By default, the starred version means:
  59 #   Expand the author list even if the maxnames setting would cause
  60 #   BibTeX/Biber to shorten it with "et al.".
  61 #   If the star has a different meaning for a command, it can be
  62 #   specified in angle brackets: <!_stardesc!_stardesctooltip>.
  63 #   Maximal two translatable macro keywords, marked by the prefix '!_',
  64 #   can be given. The first points to the string that replaces the
  65 #   "Full aut&hor list" checkbox label in the Citation dialog, the
  66 #   second one an optional tooltip for this checkbox. Note that these
  67 #   two macros have to be defined in the CiteFormat section (see below),
  68 #   dropping the '!' from the prefix (see below), e.g.:
  69 #   _stardesc Starred command label
  70 #   _stardesctooltip Tooltip for the starred command checkbox.
  71 # * A trailing $ indicates that a command features "qualified citation
  72 #   lists" (a specific Biblatex feature)
  73
  74 #
  75 # CITE COMMAND DEFINITIONS for either engine type
  76 #
  77 # We support the same cite command as natbib
  78 # and add biblatex citation commands on top.
  79
  80 CiteEngine authoryear
  81         Citet|textcite*[][]
  82         Citep|parencite*[][]
  83         Citealt|cite*[][]
  84         Citealp*[][]
  85         Citeauthor*[][]
  86         citeyearpar[][]
  87         citeyear=cite*
  88         citebyear[][]=citeyear
  89         Footcite$[][]=smartcite
  90         Autocite$[][]
  91         citetitle*<!_citetitlestar!_citetitlestartooltip>[][]
  92         fullcite[][]
  93         footfullcite[][]
  94         nocite
  95         keyonly
  96 End
  97
  98 CiteEngine numerical
  99         Citep|citealp,citealt*[][]
 100         Citet|textcite*[][]
 101         supercite
 102         Footcite$[][]=smartcite
 103         Autocite$[][]
 104         Citeauthor[][]*
 105         citeyearpar[][]
 106         citeyear|citebyear[][]
 107         citetitle*<!_citetitlestar!_citetitlestartooltip>[][]
 108         fullcite[][]
 109         footfullcite[][]
 110         nocite
 111         keyonly
 112 End
 113
 114
 115 #
 116 # CITE FORMAT
 117 #
 118
 119 # The following defines how the commands are represented in the GUI
 120 # (inset button and citation dialog) as well as in XHTML, docbook and
 121 # plain text output.
 122 #
 123 # There are common definitions (default) and specific definitions for
 124 # either cite engine type (which overwrite existing defaults.
 125 #
 126
 127 # Input standard format definitions for the bibliography
 128 Input stdciteformats.inc
 129
 130 CiteFormat default
 131         #
 132         # MACROS
 133         #
 134         # 1. Translatable bits (need to be marked by _ prefix)
 135         #    Note that preceding and trailing spaces matter.
 136         #
 137         _notcited not cited
 138         _addtobib Add to bibliography only.
 139         _keyonly Key only.
 140         _key Key
 141         _finaland , and
 142         _footnote Footnote
 143         _foot Foot
 144         _fullcite bibliography entry
 145         _bibentry Full bibliography entry.
 146         _autocite Autocite
 147         _auto Auto
 148         # GUI strings for the starred commands
 149         _citetitlestar F&orce full title[[Possible substitute to All aut&hors]]
 150         _citetitlestartooltip Use full title even if shorttitle exists
 151         # The following are handled by BiblioInfo
 152         _etal  et al.
 153         _namesep , [[separate author names in citation, except for last name]]
 154         _lastnamesep , and [[separate name of last author in citation]]
 155         _pairnamesep  and [[separate two authors in citation]]
 156
 157         #
 158         # 2. Macros re-used in the style definitions
 159         #
 160         # NOTE: Year is always in parens, also in numerical style
 161         !yearopen (
 162         !yearclose )
 163
 164         # A dummy year modifier. This just indicates that a modifier might be output,
 165         # to differentiate \cite* and \citeyear
 166         !dummymod [a]
 167
 168         # A link that lets us jump to the bibliography entry in LyXHTML
 169         # %clean:key% will be substituted by the cite key to give a unique id
 170         !startlink {!<a href='#LyXCite-%clean:key%'>!}
 171         !endlink {!</a>!}
 172
 173         # Add " , and " before the last item (but " and " if there are only two), else ", "
 174         !smartsep {%second%[[{%next%[[%_namesep%]][[%_pairnamesep%]]}]][[{%next%[[%_namesep%]][[%_lastnamesep%]]}]]}
 175
 176         # "Author et al." or "??"
 177         !abbrvciteauthor {%abbrvciteauthor%[[%abbrvciteauthor%]][[??]]}
 178         # "Author, ..." or "??"
 179         !fullciteauthor {%fullciteauthor%[[%fullciteauthor%]][[??]]}
 180         # Handle starred command: abbr. or full author list
 181         !makeauthor {%ifstar%[[%!fullciteauthor%]][[%!abbrvciteauthor%]]}
 182         # "prenote "
 183         !textbefore {%textbefore%[[%textbefore% ]]}
 184         # ", postnote"
 185         !textafter {%textafter%[[, %textafter%]]}
 186         # "prenote " (for qualified lists)
 187         !ctextbefore {%curpretext%[[%curpretext% ]]}
 188         # ", postnote" (for qualified lists)
 189         !ctextafter {%curposttext%[[, %curposttext%]]}
 190         # Add a year if it exists (else "??") and possibly a modifier (as in 2017a)
 191         !makeyear {%year%[[%year%]][[??]]}{%modifier%[[%modifier%]]}
 192         # Add a year if it exists (else "??") and indicate a possible modifier (as in 2017[a])
 193         !myear {%year%[[%year%]][[??]]}{%modifier%[[%modifier%]][[{%export%[[]][[%!dummymod%]]}]]}
 194         # Add a year if it exists (else "??") without any modifier at all
 195         !byear {%year%[[%year%]][[??]]}
 196         # Add a shorttitle or title if it exists (else "??")
 197         !makeshorttitle {%shorttitle%[[%shorttitle%]][[{%title%[[%title%]][[??]]}]]}
 198         # Add a title (or "??")
 199         !maketitle {%ifstar%[[{%title%[[%title%]][[??]]}]][[%!makeshorttitle%]]}
 200         # "cf. Key..."
 201         !fullcite %bibentry%%!nextfullcite%
 202
 203         # "...; Author..."
 204         !nextauthor {%next%[[%!sep% %!startlink%%!makeauthor%%!endlink%%!nextauthor%]]}
 205         # "..., CiteKey..."
 206         !nextkey {%next%[[%!sep% %key%%!nextkey%]]}
 207         # ".., Year..." (including extra label, as in 2017a)
 208         !nextyear {%next%[[%!sep% %!startlink%%!makeyear%%!endlink%%!nextyear%]]}
 209         # "...; Nextyear ..." (including emulated extra label, as in 2017[a])
 210         !nextmyear {%next%[[%!sep% %!startlink%%!myear%%!endlink%%!nextmyear%]]}
 211         # "...; Nextyear ..." (without any extra label)
 212         !nextbyear {%next%[[%!sep% %!startlink%%!byear%%!endlink%%!nextbyear%]]}
 213         # "...; Nexttitle ..."
 214         !makenexttitle {%next%[[%!sep% %!startlink%%!maketitle%%!endlink%%!makenexttitle%]]}
 215         # "...; NextKey..."
 216         !nextfullcite {%next%[[%!sep% %bibentry%%!nextfullcite%]]}
 217
 218         #
 219         # ACTUAL STYLE DEFINITIONS
 220         #
 221         # (identical in authoryear and numerical)
 222         #
 223
 224         # "cf. Author; NextAuthor, p. xx"
 225         citeauthor %!textbefore%%!startlink%%!makeauthor%%!endlink%%!nextauthor%%!textafter%
 226         # "cf. Year; NextYear, S. xx" [Authoryear] / "cf. Year, NextYear, S. xx" [Numerical]
 227         citeyear %!textbefore%%!startlink%%!myear%%!endlink%%!nextmyear%%!textafter%
 228         # "cf. Year; Nextyear, p. xx" (without any extra label)
 229         citebyear %!textbefore%%!startlink%%!byear%%!endlink%%!nextbyear%%!textafter%
 230         # "(cf. Year; NextYear, p. xx)" [Authoryear] / "(cf. Year, NextYear, p. xx)" [Numerical]
 231         citeyearpar %!yearopen%%!textbefore%%!startlink%%!makeyear%%!endlink%%!nextyear%%!textafter%%!yearclose%
 232         # "cf. Year; Nextyear, p. xx" (without any extra label)
 233         citetitle %!textbefore%%!startlink%%!maketitle%%!endlink%%!makenexttitle%%!textafter%
 234         # "Bibliography entry." (dialog) / "cf. Key; NextKey..., p. xx (bibliography entry)" (button)
 235         fullcite {%dialog%[[%_bibentry%]][[%!textbefore%{%label%[[%!fullcite%]][[%key%%!nextkey% (%_fullcite%)]]}%!textafter%}]]}
 236         # "Footnote: Full bibliography entry." (dialog) / "Foot: Key (bibliography entry)"
 237         footfullcite {%dialog%[[%_footnote%]][[%_foot%]]}: {%dialog%[[%_bibentry%]][[{%label%[[%!fullcite%]][[%key%%!nextkey% (%_fullcite%)]]}]]}
 238         # "Add to bibliography only." (dialog) / "[ID] (not cited)" (button)
 239         nocite {%dialog%[[%_addtobib%]][[%key%%!nextkey% (%_notcited%)]]}
 240         # Output only the key
 241         keyonly {%dialog%[[%_keyonly%]][[%_key%: %key%%!nextkey%]]}
 242 End
 243
 244 CiteFormat authoryear
 245         #
 246         # MACROS
 247         #
 248         !open (
 249         !sep ;
 250         !close )
 251
 252         # "cf. Author et. al Year..."
 253         !makecite %!ctextbefore%%!startlink%%!abbrvciteauthor% %!makeyear%%!endlink%%!ctextafter%%!nextcite%
 254         # "Author et al. (cf. Year..."
 255         !makecitet %!startlink%%!makeauthor%%!endlink% %!open%%!textbefore%%!makeyear%%!nextcitet%
 256         # "cf. Author et al. Year..."
 257         !makecitealt  %!textbefore%%!startlink%%!makeauthor% %!makeyear%%!endlink%%!nextcitealt%
 258         # "Author et al., Year..."
 259         !makecitealp %!startlink%%!makeauthor%, %!makeyear%%!endlink%%!nextcitealp%
 260
 261         # "...; Nextauthor Year..."
 262         !nextcite {%next%[[%!sep% %!makecite%]]}
 263         # "...), [and] Nextauthor (Year..."
 264         !nextcitet {%next%[[%!close%%!smartsep%%!startlink%%!makeauthor%%!endlink% %!open%%!makeyear%%!nextcitet%]]}
 265         # "...; NextAuthor et al. Year..."
 266         !nextcitealt {%next%[[%!sep% %!startlink%%!makeauthor% %!makeyear%%!endlink%%!nextcitealt%]]}
 267         # "...; NextAuthor et al., Year..."
 268         !nextcitealp {%next%[[%!sep% %!makecitealp%]]}
 269
 270         #
 271         # ACTUAL STYLE DEFINITIONS
 272         #
 273         # (additions and modifications to default)
 274         #
 275
 276         # "Author (cf. Year),[ and] NextAuthor (Year, p. xx)"
 277         citet %!makecitet%%!textafter%%!close%
 278         # "(cf. Author et al., Year; NextAuthor et al., Year, p. xx)"
 279         citep %!open%%!textbefore%%!makecitealp%%!textafter%%!close%
 280         # "cf. Author et al., Year; NextAuthor et al., Year, p. xx"
 281         citealp %!textbefore%%!makecitealp%%!textafter%
 282         # "cf. Author Year; NextAuthor Year, p. xx" [NB: textbefore position differs from real natbib!]
 283         citealt %!makecitealt%%!textafter%
 284         # "Footnote: cf. Author A Year; Author B Year, p. xx."
 285         footcite {%dialog%[[%_footnote%]][[%_foot%]]}: %!textbefore%%!makecite%%!textafter%.
 286         # "Auto: (cf. Author A Year; Author B Year, p. xx)"
 287         autocite {%dialog%[[%_autocite%]][[%_auto%]]}: %!open%%!textbefore%%!makecite%%!textafter%%!close%
 288
 289         # Fallback style: "Author A (cf. Year),[ and] Author B (Year, p. xx)"
 290         cite %!makecitet%%!textafter%%!close%
 291 End
 292
 293 CiteFormat numerical
 294         #
 295         # MACROS
 296         #
 297         # 1. Translatable bits (need to be marked by _ prefix)
 298         #
 299         _super Super
 300         _superscript Superscript
 301
 302         #
 303         # 2. Macros re-used in the style definitions
 304         #
 305         !open [
 306         !sep ,
 307         !close ]
 308
 309         # "Author [cf. ID..."
 310         !makecitet %!makeauthor% %!open%%!textbefore%{%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%]]}%!nextcitet%
 311         # "ID..."
 312         !makecitealt {%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%]]}%!nextcitealt%
 313         # "ID..."
 314         !hashkey {%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%%!nexthashkey%]]}
 315         # "ID"
 316         !makekey %!ctextbefore%{%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%]]}%!ctextafter%%!nextkey%
 317
 318         # "...], [and] NextAuthor [ID..."
 319         !nextcitet {%next%[[%!close%%!smartsep%%!makeauthor% %!open%%!textbefore%{%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%]]}%!nextcitet%]]}
 320         # "..., ID..."
 321         !nextcitealt {%next%[[%!sep% %!makecitealt%]]}
 322         # FIXME: What is this?
 323         !nexthashid {%next%[[%!sep% #ID%!nexthashid%]]}
 324         # "..., NextID..."
 325         !nexthashkey {%next%[[%!sep% %!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%%!nexthashkey%]]}
 326         # "...); Nextauthor [ID..."
 327         !nextcitet {%next%[[%!close%%!smartsep%%!makeauthor% %!open%{%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%]]}%!nextcitet%]]}
 328         # "..., NextID..."
 329         !nextkey {%next%[[%!sep% %!ctextbefore%{%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%]]}%!ctextafter%%!nextkey%]]}
 330
 331         #
 332         # ACTUAL STYLE DEFINITIONS
 333         #
 334         # (additions and modifications to default)
 335         #
 336
 337         # "[cf. ID, NextID, p. xx]"
 338         citep %!open%%!textbefore%%!hashkey%%!textafter%%!close%
 339         # "Author [cf. ID],[ and] Nextauthor [NextID, p. xx]"
 340         citet %!makecitet%%!textafter%%!close%
 341         # "Footnote: cf. ID, NextID, p. xx."
 342         footcite {%dialog%[[%_footnote%]][[%_foot%]]}: %!textbefore%%!makekey%%!textafter%.
 343         # "Auto: (cf. Author A Year; Author B Year, p. xx)"
 344         autocite {%dialog%[[%_autocite%]][[%_auto%]]}: %!open%%!textbefore%%!makekey%%!textafter%%!close%
 345         # "Superscript: ID" (dialog) / "Super: ID" (button)
 346         supercite {%dialog%[[%_superscript%]][[%_super%]]}: %!makekey%
 347
 348         # Fallback style: "[cf. ID, NextID..., p. xx]"
 349         cite %!open%%!textbefore%%!hashkey%%!textafter%%!close%
 350 End