# The &kile; Handbook

## Preface

### Requirements

To run &kile;, you need to have the following components installed on your system:

- K Desktop environment (&kde;): &kde; is a popular open-source desktop environment.

- &Qt;: &Qt; is a C++ &GUI; and network library needed to compile &kile;.

- &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.

Most of these items 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.

&kile; might also be available as a pre-compiled package for your &Linux; distribution already. Please check with the package manager of your distribution.

### Intended Audience

This manual is intended for any individual, regardless of her or his experience with &latex;, &kde;, &kile; 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 &kile; web page.

Do you need answers about &kile;? Are you stuck with the compilation process? Do you want to see a new feature implemented? The preferred way to ask technical questions or to start a discussion is to use our mailing list: kile-devel@lists.sourceforge.net.

## Introduction

### Basic facts

#### About &kile;

&kile; is an integrated &latex; environment for the &kde; desktop. &kile; gives you the ability to use all the functionality of &latex; in a graphical interface, giving you easy, immediate, and customized access to all programs for &latex; code-completion, compiling, postprocessing, debugging, conversion and viewing tools; you also get very handy wizards, a &latex; reference and a powerful project manager.

#### &kile; and the &kate; Editor Component

&kile; is based on the &kate; editor component, &ie; a lot of its editing capabilities stem from the &kate; editor component itself. &kile; extends these capabilities with features to edit &latex; documents. To learn more about the &kate; editor component and its capabilities, see the &kate; webpage.

#### What is &latex;?

&latex; is a text-processing system derived from &tex;, a program developed originally in 1977 by Donald Knuth to help layout text in a professional way and obtain a layout quality that is on a par with the work of a professional typesetter. &latex; was created by Leslie Lamport to give authors an automatic typesetter, especially to ease the expensive and painstaking process of typesetting of mathematical formulas and expressions, which are enclosed within dollar signs in &latex; for a reason. Today, word-processing programs let any user act as typesetter, but what is often needed is a document that simply looks good without having to spend hours to bring it into shape. &latex; takes that burden on its shoulders, and lets you concentrate on the document instead of on the layout. And yes, it will look good!

#### How do you pronounce it? Why that strange typesetting?

There is a funny tradition of &tex;-related packages to have the strangest pronunciation and typesetting possible. &tex; was supposed to be brought in from the Greek τεχ, in Latin letters tech. There are a lot of explanations why, but most likely it is because &tex; was originally conceived for technical reports, and indeed its foremost ability was the correct and easy typesetting of mathematical formulae, then an extremely expensive, time-consuming and frustrating business.

The pronunciation is supposed to be as follows: T as you would expect, E as in get, and X as in the German ich. If you do not know what ch sounds like, it is more or less like the sound a hissing cat produces; the IPA symbol is /ç/. Many people report a different pronunciation of ach (IPA symbol /x/), but according to some Greeks, the first version is indeed correct. You should be aware that a lot of people mispronounce &tex; as /teks/ or /tek/.

Last, in &latex; the first LA is pronounced as lay: the idea being, while raw &tex; is difficult, even a layman can use &latex; macros. A less inspiring, but more realistic explanation is that it stems from the surname of Leslie Lamport, the creator of &latex;. Now you know!

### &latex; 101

The &latex; typesetting system is similar to other markup languages such as &XML;, which is used in many types of documents (including the one you are reading), or &HTML;, which is used for web pages. The general idea behind markup languages is to have special keywords, called tags, that tell a program (a word processor, a web browser, or the &latex; compiler) how the text enclosed within the tags is to be interpreted. &kile; offers a number of such tags in the LaTeX menu in the menu bar.

While we will try to give you a good idea of what &latex; is, this document is, of course, not The Definitive Book on &latex;. If you want to learn &latex; in depth, you may want to borrow a specialized book from your local library.

As with any other markup language, &latex; documents contain a preamble, which defines global properties, such as paper size, page numbering, dimensions of the text on the page, and a document body, which contains the text of the document. The preamble is composed at least of the `\documentclass` command. It precedes the document body, which starts with the command `\begin{document}` and is concluded with the command `\end{document}`.

### &kile;'s Main Features

#### QuickStart Wizard

The QuickStart wizard built into &kile; is a useful feature to quickly start creating documents in &kile;. Choosing the wizard from the menubar gives you several choices for the creation of your document. You can also specify some options related to the document right away.

Class options:

- Document Class: choose the type of document you want to create: article, book, letter, report, scrartcl, scrreprt, scrbook, prosper, beamer or other custom-defined.

- Typeface Size: tell &kile; what point size (pt) you want to use.

- Paper Size: choose the size or style of sheets.

- Encoding: In general it is a good idea to use your system's standard encoding. Modern systems now move more and more to UTF-8 as the standard encoding. If you can, use utf8 or utf8x (which is indeed the correct spelling for &latex; documents).

- Other options: this allows you to set further options such as printing, draft, and others.

Packages

This lists some of the most common additional packages used in &latex;. Select the check box to include it.

Document Properties:

- Author: put your name here.

- Title: add the document title here.

- Date: specify the date.

#### Predefined Templates

The predefined templates in &kile; are:

- Empty document: real freaks start from scratch!

- Article: sets the article format, for a document short enough not to be broken down to chapters.

- Report: sets the report format, for a middle-sized document, with, for example, page numbering on the page's outer edge.

- Book: sets the book format, a full-fledged flavor, so powerful that it is used to write many university textbooks.

- Letter: sets the letter format.

- Beamer, HA-Prosper: create nice presentations in PDF with a superior look and all &latex; power.

- Powerdot: Powerdot is the follower of the packages `seminar` and `HA-Prosper`. It does not have as many options as Beamer, but it is easy to use and it can create really nice presentations in PDF.

- Scrartcl, Scrbook, Scrreprt, Scrlttr2: the KOMA-Script document classes, especially adapted to German typography. Use them whenever you write German texts.

- Xelatex: a modified `Article` template to use with `XeLaTeX`.

Note that all of these templates can be adjusted to the user's requirements.

New users need not worry: this list is just a brief description of the available features, and a more detailed description can be found in quickstart.

#### Syntax Highlighting

&kile; is similar to other programs that deal with source code and editing, and will automatically highlight commands, options and items that are used (and abused). &kile; makes it possible to easily spot problematic areas: for example, if you see major areas of text turn green, it is likely that you forgot to close a math environment somewhere.

#### Auto-Completion of Environments

The auto-completion of environments means that, when you begin a new environment by typing `\begin{environment}`, &kile; will automatically insert a matching `\end{environment}` command, with a line in between them for your text. You can of course deactivate it if you want in Settings Configure Kile... LaTeX Environments.

#### Jump to Structure Element

All documents are normally structured in a hierarchy of some type. &latex; allows you to break up documents into the following hierarchy (part being highest in the hierarchy, and subparagraph being lowest):

- \part

- \chapter

- \section

- \subsection

- \subsubsection

- \paragraph

- \subparagraph

When viewing a document in the Structure view, you can jump between elements by clicking on the element you would like to view.

#### Inverse Search

When creating your own &latex; files, inverse search can be very helpful. Once you have created a &DVI; file (DeVice Independent File) or PDF file, you can click the left mouse button while pressing &Shift; in the viewer and &kile; will jump to the corresponding line in the &latex; source code.

A &DVI; is a type of file containing a description of a formatted document, along with other information including character font, and is besides PDF the usual output of &tex; or &latex;. A number of utilities exist to view, convert and print &DVI; files on various systems and devices.

#### Forward Search

When using inverse search, the selection of items in the &DVI; or PDF file is associated with the editor, so when you click on the &DVI; or PDF file, the main window jumps to the corresponding section of &latex; code in the editor. Forward search is the exact opposite of this. Forward search will allow you to click on a specific section of text in the &latex; code, and jump to the associated position in the viewer window.

### The Toolbar

- New: begin a new document.

- Open: open a new document.

- Close: close your document.

- Define document as master: this is used when working with multiple files. Having a master document will let you work more easily with other `.tex` files included in your document. If you are using projects, you can also set in Project Project Options a project-wide master document.

- Quickbuild: compiles your &latex; source code and displays the results automatically unless there are errors contained in the document.

- Watch file mode: this mode will "watch" the &DVI; file for changes, and will not launch a new session of &okular; after Quickbuild.

- View logfile: views the `.log` file, so you can spot errors.

- Previous error: jumps backward through the `.log` file and highlights errors in the source.

- Next error: jumps forward through the `.log` file and highlights errors in the source.

- Stop: halts current tool.

- LaTeX: runs &latex; on the active document.

- ViewDVI: launches &DVI; viewer.

- DVItoPS: converts a &DVI; to a &PostScript; (PS).

- ViewPS: launches &PostScript; (PS) viewer.

- PDFLaTeX: runs &pdflatex; on the active document.

- ViewPDF: launches the PDF viewer.

- DVItoPDF: converts a &DVI; to a PDF.

- PStoPDF: converts a PS to a PDF.

- ViewHTML: views &HTML; created.

- ForwardDVI: jump to the page of the &DVI; file that corresponds to the current line in the editor.

- ForwardPDF: jump to the page of the PDF file that corresponds to the current line in the editor.

If you look at the Edit toolbar, you will notice three large drop-down menus. The drop-down menus were designed for you to be able to quickly add certain common features into your document. The first drop down box is used for quickly dividing your document by parts, chapter, sections and so on; the available commands to add segments to your &latex; source code are:

- part: highest level of sectioning for a document.

- chapter: starts a new chapter.

- section: create a new section.

- subsection: create a new subsection.

- subsubsection: a secondary section between subsection and paragraph.

- paragraph: create a new paragraph.

- subparagraph: create a new subparagraph.

The drop down box named Other is used to insert items into your document such as indexes, footnotes, and references; the available commands are:

- label: a command that produces a label for a chapter, a figure or another element.

- index: creates an entry for the index.

- footnote: creates a footnote in your document.

- ref: used to refer to a predefined label, which you can choose from a drop-down list.

- pageref: just like ref, but refers to a page instead of a structure element.

- cite: create a reference with data from a bibliography.

The Other drop-down menu The Other drop-down menu

The Other drop-down menu

Selecting the label for a reference Selecting the label for a reference

Selecting the label for a reference

When using cite, you are presented with a drop-down list of bibitems, but if you are using &bibtex; this will only work if the file belongs to a Project. For editing &bibtex; files the usage of specialized editors is recommended. The author has had good results with &kbibtex;. Of course you can also write the &bibtex; files by hand inside &kile;.

The last drop down box labeled tiny is used to set the size of the text. You can set the size of the main text, of footnotes, and so on. The available commands are:

- tiny: smallest.

- scriptsize: very small.

