New tag MaxCiteNames

[features.git] / lib / citeengines / basic.citeengine

diff --git a/lib/citeengines/basic.citeengine b/lib/citeengines/basic.citeengine
index 7de5e35d52892a0ad82049e025743f37dd1f4a29..a850f07f98e1a72582be1f9dd7bbd06c084a0ced 100644 (file)
--- a/lib/citeengines/basic.citeengine
+++ b/lib/citeengines/basic.citeengine
@@ -3,42 +3,81 @@
 #   The basic citation capabilities provided by BibTeX.
 #   Mainly simple numeric styles primarily suitable for science and maths.
 # DescriptionEnd
-# Excludes: jurabib | natbib
+# Excludes: jurabib | natbib | biblatex
 
 # Author: Julien Rioux <jrioux@lyx.org>
 
-Format 62
+Format 63
 
+# The framework (biblatex|bibtex)
+CiteFramework bibtex
+
+# Cite style variants (default|authoryear|natbib)
+# We provide only default citations
 CiteEngineType default
+
+# Default style file
 DefaultBiblio  plain
 
+#
+# CITE COMMAND DEFINITIONS for either engine type
+#
+# (cf. natbib.citeengine for a decription of the syntax)
+
 CiteEngine default
        cite[]
        nocite
 End
 
+
+#
+# CITE FORMAT
+#
+
+# The following defines how the commands are represented in the GUI
+# (inset button and citation dialog) as well as in XHTML, docbook and
+# plain text output.
+#
 CiteFormat default
-       # translatable bits
+       #
+       # MACROS
+       #
+       # 1. Translatable bits (need to be marked by _ prefix)
+       #
        _notcited not cited
        _addtobib Add to bibliography only.
 
-       # macros
+       #
+       # 2. Macros re-used in the style definitions
+       #
        !open [
        !sep ,
        !close ]
 
+       # A link that lets us jump to the bibliography entry in LyXHTML
+       # %clean:key% will be substituted by the cite key to give a unique id
        !startlink {!<a href='#LyXCite-%clean:key%'>!}
        !endlink {!</a>!}
 
-       !cite %!startlink%{%label%[[%label%]][[{%numericallabel%[[%numericallabel%]][[#%key%]]}]]}%!endlink%%!nextcite%
+       # "ID..."
+       !makecite %!startlink%{%label%[[%label%]][[{%numericallabel%[[%numericallabel%]][[#%key%]]}]]}%!endlink%%!nextcite%
 
-       !nextcite {%next%[[%!sep% %!cite%]]}
+       # "..., NextID..."
+       !nextcite {%next%[[%!sep% %!makecite%]]}
+       # FIXME: what is this?
        !nexthashkey {%next%[[%!sep% #%key%%!nexthashkey%]]}
+       # "..., NextKey..."
        !nextkey {%next%[[%!sep% %key%%!nextkey%]]}
 
+       # ", postnote"
        !textafter {%textafter%[[, %textafter%]]}
 
-       # cite styles
-       cite %!open%{%dialog%[[#ID]][[%!cite%]]}%!textafter%%!close%
+       #
+       # ACTUAL STYLE DEFINITIONS
+       #
+
+       # "[ID, NextID, ..., p. xx]"
+       cite %!open%{%dialog%[[#ID]][[%!makecite%]]}%!textafter%%!close%
+       # "Add to bibliography only." (dialog) / "[ID] (not cited)" (button)
        nocite {%dialog%[[%_addtobib%]][[%key%%!nextkey% (%_notcited%)]]}
 End