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 63
  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 # The following defines how the commands are represented in the GUI
  38 # (inset button and citation dialog) as well as in XHTML, docbook and
  39 # plain text output.
  40 #
  41 CiteFormat default
  42         #
  43         # MACROS
  44         #
  45         # 1. Translatable bits (need to be marked by _ prefix)
  46         #    Note that preceding and trailing spaces matter.
  47         #
  48         _notcited not cited
  49         _addtobib Add to bibliography only.
  50         _keyonly Key only.
  51         _key Key
  52
  53         #
  54         # 2. Macros re-used in the style definitions
  55         #
  56         !open [
  57         !sep ,
  58         !close ]
  59
  60         # A link that lets us jump to the bibliography entry in LyXHTML
  61         # %clean:key% will be substituted by the cite key to give a unique id
  62         !startlink {!<a href='#LyXCite-%clean:key%'>!}
  63         !endlink {!</a>!}
  64
  65         # "ID..."
  66         !makecite %!startlink%{%label%[[%label%]][[{%numericallabel%[[%numericallabel%]][[#%key%]]}]]}%!endlink%%!nextcite%
  67
  68         # "..., NextID..."
  69         !nextcite {%next%[[%!sep% %!makecite%]]}
  70         # FIXME: what is this?
  71         !nexthashkey {%next%[[%!sep% #%key%%!nexthashkey%]]}
  72         # "..., NextKey..."
  73         !nextkey {%next%[[%!sep% %key%%!nextkey%]]}
  74
  75         # ", postnote"
  76         !textafter {%textafter%[[, %textafter%]]}
  77
  78         #
  79         # ACTUAL STYLE DEFINITIONS
  80         #
  81
  82         # "[ID, NextID, ..., p. xx]"
  83         cite %!open%{%dialog%[[#ID]][[%!makecite%]]}%!textafter%%!close%
  84         # "Add to bibliography only." (dialog) / "[ID] (not cited)" (button)
  85         nocite {%dialog%[[%_addtobib%]][[%key%%!nextkey% (%_notcited%)]]}
  86         # Output only the key
  87         keyonly {%dialog%[[%_keyonly%]][[%_key%: %key%%!nextkey%]]}
  88 End