- footnotesize: smaller.

- small: small.

- normalsize: normal.

- large: large.

- Large: larger.

- LARGE: even larger.

- huge: still larger.

- Huge: largest.

## Quickstart

### Writing a &latex; Document with &kile; for Beginners

Users of &kile; have two choices when starting a new document: they can use the Wizard to begin a new document, select the type of document they would like to create and options such as font size, paper size, and so on; otherwise, they can write the code by hand.

    \documentclass[12pt]{article}
    \begin{document}
    	Here is a bunch of text coded in \LaTeX.
    \end{document}

Every document in &latex; begins with the command `\documentclass[optional argument]{class}`, where class specifies the document type.

Typing in the code example above from the text box gives you the following output:

Compiled text in &DVI; output Compiled text in &DVI; output

Compiled text in &DVI; output

The brackets that come after the command `\documentclass` contain the options for the command. The option `[12pt]` sets the size of the font for your article; if you do not set the font size in the beginning, you can set it later in the text.

Once you have typed in the code example from the box above, you will need to compile your &latex; source code. The easiest way for you to compile &latex; is to use the Build menu, or using the Quickbuild button.

&Alt;2 is the keyboard shortcut to compile your source code.

You have to save your source code before you can compile; &kile; will do this automatically for you.

If your document did not compile, check the log for errors. When using the Quickbuild key, the &okular; viewer should be launched automatically; if it does not, look at the log.

### Environments

An environment is a segment of text that is managed differently from the rest of the document. For example, you create a report with font size 12, but you need to change your font size for a few sentences. The commands `\begin{environment}`, `\huge` and `\end{environment}` will let you temporarily alter the text inside the environment commands to be size huge.

Changes are only effective from `\begin{environment}` to `\end{environment}`. There are no limits as to how many changes you can make inside an environment.

There are many features you can add to your document that will make it more readable and user-friendly. You can add features such as specific fonts, bold, italics, underline &etc; to your document, and these commands will end with either an `\end` command, or at the end of your environment.

- `\begin{emph}`: this command makes text italicized, and is valid until the code comes across a `\end{emph}`, or another environment. To italicize one word in a sentence, you can use the syntax: this is `\emph{my}` sentence.

- `\textbf{I am making this text inside the brackets bold}`: this command makes your text bold.

- `\quote`: to create a quote inside your document; begin your quote with `\begin{quote}` and end it with `\end{quote}`.

- `\center`: centers the text.

- `\verse`: creates offset text for poems.

- `\itemize`: makes an itemized list.

### Using &kile;

Now that we have given you some background about how to write code using the &latex; markup language, we will show you how to create a document using &kile; step-by-step.

1. Start &kile;.

2. Select Wizard Quick Start, then choose a format, and set your preferences in the wizard.

3. Once the wizard has entered text, do some customization to make the document more readable, add a minimum of one quote, some bold text, italics, and a verse to see the difference between the commands.

4. Save your file, and give it the name `intro.tex`.

5. Build your document using &Alt;2, or the button labeled LaTeX.

6. Select ViewDVI.

7. Check out all your new text.

8. When you are done viewing your document, click the Editor View button or press &Ctrl;E to return to the editor if you are using the embedded viewer, or close the viewer window if you are using a separate viewer.

That's it! You have just created your first &latex; document!

Once you have created your &DVI;, you will be able to print your document, or change it into a &PostScript; or PDF file if you want. Experiment and have fun!

### &DVI; Files

&DVI; stands for DeVice Independent file. These files are produced by &tex; or &latex; to be read by a driver of some sort on your computer. There are many different types of output that a `.dvi` can be sent to, such as a printer, &PostScript; or PDF file converter, or your computer screen.

#### Viewing a &DVI;

You have already seen how to view a &DVI; file on the screen by using the ViewDVI button in the toolbar.

#### Printing a &DVI;

To print a &DVI;, you can use the same process that you used to create your document earlier (see quick_using). At step 7, after clicking ViewDVI, select File Print in the viewer, and if you have your printer properly configured, you will be able to print the &DVI;.

#### Converting &DVI; files

The toolbar gives the options of Converting a &DVI; to other formats. Once you have created a &DVI; from your &latex; source code, you will be able to export it to a format of your choice using the toolbar buttons.

### Forward Search between &kile; and &okular;

The forward search functions allow you to jump from your editor directly to the associated position of the &DVI; or PDF file.

&kile; offers a configuration with this option for all &latex; binaries. Go to Settings Configure Kile... Tools Build and always choose the Modern configuration.

To execute a forward search, position the cursor on a line of source code, and click Forward Search to jump to the associated position in the &DVI; or PDF viewer window.

### Inverse Search between &kile; and &okular;

Inverse search is a very useful feature when you are writing a &latex; document yourself. If everything is set up properly, you can click into &okular;'s window with the left mouse button while pressing &Shift;. After that &kile; loads the &latex; source file and jumps to the proper paragraph. To use inverse search, you have to compile your &latex; file with the Modern configuration.

Inverse search cannot work unless:

- The source file has been compiled successfully.

- &okular; knows which editor you would like to use.

With this feature of &okular;, a left mouse click while pressing &Shift; in the &DVI; or PDF document will result in &kile; opening the corresponding &latex; document and attempt to go to the corresponding line. Remember to tell &okular; to use &kile; as a text editor, in &okular;'s menu item Settings Configure Okular... (on the page Editor).

Configuring &okular; Configuring &okular;

Configuring &okular;

### Resolving Errors

If you are trying to use quickbuild, and the &DVI; viewer does not open, chances are you have an error. If you have an error, it will be visible in the log file / message area, and the summary of the error will be given.

The log file will explain the source of the error in your code. In the editor, you can use the buttons in the toolbar labeled Previous LaTeX Error and Next LaTeX Error to jump to and from errors. The log file always states in which line the error occurred. To view the line where an error occurred, click on the error in the log window, and &kile; will take you to the error's line.

## Starting a New Document

When you click the button in the toolbar to begin a new document a dialog appears, asking which type of template you would like to use to write your document. The default choices are:

- Empty document

- Article

- Beamer

- Book

- HA-Prosper

- Powerdot

- Letter

- Report

- Scrartcl (from the KOMA-Script package)

- Scrbook (from the KOMA-Script package)

- Scrlttr2 (from the KOMA-Script package)

- Scrreprt (from the KOMA-Script package)

- PDF

- XeLaTeX

If you selected an Empty document, you can either start writing a document from scratch, or you can use the wizard to quickly start a new document (see intro_docwizard).

### Templates

Frequent users of &latex; typically use the same preamble for almost every document they use. Templates can be created, saved and loaded within &kile; to make it easier to start a new document.

#### Create a New Template

To create a new template, you must first either open a &tex; / &latex; file, or create a file of your own. &kile; can generate a template from an existing document by opening the desired document and selecting File Create Template from Document.

#### Configuring Automatic Substitutions

When creating a new document by selecting a template from File New, certain character combinations will be replaced by data such as your name, or the character encoding you are using. These variables can be configured in Settings Configure Kile... Settings General.

When designing your own template, it is useful to know which character combinations are replaced by which template variables:

- `$$AUTHOR$$`: This string will be replaced by the author variable.

- `$$DOCUMENTCLASSOPTIONS$$`: This string will be replaced by the documentclass options variable. Typically this is used as follows: `\documentclass[$$DOCUMENTCLASSOPTIONS$$]{article}`.

- `$$INPUTENCODING$$`: If the inputencoding variable is set to, say, `latin1` this string is replaced by `\input[latin1]{inputenc}`.

#### Create a Template from the Wizard

The easiest way to create a new template is to start the wizard, and then add commands in the editor. Once you have your document set up the way you like:

1. Save your file;

2. Go to File;

3. Choose Create Template from Document;

4. Make any corrections necessary to the template;

5. Enter a name for your new template;

6. Click OK to add your template to the menu.

Next time you start up a new document, you will be able to choose your customized template instead of the default ones.

#### Creating a Template from any File

A template can be created from any &latex; file. If you are looking for an easy way to configure a template, go find one you like on the Internet and follow the same steps as listed in templ_wiz.

For instance, you may want to create a full-fledged A0 poster. These posters are usually seen at scientific conferences, and &latex; will help you make an attractive, catchy poster. Remember that you will need the `a0poster` package, which is normally not included in standard &tex; distributions. Download it from here and place it in the same folder as your &latex; file.

#### Removing a Template

To remove a template from &kile;, do as follows:

1. Go to File Remove Template...;

2. A dialog box will appear with all templates listed: select a template;

3. Click OK, and your template will be removed.

Templates marked with an asterisk (*) cannot be removed without the proper permission.

## Editing &latex; Documents

The internal editor that &kile; uses is &kate;. &kate; is a text editor created for programmers, which incorporates the ability to read and highlight many different types of text files, among which are &latex; and &bibtex;; you can access many options for &kate; directly from &kile;'s Tools menu.

To learn more about &kate; and its capabilities, see the &kate; Handbook. &kile; users can start reading from the chapter Working with the &kate; Editor.

### The &latex; Reference

&kile; features a very practical &latex; tag reference, which you can access by choosing Help LaTeX Reference. It contains a thorough description of almost all the commands that you may use in &latex; and their syntax.

### Cursor Movements

To select text, you have the following options:

- Hold left mouse button, and drag mouse to highlight text.

- Click once on a word to move the cursor to a new area.

- Click twice on a word to select the whole word.

- Click twice on a word and pressing &Ctrl; to select the whole &tex; word. This means clicking in this way on `\par` from `\par\bigskip` only select \par.

- Click three times to select the whole sentence.

Holding the left mouse button, and dragging the text you want to select, automatically copies the selected text to the clipboard.

Holding &Shift; and using the arrow keys allows you to select portions of the source code in the editor window.

### Brackets

Bracket completion is a visual tool that the editor view uses to indicate to you which bracket matches which. If you open any `.tex` file, and select any bracket, whether it be a parenthesis (), square brackets [] or braces {}, the editor will highlight the bracket and its match in yellow (this default color can be changed). So, for example, if you position the cursor on the braces in `\section{Introduction}`, you would see `\section{Introduction}` in the default yellow highlight, showing you the location of the beginning and ending brackets.

### Highlighting

&kile; has the ability to look for and highlight different types of code. For example, &latex; commands are distinguished from normal text, and math formulas are also highlighted in a different color.

### Bullets

Many wizards can insert optional bullets, a special kind of bookmark within the text. The menu entries Edit Bullets or the corresponding keyboard shortcuts will allow you to jump to the next or last bullet. This will also highlight this bullet so that it will be deleted automatically, when you enter your first letter.

Bullets Bullets

&Ctrl;&Alt;Right Next Bullet

