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 # Excludes: jurabib | natbib | biblatex
   7
   8 # Author: Julien Rioux <jrioux@lyx.org>
   9
  10 Format 62
  11
  12 # The framework (biblatex|bibtex)
  13 CiteFramework bibtex
  14
  15 # Cite style variants (default|authoryear|natbib)
  16 # We provide only default citations
  17 CiteEngineType default
  18
  19 # Default style file
  20 DefaultBiblio  plain
  21
  22 #
  23 # CITE COMMAND DEFINITIONS for either engine type
  24 #
  25 # (cf. natbib.citeengine for a decription of the syntax)
  26
  27 CiteEngine default
  28         cite[]
  29         nocite
  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         #
  47         _notcited not cited
  48         _addtobib Add to bibliography only.
  49
  50         #
  51         # 2. Macros re-used in the style definitions
  52         #
  53         !open [
  54         !sep ,
  55         !close ]
  56
  57         # A link that lets us jump to the bibliography entry in LyXHTML
  58         # %clean:key% will be substituted by the cite key to give a unique id
  59         !startlink {!<a href='#LyXCite-%clean:key%'>!}
  60         !endlink {!</a>!}
  61
  62         # "ID..."
  63         !makecite %!startlink%{%label%[[%label%]][[{%numericallabel%[[%numericallabel%]][[#%key%]]}]]}%!endlink%%!nextcite%
  64
  65         # "..., NextID..."
  66         !nextcite {%next%[[%!sep% %!makecite%]]}
  67         # FIXME: what is this?
  68         !nexthashkey {%next%[[%!sep% #%key%%!nexthashkey%]]}
  69         # "..., NextKey..."
  70         !nextkey {%next%[[%!sep% %key%%!nextkey%]]}
  71
  72         # ", postnote"
  73         !textafter {%textafter%[[, %textafter%]]}
  74
  75         #
  76         # ACTUAL STYLE DEFINITIONS
  77         #
  78
  79         # "[ID, NextID, ..., p. xx]"
  80         cite %!open%{%dialog%[[#ID]][[%!makecite%]]}%!textafter%%!close%
  81         # "Add to bibliography only." (dialog) / "[ID] (not cited)" (button)
  82         nocite {%dialog%[[%_addtobib%]][[%key%%!nextkey% (%_notcited%)]]}
  83 End