lib/citeengines/basic.citeengine

   1 # \DeclareLyXCiteEngine{Basic (BibTeX)}
   2 # DescriptionBegin
   3 #   The basic citation capabilities provided by BibTeX.
   4 #   Mainly simple numeric styles primarily suitable for science and maths.
   5 # DescriptionEnd
   6
   7 # Author: Julien Rioux <jrioux@lyx.org>
   8
   9 Format 95
  10
  11 # The framework (biblatex|bibtex)
  12 CiteFramework bibtex
  13
  14 # Cite style variants (default|authoryear|natbib)
  15 # We provide only default citations
  16 CiteEngineType default
  17
  18 # Default style file
  19 DefaultBiblio  plain
  20
  21 #
  22 # CITE COMMAND DEFINITIONS for either engine type
  23 #
  24 # (cf. natbib.citeengine for a decription of the syntax)
  25
  26 CiteEngine default
  27         cite[]
  28         nocite
  29         keyonly
  30 End
  31
  32
  33 #
  34 # CITE FORMAT
  35 #
  36
  37 # Input standard format definitions for the bibliography
  38 Input stdciteformats.inc
  39
  40 # The following defines how the commands are represented in the GUI
  41 # (inset button and citation dialog) as well as in XHTML, docbook and
  42 # plain text output.
  43 #
  44 CiteFormat default
  45         #
  46         # MACROS
  47         #
  48         # 1. Translatable bits (need to be marked by _ prefix, if translated to the GUI language,
  49         #    or B_, if translated to the buffer language)
  50         #    Note that preceding and trailing spaces matter.
  51         #
  52         _notcited not cited
  53         _addtobib Add to bibliography only.
  54         _keyonly Key only.
  55         _key Key
  56
  57         #
  58         # 2. Macros re-used in the style definitions
  59         #
  60         !open [
  61         !sep ,
  62         !close ]
  63         # Modify scheme of the first author in the bibliography
  64         !firstnameform %prename% {%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}
  65         # Modify scheme of other authors in the bibliography
  66         !othernameform %prename% {%prefix%[[%prefix% ]]}%surname%{%suffix%[[, %suffix%]]}
  67
  68         # A link that lets us jump to the bibliography entry in LyXHTML
  69         # %clean:key% will be substituted by the cite key to give a unique id
  70         !startlink {!<a href='#LyXCite-%clean:key%'>!}
  71         !endlink {!</a>!}
  72
  73         # "ID..."
  74         !makecite %!startlink%{%label%[[%label%]][[{%numericallabel%[[%numericallabel%]][[#%key%]]}]]}%!endlink%%!nextcite%
  75
  76         # "..., NextID..."
  77         !nextcite {%next%[[%!sep% %!makecite%]]}
  78         # FIXME: what is this?
  79         !nexthashkey {%next%[[%!sep% #%key%%!nexthashkey%]]}
  80         # "..., NextKey..."
  81         !nextkey {%next%[[%!sep% %key%%!nextkey%]]}
  82
  83         # ", postnote"
  84         !textafter {%textafter%[[, %textafter%]]}
  85
  86         #
  87         # ACTUAL STYLE DEFINITIONS
  88         #
  89
  90         # "[ID, NextID, ..., p. xx]"
  91         cite %!open%{%dialog%[[#ID]][[%!makecite%]]}%!textafter%%!close%
  92         # "Add to bibliography only." (dialog) / "[ID] (not cited)" (button)
  93         nocite {%dialog%[[%_addtobib%]][[%key%%!nextkey% (%_notcited%)]]}
  94         # Output only the key
  95         keyonly {%dialog%[[%_keyonly%]][[%_key%: %key%%!nextkey%]]}
  96 End