- Jump to the next bullet in the text if there is one.

&Ctrl;&Alt;Left Last Bullet

- Jump to the previous bullet in the text if there is one.

### Select

Editing is of course one of the main aspects when you use a program like &kile;. Although &kate; already has great capabilities, &kile; adds some important features, which are especially needed to write &latex; source. &latex; always needs a lot of environments and groups, so &kile; supports very special commands to select them. Under Edit Select you will find the following commands to select text.

Edit->Select items Edit->Select items

&Ctrl;&Alt;S ,E Environment (inside)

- Select an environment without the surrounding tags. If this command is called, when an environment is already selected, &kile; will expand the selection to the next surrounding environment.

&Ctrl;&Alt;S ,F Environment (outside)

- Select an environment including the surrounding tags. This selection can also be expanded with a second call of this command.

&Ctrl;&Alt;S ,T TeX Group (inside)

- Select a &tex; group inside the surrounding braces.

&Ctrl;&Alt;S ,U TeX Group (outside)

- Select a &tex; group including the surrounding braces.

&Ctrl;&Alt;S ,M Math Group

- Select the current math group including the math commands.

&Ctrl;&Alt;S ,P Paragraph

- Select a whole paragraph, &ie; a group of text lines separated on both sides by empty lines. A paragraph does not mean just continuous lines of text, as it is in other text editors. This extended meaning also includes tables, &latex; commands and all other lines of source. The only important thing for &kile; is that this kind of paragraph is separated by two empty lines.

&Ctrl;&Alt;S ,L Line

- Select the text line of the current cursor position.

&Ctrl;&Alt;S ,W TeX Word

- Select the word under the current cursor position. This selection has also en extended meaning, because this command can also select &latex; commands, which begin with a backslash and may also have an optional star at the end.

#### Select &latex; commands

&kile; has an extended feature to select &latex; commands. If you for example have typed

    text \bfseries\itshape more text

and double click on one of the &latex; commands, both will be selected. But often you only want to select one of two or more commands. This can be done using the &Ctrl; key. You only have to press the &Ctrl; key and a double click will only select the desired command.

### Delete

To delete some parts of a document you can of course select them, and then use the Delete key. &kate; also offers the command &Ctrl;K which deletes the whole line. But &kile; offers a faster way with its own delete commands. Under Edit Delete you will find the following commands to delete text.

Edit->Delete items Edit->Delete items

&Ctrl;&Alt;T ,E Environment (inside)

- Delete an environment without the surrounding tags.

&Ctrl;&Alt;T ,F Environment (outside)

- Delete an environment including the surrounding tags.

&Ctrl;&Alt;T ,T TeX Group (inside)

- Delete a &tex; group inside the surrounding braces.

&Ctrl;&Alt;T ,U TeX Group (outside)

- Delete a &tex; group including the surrounding braces.

&Ctrl;&Alt;T ,M Math Group

- Delete the current math group including the math commands.

&Ctrl;&Alt;T ,P Paragraph

- Delete a whole paragraph. Look at the Select Paragraph command, how a paragraph is defined in &kile;.

&Ctrl;&Alt;T ,I To End of Line

- Delete the text from the current cursor position to the end of the line.

&Ctrl;&Alt;T ,W TeX Word

- Delete the word or &latex; command under the current cursor position.

### Environment

It has already been mentioned that environments are a central point in &latex;. So &kile; offers five other commands to make the work with &latex; as easy as possible under submenus Edit Environment.

Edit->Environment items Edit->Environment items

&Ctrl;&Alt;E ,B Go to Begin

- This command will jump to the beginning of the current environment, wherever your current position is. The cursor will be placed directly in front of the opening environment tag.

&Ctrl;&Alt;E ,E Go to End

- This command will jump to the end of the current environment, wherever your current position is. The cursor will be placed directly behind the closing environment tag.

&Ctrl;&Alt;E ,M Match

- When your cursor is placed in front of or above the `\begin{environment}` tag, it will be moved to the opposite end of the environment and vice versa.

&Ctrl;&Alt;E ,C Close

- Typing a lot of nested environment tags, you may lose control of all those environments. This command will close the last opened environment, so that the nested structure of environments will not be broken.

&Ctrl;&Alt;E ,A Close All

- This closes all open environments, not only the last opened environment.

### &tex; Group

&kile; also offers some special commands for &latex; groups, which are determined by braces `{...}`. In submenu Edit TeX Group you will find some important commands, which correspond to those from Edit Environment.

Edit->TeX Group Edit->TeX Group

&Ctrl;&Alt;G ,B Go to Begin

- This command will jump to the beginning of the current group, wherever your current position is. The cursor will be placed directly in front of the opening brace.

&Ctrl;&Alt;G ,E Go to End

- This command will jump to the end of the current group, wherever your current position is. The cursor will be placed directly behind the closing brace.

&Ctrl;&Alt;G ,M Match

- When your cursor is placed in front of or behind an opening brace of a &tex; group, it will be moved to the opposite end of the group and vice versa.

&Ctrl;&Alt;G ,C Close

- Typing a lot of nested group braces may be hard work. This command will close the last opened group, so that the nested structure of &tex; groups will not be broken.

### Double Quotes

In &latex;, two single quotes are used as double quotes. To help you insert these efficiently, &kile; allows you to press " to insert two opening single quotes. Furthermore, if you want to close a quotation, you also have to press ". &kile; will be smart enough to recognize this situation and inserts two closing quotes for &latex;.

To get a literal double quote on the other side, press " twice.

You can enable or disable this auto insertion of opening and closing double quotes in section Settings Configure Kile...LaTeX.

Double Quotes Double Quotes

If you also include language-specific options like `ngerman` or `french`, you will also be able to use German or French double quotes. Many more languages are available.

### Smart Newline

If you press &Ctrl;Return, &kile; inserts an intelligent newline. If your current position is inside a list environment, like `enumerate` or `itemize`, &kile; will not only insert a newline, but also add a `\item` command.

If you are inside a tabular environment, &kile; will finish the current line with `\\`, followed by the newline.

If you are inside a &latex; comment, &kile; will start the next line with a `%`.

Even better, &kile; is smart enough to support predefined &latex; and user defined environments, which can be added in section Settings Configure Kile...LaTeX.

### Smart Tabulator

Some users like to arrange columns in tabular environments and put all ampersand characters & beneath each other. &kile; tries to support this. If you press &Alt;&Shift;&, &kile; will look for the next tab in the row above. Although this tab may not be the corresponding tab, &kile; will add some spaces to adjust the column position with the current tab.

## Code Completion

Although &kate; already offers a good completion mode, &kile; extends code completion to support some special methods especially for &latex;. Five different modes are integrated. Three of them work on demand, the other two are autocompletion modes. All modes can be configured to work very differently at Settings Configure Kile....

### Automatic Environment Completion

When you begin a new environment, typing `\begin{environment}`, &kile; will automatically add an `\end{environment}` command, with a line in between for your text.

Autocompletion can be turned off in the &latex; section of Settings Configure Kile... LaTeX Environments.

Completing an Equation Environment Completing an Equation Environment

Completing an Equation Environment

### &latex; Commands

When you type some letters, you can activate this completion mode for &latex; commands and normal words with Edit Complete(La)TeX Command or the keyboard shortcut &Ctrl;&Shift;Space. &kile; first reads the letters from the current cursor position to the left and stops at the first non-letter character or a backslash. If this pattern begins with a backslash, &kile; will enter completion mode for &tex; or &latex; commands. Otherwise it enters normal dictionary mode, where you will not find any &latex; commands. Depending on the chosen mode, a completion box will be opened. You will see all commands or words whose beginning matches the current pattern. You can navigate with the cursor keys through this list and select one entry with &Enter; or a double click with the mouse.

Completing a LaTeX Command Completing a LaTeX Command

When you push the &Backspace; key, the last letter of your pattern will be deleted, and the completion list may grow. On the other hand, if you type another letter it will expand the pattern and the visible word list may shrink.

If you decide not to select any of the suggestions, you can leave this dialog with &Esc;.

You will see that all commands are written with a short description of their parameters. These descriptions are of course stripped when you select a command. Optionally you can let &kile; insert bullets at these places, so that you can easily jump to these positions with Edit Bullets Next Bullet and insert the parameter you want.

Completing a LaTeX Command Completing a LaTeX Command

Go to Settings Configure Kile... Kile Complete to configure one or more of these lists. You can choose different word lists for &tex; and &latex; commands and dictionary mode for normal words.

If you choose the option Show Latex commands, the entries of all chosen compressed word list (cwl) files for &latex; command completion are shown in a separate view of &kile;'s sidebar. You will see which commands are available and what parameters and options must or can be given for a completion. You can also simply select one entry with a mouse click and it will be inserted into the document, with all named parameters and options stripped.

LaTeX commands in the sidebar LaTeX commands in the sidebar

As each chosen word list will be shown in a separate view of its own, there could be too many views, so that &kile;'s main window may be larger than a small screen allows. As this looks very ugly, &kile; works with a maximum number of allowed views, which by default is set to 10. If this value is too big for your screen, you should reduce it.

### Environments

The command mode is not useful for code completion of environments. You always have to type some letters of `\begin`, and invoking the completion mode will result in a huge list of environment tags. On the other hand, environments are so often used that &kile; offers a special mode for code completion of environments. Forget the opening tag and write, for example, `al`.

When you call the completion mode with Edit Complete Environment or keyboard shortcut &Alt;&Shift;Space, the opening tag is automatically added and you will see `\begin{al}`. After this change, the completion list is much less cluttered.

Completing a LaTeX Command Completing a LaTeX Command

Now select an environment, and you will see that it is also automatically closed. Even more, if &kile; recognizes it as a list environment, it will also insert a first `\item` tag.

Completing a LaTeX Command Completing a LaTeX Command

Go to Settings Configure Kile... Kile Complete to configure one or more of these lists. This mode uses the same word lists as the completion mode for &tex; and &latex; commands.

### Abbreviations

&kile; supports user defined lists of abbreviations, which are replaced on demand by longer text strings. Look at Settings Configure Kile... Kile Complete to configure one or more of these lists. For the example given here, the abbreviation list in `example.cwl` must be chosen. In this file you will find, for example, the entry `L=\LaTeX`.

For example, type only the letter `L`. Now invoke the abbreviation mode of word completion with Edit Complete Abbreviation or keyboard shortcut &Ctrl;&Alt;Space, and the letter `L` is replaced by the string `\LaTeX`.

Abbreviation completion also supports newline `%n` and `%C` to place the cursor, if these characters are present in the expansion text. So if you have the entry

    en1=\begin{enumerate}%n\item %C%n\end{enumerate}%n

