Warning, /office/kbibtex/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY pdflatex "PDFL<superscript>A</superscript>T<subscript>E</subscript>X">
0004   <!ENTITY tex "T<subscript>E</subscript>X">
0005   <!ENTITY tetex "<application>teT<subscript>E</subscript>X</application>">
0006   <!ENTITY texlive "<application>TeX Live</application>">
0007   <!ENTITY bibtex "BibT<subscript>E</subscript>X">
0008   <!ENTITY biblatex "<application>biblatex</application>">
0009   <!ENTITY lyx "<application>LyX</application>">
0010   <!ENTITY % addindex "IGNORE">
0011   <!ENTITY % English "INCLUDE">
0012 ]>
0013 
0014 <book id="kbibtex" lang="&language;">
0015 
0016 <bookinfo>
0017 <title>The &kbibtex; Handbook</title>
0018 
0019 <authorgroup>
0020   <author><firstname>Yuri</firstname><surname>Chornoivan</surname>
0021     <affiliation>
0022       <address>
0023         <email>yurchor@ukr.net</email>
0024       </address>
0025     </affiliation>
0026   </author>
0027 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0028 </authorgroup>
0029 
0030 <copyright>
0031 <year>2004</year><year>2014</year>
0032 <holder>Thomas Fischer</holder>
0033 </copyright>
0034 
0035 <date>2019-05-07</date>
0036 <releaseinfo>0.9</releaseinfo>
0037 
0038 <legalnotice>
0039   &FDLNotice;
0040 </legalnotice>
0041 
0042 <abstract>
0043   <para>
0044     &kbibtex; is a graphical &bibtex; editor and shell.
0045   </para>
0046 </abstract>
0047 
0048 <keywordset>
0049   <keyword>KDE</keyword>
0050   <keyword>kbibtex</keyword>
0051   <keyword>LaTeX</keyword>
0052   <keyword>TeX</keyword>
0053   <keyword>bibliography</keyword>
0054 </keywordset>
0055 
0056 </bookinfo>
0057 
0058 <chapter id="preface">
0059   <title>Preface</title>
0060   <sect1 id="preface_sect">
0061     <title>Requirements</title>
0062     <para>
0063       To run &kbibtex;, you need to have the following components installed on your system:
0064     </para>
0065     <itemizedlist>
0066       <listitem>
0067         <para>
0068           <ulink url="https://www.kde.org/">&kf5-full; libraries</ulink>.
0069         </para>
0070       </listitem>
0071       <listitem>
0072         <para>
0073           <ulink url="https://www.ctan.org/">&latex;</ulink>: 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.
0074         </para>
0075       </listitem>
0076       <listitem>
0077         <para>
0078           <ulink url="https://www.lri.fr/~filliatr/bibtex2html/">bibtex2html</ulink> collection of tools for translating from &bibtex; to &HTML; to enhance &kbibtex; entry previewing capabilities (optional dependency).
0079         </para>
0080       </listitem>
0081     </itemizedlist>
0082     <para>
0083       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.
0084     </para>
0085   </sect1>
0086   <sect1 id="preface_audience">
0087     <title>
0088       Intended Audience
0089     </title>
0090     <para>
0091       This manual is intended for any individual, regardless of her or his experience with &latex;, &kde;, &kbibtex; or &Linux;.
0092     </para>
0093     <para>
0094       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 <ulink url="https://userbase.kde.org/KBibTeX">&kbibtex; web page</ulink>.
0095     </para>
0096   </sect1>
0097 
0098 </chapter>
0099 
0100 <chapter id="introduction">
0101   <title>
0102     Introduction
0103   </title>
0104   <sect1 id="intro_about">
0105     <title>
0106       About &kbibtex;
0107     </title>
0108     <para>
0109       &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.
0110     </para>
0111     <sect2 id="intro-bibtex">
0112       <title>About &bibtex;</title>
0113       <para>
0114         &bibtex; is a program and file format designed by Oren Patashnik and Leslie Lamport in 1985 for the &latex; document preparation system <citation>Lamport86</citation>.
0115       </para>
0116       <para>
0117         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.
0118       </para>
0119       <para>
0120         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.
0121       </para>
0122       <para>
0123         An example of &bibtex; database entry:
0124       </para>
0125 <programlisting>
0126 @article{PAM_doi:10.1007/BF00048294,
0127         author = {Streitenberger, P. and Knott, John F.},
0128         doi = {10.1007/BF00048294},
0129         issn = {1573-2673},
0130         journal = {{International Journal of Fracture}},
0131         number = {3},
0132         pages = {R49},
0133         publisher = {Springer},
0134         title = {{The calculation of crack opening area and crack opening volume from stress intensity factors}},
0135         url = {https://dx.doi.org/10.1007/BF00048294},
0136         volume = {76},
0137         x-fetchedfrom = {SpringerLink},
0138         year = {1995}
0139 }
0140 </programlisting>
0141   </sect2>
0142   <sect2 id="kbibtex-and-latex-editors">
0143     <title>&kbibtex; and &latex; Editors</title>
0144     <para>
0145       &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 <ulink url="https://en.wikipedia.org/wiki/Comparison_of_TeX_editors">this page</ulink>.
0146     </para>
0147     <para>
0148       &kbibtex; provides out-of-box <link linkend="integration">integration with &kile; and &lyx;</link> though it can be successfully used with any kind of &latex; editor.
0149     </para>
0150   </sect2>
0151   </sect1>
0152   <sect1 id="intro_mainfeat">
0153     <title>
0154       &kbibtex;'s Main Features
0155     </title>
0156     <para>
0157       &kbibtex; allows you to do the following things:
0158     </para>
0159     <itemizedlist>
0160       <listitem>
0161         <para>
0162           Enter a preamble that defines how special text should be formatted in your bibliography using <menuchoice><guimenu>Element</guimenu><guisubmenu>New element</guisubmenu><guimenuitem>New preamble</guimenuitem></menuchoice> menu item or <link linkend="main-toolbar">Main Toolbar</link>.
0163         </para>
0164       </listitem>
0165       <listitem>
0166         <para>
0167           Choose an entry encoding using <guilabel>Encoding</guilabel> item in <guilabel>Save as</guilabel> dialog or on the <link linkend="file-settings">File Settings panel</link>.
0168         </para>
0169       </listitem>
0170       <listitem>
0171         <para>
0172           Enter comments that are not taken in regard by &bibtex; using <menuchoice><guimenu>Element</guimenu><guisubmenu>New element</guisubmenu><guimenuitem>New comment</guimenuitem></menuchoice> menu item or <link linkend="main-toolbar">Main Toolbar</link>.
0173         </para>
0174       </listitem>
0175       <listitem>
0176         <para>
0177           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 <link linkend="reference-preview">Reference Preview panel</link>. Additional preview styles become available when <application>bibtex2html</application> is installed.
0178         </para>
0179       </listitem>
0180       <listitem>
0181         <para>
0182           Search for the bibliography entries data in online databases using <link linkend="online-search">Online Search panel</link>.
0183         </para>
0184       </listitem>
0185       <listitem>
0186         <para>
0187           View local or remote (online) resources (such as files) <link linkend="adding-link">linked</link> in the &bibtex; entry using <link linkend="document-preview">Document Preview panel</link>.
0188         </para>
0189       </listitem>
0190       <listitem>
0191         <para>
0192           Find and fix duplicate entries in bibliography using <menuchoice><guimenu>Edit</guimenu><guimenuitem>Find Duplicates</guimenuitem></menuchoice> menu item or <link linkend="main-toolbar">Main Toolbar</link>.
0193         </para>
0194       </listitem>
0195       <listitem>
0196         <para>
0197           Import your <ulink url="https://www.zotero.org/">Zotero</ulink> library using <link linkend="zotero">Zotero panel</link>.
0198         </para>
0199       </listitem>
0200     </itemizedlist>
0201   </sect1>
0202 </chapter>
0203 
0204 <chapter id="quickstart">
0205   <title>
0206     Quickstart
0207   </title>
0208   <sect1 id="quick_begin">
0209     <title>
0210       Writing a Bibliography File for Beginners
0211     </title>
0212     <!-- 1) No request from kbibtex from Distro user (Kubuntu) nor from kbibtex self compiled as devel user
0213          2a) Distro user has a mimeapps.list in home, but no kbibtex in it
0214          2b) Devel user has no mimeapps.list in home
0215          2c) Systemsettings -> File Associations is the place to edit/change this in a kde desktop
0216          update after rebuilding post 2014-01-12
0217          Now request Dialog, but in File Associations first app for text/x-bibtext is already kbibtex
0218          (why? from installation of distro?)
0219          This dialog even pops up when opening a .bib file with LMB click in file manager
0220     -->
0221     <para>
0222       After the first run, &kbibtex; will propose to make it the default editor for bibliography formats. We recommend you to do so.<footnote><para>If for some reasons you will decide to reconsider please remove the strings with <literal>kbibtex</literal> substring from <filename>mimeapps.list</filename> file in <filename role="directory">.local/share/applications</filename> folder of your home folder.</para></footnote>
0223     </para>
0224     <para>
0225       Then you will see a window that looks similar to this:
0226     </para>
0227     <screenshot>
0228       <screeninfo>&kbibtex; window after the first start</screeninfo>
0229       <mediaobject>
0230         <imageobject>
0231           <imagedata fileref="first-run.png" format="PNG" />
0232         </imageobject>
0233         <textobject>
0234           <phrase>&kbibtex; window after the first start</phrase>
0235         </textobject>
0236       </mediaobject>
0237     </screenshot>
0238     <para>
0239       To start a new bibliography document press the <guibutton>New</guibutton> button on the right panel, the <guibutton>New</guibutton> button on the toolbar or choose the <menuchoice><shortcut><keycombo>&Ctrl;<keycap>N</keycap></keycombo></shortcut><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice> menu item.
0240     </para>
0241     <para>
0242       Now it is time to add some entries.
0243     </para>
0244     <para>
0245       Users of &kbibtex; have two choices when adding a new entry: they can use the <link linkend="online-search">Online Search panel</link> to find entry data online or they can write the code by hand.
0246     </para>
0247     <para>
0248       Let's try to add a book entry manually.
0249     </para>
0250     <procedure>
0251       <step id="element-editing">
0252         <para>
0253           Choose <menuchoice><guimenu>Element</guimenu><guisubmenu>New element</guisubmenu><guimenuitem>New entry</guimenuitem></menuchoice> from the &kbibtex; menu. &kbibtex; should open <guilabel>Edit Element</guilabel> window.
0254         </para>
0255         <screenshot>
0256           <screeninfo>&kbibtex; element's editing window</screeninfo>
0257           <mediaobject>
0258             <imageobject>
0259               <imagedata fileref="element-editor.png" format="PNG" />
0260             </imageobject>
0261             <textobject>
0262               <phrase>&kbibtex; element's editing window</phrase>
0263             </textobject>
0264           </mediaobject>
0265         </screenshot>
0266       </step>
0267       <step>
0268         <para>
0269           Choose <guimenuitem>Book</guimenuitem> from the <guilabel>Type:</guilabel> drop down list.
0270         </para>
0271       </step>
0272       <step>
0273         <para>
0274           Enter <userinput>Lamport86</userinput> into the <guilabel>Id:</guilabel> field.
0275         </para>
0276         <tip>
0277           <para>
0278             The <quote>Id</quote> is used for referencing the bibliography entry in your main document.
0279           </para>
0280         </tip>
0281       </step>
0282       <step>
0283         <para>
0284           Go to the <guilabel>Title</guilabel> tab and enter <userinput>LaTeX: A Document Preparation System</userinput> into the <guilabel>Title:</guilabel> text box.
0285         </para>
0286       </step>
0287       <step>
0288         <para>
0289           Go to the <guilabel>Author/Editor</guilabel> tab, click on <guibutton>Add</guibutton> button and enter <userinput>Lamport, Leslie</userinput>.
0290         </para>
0291       </step>
0292       <step>
0293         <para>
0294           Go to the <guilabel>Publication</guilabel> tab then enter <userinput>1986</userinput> into the <guilabel>Year:</guilabel> text box and <userinput>Addison-Wesley</userinput> into the <guilabel>Publisher:</guilabel> text box.
0295         </para>
0296       </step>
0297       <step>
0298         <para>
0299           Click <guibutton>OK</guibutton>.
0300         </para>
0301       </step>
0302       <step>
0303         <para>
0304           Choose <menuchoice><shortcut><keycombo>&Ctrl;<keycap>S</keycap></keycombo></shortcut><guimenu>File</guimenu><guimenuitem>Save</guimenuitem></menuchoice> menu item and save your bibliography file as <filename>example.bib</filename> in your to-be-written paper folder.
0305         </para>
0306       </step>
0307     </procedure>
0308   </sect1>
0309 
0310   <sect1 id="quick-using">
0311     <title>
0312       Using the bibliography in your &latex; document
0313     </title>
0314     <para>
0315       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 <quote>References</quote> section to appear):
0316     </para>
0317 <programlisting>
0318 \bibliography{<replaceable>foo</replaceable>}
0319 \bibliographystyle{plain}
0320 </programlisting>
0321     <para>
0322     Here, <replaceable>foo</replaceable> is the name of your <filename role="extension">bib</filename> file created with &kbibtex; and <quote><literal>plain</literal></quote> is the name of bibliography style.
0323     </para>
0324     <para>
0325       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.
0326     </para>
0327     <para>
0328       Below is a list of some generic styles available everywhere:
0329     </para>
0330     <variablelist>
0331       <varlistentry>
0332         <term>
0333       <literal>plain</literal>
0334         </term>
0335         <listitem>
0336           <para>
0337             normal style, listed in alphabetic order and labeled numerically
0338           </para>
0339         </listitem>
0340       </varlistentry>
0341       <varlistentry>
0342         <term>
0343           <literal>unsrt</literal>
0344         </term>
0345         <listitem>
0346           <para>
0347             same as <literal>plain</literal> except entries appear in order of citation
0348           </para>
0349         </listitem>
0350       </varlistentry>
0351       <varlistentry>
0352         <term>
0353           <literal>alpha</literal>
0354         </term>
0355         <listitem>
0356           <para>
0357             same as <literal>plain</literal> except entry identifiers are used
0358           </para>
0359         </listitem>
0360       </varlistentry>
0361       <varlistentry>
0362         <term>
0363           <literal>abbrv</literal>
0364         </term>
0365         <listitem>
0366           <para>
0367             same as <literal>plain</literal> except uses abbreviations for first names, month names, and journal names
0368           </para>
0369         </listitem>
0370       </varlistentry>
0371     </variablelist>
0372     <para>
0373       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 <filename role="extension">tex</filename> name extension.
0374     </para>
0375 <programlisting>
0376 \documentclass{article}
0377  \begin{document}
0378  \bibliographystyle{plain}% Choose a bibliographic style
0379  Test file with a reference (see~\cite{Lamport86}).
0380  \bibliography{example}
0381  \end{document}
0382 </programlisting>
0383     <para>
0384       For our testing purposes, let this file be named <userinput>example.tex</userinput>.
0385     </para>
0386     <note>
0387       <para>
0388         Please save this file to the same folder as your <filename>example.bib</filename>.
0389       </para>
0390     </note>
0391     <para>
0392       Now that you have the basis for a document, you have to run both <application>latex</application> and <application>bibtex</application> to process it.
0393     </para>
0394     <para>
0395       First, you should run <application>latex</application> (to create a <filename>foo.aux</filename> file, which <application>bibtex</application> reads). Then run <application>bibtex</application> once to get some of the citations and create a <filename role="extension">bbl</filename> file. Then run <application>latex</application> again so that the cross references between the text file and the bibliography are correct. You may want to repeat running <application>bibtex</application> and <application>latex</application> on the file to make sure that all cross references are correct. Be warned that adding/deleting citations and sources will require running <application>bibtex</application> again.
0396     </para>
0397     <para>
0398       Thus, the following commands can be used to compile the document from console:
0399     </para>
0400     <screen>latex example
0401 bibtex example
0402 latex example
0403 latex example</screen>
0404     <tip>
0405       <para>
0406         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 (<keycombo>&Alt;<keycap>6</keycap></keycombo> in &kile;) or a toolbar button to see the results.
0407       </para>
0408     </tip>
0409     <para>
0410       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.
0411     </para>
0412     <note>
0413       <para>
0414         Congratulations! You have just created your first document with &bibtex; bibliography.
0415       </para>
0416     </note>
0417   </sect1>
0418 </chapter>
0419 
0420 <chapter id="interface">
0421   <title>
0422     &kbibtex; Interface
0423   </title>
0424     <sect1 id="panels">
0425     <title>
0426       &kbibtex;'s Panels
0427     </title>
0428     <para>
0429       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.
0430     </para>
0431     <para>
0432       You can make the &kbibtex; panels visible or hide them using the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Show Panels</guimenuitem></menuchoice> submenu. It is enough to check the panel's item to make it visible or uncheck it to hide the panel.
0433     </para>
0434     <sect2 id="list-of-documents">
0435       <title>
0436         List of Documents Panel
0437       </title>
0438         <para>
0439           The <guilabel>List of Documents</guilabel> panel allows to switch between the opened bibliography documents (<guilabel>Open Files</guilabel> tab), open recently used documents (<guilabel>Recently Used</guilabel> tab), open your main bibliography documents (<guilabel>Favorites</guilabel> tab), or browse your computer file system to find bibliography documents (<guilabel>Filesystem Browser</guilabel> tab).
0440         </para>
0441         <tip>
0442           <para>
0443             To add a bibliography file to favorites select it on any tab except <guilabel>Favorites</guilabel>, click with &RMB; and choose <guimenuitem>Add to Favorites</guimenuitem>. To remove  the bibliography from favorites select it on <guilabel>Favorites</guilabel> tab, click with &RMB; and choose <guimenuitem>Remove from Favorites</guimenuitem>.
0444           </para>
0445         </tip>
0446         <para>
0447           <screenshot>
0448             <screeninfo>List of documents panel</screeninfo>
0449             <mediaobject>
0450               <imageobject>
0451                 <imagedata fileref="list-of-documents.png" format="PNG" />
0452               </imageobject>
0453               <textobject>
0454                 <phrase>List of documents panel</phrase>
0455               </textobject>
0456             </mediaobject>
0457           </screenshot>
0458         </para>
0459     </sect2>
0460     <sect2 id="list-of-values">
0461       <title>
0462         List of Values Panel
0463       </title>
0464         <para>
0465           The <guilabel>List of Values</guilabel> panel can be used to easy up viewing statistics on usage of values in the entries fields and batch editing of these values.
0466         </para>
0467         <para>
0468           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.
0469         </para>
0470         <para>
0471           You can click with &RMB; on an entry in the lower list to access the batch editing capabilities. It is possible to <guimenuitem>Replace all occurrences</guimenuitem> of the value, <guimenuitem>Delete all occurrences</guimenuitem> of the value, <guimenuitem>Search for selected values</guimenuitem> using the <link linkend="filter-toolbar">Filter Toolbar</link>, <guimenuitem>Add value to selected entries</guimenuitem>, <guimenuitem>Replace value of selected entries</guimenuitem> or <guimenuitem>Remove value from selected entries</guimenuitem> (some entries should be selected in the main entry list first).
0472         </para>
0473         <para>
0474           <screenshot>
0475             <screeninfo>List of values panel</screeninfo>
0476             <mediaobject>
0477               <imageobject>
0478                 <imagedata fileref="list-of-values.png" format="PNG" />
0479               </imageobject>
0480               <textobject>
0481                 <phrase>List of values panel</phrase>
0482               </textobject>
0483             </mediaobject>
0484           </screenshot>
0485         </para>
0486     </sect2>
0487     <sect2 id="statistics">
0488       <title>
0489         Statistics Panel
0490       </title>
0491       <para>
0492           The <guilabel>Statistics</guilabel> panel is designed to display a comprehensive list of statistical information about the current bibliography document.
0493         </para>
0494         <para>
0495           <screenshot>
0496             <screeninfo>Statistics panel</screeninfo>
0497             <mediaobject>
0498               <imageobject>
0499                 <imagedata fileref="statistics.png" format="PNG" />
0500               </imageobject>
0501               <textobject>
0502                 <phrase>Statistics panel</phrase>
0503               </textobject>
0504             </mediaobject>
0505           </screenshot>
0506         </para>
0507     </sect2>
0508     <sect2 id="reference-preview">
0509       <title>
0510         Reference Preview Panel
0511       </title>
0512         <para>
0513           The <guilabel>Reference Preview</guilabel> panel is used to preview and save in &HTML; format the currently selected bibliography entry.
0514         </para>
0515         <para>
0516           <screenshot>
0517             <screeninfo>Reference preview panel</screeninfo>
0518             <mediaobject>
0519               <imageobject>
0520                 <imagedata fileref="reference-preview.png" format="PNG" />
0521               </imageobject>
0522               <textobject>
0523                 <phrase>Reference preview panel</phrase>
0524               </textobject>
0525             </mediaobject>
0526           </screenshot>
0527         </para>
0528         <para>
0529           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 <application>bibtex2html</application> is installed.
0530         </para>
0531         <tip>
0532           <para>
0533             When you click on the elements of the reference in &XML;-based format &kbibtex; will apply the corresponding <link linkend="filter-toolbar">filtering</link> to the bibliography list.
0534           </para>
0535         </tip>
0536         <para>
0537           Click the <guibutton>
0538           <inlinemediaobject>
0539             <imageobject>
0540               <imagedata fileref="document-open.png" format="PNG"/>
0541             </imageobject>
0542           </inlinemediaobject>
0543           Open</guibutton> button to open the reference in the default Internet browser. The <guibutton>
0544           <inlinemediaobject>
0545             <imageobject>
0546               <imagedata fileref="document-save.png" format="PNG"/>
0547             </imageobject>
0548           </inlinemediaobject>
0549           Save as &HTML;</guibutton> button can be used to save the reference in &HTML; for further use on your website.
0550         </para>
0551         <para>
0552           You can click with &RMB; on the panel to select <guimenuitem>Reload</guimenuitem> to update the reference according to the latest changes in the entry.
0553         </para>
0554     </sect2>
0555     <sect2 id="file-settings">
0556       <title>
0557         File Settings Panel
0558       </title>
0559         <para>
0560           The <guilabel>File Settings</guilabel> panel can be used to define some parameters of the <filename role="extension">bib</filename> file of the current bibliography.
0561         </para>
0562         <para>
0563           <screenshot>
0564             <screeninfo>File settings panel</screeninfo>
0565             <mediaobject>
0566               <imageobject>
0567                 <imagedata fileref="file-settings.png" format="PNG" />
0568               </imageobject>
0569               <textobject>
0570                 <phrase>File settings panel</phrase>
0571               </textobject>
0572             </mediaobject>
0573           </screenshot>
0574         </para>
0575         <para>
0576           It is possible to select <guilabel>Encoding</guilabel>, <guilabel>String Delimiters</guilabel>, <guilabel>Comment Quoting</guilabel>, <guilabel>Keyword Casing</guilabel>, and <guilabel>Person Names Formatting</guilabel>.
0577         </para>
0578         <para>
0579           By default &bibtex; will lowercase all intermediate words in sentences. Check <guilabel>Protect Titles</guilabel> check box to protect the case in the entry titles.
0580         </para>
0581     </sect2>
0582     <sect2 id="online-search">
0583       <title>
0584         Online Search Panel
0585       </title>
0586         <para>
0587           The <guilabel>Online Search</guilabel> 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.
0588         </para>
0589         <para>
0590           <screenshot>
0591             <screeninfo>Online Search panel</screeninfo>
0592             <mediaobject>
0593               <imageobject>
0594                 <imagedata fileref="online-search.png" format="PNG" />
0595               </imageobject>
0596               <textobject>
0597                 <phrase>Online Search panel</phrase>
0598               </textobject>
0599             </mediaobject>
0600           </screenshot>
0601         </para>
0602         <para>
0603           The entries can be searched by <guilabel>Free text</guilabel>, <guilabel>Title</guilabel>, <guilabel>Author</guilabel>, or <guilabel>Year</guilabel>. The number of results shown on the <link linkend="search-results">Search Results panel</link> can be tweaked using the <guilabel>Number of Results</guilabel> spin box.
0604         </para>
0605         <para>
0606           Click the <guibutton>
0607           <inlinemediaobject>
0608             <imageobject>
0609               <imagedata fileref="go-up.png" format="PNG"/>
0610             </imageobject>
0611           </inlinemediaobject>
0612           Use Entry</guibutton> 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 <guibutton>
0613           <inlinemediaobject>
0614             <imageobject>
0615               <imagedata fileref="media-playback-start.png" format="PNG"/>
0616             </imageobject>
0617           </inlinemediaobject>
0618           Search</guibutton> button can be used to start the search.
0619         </para>
0620         <para>
0621           &kbibtex; can perform a search in the most popular Internet databases. To select the set of the databases for your search switch to the <guilabel>Engines</guilabel> tab or click with &LMB; on the <guilabel>change</guilabel> link on the <guilabel>Query Terms</guilabel> tab.
0622         </para>
0623         <para>
0624           To visit the database homepage in the Internet click with &RMB; on its entry in the <guilabel>Engines</guilabel> tab and select <guimenuitem>Go to Homepage</guimenuitem>.
0625         </para>
0626     </sect2>
0627     <sect2 id="zotero">
0628       <title>
0629         Zotero Panel
0630       </title>
0631         <para>
0632           The <guilabel>Zotero</guilabel> panel can be used to import your <ulink url="https://www.zotero.org/">Zotero</ulink> library.
0633         </para>
0634         <para>
0635           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 <ulink url="https://www.zotero.org/support/">here</ulink>.
0636         </para>
0637         <para>
0638           <screenshot>
0639             <screeninfo>Zotero panel</screeninfo>
0640             <mediaobject>
0641               <imageobject>
0642                 <imagedata fileref="zotero.png" format="PNG" />
0643               </imageobject>
0644               <textobject>
0645                 <phrase>Zotero panel</phrase>
0646               </textobject>
0647             </mediaobject>
0648           </screenshot>
0649         </para>
0650         <para>
0651           Click the <guibutton>
0652           <inlinemediaobject>
0653             <imageobject>
0654               <imagedata fileref="preferences-web-browser-identification.png" format="PNG"/>
0655             </imageobject>
0656           </inlinemediaobject>
0657           Get New Credentials</guibutton> button on <guilabel>Credentials</guilabel> tab to start the Zotero authorization wizard. Follow the instructions to allow &kbibtex; access your Zotero library.
0658         </para>
0659         <para>
0660           To access the library entries double-click on the corresponding item on <guilabel>Collections</guilabel> or <guilabel>Tags</guilabel> tabs. The entries that satisfy the chosen criteria will be shown on the <link linkend="search-results">Search Results panel</link>.
0661         </para>
0662     </sect2>
0663     <sect2 id="search-results">
0664       <title>
0665         Search Results Panel
0666       </title>
0667         <para>
0668           The <guilabel>Search Results</guilabel> panel is used to handle the search results obtained using <link linkend="online-search">Online Search panel</link>.
0669         </para>
0670         <para>
0671           <screenshot>
0672             <screeninfo>Search Results panel</screeninfo>
0673             <mediaobject>
0674               <imageobject>
0675                 <imagedata fileref="search-results.png" format="PNG" />
0676               </imageobject>
0677               <textobject>
0678                 <phrase>Search Results panel</phrase>
0679               </textobject>
0680             </mediaobject>
0681           </screenshot>
0682         </para>
0683         <para>
0684           Click the <guibutton>
0685           <inlinemediaobject>
0686             <imageobject>
0687               <imagedata fileref="svn-update.png" format="PNG"/>
0688             </imageobject>
0689           </inlinemediaobject>
0690           Import</guibutton> button to import the currently selected search result into your bibliography.
0691         </para>
0692         <para>
0693           To access other actions for the currently selected search result click on it with &RMB;. From the opened menu you can review the result (<guimenuitem>View Element</guimenuitem> item) or copy it for further pasting in &bibtex; format elsewhere with <keycombo>&Ctrl;<keycap>V</keycap></keycombo> (<guimenuitem>Copy</guimenuitem> item).
0694         </para>
0695     </sect2>
0696     <sect2 id="element-editor">
0697       <title>
0698         Element Editor Panel
0699       </title>
0700         <para>
0701           The <guilabel>Element Editor</guilabel> panel can be used to edit the currently selected bibliography element.
0702         </para>
0703         <para>
0704           <screenshot>
0705             <screeninfo>Element Editor panel</screeninfo>
0706             <mediaobject>
0707               <imageobject>
0708                 <imagedata fileref="element-editor.png" format="PNG" />
0709               </imageobject>
0710               <textobject>
0711                 <phrase>Element Editor panel</phrase>
0712               </textobject>
0713             </mediaobject>
0714           </screenshot>
0715         </para>
0716         <para>
0717           Click the
0718           <inlinemediaobject>
0719             <imageobject>
0720               <imagedata fileref="view-filter.png" format="PNG"/>
0721             </imageobject>
0722           </inlinemediaobject>
0723           button to select a <link linkend="config-id-suggestions">suggested identifier</link> for the element.
0724         </para>
0725         <para>
0726           Enter the respective data in the editor fields. The field data format can be switched between <guimenuitem>Text</guimenuitem>, <guimenuitem>Reference</guimenuitem> and <guimenuitem>Source Code</guimenuitem> using the drop down box to the left of the text box.
0727         </para>
0728         <para>
0729           Click the <guibutton>
0730           <inlinemediaobject>
0731             <imageobject>
0732               <imagedata fileref="configure.png" format="PNG"/>
0733             </imageobject>
0734           </inlinemediaobject>
0735           Options</guibutton> button to open a drop down menu with two items.
0736         </para>
0737         <para>
0738           The <guimenuitem>Show all fields</guimenuitem> item can be used to show or hide all empty fields of the current element.
0739         </para>
0740         <para>
0741           It is possible to switch keyboard focus between the fields using the &Tab; key. So the second menu item, <guimenuitem>Tab key visits only editable fields</guimenuitem>, can be used to switch on and off navigation between editable fields only.
0742         </para>
0743         <para>
0744           Click the <guibutton>
0745           <inlinemediaobject>
0746             <imageobject>
0747               <imagedata fileref="tools-check-spelling.png" format="PNG"/>
0748             </imageobject>
0749           </inlinemediaobject>
0750           Check with &bibtex;</guibutton> button to preview the editing entry as it will be shown in the compiled &PDF; file.
0751         </para>
0752         <para>
0753           Check the <guilabel>Automatically apply changes</guilabel> box to have all your changes automatically applied to the entry without the need to click the <guibutton>Apply</guibutton> button.
0754         </para>
0755         <para>
0756           Click the <guibutton>
0757           <inlinemediaobject>
0758             <imageobject>
0759               <imagedata fileref="edit-undo.png" format="PNG"/>
0760             </imageobject>
0761           </inlinemediaobject>
0762           Reset</guibutton> button to revert all your changes.
0763         </para>
0764       </sect2>
0765       <sect2 id="document-preview">
0766       <title>
0767         Document Preview Panel
0768       </title>
0769         <para>
0770           The <guilabel>Document Preview</guilabel> panel can be used to preview pages or documents <link linkend="adding-link">linked</link> with the currently selected bibliography entry.
0771         </para>
0772         <tip>
0773           <para>
0774             By default, the <guilabel>Document Preview</guilabel> panel can be opened by pressing <keycombo>&Ctrl;&Shift;<keycap>D</keycap></keycombo> keyboard shortcut.
0775           </para>
0776         </tip>
0777         <para>
0778           <screenshot>
0779             <screeninfo>Document Preview panel</screeninfo>
0780             <mediaobject>
0781               <imageobject>
0782                 <imagedata fileref="document-preview.png" format="PNG" />
0783               </imageobject>
0784               <textobject>
0785                 <phrase>Document Preview panel</phrase>
0786               </textobject>
0787             </mediaobject>
0788           </screenshot>
0789         </para>
0790         <para>
0791           Click the
0792           <inlinemediaobject>
0793             <imageobject>
0794               <imagedata fileref="applications-internet.png" format="PNG"/>
0795             </imageobject>
0796           </inlinemediaobject>
0797           button to toggle between local files only and all documents including the remote ones.
0798         </para>
0799         <para>
0800           Click the
0801           <inlinemediaobject>
0802             <imageobject>
0803               <imagedata fileref="document-open.png" format="PNG"/>
0804             </imageobject>
0805           </inlinemediaobject>
0806           button to open the page or the document in the default external application.
0807         </para>
0808         <para>
0809           The <guilabel>Address</guilabel> drop down box can be used to switch between the pages and documents.
0810         </para>
0811     </sect2>
0812   </sect1>
0813   <sect1 id="toolbars">
0814     <title>
0815       &kbibtex;'s Toolbars
0816     </title>
0817     <para>
0818       &kbibtex; has two completely customizable toolbars located on the top part of its window.
0819     </para>
0820     <para>
0821       More information on customizing the toolbars can be found in the <ulink url="help:/fundamentals/config.html#toolbars">corresponding section of &kde; Fundamentals manual</ulink>. Below is the short description of the default buttons of &kbibtex; toolbars.
0822     </para>
0823     <sect2 id="main-toolbar">
0824       <title>
0825         Main Toolbar
0826       </title>
0827         <para>
0828           <screenshot>
0829             <screeninfo>Main Toolbar</screeninfo>
0830             <mediaobject>
0831               <imageobject>
0832                 <imagedata fileref="main-toolbar.png" format="PNG" />
0833               </imageobject>
0834               <textobject>
0835                 <phrase>Main Toolbar</phrase>
0836               </textobject>
0837               <caption>
0838                 <para>
0839                   The default Main Toolbar of &kbibtex;.
0840                 </para>
0841               </caption>
0842             </mediaobject>
0843           </screenshot>
0844         </para>
0845         <para>
0846           <itemizedlist>
0847             <listitem>
0848               <para>
0849                 <guibutton>New</guibutton>: creates a new bibliography document.
0850               </para>
0851             </listitem>
0852             <listitem>
0853               <para>
0854                 <guibutton>Open</guibutton>: opens the <ulink url="help:/fundamentals/files.html">generic &kde; Open/Save dialog</ulink> to open some existing bibliography to edit.
0855               </para>
0856             </listitem>
0857             <listitem>
0858               <para>
0859                 <guibutton>Close</guibutton>: closes the currently active bibliography document.
0860               </para>
0861             </listitem>
0862             <listitem>
0863               <para>
0864                 <guibutton>Save</guibutton>: saves the currently active bibliography document.
0865               </para>
0866             </listitem>
0867             <listitem>
0868               <para>
0869                 <guibutton>Save as</guibutton>: allows to save the currently open bibliography document under the new name using the <ulink url="help:/fundamentals/files.html">generic &kde; Open/Save dialog</ulink>.
0870               </para>
0871             </listitem>
0872             <listitem>
0873               <para>
0874                 <guibutton>New element</guibutton>: allows to create the new entry, comment, preamble or <link linkend="macros">macro</link> in the current bibliography document.
0875               </para>
0876             </listitem>
0877             <listitem>
0878               <para>
0879                 <guibutton>Find Duplicates</guibutton>: finds and fixes duplicate elements in the current bibliography document.
0880               </para>
0881             </listitem>
0882             <listitem>
0883               <para>
0884                 <guibutton>Send to &lyx;/&kile;</guibutton>: sends a reference on the currently selected bibliography entry to &lyx; or &kile;. More on this in the <link linkend="integration">corresponding chapter of this manual</link>.
0885               </para>
0886             </listitem>
0887           </itemizedlist>
0888         </para>
0889     </sect2>
0890     <sect2 id="filter-toolbar">
0891       <title>
0892         Filter Toolbar
0893       </title>
0894         <para>
0895           <screenshot>
0896             <screeninfo>Filter Toolbar</screeninfo>
0897             <mediaobject>
0898               <imageobject>
0899                 <imagedata fileref="filter-toolbar.png" format="PNG" />
0900               </imageobject>
0901               <textobject>
0902                 <phrase>Filter Toolbar</phrase>
0903               </textobject>
0904               <caption>
0905                 <para>
0906                   The default Filter Toolbar of &kbibtex;.
0907                 </para>
0908               </caption>
0909             </mediaobject>
0910           </screenshot>
0911         </para>
0912         <para>
0913           The simplest method to navigate in large bibliographies is to use the <guilabel>Filter</guilabel> toolbar: &kbibtex; will filter the displayed list according to your input. If you are searching for some element, but you do not know its exact position in the list, just type some letters from its data in the <guilabel>Filter</guilabel> text box.
0914         </para>
0915         <para>
0916           When you enter the first few letters, you will see the list changing. The more letters you enter, the more reduced list you will see. This filtering occurs immediately as you type.
0917         </para>
0918         <para>
0919           If you look at the right part of the <guilabel>Filter</guilabel> toolbar, you will notice two drop-down menus. The drop-down menus were designed for you to be able to quickly tailor filtering criteria to your needs. The first drop-down menu is used to define matching mode (<guimenuitem>any word</guimenuitem>, <guimenuitem>every word</guimenuitem> or <guimenuitem>exact phrase</guimenuitem>). The second is to define the field where the filtering should be done. You can choose <guimenuitem>any field</guimenuitem> or select a field to narrow down the list of the results in large bibliographies.
0920         </para>
0921         <para>
0922           There are also two buttons on this toolbar:
0923         </para>
0924         <para>
0925           <itemizedlist>
0926             <listitem>
0927               <para>
0928                 <inlinemediaobject>
0929                   <imageobject>
0930                     <imagedata fileref="application-pdf.png" format="PNG"/>
0931                   </imageobject>
0932                 </inlinemediaobject>
0933                 <guibutton>Include &PDF; files in fulltext search</guibutton>: allows you to include fulltext &PDF; in the filtering.
0934               </para>
0935             </listitem>
0936             <listitem>
0937               <para>
0938                 <inlinemediaobject>
0939                   <imageobject>
0940                     <imagedata fileref="edit-clear-locationbar-rtl.png" format="PNG"/>
0941                   </imageobject>
0942                 </inlinemediaobject>
0943                 <guibutton>Reset filter criteria</guibutton>: resets filtering criteria.
0944               </para>
0945             </listitem>
0946           </itemizedlist>
0947         </para>
0948     </sect2>
0949   </sect1>
0950   <sect1 id="menus">
0951     <title>
0952       &kbibtex;'s Menus
0953     </title>
0954     <para>
0955       &kbibtex; follows the standard &kde; menu scheme. So it has many menu entries that are common for all &kde; applications. More information on these menu entries can be found <ulink url="help:/fundamentals/menus.html">this help section</ulink>.
0956     </para>
0957     <para>
0958       Below, you can find descriptions for &kbibtex;-specific menu entries.
0959     </para>
0960     <variablelist>
0961       <varlistentry>
0962         <term>
0963           <menuchoice>
0964             <guimenu>Edit</guimenu>
0965             <guimenuitem>Delete</guimenuitem>
0966           </menuchoice>
0967         </term>
0968         <listitem>
0969           <para>
0970             Delete currently selected element in the bibliography list.
0971           </para>
0972         </listitem>
0973       </varlistentry>
0974       <varlistentry>
0975         <term>
0976           <menuchoice>
0977             <guimenu>Edit</guimenu>
0978             <guimenuitem>Find Duplicates</guimenuitem>
0979           </menuchoice>
0980         </term>
0981         <listitem>
0982           <para>
0983             Allows you to find and remove duplicates in the currently opened bibliography.
0984           </para>
0985         </listitem>
0986       </varlistentry>
0987       <varlistentry>
0988         <term>
0989           <menuchoice>
0990             <guimenu>Element</guimenu>
0991             <guisubmenu>New element</guisubmenu>
0992             <guimenuitem>New entry</guimenuitem>
0993           </menuchoice>
0994         </term>
0995         <listitem>
0996           <para>
0997             Open <link linkend="element-editor">Edit Element</link> window to enter a new bibliography entry.
0998           </para>
0999         </listitem>
1000       </varlistentry>
1001       <varlistentry>
1002         <term>
1003           <menuchoice>
1004             <guimenu>Element</guimenu>
1005             <guisubmenu>New element</guisubmenu>
1006             <guimenuitem>New comment</guimenuitem>
1007           </menuchoice>
1008         </term>
1009         <listitem>
1010           <para>
1011             Open <link linkend="element-editor">Edit Element</link> window to enter a new comment that are not taken in regard by &bibtex;.
1012           </para>
1013         </listitem>
1014       </varlistentry>
1015       <varlistentry>
1016         <term>
1017           <menuchoice>
1018             <guimenu>Element</guimenu>
1019             <guisubmenu>New element</guisubmenu>
1020             <guimenuitem>New macro</guimenuitem>
1021           </menuchoice>
1022         </term>
1023         <listitem>
1024           <para>
1025             Open <link linkend="element-editor">Edit Element</link> window to enter a new <link linkend="macros">macro</link>.
1026           </para>
1027         </listitem>
1028       </varlistentry>
1029       <varlistentry>
1030         <term>
1031           <menuchoice>
1032             <guimenu>Element</guimenu>
1033             <guisubmenu>New element</guisubmenu>
1034             <guimenuitem>New preamble</guimenuitem>
1035           </menuchoice>
1036         </term>
1037         <listitem>
1038           <para>
1039             Open <link linkend="element-editor">Edit Element</link> window to enter a new bibliography preamble that defines how special text should be formatted in your bibliography.
1040           </para>
1041         </listitem>
1042       </varlistentry>
1043       <varlistentry>
1044         <term>
1045           <menuchoice>
1046             <shortcut>
1047               <keycombo>
1048                 &Ctrl;
1049                 <keycap>E</keycap>
1050               </keycombo>
1051             </shortcut>
1052             <guimenu>Element</guimenu>
1053             <guimenuitem>Edit Element</guimenuitem>
1054           </menuchoice>
1055         </term>
1056         <listitem>
1057           <para>
1058             Open <link linkend="element-editor">Edit Element</link> window to edit the currently selected bibliography element.
1059           </para>
1060         </listitem>
1061       </varlistentry>
1062       <varlistentry id="adding-link">
1063         <term>
1064           <menuchoice>
1065             <shortcut>
1066               <keycombo>
1067                 &Ctrl;
1068                 <keycap>D</keycap>
1069               </keycombo>
1070             </shortcut>
1071             <guimenu>Element</guimenu>
1072             <guisubmenu>View Document</guisubmenu>
1073           </menuchoice>
1074         </term>
1075         <listitem>
1076           <para>
1077             Open local or remote document for the currently selected entry in the bibliography list.
1078           </para>
1079           <para>
1080             The link to the document can be added or edited using <guilabel>External</guilabel> tab of <link linkend="element-editor">Edit Element</link> window.
1081           </para>
1082           <screenshot>
1083             <screeninfo>External documents tab of entry's editing dialog</screeninfo>
1084             <mediaobject>
1085               <imageobject>
1086                 <imagedata fileref="external-tab.png" format="PNG" />
1087               </imageobject>
1088               <textobject>
1089                 <phrase>External documents tab of entry's editing dialog</phrase>
1090               </textobject>
1091             </mediaobject>
1092           </screenshot>
1093           <para>
1094             The
1095             <guilabel>
1096             <inlinemediaobject>
1097               <imageobject>
1098                 <imagedata fileref="list-add.png" format="PNG"/>
1099               </imageobject>
1100             </inlinemediaobject>
1101             Add</guilabel> button can be used to add a link to remote page.
1102           </para>
1103           <para>
1104             The
1105             <guilabel>
1106             <inlinemediaobject>
1107               <imageobject>
1108                 <imagedata fileref="list-add.png" format="PNG"/>
1109               </imageobject>
1110             </inlinemediaobject>
1111             Add file...</guilabel> drop down box is used to select some local file and add a reference or the whole file to the current bibliography.
1112           </para>
1113           <para>
1114             If you click on
1115             <inlinemediaobject>
1116               <imageobject>
1117                 <imagedata fileref="edit-clear-locationbar-rtl.png" format="PNG"/>
1118               </imageobject>
1119             </inlinemediaobject> the currently selected item will be cleared.
1120           </para>
1121           <para>
1122             Click on the
1123             <inlinemediaobject>
1124               <imageobject>
1125                 <imagedata fileref="document-open-remote.png" format="PNG"/>
1126               </imageobject>
1127             </inlinemediaobject> button to open the document link in the browser.
1128           </para>
1129           <para>
1130             Click on the
1131             <inlinemediaobject>
1132               <imageobject>
1133                 <imagedata fileref="list-remove.png" format="PNG"/>
1134               </imageobject>
1135             </inlinemediaobject> button to remove the currently selected document item.
1136           </para>
1137           <para>
1138             To rearrange items in the document list use
1139             <inlinemediaobject>
1140               <imageobject>
1141                 <imagedata fileref="go-down.png" format="PNG"/>
1142               </imageobject>
1143             </inlinemediaobject> and
1144           <inlinemediaobject>
1145               <imageobject>
1146                 <imagedata fileref="go-up.png" format="PNG"/>
1147               </imageobject>
1148             </inlinemediaobject> buttons.
1149           </para>
1150           <para>
1151             Eventually, the
1152             <inlinemediaobject>
1153               <imageobject>
1154                 <imagedata fileref="document-save.png" format="PNG"/>
1155               </imageobject>
1156             </inlinemediaobject> button can be used to save remote documents locally.
1157           </para>
1158         </listitem>
1159       </varlistentry>
1160       <varlistentry>
1161         <term>
1162           <menuchoice>
1163             <guimenu>Element</guimenu>
1164             <guimenuitem>Find &PDF;...</guimenuitem>
1165           </menuchoice>
1166         </term>
1167         <listitem>
1168           <para>
1169             Try to find some &PDF; documents for the currently selected bibliography entry in the Internet.
1170           </para>
1171           <screenshot>
1172             <screeninfo>Find &PDF; dialog</screeninfo>
1173             <mediaobject>
1174               <imageobject>
1175                 <imagedata fileref="find-pdf.png" format="PNG" />
1176               </imageobject>
1177               <textobject>
1178                 <phrase>Find &PDF; dialog</phrase>
1179               </textobject>
1180             </mediaobject>
1181           </screenshot>
1182           <para>
1183             You can <guilabel>Ignore</guilabel>, <guilabel>Download</guilabel> or just <guilabel>Use &URL; only</guilabel> for the entry.
1184           </para>
1185         </listitem>
1186       </varlistentry>
1187       <varlistentry id="format-entry-ids">
1188         <term>
1189           <menuchoice>
1190             <guimenu>Element</guimenu>
1191             <guimenuitem>Format entry ids</guimenuitem>
1192           </menuchoice>
1193         </term>
1194         <listitem>
1195           <para>
1196             Allows you to format identifiers for the currently selected bibliography entries according to the default formatting.
1197           </para>
1198           <para>
1199             The default identifiers formatting can be defined using <link linkend="config-id-suggestions">Id Suggestions page</link> of &kbibtex; configuration dialog.
1200           </para>
1201         </listitem>
1202       </varlistentry>
1203       <varlistentry>
1204         <term>
1205           <menuchoice>
1206             <guimenu>Element</guimenu>
1207             <guisubmenu>Color</guisubmenu>
1208           </menuchoice>
1209         </term>
1210         <listitem>
1211           <para>
1212             Allows you to select a color label to the currently selected bibliography entries or remove such label (<guimenuitem>No color</guimenuitem>).
1213           </para>
1214           <para>
1215             The color labels can be configured using <link linkend="config-color">Color &amp; Labels page</link> of &kbibtex; configuration dialog.
1216           </para>
1217         </listitem>
1218       </varlistentry>
1219       <varlistentry>
1220         <term>
1221           <menuchoice>
1222             <guimenu>Element</guimenu>
1223             <guimenuitem>Send to &lyx;/&kile;</guimenuitem>
1224           </menuchoice>
1225         </term>
1226         <listitem>
1227           <para>
1228             <link linkend="integration">Send references</link> to the currently selected bibliography entries to &lyx; or &kile;.
1229           </para>
1230         </listitem>
1231       </varlistentry>
1232       <varlistentry>
1233         <term>
1234           <menuchoice>
1235             <guimenu>Settings</guimenu>
1236             <guimenuitem>Configure &kbibtex;...</guimenuitem>
1237           </menuchoice>
1238         </term>
1239         <listitem>
1240           <para>
1241             Open <link linkend="config-dialog">&kbibtex; configuration dialog</link>.
1242           </para>
1243         </listitem>
1244       </varlistentry>
1245     </variablelist>
1246   </sect1>
1247   <sect1 id="config-dialog">
1248     <title>
1249       &kbibtex;'s Configuration Dialog
1250     </title>
1251     <para>
1252       Several &kbibtex; parameters can be configured via the <guilabel>Preferences</guilabel> dialog. This dialog can be opened using the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kbibtex;...</guimenuitem></menuchoice> menu item. Below you can find a description of &kbibtex; configuration pages.
1253     </para>
1254     <para>
1255       Click the <guibutton>
1256         <inlinemediaobject>
1257           <imageobject>
1258             <imagedata fileref="document-revert.png" format="PNG"/>
1259           </imageobject>
1260         </inlinemediaobject>
1261       Defaults</guibutton> button to reset all items to their default values.
1262     </para>
1263     <para>
1264       The <guibutton>
1265         <inlinemediaobject>
1266           <imageobject>
1267             <imagedata fileref="edit-undo.png" format="PNG"/>
1268           </imageobject>
1269         </inlinemediaobject>
1270         Reset</guibutton> button can be used to discard all current configuration changes without closing the <guilabel>Preferences</guilabel> window.
1271     </para>
1272     <sect2 id="config-general">
1273       <title>
1274         General Configuration
1275       </title>
1276       <screenshot>
1277         <screeninfo>General configuration</screeninfo>
1278         <mediaobject>
1279           <imageobject>
1280             <imagedata fileref="config-general.png" format="PNG" />
1281           </imageobject>
1282           <textobject>
1283             <phrase>General configuration</phrase>
1284           </textobject>
1285         </mediaobject>
1286       </screenshot>
1287       <para>
1288         This configuration page allows you to change the default <guilabel>Person Names formatting</guilabel> which will be automatically applied to the names entered in the <link linkend="element-editor">Element Editor</link> dialog.
1289       </para>
1290       </sect2>
1291     <sect2 id="config-keywords">
1292       <title>
1293         Keywords Configuration
1294       </title>
1295       <screenshot>
1296         <screeninfo>Keywords configuration</screeninfo>
1297           <mediaobject>
1298             <imageobject>
1299               <imagedata fileref="config-keywords.png" format="PNG" />
1300             </imageobject>
1301             <textobject>
1302               <phrase>Keywords configuration</phrase>
1303             </textobject>
1304           </mediaobject>
1305         </screenshot>
1306         <para>
1307           This page can be used to edit keyword list. The keywords applied to the bibliography entries with <link linkend="element-editor">Element Editor</link> are useful to structurize your bibliography. <link linkend="filter-toolbar">Filtering</link> by keywords can give you a fine-grained results by topics.
1308         </para>
1309         <para>
1310           The
1311           <guibutton>
1312             <inlinemediaobject>
1313               <imageobject>
1314                 <imagedata fileref="list-add.png" format="PNG"/>
1315               </imageobject>
1316             </inlinemediaobject>
1317           Add</guibutton> button can be used to add a keyword to the list.
1318         </para>
1319         <para>
1320           Click on the <guibutton>
1321           <inlinemediaobject>
1322             <imageobject>
1323               <imagedata fileref="list-remove.png" format="PNG"/>
1324             </imageobject>
1325           </inlinemediaobject>
1326           Remove</guibutton> button to remove the currently selected keyword item.
1327         </para>
1328       </sect2>
1329       <sect2 id="config-color">
1330       <title>
1331         Color &amp; Labels Configuration
1332       </title>
1333       <screenshot>
1334         <screeninfo>Color &amp; Labels configuration</screeninfo>
1335           <mediaobject>
1336             <imageobject>
1337               <imagedata fileref="config-color.png" format="PNG" />
1338             </imageobject>
1339             <textobject>
1340               <phrase>Color &amp; Labels configuration</phrase>
1341             </textobject>
1342           </mediaobject>
1343         </screenshot>
1344         <para>
1345           Color labels are another useful way to structurize your bibliography. This configuration page can be used to define the labels and their colors.
1346         </para>
1347         <para>
1348           The <guibutton>
1349             <inlinemediaobject>
1350               <imageobject>
1351                 <imagedata fileref="list-add.png" format="PNG"/>
1352               </imageobject>
1353             </inlinemediaobject>
1354           Add</guibutton> button can be used to add a label to the list.
1355         </para>
1356         <para>
1357           Click on the <guibutton>
1358           <inlinemediaobject>
1359             <imageobject>
1360               <imagedata fileref="list-remove.png" format="PNG"/>
1361             </imageobject>
1362           </inlinemediaobject>
1363           Remove</guibutton> button to remove the currently selected label.
1364         </para>
1365         <para>
1366           Double click on an item in the <guilabel>Color</guilabel> or <guilabel>Label</guilabel> column to start editing it.
1367         </para>
1368       </sect2>
1369       <sect2 id="config-id-suggestions">
1370       <title>
1371         Id Suggestions Configuration
1372       </title>
1373       <screenshot>
1374         <screeninfo>Id suggestions configuration</screeninfo>
1375           <mediaobject>
1376             <imageobject>
1377               <imagedata fileref="config-id-suggestions.png" format="PNG" />
1378             </imageobject>
1379             <textobject>
1380               <phrase>Id suggestions configuration</phrase>
1381             </textobject>
1382           </mediaobject>
1383         </screenshot>
1384         <para>
1385           This configuration page is used to handle identifier suggestion schemes for <link linkend="element-editor">Element Editor</link>. You can add, edit, remove and rearrange the schemes using the respective buttons to the right of the suggestions list.
1386         </para>
1387         <para>
1388           Click the <guibutton>
1389           <inlinemediaobject>
1390             <imageobject>
1391               <imagedata fileref="favorites.png" format="PNG"/>
1392             </imageobject>
1393           </inlinemediaobject>
1394           Toggle Default</guibutton> button to switch the default id suggestion scheme to the currently selected item. This button can be used to define format for the <link linkend="format-entry-ids">Format entry ids</link> action.
1395         </para>
1396       </sect2>
1397       <sect2 id="config-user-interface">
1398       <title>
1399         User Interface Configuration
1400       </title>
1401       <screenshot>
1402         <screeninfo>User interface configuration</screeninfo>
1403           <mediaobject>
1404             <imageobject>
1405               <imagedata fileref="config-user-interface.png" format="PNG" />
1406             </imageobject>
1407             <textobject>
1408               <phrase>User interface configuration</phrase>
1409             </textobject>
1410           </mediaobject>
1411         </screenshot>
1412         <para>
1413           Using this configuration page you can make &kbibtex; show or hide comments and macros in the bibliography list, choose bibliography system (&bibtex; or &biblatex;) and define what to do when you double-click an element in the bibliography list (<guimenuitem>Open Editor</guimenuitem> or <link linkend="document-preview"><guimenuitem>View Document</guimenuitem></link>).
1414         </para>
1415         <tip>
1416           <para>
1417             &biblatex; is a reimplementation of &bibtex;. With &biblatex; the formatting of the bibliography is entirely controlled by &latex; macros, not <filename role="extension">bst</filename> files. It supports subdivided bibliographies, multiple bibliographies within one document, and separate lists of bibliographic shorthands. Bibliographies may be subdivided into parts and/or segmented by topics. Just like the bibliography styles, all citation commands may be freely defined. The &biblatex; package is completely localized and can interface with the babel package.<footnote><para>From &biblatex; documentation.</para></footnote>
1418           </para>
1419           <para>
1420             Also &biblatex; can use <ulink url="http://biblatex-biber.sourceforge.net/">biber</ulink> as a backend. With &biblatex; it is possible to use UTF-8 symbols in bibliography entries.
1421           </para>
1422           <para>
1423             So you can use &biblatex; to create sophisticated bibliographies.
1424           </para>
1425         </tip>
1426       </sect2>
1427       <sect2 id="config-saving">
1428       <title>
1429         Saving and Exporting Configuration
1430       </title>
1431       <screenshot>
1432         <screeninfo>Saving and exporting configuration</screeninfo>
1433           <mediaobject>
1434             <imageobject>
1435               <imagedata fileref="config-saving.png" format="PNG" />
1436             </imageobject>
1437             <textobject>
1438               <phrase>Saving and exporting configuration</phrase>
1439             </textobject>
1440           </mediaobject>
1441         </screenshot>
1442         <para>
1443           This page allows you to choose a &latex; command (&eg; <userinput>\cite{...}</userinput>) which will be used as a wrapper for the reference copied with <menuchoice><shortcut><keycombo>&Ctrl;&Shift;<keycap>C</keycap></keycombo></shortcut><guimenuitem>Copy Reference</guimenuitem></menuchoice> item of popup menu from the bibliography list.
1444         </para>
1445         <para>
1446           It is also possible to make &kbibtex; determine <link linkend="lyx-integration">&lyx; data pipe</link> automatically by checking the corresponding box.
1447         </para>
1448         <para>
1449           When <guilabel>Detect &lyx; pipe automatically</guilabel> item is not checked, you can add the pipe address manually in the text box <guilabel>Manually specified &lyx; pipe</guilabel> or select it using the <ulink url="help:/fundamentals/files.html">generic &kde; Open/Save dialog</ulink> by pressing the button to the right of the text box.
1450         </para>
1451         <para>
1452           Eventually, you can configure backups here. It is possible to select the backup subject (<guimenuitem>Local files only</guimenuitem>, <guimenuitem>No backups</guimenuitem> or <guimenuitem>Both local and remote files</guimenuitem>) using <guilabel>Backups when saving</guilabel> drop down box and the number of backups to store.
1453         </para>
1454       </sect2>
1455       <sect2 id="config-pdf">
1456       <title>
1457         &PDF; &amp; Postscript Configuration
1458       </title>
1459       <screenshot>
1460         <screeninfo>&PDF; &amp; Postscript configuration</screeninfo>
1461           <mediaobject>
1462             <imageobject>
1463               <imagedata fileref="config-pdf.png" format="PNG" />
1464             </imageobject>
1465             <textobject>
1466               <phrase>&PDF; &amp; Postscript configuration</phrase>
1467             </textobject>
1468           </mediaobject>
1469         </screenshot>
1470         <para>
1471           This configuration page can be used to choose some options for <link linkend="element-editor">previewing of &kbibtex; entries</link>. You can select <guilabel>Paper Size</guilabel>, language for <ulink url="https://www.ctan.org/pkg/babel">babel</ulink> &latex; package and the <link linkend="quick-using">bibliography style</link>.
1472         </para>
1473       </sect2>
1474   </sect1>
1475 </chapter>
1476 
1477 <chapter id="advanced">
1478   <title>
1479     Advanced Usage
1480   </title>
1481   <sect1 id="crossreferences">
1482     <title>
1483       Cross References
1484     </title>
1485     <para>
1486       Cross references allows you to save some time by creating links between <quote>parent</quote> entry (can be treated as a proceedings or collection of articles) and <quote>children</quote> entries (reports or articles).
1487     </para>
1488     <para>
1489       To create a cross reference just add its identifier in the <guilabel>Cross-Reference:</guilabel> field of the entry's <guilabel>Publication</guilabel> tab.
1490     </para>
1491     <screenshot>
1492       <screeninfo>Publication tab of entry's editing dialog</screeninfo>
1493       <mediaobject>
1494         <imageobject>
1495           <imagedata fileref="cross-ref.png" format="PNG" />
1496         </imageobject>
1497         <textobject>
1498           <phrase>Publication tab of entry's editing dialog</phrase>
1499         </textobject>
1500       </mediaobject>
1501     </screenshot>
1502     <para>
1503       You can either enter the identifier directly or click on the
1504       <inlinemediaobject>
1505         <imageobject>
1506           <imagedata fileref="flag.png" format="PNG"/>
1507         </imageobject>
1508       </inlinemediaobject> button to choose it from the list of available identifiers.
1509     </para>
1510   </sect1>
1511   <sect1 id="macros">
1512     <title>
1513       Macros
1514     </title>
1515     <para>
1516       Suppose your bibliography contains many references to the same journal and you do not want to enter its title over and over again. Then you can define a macro for the journal title.
1517     </para>
1518     <para>
1519       Let's say, we want to define a macro <replaceable>efm</replaceable> for <quote>Engineering Fracture Mechanics</quote>. Then we should do as follows:
1520     </para>
1521     <procedure>
1522       <step>
1523         <para>
1524           Choose <menuchoice><guimenu>Element</guimenu><guisubmenu>New element</guisubmenu><guimenuitem>New macro</guimenuitem></menuchoice> menu item.
1525         </para>
1526       </step>
1527       <step>
1528         <para>
1529           Enter an identifier (abbreviation) for the title in the <guilabel>Id:</guilabel> text box. The default identifier is <userinput>New1</userinput>. We should enter <userinput>efm</userinput>.
1530         </para>
1531       </step>
1532       <step>
1533         <para>
1534           Choose
1535           <inlinemediaobject>
1536             <imageobject>
1537               <imagedata fileref="draw-text.png" format="PNG"/>
1538             </imageobject>
1539           </inlinemediaobject> (<guilabel>Plain Text</guilabel>). The other option,
1540           <inlinemediaobject>
1541             <imageobject>
1542               <imagedata fileref="code-context.png" format="PNG"/>
1543             </imageobject>
1544           </inlinemediaobject> (<guilabel>Source Code</guilabel>) can be used if you want to insert some macro with &latex; commands in it.
1545         </para>
1546       </step>
1547       <step>
1548         <para>
1549           Enter <userinput>Engineering Fracture Mechanics</userinput> in the <guilabel>Value:</guilabel> textbox.
1550         </para>
1551         <screenshot>
1552           <screeninfo>Defining macro</screeninfo>
1553           <mediaobject>
1554             <imageobject>
1555               <imagedata fileref="add-macro.png" format="PNG" />
1556             </imageobject>
1557             <textobject>
1558               <phrase>Defining macro</phrase>
1559             </textobject>
1560           </mediaobject>
1561         </screenshot>
1562       </step>
1563       <step>
1564         <para>
1565           Click on the <guibutton>Apply</guibutton> button.
1566         </para>
1567       </step>
1568       <step>
1569         <para>
1570           Optionally, switch to the <guilabel>Source</guilabel> tab to inspect the code of the macro.
1571         </para>
1572         <screenshot>
1573           <screeninfo>Defining macro (source code)</screeninfo>
1574           <mediaobject>
1575             <imageobject>
1576               <imagedata fileref="add-macro-source.png" format="PNG" />
1577             </imageobject>
1578             <textobject>
1579               <phrase>Defining macro (source code)</phrase>
1580             </textobject>
1581           </mediaobject>
1582         </screenshot>
1583       </step>
1584       <step>
1585         <para>
1586           Click on <guibutton>OK</guibutton> button.
1587         </para>
1588       </step>
1589     </procedure>
1590     <para>
1591       The same procedure can be used to fix the titles, author and month names, &etc; according to abbreviation rules of your publisher for the entries from online databases. By default, these rules (macros) should be defined in the bibliography style files (<filename role="extension">bst</filename>).
1592     </para>
1593   </sect1>
1594 </chapter>
1595 
1596 <chapter id="integration">
1597   <title>
1598     Integration with &kile; and &lyx;
1599   </title>
1600   <para>
1601     &kbibtex; can be easily integrated with common &latex; editors, namely &kile; and &lyx;.
1602   </para>
1603   <sect1 id="kile-intergation">
1604     <title>
1605       Integration with &kile;
1606     </title>
1607     <para>
1608       <ulink url="http://kile.sourceforge.net/">&kile;</ulink> is a &tex; and &latex; source editor and shell.
1609     </para>
1610     <para>
1611       &kbibtex; is a default viewer/editor for &bibtex; files in &kile;, so there is no need for additional configuration.
1612     </para>
1613     <para>
1614       To add selected citations from bibliography files start &kile;, open some &latex; file, place the cursor there you want to add the citation, then switch to &kbibtex; window, select elements in the element list and choose <menuchoice><guimenu>Element</guimenu><guimenuitem>Send to &lyx;/&kile;</guimenuitem></menuchoice> or use the <guimenuitem>Send to &lyx;/&kile;</guimenuitem> element's context (&RMB;-click) menu item.
1615     </para>
1616     <para>
1617       The citations will be inserted as <userinput>\cite{<replaceable>element identifiers</replaceable>}</userinput> at the cursor position in the current &kile; document.
1618     </para>
1619   </sect1>
1620   <sect1 id="lyx-integration">
1621     <title>
1622       Integration with &lyx;
1623     </title>
1624     <para>
1625       <ulink url="https://www.lyx.org/">&lyx;</ulink> is a document processor that encourages an approach to writing based on the structure of your documents (WYSIWYM) and not simply their appearance (WYSIWYG).
1626     </para>
1627     <para>
1628       &kbibtex; can be integrated into &lyx; via &lyx; input/output pipe.
1629     </para>
1630     <procedure>
1631       <step>
1632         <para>
1633           First, you have to configure &lyx; to use the pipe. Choose <menuchoice><guimenu>Tools</guimenu><guimenuitem>Preferences</guimenuitem></menuchoice> from &lyx; main menu. Open <guilabel>Paths</guilabel> page and enter some path (&eg; <filename>~/.lyx/lyxpipe</filename>) into the <guilabel>LyXServer pipe</guilabel> text box.
1634         </para>
1635         <screenshot>
1636           <screeninfo>&lyx; configuration</screeninfo>
1637           <mediaobject>
1638             <imageobject>
1639               <imagedata fileref="lyx-preferences.png" format="PNG" />
1640             </imageobject>
1641             <textobject>
1642               <phrase>&lyx; configuration</phrase>
1643             </textobject>
1644           </mediaobject>
1645         </screenshot>
1646       </step>
1647       <step>
1648         <para>
1649           Click <guibutton>Save</guibutton> to save the changes.
1650         </para>
1651       </step>
1652       <step>
1653         <para>
1654           Choose <menuchoice><guimenu>Tools</guimenu><guimenuitem>Reconfigure</guimenuitem></menuchoice> to reconfigure &lyx; and restart it.
1655         </para>
1656       </step>
1657       <step>
1658         <para>
1659           To add selected citations from bibliography files, open some document, place the cursor there you want to add a bibliography and select <menuchoice><guimenu>Insert</guimenu><guisubmenu>List / TOC</guisubmenu><guimenuitem>&bibtex; Bibliography...</guimenuitem></menuchoice> from the &lyx; main menu.
1660         </para>
1661       </step>
1662       <step>
1663         <para>
1664           Press <guibutton>Add...</guibutton> then <guibutton>Browse...</guibutton>. Point &lyx; to a &kbibtex; <filename role="extension">bib</filename> file. Click on <guibutton>Add</guibutton> then click on <guibutton>OK</guibutton>.
1665         </para>
1666       </step>
1667       <step>
1668         <para>
1669           Then place the cursor where you want to add the citation and switch to &kbibtex; window. Select elements in the element list and choose <menuchoice><guimenu>Element</guimenu><guimenuitem>Send to &lyx;/&kile;</guimenuitem></menuchoice> or use <guimenuitem>Send to &lyx;/&kile;</guimenuitem> element's context (&RMB;-click) menu item.
1670         </para>
1671       </step>
1672       <step>
1673         <para>
1674           The citations will be inserted as a reference at the cursor position in the current &lyx; document.
1675         </para>
1676       </step>
1677     </procedure>
1678   </sect1>
1679 </chapter>
1680 
1681 <chapter id="credits">
1682   <title>Credits and License</title>
1683   <para>
1684     &kbibtex;
1685   </para>
1686   <para>
1687     Program copyright &copy; 2004-2014 Thomas Fischer
1688     <email>fischer@unix-ag.uni-kl.de</email>
1689   </para>
1690   <para>
1691     Documentation copyright &copy; 2013 Yuri Chornoivan
1692     <email>yurchor@ukr.net</email>
1693   </para>
1694 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
1695 &underFDL;
1696 &underGPL;
1697 </chapter>
1698 
1699 <bibliography>
1700   <biblioentry>
1701     <abbrev>Lamport86</abbrev>
1702     <author>
1703       <personname>
1704         <firstname>Leslie</firstname>
1705         <surname>Lamport</surname>
1706       </personname>
1707     </author>
1708     <title>
1709       Latex: a document preparation system
1710     </title>
1711     <pubdate>1986</pubdate>
1712     <publisher>
1713       <publishername>Addison-Wesley Publishing Company</publishername>
1714     </publisher>
1715   </biblioentry>
1716 </bibliography>
1717 
1718 &documentation.index;
1719 
1720 </book>
1721 
1722 <!--
1723 Local Variables:
1724 mode: xml
1725 sgml-minimize-attributes:nil
1726 sgml-general-insert-case:lower
1727 sgml-indent-step:0
1728 sgml-indent-data:nil
1729 End:
1730 
1731 vim:tabstop=2:shiftwidth=2:expandtab
1732 -->