]> git.lyx.org Git - features.git/blob - lib/citeengines/basic.citeengine
Add some documentation to the rather esoteric style files
[features.git] / 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 CiteFramework bibtex
13 CiteEngineType default
14 DefaultBiblio  plain
15
16 CiteEngine default
17         cite[]
18         nocite
19 End
20
21 CiteFormat default
22         # Translatable bits
23         _notcited not cited
24         _addtobib Add to bibliography only.
25
26         # Macros
27         !open [
28         !sep ,
29         !close ]
30
31         # A link that lets us jump to the bibliography entry in LyXHTML
32         # %clean:key% will be substituted by the cite key to give a unique id
33         !startlink {!<a href='#LyXCite-%clean:key%'>!}
34         !endlink {!</a>!}
35
36         # Start citation: ID...
37         !makecite %!startlink%{%label%[[%label%]][[{%numericallabel%[[%numericallabel%]][[#%key%]]}]]}%!endlink%%!nextcite%
38
39         # Follow-up citations: ..., NextID...
40         !nextcite {%next%[[%!sep% %!makecite%]]}
41         # FIXME: what is this?
42         !nexthashkey {%next%[[%!sep% #%key%%!nexthashkey%]]}
43         # Simply the cite key(s): Key, NextKey, ...
44         !nextkey {%next%[[%!sep% %key%%!nextkey%]]}
45
46         # Postnote: ", p. xx"
47         !textafter {%textafter%[[, %textafter%]]}
48
49         ## The actual cite styles ##
50         # \cite: [ID, NextID, ..., p. xx]
51         cite %!open%{%dialog%[[#ID]][[%!makecite%]]}%!textafter%%!close%
52         # \nocite: "Add to bibliography only." (dialog) / "Key, Nextkey (not cited)" (inset)
53         nocite {%dialog%[[%_addtobib%]][[%key%%!nextkey% (%_notcited%)]]}
54 End