in the completion file, and invoke the abbreviation completion, the expansion looks as below, where `x` shows the final cursor position.

    \begin{enumerate}
    	\item x
    \end{enumerate}

#### Abbreviations

If you choose Show abbreviations, all possible abbreviations are shown in a view of the sidebar. So you will have a good survey of all possible abbreviations.

### Autocompletion Modes

#### &latex; Commands

You can also enable an autocompletion mode for &latex; commands. When a given threshold of letters (default: 3) is entered, a popup window opens with a list of all matching &latex; commands. You can select one of these commands, or ignore this window and type further letters. The entries of the completion box will always change and match your currently typed word.

Go to Settings Configure Kile... Kile Complete to enable or disable this mode or to change the threshold.

Completing an Equation Environment Completing an Equation Environment

#### Document Words

Large dictionaries are not useful in autocompletion mode. But, we have seen that a lot of words in a document are typed more than once. So &kile; offers a completion for all words from the document that the user has already typed. You can manually invoke this completion, if you press &Ctrl;Space. Note that this mode is different from the completion mode for &latex; commands.

If you want to turn this mode on or off, go to Settings Configure Kile... Editor Editing Auto Completion. In this dialog you can configure if completion mode for document words should be enabled. There is also an additional autocompletion mode, where a completion box pops up, when a certain threshold is reached.

### Writing Own Completion Files

The latest specification of the completion file format can found in the CWL file format specification.

Completion files can be installed in a user's home folder under the `~/.kde/share/apps/kile/complete/<mode>/` subdirectory, where `<mode>` either stands for `abbreviation`, `dictionary` or `tex`.

## Wizards and Dialogs

### QuickStart Wizard

This wizard has already been described in the section intro_docwizard.

### Include Graphics

The Include Graphics dialog makes insertion of graphics as easy as possible. You can reach it via the menubar with LaTeX Image Insertion. Please take a look at build_graphics and build_epsgraphics to get an overview of some basic facts concerning graphic formats.

Including a graphics element Including a graphics element

1. Choose a graphics file. This can be a JPEG, PNG, PDF, EPS or even a zipped or gzipped EPS file. If you have installed &imagemagick; and also configured &kile; to use it (Settings Configure Kile... LaTeX Graphics), the width and the height of the graphic is automatically shown. If &imagemagick; can determine a resolution, the size of the graphics is also shown in centimeters.

2. Decide whether your image shall be centered on the page.

3. Choose whether you want the `\graphicspath` notation for your graphics file.

   By default graphics files have to be in the same folder as your master document. However, it is possible to put them in other folders to make things tidier. Without a `\graphicspath` command, &kile; would include the path for the graphics file. But if you use `\graphicspath` in your preamble like this:

       \graphicspath{{/path/to/my/graphics}{other/path/to/more/graphics}}

   and check this option, &kile; will only use the base name of the graphics file.

   Another example: if you set `\graphicspath` command like:

       \graphicspath{{./}{camera/}{images/}}

   &latex; will search in the current folder, then in `camera` and finally in `images` to find your graphics file.

4. If you choose either a width or a height, the whole graphics will be proportionally scaled. If you set two values for width and height at the same time, width and height may be scaled with different factors, and this could not be what you want. See also the information near the top of the dialog to know the original size of the graphics.

5. Insert an angle by which to rotate the graphics counterclockwise.

6. The bounding-box information is set automatically when you choose a graphics file. This information is only needed when you work with traditional &latex; and bitmapped graphics. See the discussion of EPS graphics.

   If &latex; needs a bounding box and you do not want to generate a bb file, &kile; supports this option. On the other hand, &pdflatex; will give a warning when you want to include a png or jpg graphics with this option. This checkbox enables or disables the bounding-box option.

7. Scale the image by the desired scale factor. ⪚, 0.5 to reduce by half, or 2 to double. When you use this option, you do not have to set a width or height for the image.

8. In the Trim Image tab you can crop your image in all four directions.

9. Finally, you have to specify whether you want to embed this image into a figure environment. When you want the text to wrap around the figure, use the wrapfigure environment instead.

   When you choose the wrapfigure environment, you need to include the wrapfig package in your preamble.

   In either case you can insert a caption and a label for your image. Generally, it is a good idea to add a different prefix to each kind of label. It is common to use the prefix `fig:` for images.

10. If you pick the figure environment, you can choose where &latex; should preferably position the figure.

11. In the wrapfigure environment you can:

    1. Pick a placement rule for the figure and decide whether the figure should float or not. In a two-sided document you can define whether the figure should be on the inside or outside edge of the page.

    2. Define how many shortened lines of the text are set alongside the figure. If you leave this empty, &latex; will determine this itself as well as is possible.

    3. Define an overhang to the chosen side. This is especially useful when you have columns in your document and you want a figure to span over more than just one column or you want shortened text on both sides of the figure.

    4. Choose a width for the figure. This should be a bit bigger than the actual image width, so there will be some empty space between the figure and the text.

### Arrays and tabulars

One of the most boring jobs one can do in &latex; is to write a matrix or a tabular environment. One has to keep track of all the elements, ensure that the environment is well formed, and that all things are where they are supposed to be. Good indentation helps, but there is a simpler way: using &kile;'s Wizard Array or Wizard Tabular menu entries. You will then have a matrix-style input form that you can easily fill in with your entries. This dialog also offers some options to typeset the tabular material.

Inserting a tabular environment Inserting a tabular environment

Using the toolbar on top of the dialog you can set the `align` of a cell, define a certain `font style`, `join` and `split` cells, choose a `border`, and specify background and font `colors`. On the extreme right there is a Paste button. With this button you can insert a table from the clipboard into the dialog, which allows you to copy and paste tables from a spreadsheet program, for example.

Below you can choose how many rows and columns you want, and you can tweak some more details about your array:

- With the Name option you can select which environment should be used for your array or tabular material.

- You can select the vertical cell alignment with the Parameter option. This is only enabled for environments which support that feature.

- If it exists for the selected environment, you can select use starred version. When you select this option, you also have to specify a table width.

- Tables sometimes look nicer when you select the use booktabs package option.

- Of course, you can also Center your whole array.

- Inserting bullets helps you when you want to fill in your content in the editor. With this option checked, &kile; will insert bullet placeholders for each element of your array.

The Wizard Tabbing option will display a simpler dialog to quickly set up a tabbing environment. It allows you to easily specify the number of rows or columns and the required spacing.

### Inserting floating elements

&kile; helps you with inserting your floating elements. With the Wizard Floats wizard it is very simple to create a new figure or table environment.

Inserting a floating element Inserting a floating element

To insert a new floating environment just follow these steps:

1. Choose whether you want to insert a figure or a table.

2. Select the desired positioning rules.

3. Enter a caption for your floating element.

4. Type in a label for your new floating element. &kile; will automatically suggest an appropriate prefix , ⪚ "fig:" for figures and "tab:" for tables.

### Inserting Math environments

Remembering how all the different math elements work can be really annoying. Of course &kile; can do the magic for you here: Wizard Math

Inserting a math element Inserting a math element

Options:

- Name: Choose the type of math element you want to create.

- Without numbering: This can switch numbering off for numbered elements like equations or aligns.

- Space command to separate groups: In an environment which supports several groups like alignat, you can define a space separator when you have more than one group. You can enter any space command here, which exists in mathmode, ⪚ \quad.

- Standard tabulator: Select the tabulator which should be used. &kile; should automatically pick the right one for you here.

- Displaymath mode: For environments like matrices or arrays you can choose which math environment your mathematical text should be displayed with.

- Use bullets: With this option checked, &kile; will insert bullet placeholders for each element of your mathematical text.

### &PostScript; Utilities

PS files are not so popular as PDF files, but are an excellent base for manipulations and rearrangements of pages. If you need PDF output, you can rearrange pages with some &PostScript; utilities and then convert it to PDF with `ps2pdf`.

The &PostScript; Wizard under Wizard Postscript Tools will suggest the most popular rearrangement. The conversion is done by the programs `pstops` and `psselect`, which can be found in most distributions in the package `psutils`. If one of these programs is not available, the corresponding item will not be visible.

Dialog PSTools Dialog PSTools

First choose your input file. If &kile; finds a PS file corresponding to your current master document, it is already filled in as the input file, but you are also free to choose another file. Then choose an output file, and select one of the tasks. Finally, you have to decide whether you want to do the conversion only, or also invoke &okular; to view the result.

1 A5 page + empty page --> A4

- Combine one A5 page together with one empty page on one A4 page. Whenever two A5 pages are combined together, they are rotated 90 degrees and will be arranged on an A4 page in landscape mode.

  A5 + empty page A5 + empty page

1 A5 page + duplicate --> A4

- Put one A5 page and a duplicate together on one A4 page.

  duplicate A5 pages Duplicate an A5 page

2 A5 pages --> A4

- Put two consecutive A5 pages together on one A4 page.

  Combine two A5 pages Combine two A5 pages

2 A5L pages --> A4

- Put two consecutive A5 pages in landscape mode together on one A4 page.

4 A5 pages --> A4

- Combine four consecutive A5 pages together on one A4 page. The A5 pages have to be scaled with factor 0.7 to fit on the page.

  4 A5 pages --> A4 4 A5 pages --> A4

1 A4 page + empty page --> A4

- Combine one A4 page together with one empty page on one A4 page. Whenever two A4 pages are combined together on one resulting A4 page, they have to be scaled with factor 0.7 and will be arranged in landscape mode.

  1 A4 page + empty page --> A4 1 A4 page + empty page --> A4

1 A4 page + duplicate --> A4

- Put one A4 page and a duplicate together on one A4 page.

  1 A4 page + duplicate --> A4 1 A4 page + duplicate --> A4

2 A4 pages --> A4

- Put two consecutive A4 pages together on one A4 page.

  Combine two A4 pages Combine two A4 pages

2 A4L pages --> A4

- Put two consecutive A4 pages in landscape mode together on one A4 page.

select even pages

- Select all even pages of a document.

select odd pages

- Select all odd pages of a document.

select even pages (reverse order)

- Select all even pages of a document and reverse the order.

select odd pages (reverse order)

- Select all odd pages of a document and reverse the order.

reverse all pages

- Reverse all pages of a document.

copy all pages (sorted)

- Copy all pages of a document. You have to choose the number of sorted copies.

  Copy all pages (sorted) Copy all pages (sorted)

copy all pages (unsorted)

- Copy all pages of a document. You have to choose the number of non-sorted copies.

  Copy all pages (unsorted) Copy all pages (unsorted)

pstops: choose parameter

- There are many options for &PostScript; utilities `pstops` and `psselect`. If you need a very special one, you can invoke `pstops` with an option of your choice. Please read the manual for all possible options.

