Swiss Academic Software Version EN 1.0 LyX ab 2.0.3/Citavi ab 3.3.1 Beta

This guide shows how you can best configure Citavi to work with LyX. In Citavi you will generate an

automatically updated BibTeX file that is linked to your LyX document. Citations can then be inserted from

Citavi or from within LyX, while quotations can be inserted with a click using Citavis Publication Assistant.

A. Configuring Citavi 1. Click Tools > Options > General and then make sure that your LaTeX settings match those in the

screenshot below:

2. Select Generate BibTeX keys for all references that do not have one yet. The citations in your LyX

document are created using the entries in the BibTeX file generated using the BibTeX keys in your Citavi

project. For that reason, all of the references you want to use in LyX need a unique BibTeX key. Do not

change any keys for references that have already been inserted into your document.

2

3. Next, create an export preset for the BibTeX file. In the export preset you determine the name and

format of the BibTeX file. You can also say whether the file should be automatically updated when

changes are made in Citavi. Click File > Export:

4. In the next step, select All n references in this project. Please note that if your Citavi project is very large

and you dont use BibLaTeX you may experience errors due to problems with the BibTeX compiler.

5. Select one of the TeX export filters:

3

6. Select Save to text file, click Browse, and then select the folder containing your LyX document. Give the

document a name related to your project.

4

7. Save the export preset, preferably with a name that reflects the journal you will submit to or with the

name of your publication. If you click Automatically export when saving, the export will be

automatically run in the background every time Citavi saves. Click Next.

8. Alternatively you can manually update the BibTeX file by clicking File > Export > [Name of the export

preset].

5

9. You can also customize the export definition if you want:

10. In the two windows that follow, you can customize the reference type and field mapping as well as the

name used in BibTeX. Usually there is no need to do this.

11. In the next window you can select additional options. The options available depend on the package and

style definition you are using. If you notice that necessary options are missing, please contact us at

service@citavi.com.

6

12. If youve made changes to the BibTeX definition, save these under a new name. Otherwise, click Next.

B. Configuring LyX 1. In Tools > Preferences > Editing > Keyboard/Mouse clear the Use keyboard map checkbox:

7

2. In Tools > Preferences > Paths enter the named pipe in the LyXServer pipe field:

3. In your LyX document, place the insertion point where you want your bibliography to appear and then

click Insert > List/TOC > BibTeX Bibliography:

8

4. Click Add and then click Browse to select the BibTeX file:

5. Add the BibTeX file by clicking Add and then OK.

9

C. Inserting Citations and Quotations in LyX 1. You can insert citations from within Citavi by clicking Citation > Quote with {placeholder}1.

2. You can also insert citations using Citavis Publication Assistant. Press F7 to open the Publication

Assistant.

1 The name of this option isnt entirely accurate, since placeholders are not inserted. Instead a formatted citation is inserted.

10

3. Citations can also be inserted from within LyX by clicking Insert > Citation.

4. Search for the desired reference using the BibTeX key or the search feature and define the formatting

for the citation. The available options depend on the citation style and package you are using.

11

5. In this window you can define the formatting for each citation and insert text before and after the

citation. You also open this window at a later time simply by clicking a citation in your document.

6. The formatting for a citation can be changed later on by right-clicking the citation. The options reflect

\cite, \citep, \citealt, etc. The options available depend on the package and citation style you are using.

12

7. Citavi knowledge items are best inserted using the Publication Assistant, since you can then use all

Quote commands entered under Tools > Options > General. You will only be able to see your quotations

with the chosen formatting after compiling your document.

D. Helpful Hints 1. Although integration with LyX works, it is by no means perfect. We are planning to make many changes

in Citavi 4. Please share your comments and observations with us so we can improve your experience.

2. Errors are more difficult to find in LyX than in normal LaTeX documents. We recommend saving and

compiling your LyX document very frequently so that you notice errors right away. The easiest way to

remove errors is to undo any changes since the last time you compiled.

3. If your package or citation style requires a different format in the BibTeX file, change the export

definition in Citavi. Do not manually correct the BibTeX file, since any time a change is made in Citavi the

BibTeX entries will be newly generated and your changes in the file will be overwritten.

Exception: If you insert a BibTeX entry that does not correspond to a title or quotation in Citavi, it will

not be overwritten.

4. If you choose a certain format for a citation as described in section C, steps 4-6 and then change the

citation style or package, you will receive a compilation error if the new package doesnt support the

format you selected.

5. Deactivate any automatic exports in Citavi that you are no longer using. Multiple BibTeX exports running

in the background can slow down Citavis performance considerably.