lib/citeengines/biblatex.citeengine

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