psselect: choose parameter

- You can invoke `psselect` with an option of your choice. Please read the manual for all possible options.

### PDF Utilities

Many people think of PDFs as frozen files, which cannot be modified. But this is not true, as there exist excellent tools

- for manipulations and rearrangements of pages

- to read and update document info

- to read, set or change some permissions

of an existing PDF document.

&kile;'s PDF wizard under Wizard PDF Tools uses two different methods to manipulate and rearrange PDF documents:

- &latex; package `pdfpages`, which is part of each &latex; distribution. `pdfpages` doesn't work with encrypted pages.

- `pdftk`, which is an excellent command line tool for doing everyday things with PDF documents (see The PDF Toolkit).

If one of these helpers, `pdfpages` or `pdftk`, is not present in your system, the corresponding items will not be visible. Furthermore, remember that only `pdftk` can work with encrypted files.

#### Rearrangements

If &kile;'s PDF wizard is called, it starts with the `Rearrangements` register card.

Dialog PDF Tools Dialog PDF Tools

First choose your input file. If &kile; finds a PDF file corresponding to your current master document, it will already be filled in as the input file, but you are also free to choose another file. Then choose an output file or overwrite the existing PDF file, and select one of the tasks. Finally, you have to decide whether you want to do the conversion only, or also invoke the viewer (⪚ &okular;) to show the resulting document.

If the PDF file is encrypted, only `pdftk` will work and you have to give the password of this document to execute tasks.

1 page + empty page --> A4

- Combine one page together with an empty page on one A4 page. Whenever two A5 pages are combined together, they are rotated by 90 degrees and arranged on an A4 page in landscape mode.

  A5 + empty page A5 + empty page

  Whenever two A4 pages are combined together, they are scaled, rotated by 90 degrees and arranged on an A4 page in landscape mode.

  A4 + empty page --> A4 A4 + empty page

1 page + duplicate --> A4

- Put one page and a duplicate together on one A4 page.

  Duplicate a page Duplicate a page

  If the page to be duplicated has A4 size, it will be scaled to fit on the page.

  Duplicate a page Duplicate a page

2 pages --> A4

- Combine two consecutive pages together on one A4 page. Whenever two A5 pages are combined together, they are rotated by 90 degrees and arranged on an A4 page in landscape mode.

  Combine two A5 pages Combine two A5 pages

  Whenever two A4 pages are combined together, they are scaled, rotated by 90 degrees and arranged on an A4 page in landscape mode.

  Combine two A4 pages Combine two A4 pages

2 pages (landscape) --> A4

- Put two consecutive pages in landscape mode together on one A4 page.

  Combine two pages (in landscape mode) Combine two pages (in landscape mode)

4 pages --> A4

- Combine four consecutive pages together on one A4 page. The pages have to be scaled to fit on the page.

  4 pages --> A4 4 pages --> A4

4 pages (landscape) --> A4

- Combine four consecutive pages in landscape mode together on one A4 page. The pages have to be scaled to fit on the page.

  Combine four pages (in landscape mode) Combine four pages (in landscape mode)

select even pages

- Select all even pages of a document.

select odd pages

- Select all odd pages of a document.

select even pages (reverse order)

- Select all even pages of a document and reverse the order.

select odd pages (reverse order)

- Select all odd pages of a document and reverse the order.

reverse all pages

- Reverse all pages of a document.

decrypt a file

- If the PDF file is encrypted, you can decrypt it.

select pages

- Add a comma separated list of pages or page ranges, ⪚ 1,4-7,9. Only these pages will appear in the resulting PDF file.

delete pages

- Add a comma separated list of pages or page ranges, which should be removed from the chosen PDF file.

apply a background watermark

- Applies a PDF watermark to the background of a single input PDF. The wizard only uses the first page from the background PDF and applies it to every page of the input PDF. This page is scaled and rotated as needed to fit the input page.

apply a background color

- Applies a background color to all pages of the current document. This can only be done once, as the second color will be put behind the first color and will not then be visible.

apply a foreground stamp

- Applies a foreground stamp on top of the input PDF document's pages. The wizard uses only the first page from the stamp PDF and applies it to every page of the input PDF. This page is scaled and rotated as needed to fit the input page. This works best if the stamp PDF page has a transparent background.

pdftk: choose parameter

- You can invoke `pdftk` with an option of your choice. Please read the manual for all possible options.

pdfpages: choose parameter

- You can invoke `pdfpages` with an option of your choice. Please read the manual for all possible options.

#### Properties

The setting, changing and removing of properties will only be possible if `pdftk` is installed and if additionally &kile; was compiled with the `libpoppler` library.

Dialog PDF Properties Dialog PDF Properties

Traditional PDF metadata includes the document's title, author, subject, keywords, creator, producer and the dates of creation and last modification.

#### Permissions

Also, the setting, changing and removing of permissions will be only possible if `pdftk` is installed.

Dialog PDF Permissions Dialog PDF Permissions

A password is necessary to set or change these document settings. Additionally, PDF encryption is done to lock the file's content behind this password or to enforce lighter restrictions imposed by the author. So the author can allow or restrict:

- printing pages

- modifying pages

- copying text and graphics from pages

- changing or adding annotations

- filling form fields with data.

Changing permissions always forces encryption associated with 128-bit security of `Acrobat` 5 and 6, and also needs a password.

But always remember: encryption and a password do not provide any real PDF security. The content is encrypted, but the key is known. You should see it more as a polite but firm request to respect the author's wishes.

### Document Statistics

The statistics dialog in File Statistics gives you a statistical overview for a selection, a document or a whole project. It includes the number of words, &latex; commands/environments and also includes the number of characters for each type.

The statistics obtained can be copied as text or as a nicely formatted &latex; table to the clipboard.

When you select a text and open the statistics dialog, you get the statistics for the currently selected text. If you open the dialog without any text selected, the statistics for all opened files are shown. If you want to get statistics for the whole project, you can use Project Open All Project Files for an easy and quick way to open all source files of your project.

A note of caution has to be sounded about the accuracy of the numbers. We have included some logic to get a good estimate, ⪚ K\"uhler gives one word and one command, with six and two characters respectively. But there are other combinations in which parts of commands are counted as words and vice versa. Please note that the algorithm was developed and tested for languages similar to English or German. So don't take the numbers for granted. If you write a report whose length has to be of a certain numbers of words or characters, please make some tests first in order to check whether &kile;'s accuracy satisfies your needs.

## Special Tags in &latex;

### Using the &latex; Tag Library

&latex; has thousands of tags for symbols and special characters. The easiest way to insert these tags is to use the sidebar menu, to the left of the editor window.

The Sidebar Menu The Sidebar Menu

The Sidebar Menu

The following types are available:

- Most Frequently Used

- Relation

- Operators

- Arrows

- Miscellaneous Math

- Miscellaneous Text

- Delimiters

- Greek

- Special Characters

- Cyrillic Characters

- User Defined

The tooltips of the icons show the &latex; commands and additionally needed packages.

Pressing &Shift; and clicking a symbol will result in `$\symbolcmd$` being inserted. Similarly, pressing &Ctrl; inserts it in curly brackets.

If you insert a command which requires a package which is not included in your &latex; document, you will see a warning message in the logview window.

The first list of symbols holds the Most Frequently Used symbols. Inserted symbols will be added to this list, for quick and easy reference. The ordering of the symbols will not be changed upon addition of new symbols, instead a reference counter is incremented. If the number of items exceeds 30 items, the item with the lowest count is removed.

The User Defined symbol list can hold your own symbols. To create your own symbols you need the program gesymb and the file `definitions.tex` from the kile source package. Additionally you need a &latex; compiler (what a surprise) and &dvipng; (version 1.7 or later). The procedure is that you create a &latex; file with `\input{definitions}`, which makes the commands listed below available, and let `gesymb mysymbols.tex user` (which calls &latex; and &dvipng;) create the icons. After copying them to `$HOME/.kde/share/apps/kile/mathsymbols/user/` and restarting kile you can use your own symbols.

The following commands are defined in `definitions.tex`:

- `\command[\optarg]{\symbol}`: Include the symbol `\symbol` in the symbol list, the optional argument `\optarg` specifies the command which kile should insert. If it is not given the command in the mandatory argument is used.

- `\mathcommand[\optarg]{\symbol}`: Same as above, except that the command in the mandatory argument is inserted in math mode.

- `\pkgs[arg]{pkg}`: Declare that the command given in this line needs the &latex; package `pkg` with the optional argument `arg`. This command has to be in front of the `\command` command and overrides any package specification by the neededpkgs enviroment.

- `\begin{neededpkgs}[pkgs-args]{pkgs} ... \end{neededpkgs}`: Has the same effect as above, but for all enclosed commands.

