lib/citeengines/natbib.citeengine

   1 # \DeclareLyXCiteEngine[natbib.sty]{Natbib (BibTeX)}
   2 # DescriptionBegin
   3 #   Natbib supports a range of both author-year and numerical styles mainly
   4 #   aimed at the Humanities. It features automatic sorting and merging of
   5 #   numerical citations, annotations, capitalization of the `van' part of
   6 #   author names, shortened and full author lists, and more.
   7 # DescriptionEnd
   8
   9 # Author: Julien Rioux <jrioux@lyx.org>
  10
  11 Format 63
  12
  13 Requires natbib
  14
  15 # The framework (biblatex|bibtex)
  16 CiteFramework bibtex
  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:plainnat|numerical:plainnat
  24
  25 # Maximum number of names before "et al." chimes in
  26 MaxCiteNames 2
  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 (see below),
  64 #   dropping the '!' from the prefix (see below), e.g.:
  65 #   _stardesc Starred command label
  66 #   _stardesctooltip Tooltip for the starred command checkbox.
  67
  68 #
  69 # CITE COMMAND DEFINITIONS for either engine type
  70 #
  71 CiteEngine authoryear
  72         Citet*[][]
  73         Citep*[][]
  74         Citealt*[][]
  75         Citealp*[][]
  76         Citeauthor*[]
  77         citeyear[]
  78         citeyearpar[][]
  79         nocite
  80         keyonly
  81 End
  82
  83 CiteEngine numerical
  84         Citep*[][]
  85         Citealp*[][]
  86         Citet*[][]
  87         Citealt*[][]
  88         Citeauthor*
  89         citeyearpar[][]
  90         citeyear
  91         nocite
  92         keyonly
  93 End
  94
  95
  96 #
  97 # CITE FORMAT
  98 #
  99
 100 # The following defines how the commands are represented in the GUI
 101 # (inset button and citation dialog) as well as in XHTML, docbook and
 102 # plain text output.
 103 #
 104 # There are common definitions (default) and specific definitions for
 105 # either cite engine type (which overwrite existing defaults.
 106 #
 107 CiteFormat default
 108         #
 109         # MACROS
 110         #
 111         # 1. Translatable bits (need to be marked by _ prefix)
 112         #    Note that preceding and trailing spaces matter.
 113         #
 114         _notcited not cited
 115         _addtobib Add to bibliography only.
 116         _keyonly Key only.
 117         _key Key
 118         # The following are handled by BiblioInfo
 119         _etal  et al.
 120         _namesep , [[separate author names in citation, except for last name]]
 121         _lastnamesep , and [[separate name of last author in citation]]
 122         _pairnamesep  and [[separate two authors in citation]]
 123
 124         #
 125         # 2. Macros re-used in the style definitions
 126         #
 127         # A link that lets us jump to the bibliography entry in LyXHTML
 128         # %clean:key% will be substituted by the cite key to give a unique id
 129         !startlink {!<a href='#LyXCite-%clean:key%'>!}
 130         !endlink {!</a>!}
 131
 132         # "Author et al." or "??"
 133         !abbrvciteauthor {%abbrvciteauthor%[[%abbrvciteauthor%]][[??]]}
 134         # "Author, ..." or "??"
 135         !fullciteauthor {%fullciteauthor%[[%fullciteauthor%]][[??]]}
 136         # Handle starred command: abbr. or full author list
 137         !makeauthor {%ifstar%[[%!fullciteauthor%]][[%!abbrvciteauthor%]]}
 138         # "prenote "
 139         !textbefore {%textbefore%[[%textbefore% ]]}
 140         # ", postnote"
 141         !textafter {%textafter%[[, %textafter%]]}
 142         # Add a year if it exists (else "??") and possibly a modifier (as in 2017a)
 143         !year {%year%[[%year%]][[??]]}{%modifier%[[%modifier%]]}
 144
 145         # "...; Author..."
 146         !nextauthor {%next%[[%!sep% %!startlink%%!abbrvauthor%%!endlink%%!nextauthor%]]}
 147         # Handle starred command: abbr. or full author list
 148         !makenextauthor {%next%[[%!sep% %!startlink%%!makeauthor%%!endlink%%!makenextauthor%]]}
 149         # "..., CiteKey..."
 150         !nextkey {%next%[[%!sep% %key%%!nextkey%]]}
 151         # "..., Year..."
 152         !nextyear {%next%[[%!sep% %!startlink%%!year%%!endlink%%!nextyear%]]}
 153
 154         #
 155         # ACTUAL STYLE DEFINITIONS
 156         #
 157         # (identical in authoryear and numerical)
 158         #
 159
 160         # "(cf. Year; NextYear, p. xx)" [Authoryear] / "(cf. Year, NextYear, p. xx)" [Numerical]
 161         citeyearpar %!open%%!textbefore%%!startlink%%!year%%!endlink%%!nextyear%%!textafter%%!close%
 162         # "Add to bibliography only." (dialog) / "[ID] (not cited)" (button)
 163         nocite {%dialog%[[%_addtobib%]][[%key%%!nextkey% (%_notcited%)]]}
 164         # Output only the key
 165         keyonly {%dialog%[[%_keyonly%]][[%_key%: %key%%!nextkey%]]}
 166 End
 167
 168 CiteFormat authoryear
 169         #
 170         # MACROS
 171         #
 172         !open (
 173         !sep ;
 174         !close )
 175
 176         # "Author et al. (cf. Year..."
 177         !makecitet %!startlink%%!makeauthor%%!endlink% %!open%%!textbefore%%!year%%!nextcitet%
 178         # "Author et al. cf. Year..." [sic!]
 179         !makecitealt %!startlink%%!makeauthor% %!textbefore%%!year%%!endlink%%!nextcitealt%
 180         # "Author et al., Year..."
 181         !makecitealp %!startlink%%!makeauthor%, %!year%%!endlink%%!nextcitealp%
 182
 183         # "...); Nextauthor (Year..."
 184         !nextcitet {%next%[[%!close%%!sep% %!startlink%%!makeauthor%%!endlink% %!open%%!year%%!nextcitet%]]}
 185         # "...; NextAuthor et al. Year..."
 186         !nextcitealt {%next%[[%!sep% %!makecitealt%]]}
 187         # "...; NextAuthor et al., Year..."
 188         !nextcitealp {%next%[[%!sep% %!makecitealp%]]}
 189
 190         #
 191         # ACTUAL STYLE DEFINITIONS
 192         #
 193         # (additions and modifications to default)
 194         #
 195
 196         # "Author (cf. Year); NextAuthor (Year, p. xx)"
 197         citet %!makecitet%%!textafter%%!close%
 198         # "(cf. Author et al., Year; NextAuthor et al., Year, p. xx)"
 199         citep %!open%%!textbefore%%!makecitealp%%!textafter%%!close%
 200         # "cf. Author et al., Year; NextAuthor et al., Year, p. xx"
 201         citealp %!textbefore%%!makecitealp%%!textafter%
 202         # "Author cf. Year; NextAuthor Year, p. xx" [sic!]
 203         citealt %!makecitealt%%!textafter%
 204         # "Author; NextAuthor, p. xx"
 205         citeauthor %!startlink%%!makeauthor%%!endlink%%!makenextauthor%%!textafter%
 206         # "Year; NextYear, p. xx"
 207         citeyear %!startlink%%!year%%!endlink%%!nextyear%%!textafter%
 208
 209         # Fallback style: "Author (cf. Year); NextAuthor (Year, p. xx)"
 210         cite %!makecitet%%!textafter%%!close%
 211 End
 212
 213 CiteFormat numerical
 214         #
 215         # MACROS
 216         #
 217         !open [
 218         !sep ,
 219         !close ]
 220
 221         # "Author [cf. ID..."
 222         !makecitet %!makeauthor% %!open%%!textbefore%{%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%]]}%!nextcitet%
 223         # "Author cf. ID..."
 224         !makecitealt %!makeauthor% %!textbefore%{%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%]]}%!nextcitealt%
 225         # "ID..."
 226         !hashkey {%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%%!nexthashkey%]]}
 227
 228         # "...], NextAuthor [ID..."
 229         !nextcitet {%next%[[%!close%%!sep% %!makeauthor% %!open%%!textbefore%{%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%]]}%!nextcitet%]]}
 230         # "..., NextAuthor ID..."
 231         !nextcitealt {%next%[[%!sep% %!makeauthor% {%dialog%[[#ID]][[%!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%]]}%!nextcitealt%]]}
 232         # FIXME: What is this?
 233         !nexthashid {%next%[[%!sep% #ID%!nexthashid%]]}
 234         # "..., NextID..."
 235         !nexthashkey {%next%[[%!sep% %!startlink%{%numericallabel%[[%numericallabel%]][[#%key%]]}%!endlink%%!nexthashkey%]]}
 236
 237         #
 238         # ACTUAL STYLE DEFINITIONS
 239         #
 240         # (additions and modifications to default)
 241         #
 242
 243         # "[cf. ID, NextID, p. xx]"
 244         citep %!open%%!textbefore%%!hashkey%%!textafter%%!close%
 245         # "Author [cf. ID], Nextauthor [NextID, p. xx]"
 246         citet %!makecitet%%!textafter%%!close%
 247         # "cf. ID, NextID, p. xx"
 248         citealp %!textbefore%%!hashkey%%!textafter%
 249         # "Author cf. ID, NextAuthor ID, p. xx"
 250         citealt %!makecitealt%%!textafter%
 251         # "Author, NextAuthor"
 252         citeauthor %!startlink%%!makeauthor%%!endlink%%!makenextauthor%
 253         # "Year, NextYear"
 254         citeyear %!startlink%%!year%%!endlink%%!nextyear%
 255
 256         # Fallback style: "[cf. ID, NextID, p. xx]"
 257         cite %!open%%!textbefore%%!hashkey%%!textafter%%!close%
 258 End