diff --git a/doc/index.docbook b/doc/index.docbook
index 42782723..a7919ad5 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,1734 +1,1733 @@
ATEX">
ATEX">
- PDF">
EX">
teTEX">
TeX Live">
EX">
biblatex">
LyX">
]>
The &kbibtex; HandbookYuriChornoivanyurchor@ukr.net20042014Thomas Fischer2019-05-070.9
&FDLNotice;
&kbibtex; is a graphical &bibtex; editor and shell.
KDEkbibtexLaTeXTeXbibliographyPrefaceRequirements
To run &kbibtex;, you need to have the following components installed on your system:
&kf5-full; libraries.
&latex;: high-quality document typesetting program. Most likely you want the &texlive; (or on older systems the &tetex;) package, if you are on a Unix-like system. It is an optional dependency, but without it &kbibtex; provides very limited functionality.
bibtex2html collection of tools for translating from &bibtex; to &HTML; to enhance &kbibtex; entry previewing capabilities (optional dependency).
Most of these items as well as &kbibtex; itself might be included in your &Linux; distribution; please refer to your distribution documentation, or refer to your installation &CD; or DVD, for adding these packages to your computer.
Intended Audience
This manual is intended for any individual, regardless of her or his experience with &latex;, &kde;, &kbibtex; or &Linux;.
Advanced users are not likely to read this manual, but all suggestions on documentation will be considered. If you would like to contribute to this project or the documentation, please consult the &kbibtex; web page.
Introduction
About &kbibtex;
&kbibtex; is an integrated environment for creating and editing bibliographies in &bibtex; format. &kbibtex; gives you the ability to use all the functionalities of &bibtex; in a graphical interface, giving you easy, immediate, and customized access to local and online bibliographies with ability of entries completing, compiling, previewing and searching.
About &bibtex;
&bibtex; is a program and file format designed by Oren Patashnik and Leslie Lamport in 1985 for the &latex; document preparation system Lamport86.
The format is entirely character based, so it can be used by any program (although the standard character set for accents is &tex;). It is field (tag) based and the &bibtex; program will ignore unknown fields, so it is expandable. It is probably the most common format for bibliographies on the Internet.
The &bibtex; program uses style files, a list of citations from &latex;, and a &bibtex; database to create a &latex; file listing the cited references. The idea of style files is that final copy in any journal-specific form can be done automatically.
An example of &bibtex; database entry:
@article{PAM_doi:10.1007/BF00048294,
author = {Streitenberger, P. and Knott, John F.},
doi = {10.1007/BF00048294},
issn = {1573-2673},
journal = {{International Journal of Fracture}},
number = {3},
pages = {R49},
publisher = {Springer},
title = {{The calculation of crack opening area and crack opening volume from stress intensity factors}},
url = {http://dx.doi.org/10.1007/BF00048294},
volume = {76},
x-fetchedfrom = {SpringerLink},
year = {1995}
}
&kbibtex; and &latex; Editors
&latex; code can be edited with a wide variety of tools from simple minimalistic text editors to powerful visual suites. For the comparison of &latex; editors, see this page.
&kbibtex; provides out-of-box integration with &kile; and &lyx; though it can be successfully used with any kind of &latex; editor.
&kbibtex;'s Main Features
&kbibtex; allows you to do the following things:
Enter a preamble that defines how special text should be formatted in your bibliography using ElementNew elementNew preamble menu item or Main Toolbar.
Choose an entry encoding using Encoding item in Save as dialog or on the File Settings panel.
Enter comments that are not taken in regard by &bibtex; using ElementNew elementNew comment menu item or Main Toolbar.
Preview and save bibliography entries in various formats (Source (&bibtex;), Source (RIS), Wikipedia, standard (&XML;/XSLT), fancy (&XML;/XSLT), and abstract-only (&XML;/XSLT)) using Reference Preview panel. Additional preview styles become available when bibtex2html is installed.
Search for the bibliography entries data in online databases using Online Search panel.
View local or remote (online) resources (such as files) linked in the &bibtex; entry using Document Preview panel.
Find and fix duplicate entries in bibliography using EditFind Duplicates menu item or Main Toolbar.
Import your Zotero library using Zotero panel.
Quickstart
Writing a Bibliography File for Beginners
After the first run, &kbibtex; will propose to make it the default editor for bibliography formats. We recommend you to do so.If for some reasons you will decide to reconsider please remove the strings with kbibtex substring from mimeapps.list file in .local/share/applications folder of your home folder.
Then you will see a window that looks similar to this:
&kbibtex; window after the first start&kbibtex; window after the first start
To start a new bibliography document press the New button on the right panel, the New button on the toolbar or choose the &Ctrl;NFileNew menu item.
Now it is time to add some entries.
Users of &kbibtex; have two choices when adding a new entry: they can use the Online Search panel to find entry data online or they can write the code by hand.
Let's try to add a book entry manually.
Choose ElementNew elementNew entry from the &kbibtex; menu. &kbibtex; should open Edit Element window.
&kbibtex; element's editing window&kbibtex; element's editing window
Choose Book from the Type: drop down list.
Enter Lamport86 into the Id: field.
The Id is used for referencing the bibliography entry in your main document.
Go to the Title tab and enter LaTeX: A Document Preparation System into the Title: text box.
Go to the Author/Editor tab, click on Add button and enter Lamport, Leslie.
Go to the Publication tab then enter 1986 into the Year: text box and Addison-Wesley into the Publisher: text box.
Click OK.
Choose &Ctrl;SFileSave menu item and save your bibliography file as example.bib in your to-be-written paper folder.
Using the bibliography in your &latex; document
To actually use the bibliography in your paper, you need to add the following commands in your &latex; file (these commands are usually can be found at the end of the document - where the References section to appear):
\bibliography{foo}
\bibliographystyle{plain}
Here, foo is the name of your bib file created with &kbibtex; and plain is the name of bibliography style.
There is a plenty of specific bibliography styles. Please consult your publisher for the one to choose or try and find the one that suits the best for your purposes.
Below is a list of some generic styles available everywhere:
plain
normal style, listed in alphabetic order and labeled numerically
unsrt
same as plain except entries appear in order of citation
alpha
same as plain except entry identifiers are used
abbrv
same as plain except uses abbreviations for first names, month names, and journal names
So you can use your &latex; editor's capabilities (please consult the editor documentation for this) or just enter the following code in a generic text editor then save the file with tex name extension.
\documentclass{article}
\begin{document}
\bibliographystyle{plain}% Choose a bibliographic style
Test file with a reference (see~\cite{Lamport86}).
\bibliography{example}
\end{document}
For our testing purposes, let this file be named example.tex.
Please save this file to the same folder as your example.bib.
Now that you have the basis for a document, you have to run both latex and bibtex to process it.
First, you should run latex (to create a foo.aux file, which bibtex reads). Then run bibtex once to get some of the citations and create a bbl file. Then run latex again so that the cross references between the text file and the bibliography are correct. You may want to repeat running bibtex and latex on the file to make sure that all cross references are correct. Be warned that adding/deleting citations and sources will require running bibtex again.
Thus, the following commands can be used to compile the document from console:
latex example
bibtex example
latex example
latex example
If you are using some advanced &latex; shell like &kile; or &lyx;, there is no need to worry about running all these commands from console emulator. Just use a hot key (&Alt;6 in &kile;) or a toolbar button to see the results.
- Now, you can see the results as a &DVI; or &pdf; file (the format depends on your configuration), stored in the same folder as your source files.
+ Now, you can see the results as a &DVI; or &PDF; file (the format depends on your configuration), stored in the same folder as your source files.
Congratulations! You have just created your first document with &bibtex; bibliography.
&kbibtex; Interface
&kbibtex;'s Panels
The main functionality of &kbibtex; is available through its nine panels. It is possible to rearrange these panels or even detach them from the main window by clicking with &LMB; on the panel's header and dragging it to the new place.
You can make the &kbibtex; panels visible or hide them using the SettingsShow Panels submenu. It is enough to check the panel's item to make it visible or uncheck it to hide the panel.
List of Documents Panel
The List of Documents panel allows to switch between the opened bibliography documents (Open Files tab), open recently used documents (Recently Used tab), open your main bibliography documents (Favorites tab), or browse your computer file system to find bibliography documents (Filesystem Browser tab).
To add a bibliography file to favorites select it on any tab except Favorites, click with &RMB; and choose Add to Favorites. To remove the bibliography from favorites select it on Favorites tab, click with &RMB; and choose Remove from Favorites.
List of documents panelList of documents panel
List of Values Panel
The List of Values panel can be used to easy up viewing statistics on usage of values in the entries fields and batch editing of these values.
The upper drop down box is used to choose the bibliography field to display statistic data (a count of entries with the same value for the field) on the lower list.
You can click with &RMB; on an entry in the lower list to access the batch editing capabilities. It is possible to Replace all occurrences of the value, Delete all occurrences of the value, Search for selected values using the Filter Toolbar, Add value to selected entries, Replace value of selected entries or Remove value from selected entries (some entries should be selected in the main entry list first).
List of values panelList of values panel
Statistics Panel
The Statistics panel is designed to display a comprehensive list of statistical information about the current bibliography document.
Statistics panelStatistics panel
Reference Preview Panel
The Reference Preview panel is used to preview and save in &HTML; format the currently selected bibliography entry.
Reference preview panelReference preview panel
It is possible to preview the reference as Source (&bibtex;), Source (RIS), Wikipedia, standard (&XML;/XSLT), fancy (&XML;/XSLT), and abstract-only (&XML;/XSLT) formats. Additional options become available when bibtex2html is installed.
When you click on the elements of the reference in &XML;-based format &kbibtex; will apply the corresponding filtering to the bibliography list.
Click the
Open button to open the reference in the default Internet browser. The
Save as &HTML; button can be used to save the reference in &HTML; for further use on your website.
You can click with &RMB; on the panel to select Reload to update the reference according to the latest changes in the entry.
File Settings Panel
The File Settings panel can be used to define some parameters of the bib file of the current bibliography.
File settings panelFile settings panel
It is possible to select Encoding, String Delimiters, Comment Quoting, Keyword Casing, and Person Names Formatting.
By default &bibtex; will lowercase all intermediate words in sentences. Check Protect Titles check box to protect the case in the entry titles.
Online Search Panel
The Online Search panel can be used to perform a search in the Internet bibliography databases to find the needed entries or to obtain the complete set of data for a manually entered entry.
Online Search panelOnline Search panel
The entries can be searched by Free text, Title, Author, or Year. The number of results shown on the Search Results panel can be tweaked using the Number of Results spin box.
Click the
Use Entry button to fill the search criteria fields from the currently selected bibliography entry. This way you can complete the existing entry with the data from the Internet databases. The
Search button can be used to start the search.
&kbibtex; can perform a search in the most popular Internet databases. To select the set of the databases for your search switch to the Engines tab or click with &LMB; on the change link on the Query Terms tab.
To visit the database homepage in the Internet click with &RMB; on its entry in the Engines tab and select Go to Homepage.
Zotero Panel
The Zotero panel can be used to import your Zotero library.
Zotero uses specialized browser add-ons to save bibliography entries from Internet pages. The data are stored in an online database that can be reached from anywhere. Zotero documentation can be found here.
Zotero panelZotero panel
Click the
Get Credentials button on Credentials tab to start the Zotero authorization wizard. Follow the instructions to allow &kbibtex; access your Zotero library.
To access the library entries double-click on the corresponding item on Collections or Tags tabs. The entries that satisfy the chosen criteria will be shown on the Search Results panel.
Search Results Panel
The Search Results panel is used to handle the search results obtained using Online Search panel.
Search Results panelSearch Results panel
Click the
Import button to import the currently selected search result into your bibliography.
To access other actions for the currently selected search result click on it with &RMB;. From the opened menu you can review the result (View Element item) or copy it for further pasting in &bibtex; format elsewhere with &Ctrl;V (Copy item).
Element Editor Panel
The Element Editor panel can be used to edit the currently selected bibliography element.
Element Editor panelElement Editor panel
Click the
button to select a suggested identifier for the element.
Enter the respective data in the editor fields. The field data format can be switched between Text, Reference and Source Code using the drop down box to the left of the text box.
Click the
Options button to open a drop down menu with two items.
The Show all fields item can be used to show or hide all empty fields of the current element.
It is possible to switch keyboard focus between the fields using the 	 key. So the second menu item, Tab key visits only editable fields, can be used to switch on and off navigation between editable fields only.
Click the
- Check with &bibtex; button to preview the editing entry as it will be shown in the compiled &pdf; file.
+ Check with &bibtex; button to preview the editing entry as it will be shown in the compiled &PDF; file.
Check the Automatically apply changes box to have all your changes automatically applied to the entry without the need to click the Apply button.
Click the
Reset button to revert all your changes.
Document Preview Panel
The Document Preview panel can be used to preview pages or documents linked with the currently selected bibliography entry.
By default, the Document Preview panel can be opened by pressing &Ctrl;&Shift;D keyboard shortcut.
Document Preview panelDocument Preview panel
Click the
button to toggle between local files only and all documents including the remote ones.
Click the
button to open the page or the document in the default external application.
The address drop down box can be used to switch between the pages and documents.
&kbibtex;'s Toolbars
&kbibtex; has two completely customizable toolbars located on the top part of its window.
More information on customizing the toolbars can be found in the corresponding section of &kde; Fundamentals manual. Below is the short description of the default buttons of &kbibtex; toolbars.
Main Toolbar
Main ToolbarMain Toolbar
The default Main Toolbar of &kbibtex;.
New: creates a new bibliography document.
Open: opens the generic &kde; Open/Save dialog to open some existing bibliography to edit.
Close: closes the currently active bibliography document.
Save: saves the currently active bibliography document.
Save as: allows to save the currently open bibliography document under the new name using the generic &kde; Open/Save dialog.
New element: allows to create the new entry, comment, preamble or macro in the current bibliography document.
Find Duplicates: finds and fixes duplicate elements in the current bibliography document.
Send to &lyx;/&kile;: sends a reference on the currently selected bibliography entry to &lyx; or &kile;. More on this in the corresponding chapter of this manual.
Filter Toolbar
Filter ToolbarFilter Toolbar