An example for completeness is given here:

    \documentclass[a4paper,10pt]{article}
    \usepackage{amssymb}
    \input{definitions}
    %
    \begin{document}
    \pagestyle{empty}
    %
    \begin{neededpkgs}{amssymb}
    \mathcommand{\surd}
    \pkgs{amsmath}\mathcommand[\ddddot{}]{\ddddot{a}}
    \mathcommand{\angle}
    \end{neededpkgs}
    \command{\"A}
    \mathcommand{\exists}
    \mathcommand[\stackrel{}{}]{\stackrel{abc}{=}}

    %\begin{neededpkgs}[russian,koi8-r,T2C,]{babel,inputenc,fontenc,mathtext}
    %
    %   \end{neededpkgs}
    % this would need to include the packages
    % \usepackage{mathtext}
    % \usepackage[T2C]{fontenc}
    % \usepackage[russian]{babel}
    % \usepackage[koi8-r]{inputenc}
    %  just to explain the format
    \end{document}

### Using Bibitems

`\bibitem` is a command used to enter a reference in a `thebibliography` environment in your document. The syntax for using `\bibitem` is `\bibitem[label]{key}`.

The optional `[label]` is for you to add your own labeling system for the bibliography entry. If no label is set, the entries will be set in numerical order: [1], [2], [3], &etc;

The argument `{key}` is used to reference and link the commands `\bibitem` and `\cite` to each other and the information they contain. The command `\cite` contains the label associated with the intended `\bibitem`, which is located inside a `thebibliography` environment, and contains the reference data. Both corresponding `\bibitem` and `\cite` must have the same `{key}`; the easiest way to organize keys is by the author's last name. The secondary braces in the `thebibliography` environment denote the longest bibliography label you expect to have. So, inserting `{`foo`}` means you can have any label shorter or as large as the expression ``foo``. Failure to set this parameter correctly may result in a not so attractive indentation of your bibliography.

The bibliography is a section apart from your main document, and an example of code for the bibliography would look like the following:

    \begin{thebibliography}{50}
    	\bibitem{Simpson} Homer J. Simpson. \textsl{Mmmmm...donuts}. Evergreen Terrace Printing Co.,
    	                  Springfield, SomewhereUSA, 1998
    \end{thebibliography}

Then, your main source code would contain the location of the information relating to the `\bibitem` using `\cite`. That source code would look similar to this:

    My thesis, about the philosophy of The Simpsons\copyright comes from my favorite book \cite{Simpson}.

As it is often difficult to remember the exact citation key once you have many references, &kile; provides an easy way to insert a citation. Using LaTeX References Cite a list with all the citation keys pops up. Select the correct reference and a citation will be inserted into your document. To update the list of keys, either save the file, or Edit Refresh Structure, or press F12. With code completion enabled, &kile; will show you a list of all the `bibitem`-labels as soon as you open up a `\cite` command.

The final result in your document's bibliography would then look like this:

`[1] Homer J. Simpson. Mmmmm...donuts. Evergreen Terrace Printing Co., Springfield, SomewhereUSA, 1998.`

&kile; can also work together with &bibtex; editors, such as &kbibtex; to make it easier to enter citations. When a &bibtex; file is added to the project, &kile; will help you complete citation commands, just as described above.

&include-section-usermenu;

## The Build Tools

### Compiling, converting and viewing

To view the result of your work, you first need to compile the source. All the build tools are grouped closely together in the Build Compile, Build Convert, and Build View menus.

To compile your source code for screen viewers like &okular; or further conversion, you can use the shortcut &Alt;2. Then you can view the &DVI; file using your default viewer with &Alt;3, convert the &DVI; to a PS file with &Alt;4, and view the PS file with &Alt;5.

#### &bibtex;

If you are using &bibtex; for your bibliography entries, you usually have to follow a special compiling scheme. This means calling &latex; and then &bibtex; and then &latex; twice again. Fortunately &kile; is clever enough to detect automatically if it is necessary to call additional tools like &bibtex;, &makeidx; and &asymptote;. This logic is turned on by default and can be changed in Settings Configure Kile...Tools Build in the General tab in the &latex; and &pdflatex; tools.

#### MetaPost and &asymptote;

If you want to compile your document with MetaPost or &asymptote;, picture drawing programs, you can do it with Build Compile Metapost, or Build Compile&asymptote;.

#### &pdflatex;

There is also another way to compile your document, if you want a PDF: you can run &pdflatex;, that will compile the source directly into a PDF file, with &Alt;6: you can then view the compiled file by pressing &Alt;7.

Alternatively, you can convert a PS into a PDF with &Alt;8, or a &DVI; directly into a PDF with &Alt;9.

Using &pdflatex; instead of &latex; may be just a matter of simplicity or habit, but sometimes the behavior of the two programs can differ.

#### &latex; to Web

Finally, you may want to publish your work on the web and not just on paper. You may then use the latex2html program, that can be called from &kile;'s menu Build Convert LaTeX to Web. The result will be placed in a subfolder of the work folder, and you will be able to see the result of the conversion choosing the menu item Build View View &HTML;.

#### Passing Command Line Parameters

If you want to pass some specific command line parameters to the compile, convert or view tools, you can configure their call in Settings Configure Kile...Tools Build.

### Quick Preview

You will always need some time to view the result, when working with &latex;. &latex; has to compile the source and the viewer has to be called. This can be annoying if you only changed some letters in an equation difficult to typeset. &kile; offers a Quick Preview mode, where you can compile only a part of a document and save a lot of time. It supports four different modes, which can be combined with seven configurations.

Quick Preview Quick Preview

All settings must be done in Settings Configure Kile... Tools Preview.

Quick Preview Configuration Quick Preview Configuration

#### Selection Mode

The user has to select a part of the document. Menu entry Build QuickPreview Selection or the keyboard shortcut &Ctrl;&Alt;P,S will start the selected programs. &kile; takes the preamble of the original text, so that all packages and user defined commands are included. The user can choose one of eight predefined configurations:

- LaTeX+&DVI; (embedded viewer)

- LaTeX+&DVI; (&okular;)

- LaTeX+PS (embedded viewer)

- LaTeX+PS (&okular;)

- PDFLaTeX+PDF (embedded viewer)

- PDFLaTeX+PDF (&okular;)

- XeLaTeX+PDF (embedded viewer)

- XeLaTeX+PDF (&okular;)

This should be sufficient for all situations for which a quick preview is needed.

#### Environment Mode

Very often you want to preview the current environment, and especially mathematical environments, which sometimes may be difficult to write. &kile; offers a very fast way to do this. No selection is needed, just choose Build QuickPreview Environment or the keyboard shortcut &Ctrl;&Alt;P,E and the current environment will be compiled and shown.

#### Subdocument Mode

If you have a large project with a lot of documents, compiling the whole project is not a great idea, if you have made changes only in one single document. &kile; is able to compile and show a preview of the current subdocument. It takes the preamble from the master document and only compiles the current part when you choose Build QuickPreview Subdocument or the keyboard shortcut &Ctrl;&Alt;P,D.

#### Mathgroup Mode

The mathgroup preview mode allows you to preview the mathgroup you are currently editing. &kile; takes the preamble from the master document and only compiles the mathgroup the cursor is currently in when you choose Build QuickPreview Mathgroup or the keyboard shortcut &Ctrl;&Alt;P,M.

#### Quick Preview in Bottom Bar

Instead of showing the preview in a new document &kile; can also be configured to use the bottom bar for preview compilations. You can activate this feature in the quick preview configuration panel.

### Graphic File Formats

#### &latex; and &pdflatex;

&pdflatex;, when used with `graphics` or `graphicx` packages, can correctly compile PNG and JPG files into &DVI; or PDF, but is not able to handle EPS files. Conversely, the process of compiling with &latex; to &DVI; and converting to PS and eventually PDF does support EPS, but does not support PNG and JPG.

A lot of users want to create PDF documents, but also want to use the excellent Pstricks package to create &PostScript; graphics, or they want to use the &PostScript; output of mathematical and scientific software like Mathematica, Maple or MuPAD. These &latex; users have to compile first in &PostScript;, even if they want to create PDF documents, because these programs produce &PostScript; code which cannot be managed by &pdflatex;. However, it is not so hard as it may sound, because &kile; will help.

#### Graphics Conversion

To overcome this frustrating loop, when you want to include both &PostScript; code and PNG or JPG files, you have a number of workarounds:

- If you need a file in PS format, but have JPG or PNG graphics, you can also simply use &pdflatex; with &DVI; output first, and then run dvips to create the PS file. You see that &pdflatex; is a very good choice, if your source contains no &PostScript; code at all.

- You can convert EPS files to PNG or other formats with utilities as the Gimp or &imagemagick; and use &pdflatex;.

- A preferred way is to convert EPS graphics to PDF graphics with `epstopdf`, which comes with every &tex; distribution and then use &pdflatex;. It produces high quality graphics, and you can even control the result with some of the following options:

      	-dAutoFilterColorImages=false
      	-dAutoFilterGrayImages=false
      	-sColorImageFilter=FlateEncode
      	-sGrayImageFilter=FlateEncode
      	-dPDFSETTINGS=/prepress
      	-dUseFlateCompression=true

  Even better: if your system allows `shell-escape`, conversion can be done on the fly. All you have to do is to include the epstopdf package, which is part of all &tex; distributions, with the command `\usepackage{epstopdf}`. Assuming that your code is:

      	\includegraphics[width=5cm]{test.eps}

  When you call &pdflatex; with option `--shell-escape`, graphics `test.eps` is automatically converted into `test.pdf`.

  This conversion will take place each time you run &pdflatex;. If your graphics command is given implicitly:

      	\includegraphics[width=5cm]{test}

  epstopdf checks whether `test.pdf` is already available, so that the conversion step can be skipped.

- You can convert the other way around, and use &latex; and PS-PDF conversion. This is not always a good idea, since EPS encapsulation of JPG or PNG can yield larger files, that in turn yield unnecessarily large documents. This is however highly dependent on the graphic utility that you use, since EPS can encapsulate other graphics, but not all applications support this perfectly. Some might actually try to build your JPG image with vectors and various scripting, which will result in gigantic files. Conversion of all graphics formats to EPS can be done by &imagemagick;. Another simple program that does this process correctly is jpg2ps.

- You can also use an automatic conversion. All graphics files are converted on the fly to EPS, and inserted into the PS document. This is a comfortable way, but you have to set up your system properly. This is discussed in the section EPS Graphics.

#### Use the right File for the right Graphic

- EPS is sort of a graphic vector scripting language, describing all the lines and dots the graphic is made of; it looks good even when magnified beyond its default size, and suits best diagrams and vectorial graphics natively produced in EPS, which look very clear and sharp while maintaining a very small byte size.

- PNG (or the deprecated &GIF;) is a non-lossy file format, with good compression and quality. It is very good for diagrams, scans of drawings, or anything whose sharpness you do want to retain. It is sometimes overkill when used for photos.

- JPG is a lossy format, that compresses files better than PNG at the price of some loss in the picture detail. This is usually irrelevant for photos, but may cause bad quality for diagrams, drawings, and may make some thin lines disappear outright; in those cases use EPS or PNG.

But always remember: garbage in, garbage out! No conversion will make a bad picture good.

### EPS Graphics

EPS graphics files are the traditional way to insert graphics files into &latex; documents. As mailing lists are full with questions concerning EPS graphics, we will discuss some important aspects and demonstrate how &kile; supports them.

#### &latex; and EPS Graphics

If you decided to use the traditional &latex; to produce PS or PDF output, you will probably run into some problems with graphics. You have to use EPS graphics (Encapsulated &PostScript;); no JPEG or PNG files. This should be no problem, as there are a lot of converters like `convert` from the excellent &imagemagick; package. But, it needs some time of course.

The EPS files are used by both &latex; and the &DVI;-PS converter:

- &latex; scans the EPS file for the bounding-box line, which tells &latex; how much space to reserve for the graphics.

- The &DVI;-PS converter then reads the EPS file and inserts the graphics in the PS file.

This has some implications:

- &latex; never reads the EPS file if the bounding-box parameters are specified in the graphics insertion command.

- Since &latex; cannot read non-ASCII files, it cannot read the bounding-box information from compressed or non-EPS graphics files.

- The EPS graphics are not included in the &DVI; file. Since the EPS files must be present when the &DVI; file is converted to PS, the EPS files must accompany the &DVI; files whenever they are moved.

Now you can call &latex;, and a &DVI;-PS converter like dvips to create your &PostScript; document. If your goal is a PDF document, you should run `dvips` with option `-Ppdf` and then call `ps2pdf`. You will find a lot of documents describing this solution.

#### The &PostScript; Way of &kile;

&kile; helps you to get the bounding-box information. If you have installed &imagemagick; package, &kile; will extract this information from the EPS file and insert it as an option. This is done automatically when you select the graphics file. There are two advantages to proceeding like this:

- The information is already scanned in the dialog, and need not to be done by &latex; later on.

- Even more important is that the width and height of the picture can be calculated, when the resolution is known. This information will be shown near the top of the dialog, and may serve as a clue when you want to scale the graphics.

- &kile; can also support zipped or gzipped EPS files, which are much smaller than uncompressed EPS files. But, this feature can only be used with a special system setup and a change of your local graphics configuration, as it is described in the Bitmap Graphics section.

#### The &PostScript; Way and Bitmap Graphics

If your system allows `shell-escape`, &kile; also supports an easy way to include bitmap graphics, if you set up your &tex; system properly. There is no need to convert JPEG or PNG graphics, this can be done automatically when the &DVI; file is converted to PS.

&latex; needs some information about the file suffixes. The package `graphicx` looks for a file `graphics.cfg`, which must be somewhere in your search path for &latex; documents. Search for entries like:

       \DeclareGraphicsRule{.pz}{eps}{.bb}{}%
       \DeclareGraphicsRule{.eps.Z}{eps}{.eps.bb}{}%
       \DeclareGraphicsRule{.ps.Z}{eps}{.ps.bb}{}%
       \DeclareGraphicsRule{.ps.gz}{eps}{.ps.bb}{}%
       \DeclareGraphicsRule{.eps.gz}{eps}{.eps.bb}{}%

and replace these lines with:

       \DeclareGraphicsRule{.pz}{eps}{.bb}{}%
       \DeclareGraphicsRule{.eps.Z}{eps}{.eps.bb}{}%
       \DeclareGraphicsRule{.ps.Z}{eps}{.ps.bb}{}%
       \DeclareGraphicsRule{.ps.gz}{eps}{.ps.bb}{}%
       % changed or new graphic rules
       \DeclareGraphicsRule{.eps.zip}{eps}{.eps.bb}{`unzip -p #1}%   zipped EPS
       \DeclareGraphicsRule{.eps.gz}{eps}{.eps.bb}{`gunzip -c #1}%   gzipped EPS
       \DeclareGraphicsRule{.jpg}{eps}{}{`convert #1 eps:-}%         JPEG
       \DeclareGraphicsRule{.gif}{eps}{.bb}{`convert #1 eps:-}%      GIF
       \DeclareGraphicsRule{.png}{eps}{.bb}{`convert #1 eps:-}%      PNG
       \DeclareGraphicsRule{.tif}{eps}{.bb}{`convert #1 eps:-}%      TIFF
       \DeclareGraphicsRule{.pdf}{eps}{.bb}{`convert #1 eps:-}%      PDF-graphics

You will find this file, for example in Debian, at `/etc/texmf/latex/graphics.cfg`. The best way to proceed is to copy this file to your local texpath and then change this copy. See your &tex; distribution manual to learn how to get a list of your &tex; folders.

With this configuration file you are able to insert bitmap graphics and zipped or gzipped EPS files in &latex;. The command for conversion is given by `dvips`. When you look at the conversion command you will see that no extra file is created. The result of the conversion process is directly piped into the PS file. The only thing &latex; must know is the size of the graphics, and therefore we need the bounding box, which is provided by &kile;.

Some say that this way is insecure; you have to decide on how to work. In any case, you need no bounding box, as &kile; will extract this information from all types of graphics.

#### &pdflatex; and EPS Graphics

As already stated, &pdflatex; is not able to handle EPS graphic files, but converters like epstopdf will help. The best way is to include package `epstopdf`, which must follow the `graphicx` package.

       \usepackage[pdftex]{graphicx}
       \usepackage{epstopdf}

Now you can already include EPS graphics, if you run `pdflatex` with option `--shell-escape`, but we can make it even better and also handle zipped or gzipped EPS files. Again we have to change the graphics configuration file `graphics.cfg` as above. This time we search for:

       % pdfTeX is running in pdf mode
       \ExecuteOptions{pdftex}%

and simply add some lines:

       % pdfTeX is running in pdf mode
       \ExecuteOptions{pdftex}%
       \AtEndOfPackage{%
          \g@addto@macro\Gin@extensions{.eps.gz,.eps.zip}%
          \@namedef{Gin@rule@.eps.gz}#1{{pdf}{.pdf}{`gunzip -c #1 | epstopdf -f >\Gin@base.pdf}}%
          \@namedef{Gin@rule@.eps.zip}#1{{pdf}{.pdf}{`unzip -p #1 | epstopdf -f >\Gin@base.pdf}}%
       }%

With these lines, &pdflatex; is able to handle EPS files, and hopefully there should be no more issues concerning graphics.

### Master Document

Defining your document as a master allows you to work with separate files, which gives you a parent document (or Master document), and child documents that make up a complete work. After having defined your Master document, with the corresponding command in the Settings menu, all the commands of the Tools menu will apply only to this document, even when you are working on the child documents. You can even close the Master document.

### Error Handling

After you have compiled something, &kile; takes a look at the error messages that were generated. If there are any errors or warnings, they will be briefly reported in the Log and Messages window. One can take a closer look at the messages by selecting Build View Log File, or by using the keyboard shortcut &Alt;0. The generated log is then displayed in the Log and Messages view; errors and warnings are highlighted.

Viewing the log Viewing the log

Viewing the log

You can easily jump from one message in the log file to another by using the Build Next / Previous LaTeX Error / Warning menu items, or by using the corresponding toolbar buttons.

To jump to the line in the &latex; source where the error or warning occurred, click on the error or warning in the Log and Messages view. &kile; will take you automatically to the offending line.

### The Watch File Mode

When you launch the Quickbuild command, a viewer of some sort will normally be called after the compilation. If you are not using an embedded viewer, a new window will be opened every time.

If you are adjusting the look of your document, you might launch Quickbuild very often, and have many viewer windows open on your desktop; to avoid this confusion, you can activate the Watch file mode, that will prevent Quickbuild from launching a viewer.

This mode is of course useless with the embedded viewers, as you have to close them anyway to get back to editing the document and recompiling.

## Navigating the &latex; Source

### Using the Structure View

The Structure view shows the hierarchy of the document being created in &kile;, and allows you to quickly navigate it, showing its segmentation. To navigate around your document, all you need to do is to left click on any label, chapter, section, subsection, etc., and you will be taken to the beginning of the corresponding area.

If you included a separate &latex; file in your source using the `\input` or `\include` tags, these files will be referred to in the Structure view; double-clicking on their names will make &kile; bring up the included file in the editor window.

The hierarchy tree also has a separate branch for labels used in the text.

#### Using the Context Menu

Most of the entries in the structure view have a lot of entries in the context menu, which you can open with a right mouse click. So look at the structure view in the following picture.

Using the Structure View Using the Structure View

You will find some labels, some sectioning entries, two figure environments and three pictures. If you right click on one of the sectioning entries, a menu with some useful commands will popup. All commands like Select, Delete or Comment will work with all lines, which belong to this section.

Context menu for sectioning entries Context menu for sectioning entries

Clicking on a figure or table entry will offer some actions with respect to references and a right click on a graphics entry will offer some programs to open the graphics.

Context menu for figure/tables and graphics entries Context menu for figure/tables and graphics entries

#### Updating the Structure View

To update your structure view you can either go to Edit Refresh Structure, hit F12, or you can save your document, which will make &kile; update its Structure view.

### Bookmarks

Bookmarks are your reference to a segment of text or a line inside the &kile; environment. To use a bookmark, select a specific line of your document you would like to return to, then press &Ctrl; B, and &kile; will add a bookmark to this line. Alternatively, you can also set a bookmark by highlighting a line and choosing the menu labeled Bookmarks Set Bookmark.

To remove all your bookmarks, select Bookmarks Clear All Bookmarks.

## Projects

### Working with Projects

In &kile; you can create and work with projects. A project is a group of &latex;, graphic, &bibtex;, or other files that contain all the information that is used to build your complete document. A typical project would be a document consisting of several chapters, written in different `.tex` files; all of them could be included in a project, to make the whole document easier to manage. The specifications of the project are stored in a special file, with extension `.kilepr`.

A Project adds the following functionalities:

- You need not set a master document, &kile; does this automatically.

- Project files can easily be archived together by going to Project Archive

- The Files and Projects view shows which files are included in the project.

- After opening a project, any file that was previously opened will be restored with the original encoding and highlighting.

- Code completion works across all project files.

- Reference completion works across all project files.

- Citation completion works across all project files.

- Search in all project files.

- Specify custom quickbuild and &makeidx; command.

You can find all project related commands in the Project-menu. From there you can open, close and manage your projects.

### Creating a Project

To create a project, select Project New Project....

Project creation window Project creation window

You will be asked to give the following information to create your project:

- Title of your project (Project title text field).

  The title of the project will be used to create a name of the project file by transforming to lowercase and adding `.kilepr` extension.

- A folder where the project file will be stored (Project folder text field).

- If you want to create a new main file of the project check the Create a new file and add it to this project item.

- When you fill out the Filename box, you have to include a relative path from where the `.kilepr` project file is stored (see the Project folder item).

- Type of the created file, Empty File, Article, Book, Letter, Report, &etc; can be chosen from a visual list at the bottom of the File panel.

- Extensions for the default files in the project can be selected using the Extensions panel. Your choice will be used to define the files that should be opened when you choose Project Open All Project Files menu item and in the &kile; wizards. The extensions in the text field should be separated with spaces.

### The Files and Projects View

The Files and Projects view is a button of the sidebar menu. From this view, you can see the structure of your project, its files, and the name of the `.kilepr` file that stores the project information. Adding, removing, or changing options in your project is done via the Files and Projects view.

The Files and Projects View The Files and Projects View

The Files and Projects View

### Adding and Removing Files

To add a file to your project, open any &tex; file, right click on its name in the Files and Projects view, and select Add to Project. If you have opened multiple projects, a dialog box will pop up in which you can specify to which project the file should be added.

You can also right-click on the project's name in the Files and Projects view, and select Add Files... to bring up a file selection dialog.

Adding a file to a project Adding a file to a project

Adding a file to a project

To remove a file from a project, right-click on it and select Remove File. This does not delete your file (and also does not close it), but only removes it from the list of files contained in the `.kilepr` extension.

#### Archiving your Project

&kile; allows you to easily backup your project by storing all its files into a single archive (often known as a tarball). To archive your project, right-click on its name in the Files and Projects view, or select Project Archive.

By default, all files in a project are added to the archive. If you do not want to include a certain file in the archive, right-click on it in the Files and Projects view, and uncheck the Include in Archive option.

The archive operation is currently realized by executing the `tar` from the project folder (where the `.kilepr` file is located).

### Project Options

&kile; has a few options related to your project that can be set. To change them, right-click on the title of your project and select Project Options, and you will have the option of changing:

- The title of your project.

- Default file extensions.

- The Master document.

- The Quickbuild command.

- The &makeidx; options.

### Closing a Project

To close a project, select the Files and Projects view from the vertical toolbar, right click on your project title, and then select Close. This will close your project, all the files associated with your project, and will also add the name of the project you just closed to Open Recent Project... in the Project menu.

## Document Encoding

The &kile; editor allows you to read, convert and save text in the character encoding your document needs. With this it is possible, for example, to use accented characters, such as are commonly used in Italian or French, directly in &latex; documents. Selecting the encoding for your document can be done in two ways:

- One way to set the document encoding is by using the submenu Settings Configure Kile...Editor, where you can set the default character encoding for all files.

  Set the default character encoding Set the default character encoding

- A second way to set the encoding for a document is to choose the desired encoding within the wizard to create a new document.

&latex; itself only understands ASCII, which represents a very limited set of characters. Hence, it is not possible to use accented characters directly. To use them nevertheless, a special syntax was invented: such as for example `\"e` for `ë`. The inputenc package is available to help you with this. It is included in the preamble using `\usepackage[latin1]{inputenc}`, where the optional argument specifies the encoding you would like to use (nowadays in most cases `utf8`). This tells &latex; to translate all of the `ë`'s you wrote to `\"e`'s before compiling. Please refer to the inputenc documentation directly for more information. Last but not least: remember to make sure that your file is actually saved in the same encoding you specified for the inputenc package!

This multitude of different character coding tables has created numerous problems: for example, you cannot write a course of Turkish in French without losing one language's special characters. There is general agreement that, sooner or later, everybody will switch to Unicode. There are many implementations of Unicode, and UTF-8 is the most successful in &Linux;; &Windows;® relies instead on the more cumbersome and less flexible UCS-2. Most distributions have already begun setting their default encoding to UTF-8, and therefore you may be very interested in using the `utf8` argument to the `inputenc` package.

### The &ucs; Package

If you don't have the &ucs; package installed, you can proceed as follows:

- Get the &ucs; package from CTAN.

- To install it, unpack the downloaded file and place it in a folder listed in your $`TEXINPUTS` environment variable. This can also be set inside &kile;.

    \usepackage{ucs}
    \usepackage[utf8]{inputenc}

### XeLaTeX

If you are using `XeLaTeX`, you can simply load the `xltxtra` package. It will additionally load all the required packages.

    \usepackage{xltxtra}

### &cjk; Support

Adding support for ideographic languages is quite tricky. However, once you are done with it, it will work quite well. Other than installing packages, there is some extra configuration work to do.

Your &Linux; distribution might already have a &cjk; (Chinese, Japanese, Korean) package ready for you, so you might be saved the hassle of manually installing everything. Do check before going forward!

There is the possibility of using the &ucs; package in order to write short snippets of &cjk; text, but that option is seriously limited as it does not handle, among other things, newlines. Instead, we will install the complete &cjk;-&latex; package and make it work for both &latex; and &pdflatex;. A lot of this material has been inspired by Pai H. Chou's page about how to setup &pdflatex;.

1. Download the &cjk; package. Copy its unpacked files to an appropriate subfolder of $`TEXMF`, just as you did with the &ucs; package before (see ucs). The files will be unpacked in a `CJK/X_Y.Z` folder; it is not important that you take them out, though it will probably be tidier and easier for you to maintain.

2. Now you have to download a font that supports all the &cjk; characters you need. You can choose any `*.ttf` file that covers them, but in this walkthrough we will use Cyberbit. Unzip the file and rename `Cyberbit.ttf` to `cyberbit.ttf`, since uppercase might confuse your system.

   Place `cyberbit.ttf` in a folder together with `Unicode.sfd`, and generate the `*.tfm` and `*.enc` files with the command ``$ ttf2tfm cyberbit.ttf -w cyberbit@Unicode@``. For some reason, sometimes this does not produce the hundreds of files it should. Should that happen in your case, you can download both `*.tfm` and `*.enc` files.

   Place the `*.tfm` files in an appropriate folder, say `$`TEXMF`/fonts/tfm/bitstream/cyberbit/`; the `*.enc` files may be installed in `$`TEXMF`/pdftex/enc/cyberbit/`.

3. Now we need a map file to connect the `*.enc` files to the font. Download `cyberbit.map` and install it in `$`TEXMF`/pdftex/config/`.

4. Download another file, `c70cyberbit.fd`, and place it in an appropriate folder. You may choose, for example, `$`TEXMF`/tex/misc/`.

5. The last file we have to generate is a &PostScript; Type 1 font, necessary to read &DVI; files generated with &latex;. Run the command ``$ ttf2pfb cyberbit.ttf -o cyberbit.pfb``, and copy the resulting `cyberbit.pfb` to a folder such as `$`TEXMF`/fonts/type1/cyberbit/`.

6. Let's now place `cyberbit.ttf` among the fonts where &latex; can find it. You could place it in a folder named `$`TEXMF`/fonts/truetype/`.

7. Check the configuration file you find at `$`TEXMF`/web2c/texmf.cnf`, and make sure that the line mentioning `TTFONTS` is uncommented and points to the folder where you saved `cyberbit.ttf`.

8. To make it possible for &pdflatex; to use your &cjk; fonts, it is necessary that you add a line in the configuration file `$`TEXMF`/pdftex/config/pdftex.cfg`. Add `map +cyberbit.map` in the file to complete the configuration for &pdflatex;.

9. To configure &latex; so that you can produce &DVI; files with &cjk; characters, you have to add a line in file `ttfonts.map`. The file might be in a folder named `$`TEXMF`/ttf2pk/`, but you will probably have to look for it. Append the line `cyberbit@Unicode@ cyberbit.ttf` to it.

10. Now, you only have to run ``texhash`` and the system should be ready.

To test whether your configuration is correct, you can try to compile this test file.

#### &cjk; Troubleshooting

There are many things that can go wrong when adding &cjk; support manually. If something seems not to work, the following checklist might help you.

- Obviously, since you run &latex; as a user and not as root, you must allow ordinary users to access the new files. Make sure all folders and files are accessible using the `chmod` command.

- If &latex; writes a &DVI; without problems, but you cannot view it, it is almost certainly because of some problems in the automatic generation of `*.pk` fonts. They are supposed to be generated on the fly when viewing a &DVI; file, but this might fail for a number of reasons: double-check `ttfonts.map` for your custom line first. However, it might happen that your `ttf2pk` command, which is usually invoked by the &DVI; viewer, has been compiled without support for the kpathsea libraries. If this is the case, ``ttf2pk` `--version`` will make no mention of kpathsea. As support for these libraries is necessary, you might have to find a new package, or recompile FreeType 1 yourself.

#### How do I input &cjk; in Unicode?

There are a number of different input engines, and the choice can depend also on personal preference. The author uses Skim, a port to &kde; of the Scim engine. Refer to your distribution's documentation to learn how to install these programs. Configuration of such programs can be tricky too, in the case of Skim you will have to define an environment variable ``XMODIFIERS`="@im=SCIM"` before starting X.

&include-section-scripting;

## Help

### Help Documents

&latex; is a rather sophisticated system, where basic features can be expanded by a great variety of additional packages. &kile; provides numerous different ways to aid the user.

The Help LaTeX Documentation submenu includes links on documentation for all the included packages and an additional &latex; reference.

Documentation Browser

- A handy tool to browse all &latex; topics. Please install &latex; help packages for your distribution if you need the full-fledged documentation compendium.

LaTeX

- A full unofficial reference for &tex; and friends. This is not only a description of all programs, but some important packages are also mentioned. It also includes a full reference manual of &latex; commands—ideal for looking up a particular piece of formatting while writing a document. As this document is really extensive, it is referenced in &kile; by three bookmarks.

LaTeX Commands

- Another alphabetical index of the most common &latex; commands.

LaTeX Environments

- An alphabetical index of the most common &latex; environments.

### Context Sensitive Help

&kile; also supports a context sensitive help, which is called with &Ctrl;&Alt;H,K. In Settings Configure Kile... Kile Help you can choose whether you want to use &kile;'s &latex; reference or the help system of &tetex;/&texlive;, which is the default setting.

Bullets Bullets

### Searching for Keywords

It is not always easy to find the right document as &tetex;/&texlive; ships with a huge number of help documents. In order to facilitate this process, &tetex;/&texlive; provides a tiny program called texdoctk. It provides a database of all the help documents, for which &kile; offers a user-friendly interface.

Bullets Bullets

All the documents are grouped into categories. Additionally, one can search for package names or keywords. &kile; will then show only the help documents matching the search string.

Bullets Bullets

A mouse double-click or the Space key will start a viewer for the selected document. This can be an arbitrary document, not only a &DVI;, PS, PDF or &HTML; document. &kile; takes the &kde; settings into account in order to start an appropriate viewer.

### User Defined Help

Besides this static &tetex;/&texlive; documentation, &kile; also supports a more flexible variable way for help documents. In the Help menu &kile; has a special User help submenu, where the user can add documents of his or her own choice. These can be the most important documents of the &tetex;/&texlive; documentation, or even self-written documents. It is also possible to enter URLs.

Go to Settings Configure Kile... Kile Help and choose the Configure button to configure this User help menu. You can add, remove or move menu entries around, and insert separators to optimize the structure of the menu.

Dialog: configure user defined help entries Dialog: configure user defined help entries

Pressing the Add button will open another dialog, where you can edit the name of the menu entry, and choose the corresponding file or &URL;. The second button to the right of the text field launches &konqueror;, which can be used to determine the correct &URL;.

Dialog: add a new helpentry Dialog: add a new helpentry

After finishing the configuration, all the entries will appear in the Help menu of &kile; as a special menu entry User help.

Userhelp menu Userhelp menu

## Credits and License

&kile; is an open-source user-friendly &latex; / &tex; source code editor. It runs on systems that have the &kde; Desktop Environment installed. &kde; is available for several architectures including &Linux; and other Unix-like systems.

Many thanks are owed to the people who strive to continue the &kile; project and to those who sacrifice numerous hours of their time to develop tools we can all use under the &GNU; license. Up-to-date information about contributors can be found in the About &kile; dialog from the Help menu.

Many thanks to all those involved!

&underFDL; &underGPL;
&documentation.index;