diff options
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/en/TODO | 1 | ||||
| -rw-r--r-- | doc/en/bullets.png | bin | 0 -> 8975 bytes | |||
| -rw-r--r-- | doc/en/complete_cmd1.png | bin | 0 -> 15613 bytes | |||
| -rw-r--r-- | doc/en/complete_cmd2.png | bin | 0 -> 2974 bytes | |||
| -rw-r--r-- | doc/en/complete_env1.png | bin | 0 -> 7702 bytes | |||
| -rw-r--r-- | doc/en/complete_env2.png | bin | 0 -> 3743 bytes | |||
| -rw-r--r-- | doc/en/config-complete.png | bin | 0 -> 46403 bytes | |||
| -rw-r--r-- | doc/en/config-dblquotes.png | bin | 0 -> 26336 bytes | |||
| -rw-r--r-- | doc/en/config-encoding.png | bin | 0 -> 83375 bytes | |||
| -rw-r--r-- | doc/en/config-quickpreview.png | bin | 0 -> 47956 bytes | |||
| -rw-r--r-- | doc/en/config-userhelp.png | bin | 0 -> 26609 bytes | |||
| -rw-r--r-- | doc/en/delete.png | bin | 0 -> 19087 bytes | |||
| -rw-r--r-- | doc/en/dialog-addhelp.png | bin | 0 -> 13112 bytes | |||
| -rw-r--r-- | doc/en/dialog-docbrowser1.png | bin | 0 -> 40989 bytes | |||
| -rw-r--r-- | doc/en/dialog-docbrowser2.png | bin | 0 -> 26841 bytes | |||
| -rw-r--r-- | doc/en/dialog-pstools.png | bin | 0 -> 20391 bytes | |||
| -rw-r--r-- | doc/en/dialog-tabular.png | bin | 0 -> 19155 bytes | |||
| -rw-r--r-- | doc/en/environment.png | bin | 0 -> 12969 bytes | |||
| -rw-r--r-- | doc/en/includegraphics.png | bin | 0 -> 34743 bytes | |||
| -rw-r--r-- | doc/en/index.docbook | 3720 | ||||
| -rw-r--r-- | doc/en/latex_example.png | bin | 0 -> 4086 bytes | |||
| -rw-r--r-- | doc/en/latexhelp.html | 3633 | ||||
| -rw-r--r-- | doc/en/psutils1.png | bin | 0 -> 1080 bytes | |||
| -rw-r--r-- | doc/en/psutils15.png | bin | 0 -> 1613 bytes | |||
| -rw-r--r-- | doc/en/psutils16.png | bin | 0 -> 1607 bytes | |||
| -rw-r--r-- | doc/en/psutils2.png | bin | 0 -> 1086 bytes | |||
| -rw-r--r-- | doc/en/psutils3.png | bin | 0 -> 1638 bytes | |||
| -rw-r--r-- | doc/en/psutils5.png | bin | 0 -> 3342 bytes | |||
| -rw-r--r-- | doc/en/psutils6.png | bin | 0 -> 1275 bytes | |||
| -rw-r--r-- | doc/en/psutils7.png | bin | 0 -> 1308 bytes | |||
| -rw-r--r-- | doc/en/psutils8.png | bin | 0 -> 1947 bytes | |||
| -rw-r--r-- | doc/en/quickpreview.png | bin | 0 -> 72586 bytes | |||
| -rw-r--r-- | doc/en/select.png | bin | 0 -> 18516 bytes | |||
| -rw-r--r-- | doc/en/snap_autocomplete.png | bin | 0 -> 5402 bytes | |||
| -rw-r--r-- | doc/en/snap_compile_error.png | bin | 0 -> 26770 bytes | |||
| -rw-r--r-- | doc/en/snap_editusertag.png | bin | 0 -> 12314 bytes | |||
| -rw-r--r-- | doc/en/snap_encoding.png | bin | 0 -> 5622 bytes | |||
| -rw-r--r-- | doc/en/snap_kdvi_settings.png | bin | 0 -> 23369 bytes | |||
| -rw-r--r-- | doc/en/snap_projectview.png | bin | 0 -> 35220 bytes | |||
| -rw-r--r-- | doc/en/snap_projectview_add.png | bin | 0 -> 27265 bytes | |||
| -rw-r--r-- | doc/en/snap_ref_choose.png | bin | 0 -> 22550 bytes | |||
| -rw-r--r-- | doc/en/snap_ref_select.png | bin | 0 -> 7728 bytes | |||
| -rw-r--r-- | doc/en/snap_sidebarmenu.png | bin | 0 -> 34982 bytes | |||
| -rw-r--r-- | doc/en/snap_structview_label.png | bin | 0 -> 46714 bytes | |||
| -rw-r--r-- | doc/en/snap_usertag.png | bin | 0 -> 35026 bytes | |||
| -rw-r--r-- | doc/en/texgroup.png | bin | 0 -> 10299 bytes |
47 files changed, 7356 insertions, 0 deletions
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..6fed977 --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kile diff --git a/doc/en/TODO b/doc/en/TODO new file mode 100644 index 0000000..dc5cba3 --- /dev/null +++ b/doc/en/TODO @@ -0,0 +1 @@ +- add section on how to use character encodings in Kile diff --git a/doc/en/bullets.png b/doc/en/bullets.png Binary files differnew file mode 100644 index 0000000..8d25b45 --- /dev/null +++ b/doc/en/bullets.png diff --git a/doc/en/complete_cmd1.png b/doc/en/complete_cmd1.png Binary files differnew file mode 100644 index 0000000..5c9509b --- /dev/null +++ b/doc/en/complete_cmd1.png diff --git a/doc/en/complete_cmd2.png b/doc/en/complete_cmd2.png Binary files differnew file mode 100644 index 0000000..c8b54cc --- /dev/null +++ b/doc/en/complete_cmd2.png diff --git a/doc/en/complete_env1.png b/doc/en/complete_env1.png Binary files differnew file mode 100644 index 0000000..6a5c3c2 --- /dev/null +++ b/doc/en/complete_env1.png diff --git a/doc/en/complete_env2.png b/doc/en/complete_env2.png Binary files differnew file mode 100644 index 0000000..493807c --- /dev/null +++ b/doc/en/complete_env2.png diff --git a/doc/en/config-complete.png b/doc/en/config-complete.png Binary files differnew file mode 100644 index 0000000..5305c36 --- /dev/null +++ b/doc/en/config-complete.png diff --git a/doc/en/config-dblquotes.png b/doc/en/config-dblquotes.png Binary files differnew file mode 100644 index 0000000..117138d --- /dev/null +++ b/doc/en/config-dblquotes.png diff --git a/doc/en/config-encoding.png b/doc/en/config-encoding.png Binary files differnew file mode 100644 index 0000000..26aa22c --- /dev/null +++ b/doc/en/config-encoding.png diff --git a/doc/en/config-quickpreview.png b/doc/en/config-quickpreview.png Binary files differnew file mode 100644 index 0000000..e16987f --- /dev/null +++ b/doc/en/config-quickpreview.png diff --git a/doc/en/config-userhelp.png b/doc/en/config-userhelp.png Binary files differnew file mode 100644 index 0000000..a39e6c1 --- /dev/null +++ b/doc/en/config-userhelp.png diff --git a/doc/en/delete.png b/doc/en/delete.png Binary files differnew file mode 100644 index 0000000..eaa2e57 --- /dev/null +++ b/doc/en/delete.png diff --git a/doc/en/dialog-addhelp.png b/doc/en/dialog-addhelp.png Binary files differnew file mode 100644 index 0000000..f0053a3 --- /dev/null +++ b/doc/en/dialog-addhelp.png diff --git a/doc/en/dialog-docbrowser1.png b/doc/en/dialog-docbrowser1.png Binary files differnew file mode 100644 index 0000000..3093c25 --- /dev/null +++ b/doc/en/dialog-docbrowser1.png diff --git a/doc/en/dialog-docbrowser2.png b/doc/en/dialog-docbrowser2.png Binary files differnew file mode 100644 index 0000000..88c327c --- /dev/null +++ b/doc/en/dialog-docbrowser2.png diff --git a/doc/en/dialog-pstools.png b/doc/en/dialog-pstools.png Binary files differnew file mode 100644 index 0000000..0dead3c --- /dev/null +++ b/doc/en/dialog-pstools.png diff --git a/doc/en/dialog-tabular.png b/doc/en/dialog-tabular.png Binary files differnew file mode 100644 index 0000000..fd60334 --- /dev/null +++ b/doc/en/dialog-tabular.png diff --git a/doc/en/environment.png b/doc/en/environment.png Binary files differnew file mode 100644 index 0000000..1bb57fb --- /dev/null +++ b/doc/en/environment.png diff --git a/doc/en/includegraphics.png b/doc/en/includegraphics.png Binary files differnew file mode 100644 index 0000000..ccf9caf --- /dev/null +++ b/doc/en/includegraphics.png diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..5ec2f64 --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,3720 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kile "<application>Kile</application>"> + <!ENTITY latex "L<superscript>A</superscript>T<subscript>E</subscript>X"> + <!ENTITY pdflatex "PDFL<superscript>A</superscript>T<subscript>E</subscript>X"> + <!ENTITY tex "T<subscript>E</subscript>X"> + <!ENTITY tetex "<application>teT<subscript>E</subscript>X</application>"> + <!ENTITY texlive "<application>TeX Live</application>"> + <!ENTITY bibtex "BibT<subscript>E</subscript>X"> + <!ENTITY makeindex "makeindex"> + <!ENTITY kbibtex "KBibT<subscript>E</subscript>X"> + <!ENTITY kbib "KBib"> + <!ENTITY asymptote "Asymptote"> + <!ENTITY imagemagick "<application>ImageMagick</application>"> + <!ENTITY kde "<acronym>KDE</acronym>"> + <!ENTITY kdvi "<application>KDVI</application>"> + <!ENTITY dvipng "<application>dvipng</application>"> + <!ENTITY kghostview "<application>KGhostView</application>"> + <!ENTITY kpdf "<application>KPDF</application>"> + <!ENTITY postscript "<application>PostScript</application>"> + <!ENTITY makeidx "<application>makeidx</application>"> + <!ENTITY kate "<application>Kate</application>"> + <!ENTITY cjk "<abbrev>CJK</abbrev>"> + <!ENTITY ucs "<abbrev>ucs</abbrev>"> + <!ENTITY url "<acronym>URL</acronym>"> + <!ENTITY kappname "&kile;"> + <!ENTITY package "kdeextragear-2"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kile; Handbook</title> + +<authorgroup> + <author><firstname>Jonathan</firstname><surname>Pechta</surname></author> + <author><firstname>Federico</firstname><surname>Zenith</surname> + <affiliation><address><email>zenith@chemeng.ntnu.no</email></address></affiliation></author> + <author><firstname>Holger</firstname><surname>Danielsson</surname> + <affiliation><address><email>holger.danielsson@versanet.de</email></address></affiliation></author> + <author><firstname>Thomas</firstname><surname>Braun</surname></author> + <author><firstname>Michel</firstname><surname>Ludwig</surname> + <affiliation><address><email>michel.ludwig@kdemail.net</email></address></affiliation></author> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2003</year> +<holder>Jonathan Pechta</holder> +</copyright> + +<copyright> +<year>2003</year><year>2005</year><year>2006</year> +<holder>Federico Zenith</holder> +</copyright> + +<copyright> +<year>2005</year><year>2006</year> +<holder>Holger Danielsson</holder> +</copyright> + +<copyright> +<year>2007</year> +<holder>Thomas Braun</holder> +</copyright> + +<copyright> +<year>2007</year> +<holder>Michel Ludwig</holder> +</copyright> + +<date>November 19, 2007</date> +<releaseinfo>2.0</releaseinfo> + +<legalnotice> +&FDLNotice; +</legalnotice> + +<abstract> +<para> +&kile; is a &tex; and &latex; source editor and shell. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdenonbeta</keyword> +<keyword>Kile</keyword> +<keyword>LaTeX</keyword> +<keyword>TeX</keyword> +</keywordset> + +</bookinfo> + +<chapter id="preface"> + +<title>Preface</title> + + <sect1 id="preface_sect"> + + <title>Requirements</title> + + <para>To Run &kile;, you will be required to have the following components + installed on your system:</para> + + <itemizedlist> + <listitem><para>Trinity Desktop environment (&tde;): + &tde; is a popular open-source desktop environment.</para></listitem> + <listitem><para><ulink url="http://www.trolltech.com/products/qt/">Qt</ulink>: Qt is a C++ + GUI and network library needed to compile &kile;.</para></listitem> + <listitem><para><ulink url="http://www.ctan.org/">&latex;</ulink>: high-quality document + typesetting program. Most likely you want the &texlive; (or on older systems the &tetex;) package, if you are on a + Unix-like system.</para></listitem> + </itemizedlist> + + <para>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.</para> + + <para>The &kile; project includes several binary packages of &kile; for different distributions that can be easily + installed and run without having to compile; check out the <ulink url="http://kile.sourceforge.net/">&kile; + homepage</ulink>.</para> + + </sect1> + + <sect1 id="preface_audience"> + + <title>Intended Audience</title> + + <para>This manual is intended for any individual, regardless of her or his experience with + &latex;, &kde;, &kile; or Linux.</para> + + <para>Advanced users are not likely to read this manual, but all suggestions on + documentation will be considered. If you would like to contribute to this project or the + documentation, please consult the <ulink url="http://kile.sourceforge.net/">&kile; web page</ulink>.</para> + + <para>Need answers about &kile;? Are you stuck with your compile? Want to see a new + feature? The preferred way to ask technical questions or start a discussion is to + use our mailing list: <email>kile-devel@lists.sourceforge.net</email>.</para> + + </sect1> + +</chapter> + +<chapter id="introduction"> + + <title>Introduction</title> + + <sect1 id="intro_about"> + + <title>Basic facts</title> + + <sect2> + + <title>About &kile;</title> + + <para>&kile; is an integrated &latex; environment for the &kde; desktop. &kile; gives you the + ability to use all the functionalities of &latex; in a graphical interface, giving you easy, + immediate, and customized access to all programs for &latex; codecompletion, compiling, postprocessing, + debugging, conversion and viewing tools; you also get very handy wizards, a &latex; + reference and a powerful project management.</para> + + </sect2> + + <sect2> + + <title>What is &latex;</title> + + <para>&latex; is a text-processing system derived from &tex;, a program developed originally in + 1977 by Donald Knuth to help him layout his work professionally, obtaining a work similar + to a typesetter's; the typesetter is the professional that styles a document's look according to + specifications for the type of document. + &latex; was created by Leslie Lamport to give authors an automatic typesetter, especially when + it came to the expensive and painstaking typesetting of mathematical formulas and expressions, + that <emphasis>by no chance</emphasis> are enclosed in dollar signs in &latex;. + Today, word-processing programs let any user be the typesetter; but what you often want + is a document that looks good, not one that you spent hours on to make it look good. + &latex; takes that burden, and lets you think of the document, not of the layout. And yes, + it <emphasis>will</emphasis> look good!</para> + + </sect2> + + <sect2> + + <title>How do you pronounce it? Why that strange typesetting?</title> + + <para>There is a funny traditions of &tex;-related packages to have the strangest pronunciation + and typesetting possible. &tex; was supposed to be brought in from the Greek <emphasis>τεχ</emphasis>, + in Latin letters <emphasis>tech</emphasis>. 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.</para> + <para>The pronunciation is supposed to be as follows: <emphasis>T</emphasis> as you would expect, + <emphasis>E</emphasis> as in <emphasis>get</emphasis>, and <emphasis>X</emphasis> as in the + German i<emphasis>ch</emphasis>. If you do not know what <emphasis>ch</emphasis> sounds like, + it is more or less as an hissing cat; the IPA symbol is /ç/. Many people report the different pronunciation + of <emphasis>ach</emphasis> (IPA symbol /x/), but I have personally asked some Greeks, and can + confirm the first version. You should be aware that a lot of people mispronounce /teks/ or /tek/.</para> + <para>Last, in &latex; the first L<superscript>A</superscript> is pronounced as + <emphasis>lay</emphasis>: the idea is that, while raw &tex; is difficult, even a <emphasis>lay</emphasis>man + 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!</para> + + </sect2> + + </sect1> + + <sect1 id="intro_latexbasics"> + + <title>&latex; 101</title> + + <para>The &latex; typesetting system is similar to other markup languages as XML, used for + many types of documents (including the one you are reading), or HTML, used for web + pages. The general idea is about having specially wrapped keywords, called <emphasis> + tags</emphasis>, that tell a program (a word processor, a web browser, or the &latex; + compiler) how to present text. &kile; offers you a good number of such tags in the + menu <guimenu>LaTeX</guimenu> in the menu bar.</para> + + <para>While we will try to give you a good idea of what &latex; is, this is not The Definitive + Book on &latex;. If you want to learn &latex; well, you may want to loan a book in your + library. The writer has had a good experience with A Guide to &latex; by H. Kopka + and P. W. Daly, and still keeps it on the shelf.</para> + + <para>As other markup languages, &latex; contains a <emphasis>preamble</emphasis>, which + sets global commands, such as paper size, page numbering, dimensions of the text on the page, + and a <emphasis>body</emphasis>, that contains the document text; the preamble contains + at least the <userinput>\documentclass</userinput> command, and precedes the body, that + starts with the command <userinput>\begin{document}</userinput>, and is quite predictably + concluded by the command <userinput>\end{document}</userinput>.</para> + + </sect1> + + <sect1 id="intro_mainfeat"> + + <title>&kile;'s Main Features</title> + + <sect2 id="intro_docwizard"> + + <title>QuickStart Wizard</title> + + <para>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.</para> + + <para>Class options:</para> + + <itemizedlist> + <listitem><para><guilabel>Document Class</guilabel>: choose the type of document you want to create: + article, book, letter, report, scrartcl, scrreprt, scrbook, prosper, beamer or other + custom-defined.</para></listitem> + <listitem><para><guilabel>Typeface Size</guilabel>: tell &kile; what point size (pt) + you want to use.</para></listitem> + <listitem><para><guilabel>Paper Size</guilabel>: choose the size or style of sheets.</para></listitem> + <listitem><para><guilabel>Encoding</guilabel>: In general it is a good idea to use your systems standard + encoding. Modern systems now move more and more to UTF-8 as the standard encoding. + If you can, use utf8x (which is indeed the correct spelling for &latex; documents). + </para></listitem> + <listitem><para><guilabel>Other options</guilabel>: this allows you to set further options such as printing, + draft, and others.</para></listitem> + </itemizedlist> + + <para>Packages</para> + <para>This lists some of the most common additional packages used in &latex;. Select the checkbox to include it.</para> + + <para>Document Properties</para> + <itemizedlist> + <listitem><para><guilabel>Author</guilabel>: put your name here.</para></listitem> + <listitem><para><guilabel>Title</guilabel>: add the document title here.</para></listitem> + <listitem><para><guilabel>Date</guilabel>: specify the date.</para></listitem> + </itemizedlist> + + </sect2> + + <sect2 id="intro_templates"> + + <title>Predefined Templates</title> + + <para>The predefined templates in &kile; are:</para> + + <itemizedlist> + <listitem><para>Empty document: real freaks start from scratch!</para></listitem> + <listitem><para>Article: sets the article format, for a document short enough not to + be broken down to chapters.</para></listitem> + <listitem><para>Report: sets the report format, for a middle-sized document, with for + example page numbering on the page's outer edge.</para></listitem> + <listitem><para>Book: sets the book format, a full-fledged flavor, so powerful that + it is used to write many university textbooks.</para></listitem> + <listitem><para>Letter: sets the letter format, that can automatically do those nasty + indentations that nobody really remembers.</para></listitem> + <listitem><para>Beamer,HA-Prosper: create nice presentations in PDF with a superior look and all + &latex; power.</para></listitem> + <listitem><para>Scrartcl,Scrbook,Scrreprt,Scrlttr2: the KOMA-Script document classes, + especially adapted to german typography. Use them whenever you write german + texts.</para></listitem> + </itemizedlist> + + <para>New users need not to worry, this list is just a brief description of features, + and more attention will be paid to complete these tasks in detail later in + <xref linkend="quickstart"/>.</para> + + </sect2> + + <sect2 id="intro_highlight"> + + <title>Syntax Highlighting</title> + + <para>&kile; is similar to 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 spot easily problem areas: for example, if you see major + areas of text turned green, it is likely that you forgot closing a math environment somewhere; + you would have noticed anyway by how crappy the output file would have looked, but + highlighting really saves you time and frustration.</para> + + </sect2> + + <sect2 id="intro_autocoml"> + + <title>Auto-Completion of Environments</title> + + <para>The auto-completion of environments means that, when you begin a new environment by typing + <userinput>\begin{environment}</userinput>, &kile; will automatically insert a matching + <userinput>\end{environment}</userinput> command, with a line in between them + for your text. You can of course deactivate it if you want in + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>LaTeX</guimenuitem><guilabel>Environments</guilabel></menuchoice>.</para> + + </sect2> + + <sect2 id="intro_jump"> + + <title>Jump to Structure Element</title> + + <para>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):</para> + + <itemizedlist> + <listitem><para>\part</para></listitem> + <listitem><para>\chapter</para></listitem> + <listitem><para>\section</para></listitem> + <listitem><para>\subsection</para></listitem> + <listitem><para>\subsubsection</para></listitem> + <listitem><para>\paragraph</para></listitem> + <listitem><para>\subparagraph</para></listitem> + </itemizedlist> + + <para>When viewing a document in the <guilabel>Structure</guilabel> view, you can jump + between elements by clicking on the element you would like to view.</para> + + </sect2> + + <sect2 id="intro_inverse"> + + <title>Inverse Search</title> + + <para>When creating your own &latex; files, inverse search can be very helpful. Once you + have created a DVI file (DeVice Independent File), you can click the middle- + mouse button in the DVI viewer and &kile; will jump to the corresponding line in the + &latex; source code.</para> + + <para>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.</para> + + </sect2> + + <sect2 id="intro_forward"> + + <title>Forward Search</title> + + <para>When using inverse search, the selection of items in the DVI file is associated with + the editor, so when you click on the DVI 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 DVI viewer window.</para> + + </sect2> + + </sect1> + + <sect1 id="intro_toolbar"> + + <title>The Toolbar</title> + + <itemizedlist> + <listitem><para><guibutton>New</guibutton>: begin a new document.</para></listitem> + <listitem><para><guibutton>Open</guibutton>: open a new document.</para></listitem> + <listitem><para><guibutton>Close</guibutton>: close your document.</para></listitem> + <listitem><para><guibutton>Define document as master</guibutton>: this is used when working with multiple files. + Having a master document will let you work more easily with other <literal role="extension">.tex</literal> files included + in your document. If you are using projects, you can also set in <menuchoice><guimenu>Project-></guimenu><guisubmenu>Project + Options</guisubmenu></menuchoice> a project-wide master document.</para></listitem> + <listitem><para><guibutton>Quickbuild</guibutton>: compiles your &latex; source code and displays the results + automatically, unless you have code errors.</para></listitem> + <listitem><para><guibutton>Watch file mode</guibutton>: this mode will "watch" the DVI file for changes, and + will not launch a new session of &kdvi; after <guibutton>Quickbuild</guibutton>.</para></listitem> + <listitem><para><guibutton>View logfile</guibutton>: views the <literal role="extension">.log</literal> file, + so you can spot errors.</para></listitem> + <listitem><para><guibutton>Previous error</guibutton>: jumps backward through the + <literal role="extension">.log</literal> file + and highlights errors in source.</para></listitem> + <listitem><para><guibutton>Next error</guibutton>: jumps forward through + <literal role="extension">.log</literal> file and + highlights errors in source.</para></listitem> + <listitem><para><guibutton>Stop</guibutton>: halts current tool.</para></listitem> + <listitem><para><guibutton>LaTeX</guibutton>: runs &latex; on the active document.</para></listitem> + <listitem><para><guibutton>View DVI</guibutton>: launches DVI viewer.</para></listitem> + <listitem><para><guibutton>DVI to PS</guibutton>: converts a DVI to a &postscript; (PS).</para></listitem> + <listitem><para><guibutton>View PS</guibutton>: launches &postscript; (PS) viewer.</para></listitem> + <listitem><para><guibutton>PDFLaTeX</guibutton>: runs &pdflatex; on the active document.</para></listitem> + <listitem><para><guibutton>View PDF</guibutton>: launches the PDF viewer.</para></listitem> + <listitem><para><guibutton>DVI to PDF</guibutton>: converts a DVI to a PDF.</para></listitem> + <listitem><para><guibutton>PS to PDF</guibutton>: converts a PS to a PDF.</para></listitem> + <listitem><para><guibutton>View HTML</guibutton>: views HTML created.</para></listitem> + <listitem><para><guibutton>Kdvi Forward Search</guibutton>: jump to page that corresponds to the current line in the + editor.</para></listitem> + </itemizedlist> + + <para>If you look at the <guilabel>Edit</guilabel> 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:</para> + + <itemizedlist> + <listitem><para><guilabel>part</guilabel>: highest level of sectioning for a document.</para></listitem> + <listitem><para><guilabel>chapter</guilabel>: starts a new chapter.</para></listitem> + <listitem><para><guilabel>section</guilabel>: create a new section.</para></listitem> + <listitem><para><guilabel>subsection</guilabel>: create a new subsection.</para></listitem> + <listitem><para><guilabel>subsubsection</guilabel>: a secondary section between subsection and + paragraph.</para></listitem> + <listitem><para><guilabel>paragraph</guilabel>: create a new paragraph.</para></listitem> + <listitem><para><guilabel>subparagraph</guilabel>: create a new subparagraph.</para></listitem> + </itemizedlist> + + <para>The drop-down box named <guilabel>label</guilabel> is used to insert items to your document such as + indexes, footnotes, and references; the available commands are:</para> + + <itemizedlist> + <listitem><para><guilabel>label</guilabel>: a command that produces a label for a chapter, + a figure or another element.</para></listitem> + <listitem><para><guilabel>index</guilabel>: creates an entry for the index.</para></listitem> + <listitem><para><guilabel>footnote</guilabel>: creates a footnote in your document.</para></listitem> + <listitem><para><guilabel>ref</guilabel>: used to refer to a predefined label, which + you can choose from a drop-down list.</para></listitem> + <listitem><para><guilabel>pageref</guilabel>: just like <guilabel>ref</guilabel>, but refers to + a page instead of a structure element.</para></listitem> + <listitem><para><guilabel>cite</guilabel>: create a reference with data from a bibliography.</para></listitem> + <listitem><para><guilabel>cite from ViewBib</guilabel>: ask the ViewBib tool for all selected references and insert them. + Currently this is only avaible with <ulink url="http://user.digisurf.com.au/~thachly/kbib/">&kbib;</ulink> as ViewBib tool.</para></listitem> + </itemizedlist> + + <screenshot> + <screeninfo>The <guilabel>Label</guilabel> drop-down menu</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_ref_choose.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The <guilabel>Label</guilabel> drop-down menu</phrase> + </textobject> + <caption><para>The <guilabel>Label</guilabel> drop-down menu</para></caption> + </mediaobject> + </screenshot> + + <screenshot> + <screeninfo>Selecting the label for a reference</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_ref_select.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Selecting the label for a reference</phrase> + </textobject> + <caption><para>Selecting the label for a reference</para></caption> + </mediaobject> + </screenshot> + + <para>When using <guilabel>cite</guilabel>, 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 specialised editors is recommened. + The author has made good experience with &kbibtex; and &kbib;. Of course you can also write the &bibtex; files by hand inside &kile;.</para> + + <para>The last drop-down box labeled <guilabel>tiny</guilabel> 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:</para> + + <itemizedlist> + <listitem><para><guilabel>tiny</guilabel>: smallest.</para></listitem> + <listitem><para><guilabel>scriptsize</guilabel>: very small.</para></listitem> + <listitem><para><guilabel>footnotesize</guilabel>: smaller.</para></listitem> + <listitem><para><guilabel>small</guilabel>: small.</para></listitem> + <listitem><para><guilabel>normalsize</guilabel>: normal.</para></listitem> + <listitem><para><guilabel>large</guilabel>: large.</para></listitem> + <listitem><para><guilabel>Large</guilabel>: larger.</para></listitem> + <listitem><para><guilabel>LARGE</guilabel>: even larger.</para></listitem> + <listitem><para><guilabel>huge</guilabel>: still larger.</para></listitem> + <listitem><para><guilabel>Huge</guilabel>: largest.</para></listitem> + </itemizedlist> + + </sect1> + +</chapter> +<chapter id="quickstart"> + + <title>Quickstart</title> + + <sect1 id="quick_begin"> + + <title>Writing a &latex; Document with &kile; for Beginners</title> + + <para>Users of &kile; have two choices when starting a new document: they can use the + <guimenu>Wizard</guimenu> 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.</para> + + <screen><userinput> + \documentclass[12pt]{article} + \begin{document} + Here is a bunch of text coded in \LaTeX. + \end{document}</userinput></screen> + + <para>Every document in &latex; begins with the command <userinput> + \documentclass[optional argument]{class}</userinput>, where class specifies the document type.</para> + + <para>Typing in the code example above from the text box gives you the following output:</para> + + <screenshot> + <screeninfo>Compiled text in DVI output</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="latex_example.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Compiled text in DVI output</phrase> + </textobject> + <caption><para>Compiled text in DVI output</para></caption> + </mediaobject> + </screenshot> + + <para>The brackets that come after the command <userinput>\documentclass</userinput> + contain the options for the command. The option <userinput>[12pt]</userinput> 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.</para> + + <para>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 <guimenu>Build</guimenu> menu, or using the <guilabel>Quickbuild</guilabel> button.</para> + + <para><keycombo>&Alt;<keycap>2</keycap></keycombo> + is the keyboard shortcut to compile your source code.</para> + + <para>You have to save your source code before you can compile; &kile; will do this automatically for you.</para> + + <para>If your document did not compile, check the log for errors. When using the <guilabel>Quickbuild</guilabel> + key, the &kdvi; viewer should be launched automatically; if it does not, look at the log.</para> + + </sect1> + + <sect1 id="quick_env"> + <title>Environments</title> + + <para>An environment is a segment of text that is managed differently + than 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 + <userinput>\begin{environment}</userinput>, <userinput>\huge</userinput> and + <userinput>\end{environment}</userinput> will let you temporarily alter the text inside + the environment commands to be size huge.</para> + + <para>Changes are only effective from <userinput>\begin{environment}</userinput> to + <userinput>\end{environment}</userinput>. There are no limits as how many changes + you can make inside an environment.</para> + + <para>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 + <userinput>\end</userinput> command, or at the end of your environment.</para> + + <itemizedlist> + <listitem><para><userinput>\begin{emph}</userinput>: this command makes + text italicized, and is valid until the code comes across a <userinput>\end{emph}</userinput>, + <userinput>\end{emph}</userinput> or another environment. To italicize one word in a sentence, you + can use the syntax: this is <userinput>\emph{my}</userinput> sentence.</para></listitem> + <listitem><para><userinput>\textbf{I am making this text inside the brackets bold}</userinput>: this + command makes your text bold.</para></listitem> + <listitem><para><userinput>\quote</userinput>: to create a quote inside your document; begin your quote + with <userinput>\begin{quote}</userinput> and end it with <userinput>\end{quote}</userinput>.</para></listitem> + <listitem><para><userinput>\center</userinput>: centers the text.</para></listitem> + <listitem><para><userinput>\verse</userinput>: creates offset text for poems.</para></listitem> + <listitem><para><userinput>\itemize</userinput>: makes an itemized list.</para></listitem> + </itemizedlist> + + </sect1> + + <sect1 id="quick_using"> + + <title>Using &kile;</title> + + <para>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.</para> + + <procedure> + <step><para>Start &kile;.</para></step> + <step><para>Select <menuchoice><guimenu>Wizard</guimenu><guimenuitem>Quick Start</guimenuitem></menuchoice>, + then choose a format, and set your preferences in the wizard.</para></step> + <step><para>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.</para></step> + <step><para>Save your file, and give it the name <filename>intro.tex</filename>.</para></step> + <step><para>Build your document using <keycombo>&Alt;<keycap>2</keycap></keycombo>, or the + button labeled <guilabel>LaTeX</guilabel>.</para></step> + <step><para>Select <guibutton>View DVI</guibutton>.</para></step> + <step><para>Check out all your new text.</para></step> + <step><para>When you are done viewing your document, click the <guibutton>Editor View</guibutton> + button or press <keycombo>&Ctrl;<keycap>e</keycap></keycombo> + to return to the editor if you are using the embedded + viewer, or close the viewer window if you are using a separate viewer.</para></step> + </procedure> + + <para>That's it! You have just created your first &latex; document!</para> + + <para>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!</para> + + </sect1> + + <sect1 id="quick_dvi"> + + <title>DVI Files</title> + + <para>DVI stands for <emphasis>DeVice Independent</emphasis> 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 <literal role="extension">.dvi</literal> can be sent to, such as a printer, &postscript; or PDF file converter, or your computer screen.</para> + + <sect2 id="quick_viewdvi"> + + <title>Viewing a DVI</title> + + <para>You have already seen how to view a DVI file on the screen by using the <guibutton>View + DVI</guibutton> button in the toolbar.</para> + + </sect2> + + <sect2 id="quick_printdvi"> + + <title>Printing a DVI</title> + + <para>To print a DVI, you can use the same process that you used to create your + document earlier (see <xref linkend="quick_using"/>). At step 7, after + clicking <guibutton>View DVI</guibutton>, select + <menuchoice><guimenu>File</guimenu><guimenuitem>Print</guimenuitem></menuchoice> + in the viewer, and if you have your printer properly configured, you will be able + to print the DVI.</para> + + </sect2> + + <sect2 id="quick_exportdvi"> + + <title>Converting DVI files</title> + + <para>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.</para> + + </sect2> + + </sect1> + + <sect1 id="quick_forward"> + + <title>Forward Search between &kile; and &kdvi;</title> + + <para>The forward search functions allow you to jump from your + editor directly into the associated position of the &DVI; + file. </para> + <para>&kile; offers a configuration with this option for all &latex; binaries. + Go to <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>Tools</guimenuitem><guilabel>Build</guilabel></menuchoice> + and always choose the <guilabel>Modern</guilabel> configuration.</para> + + <para>To execute a forward search, position the cursor on a line of source code, and click + <guilabel>Kdvi Forward Search</guilabel> to jump to the associated position + in the DVI viewer window.</para> + </sect1> + + <sect1 id="quick_inverse"> + + <title>Inverse Search between &kile; and &kdvi;</title> + + <para>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 &kdvi;'s window with the &MMB; (on some systems, + when you do not have a three-button mouse, you can simultaneously + use the <mousebutton>left</mousebutton> and the + <mousebutton>right</mousebutton> button). After that kile load the &latex; source file and jump to + the proper paragraph. To use inverse search, you have to compile your &latex; file with the <guilabel>Modern</guilabel> configuration.</para> + + <para>Inverse search cannot work unless:</para> + + <itemizedlist> + <listitem><para>The source file has been compiled successfully.</para></listitem> + <listitem><para>&kdvi; knows which editor you would like to use.</para></listitem> + </itemizedlist> + + <para>With this feature of &kdvi;, a middle mouse click in the DVI document will + result in &kile; opening the corresponding &latex; document and attempt to go to the + corresponding line. Remember to tell &kdvi; to use &kile; as a text editor, in &kdvi;'s + menu item <menuchoice><guimenu>Settings</guimenu><guimenuitem>DVI Options...</guimenuitem></menuchoice>.</para> + + <screenshot> + <screeninfo>Configuring &kdvi;</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_kdvi_settings.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Configuring &kdvi;</phrase> + </textobject> + <caption><para>Configuring &kdvi;</para></caption> + </mediaobject> + </screenshot> + </sect1> + + <sect1 id="quick_errors"> + + <title>Resolving Errors</title> + + <para>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.</para> + + <para>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 <guibutton>Previous LaTeX Error</guibutton> + and <guibutton>Next LaTeX Error</guibutton> 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 error's line.</para> + + </sect1> + +</chapter> +<chapter id="startnew"> + + <title>Starting a New Document</title> + + <para>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:</para> + + <itemizedlist> + <listitem><para>Empty document</para></listitem> + <listitem><para>Article</para></listitem> + <listitem><para>Beamer</para></listitem> + <listitem><para>Book</para></listitem> + <listitem><para>HA-Prosper</para></listitem> + <listitem><para>Letter</para></listitem> + <listitem><para>Report</para></listitem> + <listitem><para>Scrartcl (from the KOMA-Script package)</para></listitem> + <listitem><para>Scrbook (from the KOMA-Script package)</para></listitem> + <listitem><para>Scrlttr2 (from the KOMA-Script package)</para></listitem> + <listitem><para>Scrreprt (from the KOMA-Script package)</para></listitem> + </itemizedlist> + + <para>If you selected an <guilabel>Empty document</guilabel>, you can either start + writing a document from scratch, or you can use the wizard to quickly start a new + document (see <xref linkend="intro_docwizard"/>).</para> + + + <sect1 id="startnew_templates"> + + <title>Templates</title> + + <para>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.</para> + + + <sect2> + <title>Create a New Template</title> + + <para>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 + <menuchoice><guimenu>File</guimenu><guimenuitem>Create Template from Document</guimenuitem></menuchoice>.</para> + + </sect2> + + <sect2> + + <title>Configuring Automatic Substitutions</title> + + <para>When creating a new document by selecting a template from + <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>, + certain character combinations will be replaced by data such as your name, + or the character encoding your are using. These variables can be configured in + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>Settings</guimenuitem><guilabel>General</guilabel></menuchoice>.</para> + + <para>When designing your own template, it is useful to known which character + combinations are replaced by which template variables:</para> + + <itemizedlist> + <listitem><para><userinput>$$AUTHOR$$</userinput>: This string + will be replaced by the author variable.</para></listitem> + <listitem><para><userinput>$$DOCUMENTCLASSOPTIONS$$</userinput>: This string will be replaced + by the documentclass options variable. Typically this is used as follows: + <userinput>\documentclass[$$DOCUMENTCLASSOPTIONS$$]{article}</userinput>.</para></listitem> + <listitem><para><userinput>$$INPUTENCODING$$</userinput>: If the + inputencoding variable is set to, say, <userinput>latin1</userinput> this string is replaced by + <userinput>\input[latin1]{inputenc}</userinput>.</para></listitem> + </itemizedlist> + + </sect2> + + <sect2 id="templ_wiz"> + + <title>Create a Template from the Wizard</title> + + <para>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:</para> + + <procedure> + <step><para>Save your file;</para></step> + <step><para>Go to <guimenu>File</guimenu>;</para></step> + <step><para>Choose <guimenuitem>Create Template from Document</guimenuitem>;</para></step> + <step><para>Make any corrections necessary to the template;</para></step> + <step><para>Enter a name for your new template;</para></step> + <step><para>Click <guibutton>OK</guibutton> to add your template to the menu.</para></step> + </procedure> + + <para>Next time you start up a new document, you will be able to choose + your customized template instead of the default ones.</para> + + </sect2> + + <sect2> + + <title>Creating a Template from any File</title> + + <para>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 + listed in <xref linkend="templ_wiz"/>.</para> + + <para>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 making an attractive, catchy poster. You can get a + template for A0 posters at <ulink url="http://www.stats.ox.ac.uk/~marchini/a0poster.html">Jonathan Marchini's + home page</ulink>, but many more are available. Remember that you will need the <filename>a0poster</filename> + package, which is normally not in standard tex distributions included. Download it from + <ulink url="http://www.ctan.org/tex-archive/macros/latex/contrib/a0poster/">here</ulink> and place it in the same directory as your &latex; file.</para> + </sect2> + + <sect2 id="templ_rem"> + + <title>Removing a Template</title> + + <para>To remove a template from &kile;, do as follows:</para> + + <procedure> + <step><para>Go to <menuchoice><guimenu>File</guimenu><guimenuitem>Remove + Template...</guimenuitem></menuchoice>;</para></step> + <step><para>A dialog box will appear with all templates listed: select a template;</para></step> + <step><para>Click <guilabel>OK</guilabel>, and your template will be removed.</para></step> + </procedure> + + <para>Templates marked with an asterisk (*) cannot be removed without the proper permission.</para> + + </sect2> + + </sect1> + +</chapter> +<chapter id="editing"> + + <title>Editing &latex; Documents</title> + + <para>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 <guimenu>Tools</guimenu> menu.</para> + + <para>To learn more about &kate; and its capabilities, see the <ulink url="help:kate">Kate Handbook</ulink>. + &kile; users can start reading from the chapter <quote>Working with the Kate Editor</quote>.</para> + + <sect1 id="editing_sect"> + + <title>The &latex; Reference</title> + + <para>&kile; features a very practical &latex; tag reference, which you can access + by choosing <menuchoice><guimenu>Help</guimenu><guimenuitem>LaTeX + Reference</guimenuitem></menuchoice>. It contains a thorough description + of almost all the commands that you may use in &latex; and their syntax.</para> + + </sect1> + + <sect1 id="editing_cursor"> + + <title>Cursor Movements</title> + + <para>To select text, you have the following options:</para> + + <itemizedlist> + <listitem><para>Hold left mouse button, and drag mouse to highlight text.</para></listitem> + <listitem><para>Click once on a word to move the cursor to a new area.</para></listitem> + <listitem><para>Click twice on a word to select the whole word.</para></listitem> + <listitem><para>Click twice on a word and pressing <keycombo>&Ctrl;</keycombo> to select the whole tex word. + This means clicking in this way on <userinput>\par</userinput> from <userinput>\par\bigskip</userinput> only select \par.</para></listitem> + <listitem><para>Click three times to select the whole sentence.</para></listitem> + </itemizedlist> + + <para>Holding the left mouse button, and dragging the text you want to select, + automatically copies the selected text to the clipboard.</para> + + <para>Holding shift and using the arrow keys allows you to select portions of the source + code in the editor window.</para> + + </sect1> + + <sect1 id="editing_bracket"> + + <title>Brackets</title> + + <para>Bracket completion is a visual tool that the editor view uses to indicate you + which bracket matches which. If you open any <literal role="extension">.tex</literal> 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 + <userinput>\section{Introduction}</userinput>, you would see + <userinput>\section{Introduction}</userinput> in the default yellow highlight, + showing you the location of the beginning and ending brackets.</para> + + </sect1> + + <sect1 id="editing_highlight"> + + <title>Highlighting</title> + + <para>&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 highlighted also in a different color.</para> + + </sect1> + + <sect1 id="editing_bullets"> + + <title>Bullets</title> + + <para>Many wizards can insert optional bullets, a special kind of bookmarks within the text. The + menu entries <menuchoice><guimenu>Edit</guimenu><guisubmenu>Bullets</guisubmenu></menuchoice> or + the corresponding keyboards 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.</para> + + <screenshot> + <screeninfo>Bullets</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="bullets.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Bullets</phrase> + </textobject> + </mediaobject> + </screenshot> + + <variablelist> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>Right</keycap></keycombo></shortcut> + <guimenuitem>Next Bullet</guimenuitem></menuchoice></term> + <listitem><para>Jump to the next bullet in the text if there is one.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>Left</keycap></keycombo></shortcut> + <guimenuitem>Last Bullet</guimenuitem></menuchoice></term> + <listitem><para>Jump to the previous bullet in the text if there is one.</para></listitem> + </varlistentry> + + </variablelist> + + </sect1> + + <sect1 id="editing_select"> + + <title>Select</title> + + <para>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 <menuchoice><guimenu>Edit</guimenu><guisubmenu>Select</guisubmenu></menuchoice> + you will find the following commands to select text.</para> + + <screenshot> + <screeninfo>Edit->Select items</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="select.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Edit->Select items</phrase> + </textobject> + </mediaobject> + </screenshot> + + <variablelist> + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> + <keycap>E</keycap></shortcut> + <guimenuitem>Environment (inside)</guimenuitem></menuchoice></term> + <listitem><para>Select an environment + without the surrounding tags.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> + <keycap>F</keycap></shortcut> + <guimenuitem>Environment (outside)</guimenuitem></menuchoice></term> + <listitem><para>Select an environment + including the surrounding tags.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> + <keycap>T</keycap></shortcut> + <guimenuitem>TeX Group (inside)</guimenuitem></menuchoice></term> + <listitem><para>Select a TeX group + inside the surrounding braces.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> + <keycap>U</keycap></shortcut> + <guimenuitem>TeX Group (outside)</guimenuitem></menuchoice></term> + <listitem><para>Select a TeX group + including the surrounding braces.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> + <keycap>M</keycap></shortcut> + <guimenuitem>Math Group</guimenuitem></menuchoice></term> + <listitem><para>Select the current math group including the math commands.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> + <keycap>P</keycap></shortcut> + <guimenuitem>Paragraph</guimenuitem></menuchoice></term> + <listitem><para>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 kind of paragraph is separated by two empty lines.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> + <keycap>L</keycap></shortcut> + <guimenuitem>Line</guimenuitem></menuchoice></term> + <listitem><para>Select the text line of the + current cursor position.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> + <keycap>W</keycap></shortcut> + <guimenuitem>TeX Word</guimenuitem></menuchoice></term> + <listitem><para>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.</para></listitem> + </varlistentry> + + </variablelist> + + </sect1> + + <sect1 id="editing_delete"> + + <title>Delete</title> + + <para>To delete some parts of a document you can of course select them, and then + use the <keycombo><keycap>Delete</keycap></keycombo> key. Kate also offers the command + <keycombo>&Ctrl;<keycap>K</keycap></keycombo> which deletes the hole line.But &kile; offers a + faster way with its own delete commands. + Under <menuchoice><guimenu>Edit</guimenu><guisubmenu>Delete</guisubmenu></menuchoice> + you will find following commands to delete text.</para> + + <screenshot> + <screeninfo>Edit->Delete items</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="delete.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Edit->Delete items</phrase> + </textobject> + </mediaobject> + </screenshot> + + <variablelist> + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>T</keycap></keycombo> + <keycap>E</keycap></shortcut> + <guimenuitem>Environment (inside)</guimenuitem></menuchoice></term> + <listitem><para>Delete an environment without the surrounding tags.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>T</keycap></keycombo> + <keycap>F</keycap></shortcut> + <guimenuitem>Environment (outside)</guimenuitem></menuchoice></term> + <listitem><para>Delete an environment including the surrounding tags.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>T</keycap></keycombo> + <keycap>T</keycap></shortcut> + <guimenuitem>TeX Group (inside)</guimenuitem></menuchoice></term> + <listitem><para>Delete a TeX group inside the surrounding braces.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>T</keycap></keycombo> + <keycap>U</keycap></shortcut> + <guimenuitem>TeX Group (outside)</guimenuitem></menuchoice></term> + <listitem><para>Delete a TeX group including the surrounding braces.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>T</keycap></keycombo> + <keycap>M</keycap></shortcut> + <guimenuitem>Math Group</guimenuitem></menuchoice></term> + <listitem><para>Delete the current math group including the math commands.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>T</keycap></keycombo> + <keycap>P</keycap></shortcut> + <guimenuitem>Paragraph</guimenuitem></menuchoice></term> + <listitem><para>Delete a whole paragraph. Look at the + <menuchoice><guisubmenu>Select</guisubmenu><guimenuitem>Paragraph</guimenuitem></menuchoice> + command, how a paragraph is + defined in &kile;.</para></listitem> + </varlistentry> + + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>T</keycap></keycombo> + <keycap>I</keycap></shortcut> + <guimenuitem>To End of Line</guimenuitem></menuchoice></term> + <listitem><para>Delete the text from the current cursor position to the end of the line. + </para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>T</keycap></keycombo> + <keycap>W</keycap></shortcut> + <guimenuitem>TeX Word</guimenuitem></menuchoice></term> + <listitem><para>Delete the word or &latex; + command under the current cursor position.</para></listitem> + </varlistentry> + + </variablelist> + + </sect1> + + <sect1 id="editing_environment"> + + <title>Environment</title> + + <para>It was already 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 <menuchoice><guimenu>Edit</guimenu><guisubmenu>Environment</guisubmenu></menuchoice>.</para> + + <screenshot> + <screeninfo>Edit->Environment items</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="environment.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Edit->Environment items</phrase> + </textobject> + </mediaobject> + </screenshot> + + <variablelist> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>E</keycap></keycombo> + <keycap>B</keycap></shortcut> + <guimenuitem>Go to Begin</guimenuitem></menuchoice></term> + <listitem><para>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.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>E</keycap></keycombo> + <keycap>E</keycap></shortcut> + <guimenuitem>Go to End</guimenuitem></menuchoice></term> + <listitem><para>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.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>E</keycap></keycombo> + <keycap>M</keycap></shortcut> + <guimenuitem>Match</guimenuitem></menuchoice></term> + <listitem><para>When your cursor is placed in front of or above the + <userinput>\begin{environment}</userinput> tag, it will be moved to the + opposite end of the environment and vice versa.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>E</keycap></keycombo> + <keycap>C</keycap></shortcut> + <guimenuitem>Close</guimenuitem></menuchoice></term> + <listitem><para>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.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>E</keycap></keycombo> + <keycap>A</keycap></shortcut> + <guimenuitem>Close All</guimenuitem></menuchoice></term> + <listitem><para>This closes all open environments, not only the last opened environment.</para></listitem> + </varlistentry> + + </variablelist> + + </sect1> + + <sect1 id="editing_texgroup"> + + <title>&tex; Group</title> + + <para>&kile; also offers some special commands for &latex; groups;, + which are determined by braces <userinput>{...}</userinput>. In submenu + <menuchoice><guimenu>Edit</guimenu><guisubmenu>TeX Group</guisubmenu></menuchoice> + you will find some important commands, which correspond to those from + <menuchoice><guimenu>Edit</guimenu><guisubmenu>Environment</guisubmenu></menuchoice>. + </para> + + <screenshot> + <screeninfo>Edit->TeX Group</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="texgroup.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Edit->TeX Group</phrase> + </textobject> + </mediaobject> + </screenshot> + + <variablelist> + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>G</keycap></keycombo> + <keycap>B</keycap></shortcut> + <guimenuitem>Go to Begin</guimenuitem></menuchoice></term> + <listitem><para>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.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>G</keycap></keycombo> + <keycap>E</keycap></shortcut> + <guimenuitem>Go to End</guimenuitem></menuchoice></term> + <listitem><para>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.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>G</keycap></keycombo> + <keycap>M</keycap></shortcut> + <guimenuitem>Match</guimenuitem></menuchoice></term> + <listitem><para>When your cursor is placed in front of or behind an + opening brace of a &tex; group, he will be moved to the opposite end of + the group and vice versa.</para></listitem> + </varlistentry> + + <varlistentry><term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Alt;<keycap>G</keycap></keycombo> + <keycap>C</keycap></shortcut> + <guimenuitem>Close</guimenuitem></menuchoice></term> + <listitem><para>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.</para></listitem> + </varlistentry> + + </variablelist> + + </sect1> + + <sect1 id="editing_dblquotes"> + + <title>Double Quotes</title> + + <para>In &latex;, two single quotes are used as double quotes. To + help you insert these efficiently, &kile; allows you to press + <keycap>"</keycap> to insert two opening + single quotes. Furthermore, if you want to close a quotation, you also + have to press <keycap>"</keycap>. &kile; will + be smart enough to recognize this case and inserts two closing quotes + for &latex;.</para> + + <para>To get a literal double quote on the other side, press + <keycap>"</keycap> twice.</para> + + <para>You can enable or disable this auto insertion of opening and + closing double quotes in section + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure + Kile...</guisubmenu><guimenuitem>LaTeX</guimenuitem></menuchoice>.</para> + + <screenshot> + <screeninfo>Double Quotes</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="config-dblquotes.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Double Quotes</phrase> + </textobject> + </mediaobject> + </screenshot> + + <para>If you also include language-specific options + like <userinput>ngerman</userinput> or <userinput>french</userinput>, + you will also be able to use German or French double quotes. Many more languages are available. + </para> + + </sect1> + + <sect1 id="editing_smartnewline"> + + <title>Smart Newline</title> + + <para>If you press <keycombo>&Shift;<keycap>Return</keycap></keycombo>, + &kile; inserts an intelligent newline. If your current position + is inside a list environment, like <userinput>enumerate</userinput> + or <userinput>itemize</userinput>, &kile; will not only insert + a newline, but also add a <userinput>\item</userinput> command.</para> + + <para>If you are inside a tabular environment, &kile; will finish the + current line with <userinput>\\</userinput>, followed by the newline.</para> + + <para>If you are inside a &latex; comment, &kile; will start the next line with a + <userinput>%</userinput>.</para> + + <para>Even better, &kile; is smart enough to support predefined &latex; + and user defined environment, which can be added in section + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure + Kile...</guisubmenu><guimenuitem>LaTeX</guimenuitem></menuchoice>.</para> + + </sect1> + + <sect1 id="editing_tabulator"> + + <title>Smart Tabulator</title> + + <para>Some users like to arrange columns in tabular environments and + put all ampersand characters <keycap>&</keycap> beneath each other. &kile; tries + to support this. If you press <keycombo>&Shift;&Alt;<keycap>&</keycap></keycombo>, + &kile; will look for the next tab in the row above. Although his which may not the + corresponding tab, &kile; will add some spaces to adjust the column position with + the current tab.</para> + + </sect1> + +</chapter> + +<chapter id="completion"> + + <title>Code Completion</title> + + <para>Although &kate; already offers a good completion mode, &kile; extended + 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 + <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Kile...</guimenuitem></menuchoice>.</para> + + <sect1 id="complete_autoenvironment"> + + <title>Automatic Environment Completion</title> + + <para>When you begin a new environment, typing <userinput>\begin{environment}</userinput>, + &kile; will automatically add an <userinput>\end{environment}</userinput> command, with a + line in between for your text.</para> + + <para>Autocompletion can be turned off in the &latex; section of + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>LaTeX</guimenuitem><guilabel>Environments</guilabel></menuchoice>.</para> + + <screenshot> + <screeninfo>Completing an Equation Environment</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_autocomplete.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Completing an Equation Environment</phrase> + </textobject> + <caption><para>Completing an Equation Environment</para></caption> + </mediaobject> + </screenshot> + + </sect1> + + <sect1 id="complete_command"> + + <title>&latex; Commands</title> + + <para>When you type some letters, you can activate this completion mode for &latex; commands + and normal words with <menuchoice><guimenu>Edit</guimenu><guisubmenu>Complete</guisubmenu><guimenuitem>(La)TeX Command</guimenuitem></menuchoice> or the keyboard shortcut + <keycombo>&Ctrl;<keycap>Space</keycap></keycombo>. + &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.</para> + + <screenshot> + <screeninfo>Completing a LaTeX Command</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="complete_cmd1.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Completing a LaTeX Command</phrase> + </textobject> + </mediaobject> + </screenshot> + + <para>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 will expand the pattern and the + visible word list may shrink.</para> + + <para>If you decide not to select any of the suggestions, you can leave this + dialog with &Esc;.</para> + + <para>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 the these positions with <menuchoice><guimenu>Edit</guimenu><guisubmenu>Bullets</guisubmenu><guimenuitem>Next Bullet</guimenuitem></menuchoice> + and insert the parameter you want.</para> + + <screenshot> + <screeninfo>Completing a LaTeX Command</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="complete_cmd2.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Completing a LaTeX Command</phrase> + </textobject> + </mediaobject> + </screenshot> + + <para>Go to + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>Kile</guimenuitem><guilabel>Complete</guilabel></menuchoice> + 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.</para> + + </sect1> + + <sect1 id="complete_environment"> + + <title>Environments</title> + + <para>The <emphasis>command mode</emphasis> is not useful to complete environments. + You always have to type some letters of <userinput>\begin</userinput>, and invoking + the completion mode will result in a huge list of environments tags. On the other + hand, environments are so often used that &kile; offers a special mode to complete + environments. Forget the opening tag and write, for example, <userinput>eq</userinput>.</para> + + <para>When you call the completion mode with + <menuchoice><guimenu>Edit</guimenu><guisubmenu>Complete</guisubmenu><guimenuitem>Environment</guimenuitem></menuchoice> or keyboard shortcut <keycombo>&Alt;<keycap>Space</keycap></keycombo>, + the opening tag is automatically added and you will see <userinput>\begin{eq}</userinput>. + After this change, the completion list is much less cluttered.</para> + + <screenshot> + <screeninfo>Completing a LaTeX Command</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="complete_env1.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Completing a LaTeX Command</phrase> + </textobject> + </mediaobject> + </screenshot> + + <para>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 + <userinput>\item</userinput> tag.</para> + + <screenshot> + <screeninfo>Completing a LaTeX Command</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="complete_env2.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Completing a LaTeX Command</phrase> + </textobject> + </mediaobject> + </screenshot> + + <para>Go to + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>Kile</guimenuitem><guilabel>Complete</guilabel></menuchoice> + to configure one or more of these lists. This mode uses the same word lists as the + completion mode for &tex; and &latex; commands.</para> + + </sect1> + + <sect1 id="complete_abbreviation"> + + <title>Abbreviations</title> + + <para>&kile; supports user defined lists of abbreviations, which are replaced + on demand by longer text strings. Look at + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>Kile</guimenuitem><guilabel>Complete</guilabel></menuchoice> + to configure one or more of theses lists. For the example given here, the + abbreviation list in <filename>example.cwl</filename> must be chosen. + In this file you will find for example the entry <userinput>L=\LaTeX</userinput> for example.</para> + + <para>For example, type only the letter <userinput>L</userinput>. Now invoke + the abbreviation mode of word completion with + <menuchoice><guimenu>Edit</guimenu><guisubmenu>Complete</guisubmenu><guimenuitem>Abbreviation</guimenuitem></menuchoice> or keyboard shortcut <keycombo>&Ctrl;&Alt;<keycap>Space</keycap></keycombo>, + and the letter <userinput>L</userinput> is replaced by the string + <userinput>\LaTeX</userinput>.</para> + + </sect1> + + <sect1 id="complete_auto"> + + <title>Autocompletion Modes</title> + + <sect2 id="complete_autolatex"> + + <title>&latex; Commands</title> + + <para>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.</para> + + <para>Go to + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>Kile</guimenuitem><guilabel>Complete</guilabel></menuchoice> + to enable or disable this mode or to change the threshold.</para> + + <screenshot> + <screeninfo>Completing an Equation Environment</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="config-complete.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Completing an Equation Environment</phrase> + </textobject> + </mediaobject> + </screenshot> + + </sect2> + + <sect2 id="complete_autotext"> + + <title>Document Words</title> + + <para>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 before.</para> + + <para>If you want to turn this mode on or off, go to + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>Kile</guimenuitem><guilabel>Complete</guilabel></menuchoice>. + In this configuration dialog you can also change the threshold at which + the completion box pops up.</para> + + </sect2> + + </sect1> + + <sect1 id="complete_own_files"> + + <title>Writing Own Completion Files</title> + + <para>The specification of the completion file format can found in the <ulink url="http://websvn.kde.org/*checkout*/tags/kile/2.0/src/README.cwl"> + CWL file format specification</ulink>. + </para> + + <para> + Completion files can be installed in a user's home directory under the <filename>~/.trinity/share/apps/kile/complete/<mode>/</filename> + subdirectory, where <parameter><mode></parameter> either stands for <constant>abbreviation</constant>, <constant>dictionary</constant> or <constant>tex</constant>. + </para> + + </sect1> +</chapter> + +<chapter id="wizard"> + + <title>Wizards and Dialogs</title> + + <sect1 id="wizard_graphics"> + + <title>Include Graphics</title> + + <para>The <guilabel>Include Graphics</guilabel> dialog makes insertion of + graphics as easy as possible. Please take a look at + <xref linkend="build_graphics"/> and <xref linkend="build_epsgraphics"/> to + get an overview of some basic facts concerning graphic formats.</para> + + <screenshot> + <screeninfo>Including a graphics element</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="includegraphics.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Including a graphics element</phrase> + </textobject> + </mediaobject> + </screenshot> + + <procedure> + <step><para>Choose a graphics file. This can be a JPEG, PNG, EPS + or even a zipped or gzipped EPS file. If you have installed + <ulink url="http://www.imagemagick.org/">&imagemagick;</ulink> + and also configured &kile; to use it + (<menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>LaTeX</guimenuitem><guilabel>General</guilabel></menuchoice>), + 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.</para></step> + + <step><para>Decide whether your image shall be centered on the page.</para></step> + + <step><para>Choose either traditional &latex; or &pdflatex;. + Please remember that &pdflatex; can also create DVI output, + not only PDF.</para></step> + + <step><para>You can choose whether the filename should be taken + relative. This is the preferred way, when you use the + <userinput>\graphicspath</userinput> command.</para> + + <para>By default graphics files have to be in the same + folder than your master document. However + it is possible to put them in other folders to make + things tidier. Without a <userinput>\graphicspath</userinput> + command, &kile; would include the path for the graphics file. + But if you use <userinput>\graphicspath</userinput>, + like:</para> + +<programlisting> + \graphicspath{{/path/to/my/graphics}{other/path/to/more/graphics}} +</programlisting> + + <para>and check this option, &kile; with only use the + base name of the graphics file.</para> + + <para>Another example: if you set <userinput>\graphicspath</userinput> + command like:</para> + +<programlisting> + \graphicspath{{./}{camera/}{images/}} +</programlisting> + + <para>&latex; will search in the current folder, then in + <filename>camera</filename> and finally in + <filename>images</filename> to find your graphics file.</para></step> + + <step><para>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 dialog to know the original size of the graphics.</para></step> + + <step><para>Insert an angle by which to rotate the graphics counterclockwise.</para></step> + + <step><para>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 <link linkend="build_epsgraphics">EPS graphics</link>. + </para></step> + + <step><para>Your last choice is whether to embed this graphics into a + figure environment. If you decide to do so, you can also insert a + caption and a label. It is a good idea to add a different prefix to + each kind of label. It is common to use the prefix + <userinput>fig:</userinput> for images.</para></step> + </procedure> + + </sect1> + + <sect1 id="wizard_array"> + + <title>Array Wizard</title> + + <para>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 <guimenu>Wizard</guimenu> menu. It contains + <guimenuitem>Tabular</guimenuitem> and <guimenuitem>Array</guimenuitem> (used in math environments). + You will then have a matrix-formed input form that you can easily fill in with your entries. This dialog also + offers some options to typeset the tabular material.</para> + + <screenshot> + <screeninfo>Inserting a tabular environment</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dialog-tabular.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Inserting a tabular environment</phrase> + </textobject> + </mediaobject> + </screenshot> + + <para>The <guimenuitem>Tabbing</guimenuitem> option will display a simpler menu + to set up a tabbing environment. In all these environments, you can easily set the + number of rows and columns, along with other specific options.</para> + </sect1> + + <sect1 id="wizard_postscript"> + + <title>&postscript; Utilities</title> + + <para>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 <command>ps2pdf</command>.</para> + + <para>The <emphasis>&postscript; Wizard</emphasis> will suggest the most + popular rearrangements, but you are free to do your own choice. Work is done + by the programs <command>pstops</command> and <command>psselect</command>, which + you will find in most distributions in the package <userinput>psutils</userinput>. + If one of these programs is not available, the corresponding item will not + be visible.</para> + + <screenshot> + <screeninfo>Dialog PSTools</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dialog-pstools.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Dialog PSTools</phrase> + </textobject> + </mediaobject> + </screenshot> + + <para>First choose your input file. If &kile; finds a PS file corresponding to your + current master document, it is already filled in as 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 + &kghostview; to view the result.</para> + + <variablelist> + + <varlistentry> + <term>1 A5 page + empty page --> A4</term> + <listitem><para>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.</para> + <screenshot> + <screeninfo>A5 + empty page</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="psutils1.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>A5 + empty page</phrase> + </textobject> + </mediaobject> + </screenshot> + </listitem> + </varlistentry> + + <varlistentry> + <term>1 A5 page + duplicate --> A4</term> + <listitem><para>Put one A5 page and a duplicate together + on one A4 page.</para> + <screenshot> + <screeninfo>duplicate A5 pages</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="psutils2.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Duplicate an A5 page</phrase> + </textobject> + </mediaobject> + </screenshot> + </listitem> + </varlistentry> + + <varlistentry> + <term>2 A5 pages --> A4</term> + <listitem><para>Put two consecutive A5 pages together + on one A4 page.</para> + <screenshot> + <screeninfo>Combine two A5 pages</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="psutils3.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Combine two A5 pages</phrase> + </textobject> + </mediaobject> + </screenshot> + </listitem> + </varlistentry> + + <varlistentry> + <term>2 A5L pages --> A4</term> + <listitem><para>Put two consecutive A5 pages in landscape mode together + on one A4 page.</para></listitem> + </varlistentry> + + <varlistentry> + <term>4 A5 pages --> A4</term> + <listitem><para>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.</para> + <screenshot> + <screeninfo>4 A5 pages --> A4</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="psutils5.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>4 A5 pages --> A4</phrase> + </textobject> + </mediaobject> + </screenshot> + </listitem> + </varlistentry> + + <varlistentry> + <term>1 A4 page + empty page --> A4</term> + <listitem><para>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 portrait mode.</para> + <screenshot> + <screeninfo>1 A4 page + empty page --> A4</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="psutils6.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>1 A4 page + empty page --> A4</phrase> + </textobject> + </mediaobject> + </screenshot> + </listitem> + </varlistentry> + + <varlistentry> + <term>1 A4 page + duplicate --> A4</term> + <listitem><para>Put one A4 page and a duplicate together + on one A4 page.</para> + <screenshot> + <screeninfo>1 A4 page + duplicate --> A4</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="psutils7.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>1 A4 page + duplicate --> A4</phrase> + </textobject> + </mediaobject> + </screenshot> + </listitem> + </varlistentry> + + <varlistentry> + <term>2 A4 pages --> A4</term> + <listitem><para>Put two consecutive A4 pages together + on one A4 page.</para> + <screenshot> + <screeninfo>Combine two A4 pages</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="psutils8.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Combine two A4 pages</phrase> + </textobject> + </mediaobject> + </screenshot> + </listitem> + </varlistentry> + + <varlistentry> + <term>2 A4L pages --> A4</term> + <listitem><para>Put two consecutive A4 pages in landscape mode together + on one A4 page.</para></listitem> + </varlistentry> + + <varlistentry> + <term>select even pages</term> + <listitem><para>Select all even pages of a document.</para></listitem> + </varlistentry> + + <varlistentry> + <term>select odd pages</term> + <listitem><para>Select all odd pages of a document.</para></listitem> + </varlistentry> + + <varlistentry> + <term>select even pages (reverse order)</term> + <listitem><para>Select all even pages of a document and reverse the order.</para></listitem> + </varlistentry> + + <varlistentry> + <term>select odd pages (reverse order)</term> + <listitem><para>Select all even pages of a document and reverse the order.</para></listitem> + </varlistentry> + + <varlistentry> + <term>reverse all pages</term> + <listitem><para>Reverse all pages of a document.</para></listitem> + </varlistentry> + + <varlistentry> + <term>copy all pages (sorted)</term> + <listitem><para>Copy all pages of a document. You have to + choose the number of sorted copies.</para> + <screenshot> + <screeninfo>Copy all pages (sorted)</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="psutils15.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Copy all pages (sorted)</phrase> + </textobject> + </mediaobject> + </screenshot> + </listitem> + </varlistentry> + + <varlistentry> + <term>copy all pages (unsorted)</term> + <listitem><para>Copy all pages of a document. You have to + choose the number of non-sorted copies.</para> + <screenshot> + <screeninfo>Copy all pages (unsorted)</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="psutils16.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Copy all pages (unsorted)</phrase> + </textobject> + </mediaobject> + </screenshot> + </listitem> + </varlistentry> + + <varlistentry> + <term>pstops: choose parameter</term> + <listitem><para>There are many options for &postscript; utilities + <command>pstops</command> and <command>psselect</command>. If you + need a very special one, you can invoke <command>pstops</command> with + an option of your choice. Please read the manual for all possible + options.</para></listitem> + </varlistentry> + + <varlistentry> + <term>psselect: choose parameter</term> + <listitem><para>You can invoke <command>psselect</command> with + an option of your choice. Please read the manual for all possible + options.</para></listitem> + </varlistentry> + + </variablelist> + + </sect1> + + <sect1 id="statistics"> + <title>Document Statistics</title> + + <para>The statistics dialog gives you an statistical overview for a selection, + a document or an hole project. It includes the number of words, &latex; + commands/environments and also includes the number of characters for each type. + The statistical numbers can be copied as text or as a nice formatted &latex; tabular + to the clipboard. If you want to get statistics for the hole project you can use + <menuchoice><guimenu>File</guimenu><guisubmenu>Open All Project Files</guisubmenu></menuchoice> + for an easy and quick way to open all source files of your project.</para> + <para>A note of caution has to be sounded about the accuracy of the numbers. + We have included some logic to get a good estimate, e. g. K\"uhler gives one word and one command, + with six resp. two characters. But there are other combinations in which parts of commands + are counted as words and vice versa. It has also to be beared in mind that the algorithm + was developed and tested for languages similiar to english or german. + So don't take the numbers for granted. If you have to make an report with an + exact numbers of words or characters, make some tests to check whether &kile;'s accuracy satisfies your needs.</para> + </sect1> + +</chapter> + +<chapter id="latex"> + + <title>Special Tags in &latex;</title> + + <sect1 id="latex_library"> + <title>Using the &latex; Tag Library</title> + + <para>&latex; has thousands of tags for symbols and special characters. + The easiest way to insert these tags is to use the sidebar menu, + left of the editor window.</para> + + <screenshot> + <screeninfo>The Sidebar Menu</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_sidebarmenu.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The Sidebar Menu</phrase> + </textobject> + <caption><para>The Sidebar Menu</para></caption> + </mediaobject> + </screenshot> + <para>The following types are avaible:</para> + + <itemizedlist> + <listitem><para>Most Frequently Used</para></listitem> + <listitem><para>Relation</para></listitem> + <listitem><para>Operators</para></listitem> + <listitem><para>Arrows</para></listitem> + <listitem><para>Miscellaneous Math</para></listitem> + <listitem><para>Miscellaneous Text</para></listitem> + <listitem><para>Delimiters</para></listitem> + <listitem><para>Greek</para></listitem> + <listitem><para>Special Characters</para></listitem> + <listitem><para>Cyrillic Characters</para></listitem> + <listitem><para>User Defined</para></listitem> + </itemizedlist> + <para>The tooltips of the icons show the &latex; commands and additionally needed packages.</para> + <para>Pressing <keycombo>&Shift;</keycombo> and clicking a symbol will result in + <userinput>$\symbolcmd$</userinput> being inserted. Similiar pressing <keycombo>&Ctrl;</keycombo> + inserts it in curly brackets.</para> + <para>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.</para> + <para>The first list of symbols holds the <guilabel>Most Frequently Used</guilabel> 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 + would exceed 30 items, the item wit the lowest count will get removed.</para> + <para>The <guilabel>User Defined</guilabel> 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. + Additionaly you need a &latex; compiler (what a surprise) and + <ulink url="http://www.dvipng.sourceforge.net">&dvipng;</ulink> (version 1.7 or later). + The procedure is so that you create a &latex; file with <userinput>\input{definitions}</userinput>, + which makes the commands listed below available, and let <userinput>gesymb mysymbols.tex user</userinput> + (which calles &latex; and &dvipng;) create the icons. After copying them to + <userinput>$HOME/.trinity/share/apps/kile/mathsymbols/user/</userinput> and restarting kile you can use your own symbols. + </para> + <para> + The following commands are defined in definitions.tex: + <itemizedlist> + <listitem> + <para> + <userinput>\command[\optarg]{\symbol}</userinput>: Include the symbol <userinput>\symbol</userinput> in the + symbol list, the optional argument <userinput>\optarg</userinput> specifies the command which kile should insert. + If it is not given the command in the mandatory argument is used. + </para> + </listitem> + <listitem> + <para> + <userinput>\mathcommand[\optarg]{\symbol}</userinput>: Same as above, except that the command in the mandatory + argument is inserted in math mode. + </para> + </listitem> + <listitem> + <para> + <userinput>\pkgs[arg]{pkg}</userinput>: Declare that the command given in this line needs the &latex; package + <userinput>pkg</userinput> with the optional argument <userinput>arg</userinput>. This command has to be in + front of the <userinput>\command</userinput> command and overrides any package specification by the neededpkgs + enviroment. + </para> + </listitem> + <listitem> + <para> + <userinput>\begin{neededpkgs}[pkgs-args]{pkgs} ... \end{neededpkgs}</userinput>: Has the same effect as + above, but for all enclosed commands. + </para> + </listitem> + </itemizedlist> + </para> + <para> + An example for completeness is given here: + <screen><userinput> + \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} + </userinput></screen> + </para> + </sect1> + + <sect1 id="latex_bib"> + + <title>Using Bibitems</title> + + <para><userinput>\bibitem</userinput> is a command used to enter a reference in a + <userinput>thebibliography</userinput> environment in your document. The syntax for using + <userinput>\bibitem</userinput> is <userinput>\bibitem[label]{key}</userinput>.</para> + + <para>The optional <userinput>[label]</userinput> 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.</para> + + <para>The argument <userinput>{key}</userinput> is used to reference and link the commands + <userinput>\bibitem</userinput> and <userinput>\cite</userinput> to + each other and the information they contain. The command <userinput>\cite</userinput> contains the + label associated with the intended <userinput>\bibitem</userinput>, which is located inside a + <userinput>thebibliography</userinput> environment, and contains the reference data. + Both corresponding <userinput>\bibitem</userinput> and <userinput>\cite</userinput> must + have the same <userinput>{key}</userinput>; the easiest way to organize keys is by + the author's last name. The secondary braces in the <userinput>thebibliography</userinput> + environment denote the longest bibliography label you expect to have. + So, inserting <userinput>{<replaceable>foo</replaceable>}</userinput> means + you can have any label shorter or as large as the expression + <userinput><replaceable>foo</replaceable></userinput>. Failure to set this parameter correctly + may result in a not so attractive indentation of your bibliography.</para> + + <para>The bibliography is a section apart from your main document, and an example of + code for the bibliography would look like the following:</para> + + <screen><userinput> + \begin{thebibliography}{50} + \bibitem{Simpson} Homer J. Simpson. \textsl{Mmmmm...donuts}. + Evergreen Terrace Printing Co., Springfield, SomewhereUSA, 1998 + \end{thebibliography)</userinput></screen> + + <para>Then, your main source code would contain the location of the information relating to + the <userinput>\bibitem</userinput> using <userinput>\cite</userinput>. That source code would look similar to this:</para> + + <screen><userinput> + My thesis, about the philosophy of The Simpsons\copyright + comes from my favorite book \cite{Simpson}.</userinput></screen> + + <para>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. On the <guilabel>Edit</guilabel> + toolbar click on the second drop-down box (usually it reads <guilabel>label</guilabel>) and select + <guilabel>cite</guilabel>. 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,<menuchoice><guimenu>Edit</guimenu><guimenuitem>Refresh + Structure</guimenuitem></menuchoice> or press <keycap>F12</keycap>.</para> + + <para>The final product in your document's bibliography would then look like this:</para> + + <para><computeroutput>[1] Homer J. Simpson. Mmmmm...donuts. Evergreen Terrace Printing Co., + Springfield, SomewhereUSA, 1998.</computeroutput></para> + + <para>The easiest way to work with <userinput>\bibitem</userinput> and + <userinput>\cite</userinput> is to use the toolbar drop-down box marked + <guilabel>cite</guilabel>. When you select a citation to insert, you will be given the list of + <userinput>bibitem</userinput>s you have created so far, and will be able to select the + reference from the list. &kile; can also work together with &bibtex; editor applications, + such as &kbibtex; to help make citations easier.</para> + + </sect1> + + <sect1 id="latex_usertags"> + + <title>User-Defined Tags</title> + + <para>&kile; gives you the ability to make your own tags. A tag is similar + to a shortcut that launches some command or writes frequently-used text. + For example, Joe Sixpack uses often the sentences <userinput>I prefer \LaTeX\ + to \TeX\</userinput> and <userinput>What would I do without Linux?</userinput>. + To create user-defined tags to write these sentences, he would access + <menuchoice><guimenu>LaTeX</guimenu><guisubmenu>User Tags</guisubmenu><guimenuitem>Edit + User Tags...</guimenuitem></menuchoice>; this will present him a dialog where he can create + his own user-defined tags.</para> + <screenshot> + <screeninfo>The Edit User Tags Dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_editusertag.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The Edit User Tags Dialog</phrase> + </textobject> + <caption><para>The Edit User Tags Dialog</para></caption> + </mediaobject> + </screenshot> + + <screenshot> + <screeninfo>Invoking a User-Defined Tag</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_usertag.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Invoking a User Defined Tag</phrase> + </textobject> + <caption><para>Invoking a User Defined Tag</para></caption> + </mediaobject> + </screenshot> + + <para>He would probably give each tag a name that can clearly identify it. The name you give your tag + is entered in the section marked <guilabel>Menu item</guilabel>, and the text of frequently-used command + should be entered into the section labeled <guilabel>Value</guilabel>. Once the commands are entered, + he can use them quickly using the shortcut <keycombo>&Ctrl;&Shift;<keycap>1</keycap></keycombo> for + the first tag to enter <userinput>I prefer \LaTeX\ to \TeX\</userinput> and <keycombo>&Ctrl;&Shift; + <keycap>2</keycap></keycombo> to enter <userinput>What would I do without Linux?</userinput>.</para> + + <sect2 id="latex_usertags_uc"> + + <title>Placeholders in User-Defined Tags</title> + + <para>There are some placeholders you can use in user-defined tags: + they are <userinput>%B</userinput>, <userinput>%C</userinput>, <userinput>%M</userinput> and + <userinput>%S</userinput>.</para> + + <itemizedlist> + <listitem><para><userinput>%B</userinput>: will be replaced by a bullet.</para></listitem> + <listitem><para><userinput>%C</userinput>: this is where the cursor will be placed after the insertion of a + user-defined tag.</para></listitem> + <listitem><para><userinput>%M</userinput>: this stands for marked text; the selected text is + inserted in its place when inserting user-defined tags.</para></listitem> + <listitem><para><userinput>%S</userinput>: will be replaced by the source file's name without file extension.</para></listitem> + </itemizedlist> + + <para>To show you how this works let's say for example that we have a user-defined tag, + which contains the value <userinput>\bfseries{%M}%C</userinput>, and I have a selection of text + highlighted in my document that we want to turn into bold text. So, we highlight the + phrase <userinput>I love Fridays</userinput>, apply our user-defined tag by pressing + <keycombo>&Ctrl;&Shift;<keycap>1</keycap></keycombo>, and we get the text + <userinput>\bfseries{I love Fridays}</userinput>, with the cursor + placed at the end of the text.</para> + + </sect2> + + </sect1> + +</chapter> + +<chapter id="build"> + + <title>The Build Tools</title> + + <sect1 id="build_sect"> + + <title>Compiling, converting and viewing</title> + + <para>To view the result of your work, you first need to compile the source. All the build + tools are grouped closely together in the + <menuchoice><guimenu>Build</guimenu><guisubmenu>Compile</guisubmenu></menuchoice>, + <menuchoice><guimenu>Build</guimenu><guisubmenu>Convert</guisubmenu></menuchoice>, + and <menuchoice><guimenu>Build</guimenu><guisubmenu>View</guisubmenu></menuchoice> + menus.</para> + + <para>To compile your source code for screen viewers like &kdvi;, &kghostview;, &kpdf; or + further conversion, you can use the shortcut <keycombo>&Alt;<keycap>2</keycap></keycombo>. + Then you can view the DVI file using your default viewer with + <keycombo>&Alt;<keycap>3</keycap></keycombo>, convert + the DVI to a PS file with <keycombo>&Alt;<keycap>4</keycap></keycombo>, + and view the PS file with <keycombo>&Alt;<keycap>5</keycap></keycombo>.</para> + + <sect2> + + <title>&bibtex;</title> + + <para>If you are using <ulink url="http://www.ecst.csuchico.edu/~jacobsd/bib/formats/bibtex.html">&bibtex;</ulink> + 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 by default turned on and can be changed in <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure + Kile...</guisubmenu><guisubmenu>Tools</guisubmenu><guilabel>Build</guilabel></menuchoice> in the <guilabel>General</guilabel> tab in the &latex; and &pdflatex; tools. + </para> + + </sect2> + + <sect2> + + <title>&makeidx;</title> + + <para>If you are using the <ulink url="http://ipagwww.med.yale.edu/latex/makeindex.pdf">&makeidx;</ulink> + package to make a final, alphabetical index for your document, you have also to follow a certain + compilation pattern or let &kile; do this for you in the same way as with &bibtex; files.</para> + + </sect2> + + <sect2> + + <title>MetaPost and Asymptote</title> + + <para>If you want to compile your document with <application>MetaPost</application> or <application>Asymptote</application>, picture drawing programs, you can do it with + <menuchoice><guimenu>Build</guimenu><guisubmenu>Compile</guisubmenu><guimenuitem>Metapost</guimenuitem></menuchoice>. + or <menuchoice><guimenu>Build</guimenu><guisubmenu>Other</guisubmenu><guimenuitem>Asymptote</guimenuitem></menuchoice>.</para> + + </sect2> + + <sect2> + + <title>&pdflatex;</title> + + <para>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 + <keycombo>&Alt;<keycap>6</keycap></keycombo>: you can then view the compiled + file pressing <keycombo>&Alt;<keycap>7</keycap></keycombo>.</para> + + <para>Alternatively, you can convert a PS into a PDF with + <keycombo>&Alt;<keycap>8</keycap></keycombo>, or directly a + DVI into a PDF with <keycombo>&Alt;<keycap>9</keycap></keycombo>.</para> + + <para>Using &pdflatex; instead of &latex; may be just a matter of simplicity or habit, + but sometimes the behavior of the two program can differ.</para> + + </sect2> + + <sect2> + + <title>&latex; to Web</title> + + <para>Finally, you may want to publish your work on the web and not just on paper. You may + then use the <application>latex2html</application> program, that can be called from &kile;'s menu + <menuchoice><guimenu>Build</guimenu><guisubmenu>Convert</guisubmenu><guimenuitem>LaTeX + to Web</guimenuitem></menuchoice>. 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 + <menuchoice><guimenu>Build</guimenu><guisubmenu>View</guisubmenu><guimenuitem>View + HTML</guimenuitem></menuchoice>.</para> + + </sect2> + + <sect2 id="build_cl"> + + <title>Passing Command-Line Parameters</title> + + <para>If you want to pass some specific command-line parameters to the compile, convert + or view tools, you can configure their call in <menuchoice><guimenu>Settings</guimenu> + <guisubmenu>Configure Kile...</guisubmenu><guisubmenu>Tools</guisubmenu><guilabel>Build</guilabel></menuchoice>.</para> + + </sect2> + + </sect1> + + <sect1 id="build_preview"> + <title>Quick Preview</title> + + <para>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 <emphasis>Quick Preview</emphasis> 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.</para> + + <screenshot> + <screeninfo>Quick Preview</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="quickpreview.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Quick Preview</phrase> + </textobject> + </mediaobject> + </screenshot> + + <para>All settings must be done in + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>Tools</guimenuitem><guilabel>Preview</guilabel></menuchoice>.</para> + + <screenshot> + <screeninfo>Quick Preview Configuration</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="config-quickpreview.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Quick Preview Configuration</phrase> + </textobject> + </mediaobject> + </screenshot> + + <sect2 id="build_qp_selection"> + + <title>Selection Mode</title> + + <para>The user has to select a part of the document. Menu entry <menuchoice><guimenu>Build</guimenu><guisubmenu>QuickPreview</guisubmenu><guimenuitem>Selection</guimenuitem></menuchoice> + or the keyboard shortcut <keycombo action="simul">&Ctrl;&Alt;<keycap>P</keycap></keycombo>,<keycap>S</keycap> + 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 seven predefined configurations:</para> + + <itemizedlist> + <listitem><para><application>LaTeX+DVI (embedded viewer)</application></para></listitem> + <listitem><para><application>LaTeX+DVI (KDVI)</application></para></listitem> + <listitem><para><application>LaTeX+PS (embedded viewer)</application></para></listitem> + <listitem><para><application>LaTeX+PS (KGhostView)</application></para></listitem> + <listitem><para><application>PDFLaTeX+PDF (embedded viewer)</application></para></listitem> + <listitem><para><application>PDFLaTeX+PDF (KGhostView)</application></para></listitem> + <listitem><para><application>PDFLaTeX+PDF (KPDF)</application></para></listitem> + </itemizedlist> + + <para>This should be sufficient for all situations for which a quick preview is needed.</para> + + </sect2> + + <sect2 id="build_qp_environment"> + + <title>Environment Mode</title> + + <para>Very often you want to preview the current environment, and especially mathematic + environments, which sometimes may be difficult to write. &kile; offers a very fast way + to do this. No selection is needed, only choose + <menuchoice><guimenu>Build</guimenu><guisubmenu>QuickPreview</guisubmenu><guimenuitem>Environment</guimenuitem></menuchoice> + or the keyboard shortcut <keycombo action="simul">&Ctrl;&Alt;<keycap>P</keycap></keycombo>,<keycap>E</keycap> + and the current environment will be compiled and shown.</para> + + </sect2> + + <sect2 id="build_qp_subdocument"> + + <title>Subdocument Mode</title> + + <para>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 <menuchoice><guimenu>Build</guimenu><guisubmenu>QuickPreview</guisubmenu><guimenuitem>Subdocument</guimenuitem></menuchoice> + or the keyboard shortcut <keycombo action="simul">&Ctrl;&Alt;<keycap>P</keycap></keycombo>,<keycap>D</keycap>.</para> + + </sect2> + + <sect2 id="build_qp_mathgroup"> + + <title>Mathgroup Mode</title> + + <para>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 <menuchoice><guimenu>Build</guimenu><guisubmenu>QuickPreview</guisubmenu><guimenuitem>Mathgroup</guimenuitem></menuchoice> + or the keyboard shortcut <keycombo action="simul">&Ctrl;&Alt;<keycap>P</keycap></keycombo>,<keycap>M</keycap>.</para> + + </sect2> + + <sect2 id="qp_bottombar"> + + <title>Quick Preview in Bottom Bar</title> + + <para>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.</para> + + </sect2> + + </sect1> + + <sect1 id="build_graphics"> + + <title>Graphic File Formats</title> + + <sect2 id="build_graphics_latex"> + + <title>&latex; and &pdflatex;</title> + + <para>&pdflatex;, when used with <userinput>graphics</userinput> or + <userinput>graphicx</userinput> packages, can compile correctly 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.</para> + + <para>A lot of users want to create PDF documents, but also want to use of the excellent + <application>Pstricks</application> package to create &postscript; graphics, or they want + to use the &postscript; output of mathematical and scientific software like + <application>Mathematica</application>, <application>Maple</application> or <application>MuPAD</application>. + 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.</para> + + </sect2> + + <sect2 id="build_graphics_conversion"> + + <title>Graphics Conversion</title> + + <para>To overcome this frustrating loop, in case you want to include both &postscript; code and PNG or JPG files, + you have a number of workarounds:</para> + + <itemizedlist> + <listitem><para>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 <application>dvips</application> + to create the PS file. You see that &pdflatex; is a very good choice, if your source contains + no &postscript; code at all.</para></listitem> + + <listitem><para>You can convert EPS files to PNG or other formats with utilities as the + <ulink url="http://www.gimp.org/"><application>Gimp</application></ulink> or + <ulink url="http://www.imagemagick.org/">&imagemagick;</ulink> + and use &pdflatex;.</para></listitem> + + <listitem><para><anchor id="build_graphics_epstopdf"></anchor>A preferred way + is to convert EPS graphics to PDF graphics with + <command>epstopdf</command>, which comes with every &tex; distribution + distribution and then use &pdflatex;. It produces high quality graphics, + and you can even control the result with some of the following options: + +<programlisting> + -dAutoFilterColorImages=false + -dAutoFilterGrayImages=false + -sColorImageFilter=FlateEncode + -sGrayImageFilter=FlateEncode + -dPDFSETTINGS=/prepress + -dUseFlateCompression=true +</programlisting> + </para> + + <para>Even better: if your system allows <userinput>shell-escape</userinput>, conversion + can be done on the fly. All you have to do is to include the <application>epstopdf</application> package, + which is part of all &tex; distributions, with command <userinput>\usepackage{epstopdf}</userinput>. + Assuming that your code is + +<programlisting> + \includegraphics[width=5cm]{test.eps} +</programlisting> + + When you call &pdflatex; with option <option>--shell-escape</option>, + graphics <filename>test.eps</filename> is automatically converted into <filename>test.pdf</filename>.</para> + + <para>This conversion will take place each time you run &pdflatex;. + If your graphics command is given implicitly: + +<programlisting> + \includegraphics[width=5cm]{test} +</programlisting> + + <application>epstopdf</application> checks whether <filename>test.pdf</filename> is already + available, so that conversion step can be skipped.</para></listitem> + + <listitem><para>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 <emphasis>highly</emphasis> + 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 + <ulink url="http://www.imagemagick.org/">&imagemagick;</ulink>. + Another simple program that does this process correctly is + <ulink url="http://www.tex.uniyar.ac.ru/win32/tools/jpg2ps/"><application>jpg2ps</application></ulink>. + </para></listitem> + + <listitem><para>You can also use an automatic conversion. All graphic 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 + <link linkend="build_epsgraphics">EPS Graphics</link>.</para></listitem> + + </itemizedlist> + + </sect2> + + <sect2 id="build_graphics_type"> + + <title>Use the right File for the right Graphic</title> + + <itemizedlist> + <listitem><para>EPS is sort of a graphic vector scripting language, describing + all the lines and dots the graph is made of; it looks good even when magnified beyond its + default size, and suits best diagrams and vectorial graphic natively produced in EPS, + which look very clear and sharp while maintaining a very small byte size.</para></listitem> + <listitem><para>PNG (or the deprecated GIF) is a <emphasis>non-lossy</emphasis> 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.</para></listitem> + <listitem><para>JPG is a <emphasis>lossy</emphasis> 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.</para></listitem> + </itemizedlist> + + <para>But always remember: garbage in, garbage out! No conversion will make a bad picture good.</para> + + </sect2> + + </sect1> + + <sect1 id="build_epsgraphics"> + + <title>EPS Graphics</title> + + <para>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.</para> + + <sect2 id="build_graphics_eps"> + + <title>&latex; and EPS Graphics</title> + + <para>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 + <link linkend="build_graphics_conversion">converters</link> like + <command>convert</command> from the excellent + <ulink url="http://www.imagemagick.org/">&imagemagick;</ulink> + package. But, it needs some time of course.</para> + + <para>The EPS files are used by both &latex; and the DVI-PS converter:</para> + + <itemizedlist> + <listitem><para>&latex; scans the EPS file for the bounding box + line, which tells &latex; how much space to reserve for the + graphics.</para></listitem> + + <listitem><para>The DVI-PS converter then reads the EPS file and + inserts the graphics in the PS file.</para></listitem> + </itemizedlist> + + <para>This has some implications:</para> + + <itemizedlist> + <listitem><para>&latex; never reads the EPS file if the bounding-box + parameters are specified in the graphics-insertion command.</para></listitem> + + <listitem><para>Since &latex; cannot read non-ASCII files, + it cannot read the bounding-box information from compressed or non-EPS + graphics files.</para></listitem> + + <listitem><para>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 DVI files whenever they are + moved.</para></listitem> + </itemizedlist> + + <para>Now you can call &latex;, and a DVI-PS converter like <application>dvips</application> + to create your &postscript; document. If your goal is a PDF document, you should run + <command>dvips</command> with option <option>-Ppdf</option> and then call + <command>ps2pdf</command>. You will find a lot of documents describing this solution.</para> + + </sect2> + + <sect2 id="build_graphics_epskile"> + + <title>The &postscript; Way of &kile;</title> + + <para>&kile; helps you to get the bounding-box information. If you have installed + <ulink url="http://www.imagemagick.org/">&imagemagick;</ulink> + 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 proceed like this:</para> + + <itemizedlist> + <listitem><para>The information is already scanned in the dialog, and + need not to be done by &latex; later on.</para></listitem> + <listitem><para>Even more important is that the width and height of the picture + can be calculated, when the its 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.</para></listitem> + <listitem><para>&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, + like it is described in the <link linkend="build_graphics_bitmap">Bitmap Graphics</link> + section.</para></listitem> + </itemizedlist> + <!-- FIXME I don't understand the following sentence, tbraun + <para> The <emphasis>&postscript; Way of &kile;</emphasis> can be turned off or on in + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>LaTeX</guimenuitem><guilabel>General</guilabel></menuchoice>.</para> + --> + </sect2> + + <sect2 id="build_graphics_bitmap"> + + <title>The &postscript; Way and Bitmap Graphics</title> + + <para>If your systems allows <userinput>shell-escape</userinput>, &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.</para> + + <para>&latex; needs some information about the file suffixes. The package + <userinput>graphicx</userinput> looks for a file <filename>graphics.cfg</filename>, + which must be somewhere in your search path for &latex; documents. Search for + entries like:</para> + +<programlisting> + \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}{}% +</programlisting> + + <para>and replace these lines with:</para> + +<programlisting> + \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 +</programlisting> + + <para>You will find this file, for example in Debian, at + <filename>/etc/texmf/latex/graphics.cfg</filename>. The best way to proceed is to copy this + file to your local texpath and then change this file. See the yours &tex; distribution manual + to learn how to get a list of your &tex; folders.</para> + + <para>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 <command>dvips</command>. 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;.</para> + + <para>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.</para> + + </sect2> + + <sect2 id="build_graphics_pdflatex"> + + <title>&pdflatex; and EPS Graphics</title> + + <para>As already stated, &pdflatex; is not able to handle EPS graphic files, + but converters like <link linkend="build_graphics_epstopdf">epstopdf</link> + will help. The best way is to include package <filename>epstopdf</filename>, + which must follow the <userinput>graphicx</userinput> package.</para> + +<programlisting> + \usepackage[pdftex]{graphicx} + \usepackage{epstopdf} +</programlisting> + + <para>Now you can already include EPS graphics, if you run <command>pdflatex</command> + with option <option>--shell-escape</option>, but we can make it even better + and also handle zipped or gzipped EPS files. Again we have to change + the graphics configuration file <filename>graphics.cfg</filename> like above. + This time we search for:</para> + +<programlisting> + % pdfTeX is running in pdf mode + \ExecuteOptions{pdftex}% +</programlisting> + + <para>and simply add some lines.</para> + +<programlisting> + % 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}}% + }% +</programlisting> + + <para>With these lines, &pdflatex; is able to handle EPS files, + and hopefully there should be no more issues concerning graphics.</para> + + </sect2> + + </sect1> + + <sect1 id="build_master"> + + <title>Master Document</title> + + <para>Defining your document as a master allows you to work with separated 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 <guimenu>Settings</guimenu> + menu, all the commands of the <guimenu>Tools</guimenu> + menu will apply only to this document, even when you are working on the child + documents. You can even close the Master document.</para> + </sect1> + + <sect1 id="build_errorhandling"> + + <title>Error Handling</title> + + <para>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 <guilabel>Log and Messages</guilabel> window. One can take a closer look at the + messages by selecting <menuchoice><guimenu>Build</guimenu><guimenuitem>View Log File</guimenuitem></menuchoice>, + or by using the keyboard shortcut <keycombo>&Alt;<keycap>0</keycap></keycombo>. + The generated log is then displayed in the <guilabel>Log and Messages</guilabel> view; errors and warnings are highlighted.</para> + + <screenshot> + <screeninfo>Viewing the log</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_compile_error.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Viewing the log</phrase> + </textobject> + <caption><para>Viewing the log</para></caption> + </mediaobject> + </screenshot> + + <para>You can easily jump from one message in the log file to another by using the + <menuchoice><guimenu>Build</guimenu><guimenuitem>Next / Previous + LaTeX Error / Warning</guimenuitem></menuchoice> menu items, or by using + the corresponding toolbar buttons.</para> + + <para>To jump to the line in the &latex; source where the error or warning occurred, + click on the error or warning in the <guilabel>Log and Messages</guilabel> view. + &kile; will take you automatically to the offending line.</para> + + </sect1> + + <sect1 id="build_watch"> + + <title>The Watch File Mode</title> + + <para>When you launch the <guibutton>Quickbuild</guibutton> 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 open every time.</para> + + <para>If you are adjusting the look of your document, you might launch + <guibutton>Quickbuild</guibutton> very often, and have many viewer windows open on + your desktop; to avoid this confusion, you can activate the <guibutton>Watch file</guibutton> + mode, that will prevent <guibutton>Quickbuild</guibutton> from launching a viewer.</para> + + <para>Presently, &kdvi; supports continuous updating of the viewed DVI file, but + &kghostview; is not as perfect: to update the document after compiling, you will have + to change page, and the number of pages will not be changed in &kghostview;'s visualization.</para> + + <para>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.</para> + + </sect1> + +</chapter> + +<chapter id="navigating"> + + <title>Navigating the &latex; Source</title> + + <sect1 id="navigating_struct"> + + <title>Using the Structure View</title> + + <para>The <guilabel>Structure</guilabel> 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.</para> + + <para>If you included a separate &latex; file in your source using + the <userinput>\input</userinput> or <userinput>\include</userinput> tags, these files will + be referred to in the <guilabel>Structure</guilabel> view; double-clicking on their names in + it will make &kile; bring up the included file in the editor window.</para> + + <para>The hierarchy tree has also a separate branch for labels used in the text.</para> + + <screenshot> + <screeninfo>Using the Structure View</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_structview_label.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Using the Structure View</phrase> + </textobject> + <caption><para>Using the Structure View</para></caption> + </mediaobject> + </screenshot> + + <sect2 id="navigating_update"> + + <title>Updating the Structure View</title> + + <para>To update your structure view you can either go to + <menuchoice><guimenu>Edit</guimenu><guimenuitem>Refresh + Structure</guimenuitem></menuchoice>, hit <keycombo><keycap>F12</keycap></keycombo>, or you can save your document, + which will make &kile; update its <guilabel>Structure</guilabel> view.</para> + + </sect2> + + </sect1> + + <sect1 id="navigating_bookmarks"> + + <title>Bookmarks</title> + + <para>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 <keycombo>&Ctrl; + <keycap>B</keycap></keycombo>, 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 <menuchoice><guimenu>Bookmark</guimenu><guimenuitem>Toggle + Bookmark</guimenuitem></menuchoice>.</para> + + <para>To remove all your bookmarks, select <menuchoice><guimenu>Bookmarks</guimenu> + <guimenuitem>Clear Bookmarks</guimenuitem></menuchoice>.</para> + + <para>Please note that currently the bookmarks are not saved after exiting &kile;.</para> + + </sect1> + +</chapter> + +<chapter id="projects"> + + <title>Projects</title> + + <sect1 id="projects_working"> + + <title>Working with Projects</title> + + <para>In &kile; you can create and work with <emphasis>projects</emphasis>. 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 <literal role="extension">.tex</literal> 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 <literal role="extension">.kilepr</literal>.</para> + + <para>A Project adds the following functionalities:</para> + + <itemizedlist> + <listitem><para>You need not set a master document, &kile; does this automatically.</para></listitem> + <listitem><para>Project files can easily be archived together by going to <menuchoice><guimenu>Build</guimenu><guisubmenu>Other</guisubmenu><guimenuitem>Archive</guimenuitem></menuchoice></para></listitem> + <listitem><para>The <guilabel>Files and Project</guilabel> view shows which files are included + in the project.</para></listitem> + <listitem><para>After opening a project, any file that was previously opened will be + restored with the original encoding and highlightning.</para></listitem> + <listitem><para> Code completion works across all project files.</para></listitem> + <listitem><para> Reference completion works across all project files.</para></listitem> + <listitem><para> Citation completion works across all project files.</para></listitem> + <listitem><para> Search in all project files.</para></listitem> + <listitem><para> Specify custom quickbuild and &makeidx; command.</para></listitem> + </itemizedlist> + + </sect1> + + <sect1 id="projects_creating"> + + <title>Creating a Project</title> + + <para>To create a project, select <menuchoice><guimenu>Project</guimenu> + <guimenuitem>New Project...</guimenuitem></menuchoice>. You will be + asked to give the following information to create your project:</para> + <itemizedlist> + <listitem><para>Title of your project.</para></listitem> + <listitem><para>Name of the project file with <literal role="extension">.kilepr</literal> extension.</para></listitem> + <listitem><para>Filename.</para></listitem> + <listitem><para>Type of file creating: Empty Document, Article, Book, Letter, Report, ....</para></listitem> + </itemizedlist> + + <para>When you fill out the <guilabel>filename</guilabel> box, you have to include a relative + path from where the <literal role="extension">.kilepr</literal> project file is stored to the file.</para> + + </sect1> + + <sect1 id="projects_view"> + + <title>The File and Project View</title> + + <para>The <guilabel>File and Project</guilabel> 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 <literal role="extension">.kilepr</literal> file that stores the project information. + Adding, removing, or changing options in your project is done via + the <guilabel>File and Projects</guilabel> view.</para> + + <screenshot> + <screeninfo>The File and Project View</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_projectview.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The File and Project View</phrase> + </textobject> + <caption><para>The File and Project View</para></caption> + </mediaobject> + </screenshot> + + </sect1> + + <sect1 id="projects_adding"> + + <title>Adding and Removing Files</title> + + <para>To add a file to your project, open any &tex; file, right click on its name in the + <guilabel>Files and Project</guilabel> view, and select <guilabel>Add to + Project</guilabel>. If you have multiple projects open, a dialog box will ask + you which project the file has to be added to.</para> + + <para>If you have multiple files to be added to a project, you can select the + project from the <guilabel>Files and Project</guilabel> view and right-click then select + <guilabel>Add Files</guilabel>; you will then be able to select your files in a dialog box.</para> + + <para>You can also right-click on the project's name in the <guilabel>Files and + Project</guilabel> view, and select <guilabel>Add Files...</guilabel> to bring + up a file selection dialog.</para> + + <screenshot> + <screeninfo>Adding a file to a project</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_projectview_add.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Adding a file to a project</phrase> + </textobject> + <caption><para>Adding a file to a project</para></caption> + </mediaobject> + </screenshot> + + <para>To remove a file from a project, right-click on it and select <guilabel>Remove File</guilabel>. + This does <emphasis>not</emphasis> delete your file (and also does not close it), but only removes it from the list + of files contained in the <literal role="extension">.kilepr</literal> extension.</para> + + </sect1> + + <sect1 id="projects_options"> + + <title>Project Options</title> + + <para>&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 <guilabel>Project Options</guilabel>, + and you will have the option of changing:</para> + + <itemizedlist> + <listitem><para>The title of your project.</para></listitem> + <listitem><para>The Master document.</para></listitem> + <listitem><para>The Quickbuild command.</para></listitem> + <listitem><para>The &makeidx; options.</para></listitem> + </itemizedlist> + + <sect2 id="projects_archive"> + + <title>Archiving your Project</title> + + <para>&kile; allows you to easily backup your project by storing all its files + into a single archive (often known as <emphasis>tarball</emphasis>). To archive your project + right-click on its name in the <guilabel>Files and Project</guilabel> view, or select + <menuchoice><guimenu>Project</guimenu><guimenuitem>Archive</guimenuitem></menuchoice>.</para> + + <para>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 <guilabel>Files and Project</guilabel> + view, and uncheck the <guilabel>Include in Archive</guilabel> option.</para> + + <para>Archive commands are simple shell commands that are executed from the project + folder (where the <literal role="extension">.kilepr</literal> file is located).</para> + + </sect2> + +<!-- FIXME not working in kile, tbraun 11/3/2007 + <sect2 id="projects_ext"> + + <title>Extensions for Non-Source Files</title> + + <para>Non-source files are files such as pictures, PDF or &postscript; files, etc. that are + to be included in the project, but are not source files with the extension <literal role="extension">.tex</literal>. You have + the option to use your own regular expressions to match non-source files.</para> + </sect2> +--> + + </sect1> + + <sect1 id="projects_closing"> + + <title>Closing a Project</title> + + <para>To close a project, select the <guilabel>Files and Project</guilabel> view from + the vertical toolbar, right click on your project title, and then select <guimenuitem> + Close</guimenuitem>. 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 <guisubmenu>Open Recent + Project...</guisubmenu> in the <guimenu>Project</guimenu> menu.</para> + + </sect1> + +</chapter> + +<chapter id="lang"> + + <title>Document Encoding</title> + + <para>The &kile; editor allows you to read, convert and set the text to the encoding + your document needs. This allows you to use non-standard letters and symbols; + you can use, for example, accented characters for Italian or French. + Selecting the encoding for your document can be done in three ways:</para> + + <itemizedlist> + <listitem><para>One way to set the encoding is to use the <guilabel>Set encoding</guilabel> combo + box, located at the bottom of the <guilabel>Open File</guilabel> sidebar view.</para></listitem> + <listitem><para>Another way is using the submenu + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure + Kile...</guisubmenu><guimenuitem>Editor</guimenuitem></menuchoice>, + where you can set the default character encoding for all files.</para> + <screenshot> + <screeninfo>Set the default character encoding</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="config-encoding.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Set the default character encoding</phrase> + </textobject> + </mediaobject> + </screenshot> + </listitem> + <listitem><para>A third way to set the encoding for a document is to set the option + when you use the wizard to create a new document.</para></listitem> + </itemizedlist> + + <para>&latex; itself understands only ASCII, a very limited set of characters, so you could not use + accented or special letters directly. To use accented letters, a special syntax was created: + such as for example <userinput>\"e</userinput> for <computeroutput>ë</computeroutput>. + There is a package to help you with this, called <application>inputenc</application>, and is included + in the preamble using <userinput>\usepackage[latin1]{inputenc}</userinput>, where the optional argument + is the encoding you would like to use (nowadays in most cases <userinput>utf8x</userinput>). This tells &latex; + to translate all of the <userinput>ë</userinput>'s you wrote to <userinput>\"e</userinput>'s before + compiling. Please refer to the <application>inputenc</application> documents directly for more + information on <application>inputenc</application>. Last but not least: remember to make sure that + your file is <emphasis>actually</emphasis> encoded in the same encoding you told + <application>inputenc</application>!</para> + + <screenshot> + <screeninfo>Choosing the source file's encoding</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="snap_encoding.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Choosing the source file's encoding</phrase> + </textobject> + <caption><para>Choosing the source file's encoding</para></caption> + </mediaobject> + </screenshot> + + <para>This host of different character coding tables has been creating problems on + many applications: 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 <ulink url="http://www.unicode.org">Unicode</ulink>. There + are many implementations of Unicode, and <abbrev>UTF-8</abbrev> is the most + successful in Linux; Windows® relies instead on the more cumbersome and + less flexible <abbrev>UCS-2</abbrev>. Some distributions, as RedHat, have already + begun setting their default encoding to <abbrev>UTF-8</abbrev>, and therefore you + may be very interested in using of the <userinput>utf8x</userinput> argument to the + <userinput>inputenc</userinput> package.</para> + + <sect1 id="ucs"> + + <title>The &ucs; Package</title> + <para>If you don't have the &ucs; package installed, you can proceed as follows:</para> + <itemizedlist> + <listitem><para>Get the &ucs; package from the home page of + <ulink url="http://www.unruh.de/DniQ/latex/unicode/">Unicode support for + &latex;</ulink>, by Dominique Unruh from the University of Karlsruhe.</para></listitem> + <listitem> + <para>To install it, unpack the downloaded file and place it in a directory listed + in your $<envar>TEXINPUTS</envar> envirnoment variable. This can also be set inside kile.</para> + </listitem> + </itemizedlist> + <screen><userinput> + \usepackage{ucs} + \usepackage[utf8x]{inputenc}</userinput></screen> + + </sect1> + + <sect1 id="cjk"> + + <title>&cjk; Support</title> + + <para>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.</para> + + <tip><para>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!</para></tip> + + <para>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. We will instead install the complete + &cjk;-&latex; package and make it work for both &latex; and &pdflatex;. A lot + of this material has been inspired by <ulink url="http://www.ece.uci.edu/~chou/">Pai + H. Chou</ulink>'s <ulink url="http://www.ece.uci.edu/~chou/unicode-tex.html">page + about how to setup &pdflatex;</ulink>.</para> + + <orderedlist> + + <listitem><para>Download the <ulink + url="http://www.ctan.org/tex-archive/help/Catalogue/entries/cjk.html">&cjk;</ulink> + package. Copy its unpacked files to an appropriate subfolder of + $<envar>TEXMF</envar>, just like you did with the &ucs; package + before (see <xref linkend="ucs"/>). The files will be unpacked in a + <filename>CJK/X_Y.Z</filename> folder, it is not important that you + take them out, though it will probably be tidier for you to + maintain.</para></listitem> + + <listitem><para>Now you have to download a font that supports all the &cjk; characters + you need. You can choose any <literal role="extension">*.ttf</literal> file that + covers them, but in this walkthrough we will use <ulink + url="ftp://ftp.netscape.com/pub/communicator/extras/fonts/windows/Cyberbit.ZIP">Cyberbit</ulink>. + Unzip the file and rename <filename>Cyberbit.ttf</filename> to + <filename>cyberbit.ttf</filename>, since uppercase might confuse your system.</para> + <para>Place <filename>cyberbit.ttf</filename> in a folder together with + <ulink url="http://delloye.free.fr/Unicode.sfd"><filename>Unicode.sfd</filename></ulink>, + and generate the <literal role="extension">*.tfm</literal> and + <literal role="extension">*.enc</literal> files with the command + <userinput><command>$ ttf2tfm cyberbit.ttf -w cyberbit@Unicode@</command></userinput>. + For some reasons, sometimes this does not produce the hundreds + of files it should. Should that be your case, you can download both + <ulink url="http://www.ece.uci.edu/~chou/unicode/cyberbit-tfm.tgz"><literal + role="extension">*.tfm</literal></ulink> and + <ulink url="http://www.ece.uci.edu/~chou/unicode/cyberbit-enc.tgz"><literal + role="extension">*.enc</literal></ulink> files.</para> + <para>Place the <literal role="extension">*.tfm</literal> files in an + appropriate folder, say <filename>$<envar>TEXMF</envar>/fonts/tfm/bitstream/cyberbit/</filename>; + the <literal role="extension">*.enc</literal> files may be installed in + <filename>$<envar>TEXMF</envar>/pdftex/enc/cyberbit/</filename>.</para></listitem> + + <listitem><para>Now we need a map file to connect the <literal + role="extension">*.enc</literal> files to the font. Download <ulink + url="http://delloye.free.fr/cyberbit.map"><filename>cyberbit.map</filename></ulink> + and install it in <filename>$<envar>TEXMF</envar>/pdftex/config/</filename>.</para></listitem> + + <listitem><para>Download another file, <ulink + url="http://delloye.free.fr/c70cyberbit.fd"><filename>c70cyberbit.fd</filename></ulink>, + and place it in an appropriate folder. You may choose, for example, + <filename>$<envar>TEXMF</envar>/tex/misc/</filename>.</para></listitem> + + <listitem><para>The last file we have to generate is a &postscript; Type 1 + font, necessary to read DVI files generated with &latex;. Run the command + <userinput><command>$ ttf2pfb cyberbit.ttf -o cyberbit.pfb</command></userinput>, and copy the + resulting <filename>cyberbit.pfb</filename> in a folder like + <filename>$<envar>TEXMF</envar>/fonts/type1/cyberbit/</filename>.</para></listitem> + + <listitem><para>Let's now place <filename>cyberbit.ttf</filename> among the fonts + where &latex; can find it. You could place it in a folder named + <filename>$<envar>TEXMF</envar>/fonts/truetype/</filename>.</para></listitem> + + <listitem><para>Check the configuration file you find at + <filename>$<envar>TEXMF</envar>/web2c/texmf.cnf</filename>, and make sure that the + line mentioning <envar>TTFONTS</envar> is uncommented and points to + the folder where you saved <filename>cyberbit.ttf</filename>.</para></listitem> + + <listitem><para>To make it possible for &pdflatex; to use your &cjk; + fonts, it is necessary that you add a line in configuration file + <filename>$<envar>TEXMF</envar>/pdftex/config/pdftex.cfg</filename>. Add + <userinput>map +cyberbit.map</userinput> in the file to complete the + configuration for &pdflatex;.</para></listitem> + + <listitem><para>To configure &latex; so that you can produce DVI + files with &cjk; characters, you have to add a line in file + <filename>ttfonts.map</filename>. The file might be in a folder named + <filename>$<envar>TEXMF</envar>/ttf2pk/</filename>, but you will probably have to look + for it. Add the line <userinput>cyberbit@Unicode@ cyberbit.ttf</userinput> + into it.</para></listitem> + + <listitem><para>Now, you only have to run <userinput><command>texhash</command></userinput> + and the system should be ready.</para></listitem> + + </orderedlist> + + <para>To test whether your configuration is correct, you can try to compile + <ulink url="http://www.math.nus.edu.sg/aslaksen/cs/sample-utf8.tex">this test + file</ulink>.</para> + + <sect2> + <title>&cjk; Troubleshooting</title> + + <para>There are many things that can go wrong when setting &cjk; + support manually. If something seems not to work, the following + checklist might help you.</para> + + <itemizedlist> + + <listitem><para>Obviously, since you run &latex; as a user and + not as root, you must <emphasis>allow</emphasis> ordinary users + to access the new files. Make sure all folders and files are + accessible using the <command>chmod</command> command.</para></listitem> + + <listitem><para>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 <literal role="extension">*.pk</literal> + 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 + <filename>ttfonts.map</filename> for your custom line first. However, + it might happen that your <command>ttf2pk</command> command, which + is usually invoked by the DVI viewer, has been compiled + <emphasis>without</emphasis> support for the + <application>kpathsea</application> libraries. If this is the case, + <userinput><command>ttf2pk</command> <option>--version</option></userinput> + will make no mention of <application>kpathsea</application>. As support for + these libraries is necessary, you might have to find a new package, or + recompile <application>FreeType 1</application> by yourself.</para></listitem> + + </itemizedlist> + + </sect2> + + + <sect2> + + <title>How do I input &cjk; in Unicode?</title> + + <para>There are a number of different input engines, and the choice can + depend also on personal preference. The author uses <ulink + url="http://www.scim-im.org/projects/skim"><application>Skim</application></ulink>, + a port to &kde; of the <ulink + url="http://www.scim-im.org"><application>Scim</application></ulink> + 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 <application>Skim</application> you will have to + define an environment variable <userinput><envar>XMODIFIERS</envar>="@im=SCIM"</userinput> + <emphasis>before</emphasis> starting <application>X</application>.</para> + + </sect2> + + </sect1> + +</chapter> + +<chapter id="scripting"> + + <title>Scripting</title> + + <sect1 id="scripting_test"> + + <title>Scripting in &kile;</title> + + <para> + &kile;'s scripting feature allows for the execution of ECMAScript code. Scripts can be managed through the + scripting panel in the sidebar. + </para> + + </sect1> + + <sect1 id="scripting_api"> + + <title>API Reference</title> + + <para>In this section we describe &kile;'s scripting programming interface.</para> + + <important> + <para> + Please note that the scripting API has not been finalized yet. The API described below might change in + future versions of &kile;. + </para> + </important> + + <para> + First of all, &kile;'s script execution environment provides a global object called "kile", which owns the following + methods: + </para> + + <variablelist> + <varlistentry> + <term>(kile).<function>currentTextDocument()</function></term> + <listitem> + <para> + Returns a <classname>KileTextDocument</classname> object which reflects the currently active + text document. Returns <constant>null</constant> if no text document is active. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>(kile).<function>getInputValue(<parameter>caption</parameter>, <parameter>label</parameter>)</function></term> + <listitem> + <para> + Opens a dialog with the given caption and label. Returns the value that user has entered. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Objects of the type <classname>KileTextDocument</classname> represent text documents in &kile;. They have the following + properties: + </para> + + <variablelist> + <varlistentry> + <term>(KileTextDocument).<function>backspace()</function></term> + <listitem> + <para> + Deletes the character that is located immediately before the current cursor position and moves the cursor + one position backward in the text. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>cursorLeft()</function></term> + <listitem> + <para>Moves the cursor one position backward in the text.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>cursorRight()</function></term> + <listitem> + <para>Moves the cursor one position forward in the text.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>insertText(<parameter>text</parameter>)</function></term> + <listitem> + <para> + Inserts the text contained in the variable <parameter>text</parameter> into the document at the current + cursor location. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>insertBullet()</function></term> + <listitem> + <para>Inserts a bullet into the document at the current cursor position.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>nextBullet()</function></term> + <listitem> + <para> + Selects the first bullet located in the document immediately after the + current cursor location. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>previousBullet()</function></term> + <listitem> + <para> + Selects the first bullet located in the document immediately before the + current cursor location. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>up()</function></term> + <listitem> + <para>Moves the cursor one line up in the document.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>down()</function></term> + <listitem> + <para>Moves the cursor one line down in the document.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>cursorLine()</function></term> + <listitem> + <para>Returns the line which the cursor is currently located at.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>cursorColumn()</function></term> + <listitem> + <para>Returns the column which the cursor is currently located at.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>setCursorLine(<parameter>line</parameter>)</function></term> + <listitem> + <para>Moves the cursor to the line denoted by <parameter>line</parameter>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>(KileTextDocument).<function>setCursorColumn(<parameter>column</parameter>)</function></term> + <listitem> + <para>Moves the cursor to the column denoted by <parameter>line</parameter>.</para> + </listitem> + </varlistentry> + </variablelist> + + </sect1> + +</chapter> + +<chapter id="help"> + + <title>Help</title> + + <sect1 id="help_documents"> + + <title>Help Documents</title> + + <para>&latex; is a rather sophisticated system, where the basic features + can be expanded by a great variety of additional packages. + &kile; provides a lot of different help to support the user.</para> + + <variablelist> + + <varlistentry> + <term><guimenu>LaTeX Reference</guimenu></term> + <listitem><para>An alphabetical index of the most + common &latex; commands.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenu>TeX Documentation</guimenu></term> + <listitem><para>&tetex;/&texlive; comes with a huge amount of documents. + This includes a documentation for all included packages and an additional &latex; + reference.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenu>LaTeX</guimenu></term> + <listitem><para>A full reference for &tex; and friends. This is not + only a description of all programs, some important packages are also + mentioned. And it 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, + &kile; separates it with three important bookmarks.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenu>LaTeX Command</guimenu></term> + <listitem><para>Another alphabetical index of the most common + &latex; commands.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenu>LaTeX Subject</guimenu></term> + <listitem><para>A description of important &latex; + subjects.</para></listitem> + </varlistentry> + + <varlistentry> + <term><guimenu>LaTeX Env</guimenu></term> + <listitem><para>An alphabetical index of the most common + &latex; environments.</para></listitem> + </varlistentry> + + </variablelist> + + </sect1> + + <sect1 id="help_contextsentitive"> + + <title>Context Sensitive Help</title> + + <para>&kile; also support a context sensitive help, which is called + with <keycombo action="simul">&Ctrl;&Alt;<keycap>H</keycap></keycombo>,<keycap>K</keycap>. + In <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>Kile</guimenuitem><guilabel>Help</guilabel></menuchoice> + you can choose whether you want to use &kile;'s &latex; reference or the + help system of &tetex;/&texlive;, which is the default setting.</para> + + <screenshot> + <screeninfo>Bullets</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="config-userhelp.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Bullets</phrase> + </textobject> + </mediaobject> + </screenshot> + + </sect1> + + <sect1 id="help_search"> + + <title>Searching for Keywords</title> + + <para>It is not always easy to find the right document, as &tetex;/&texlive; + comes with a huge amount of documents. As one possible help, &tetex;/&texlive; + provides a tiny program <application>texdoctk</application>. + It comes with a database of all documents that &kile; uses to offer + an interface to it.</para> + + <screenshot> + <screeninfo>Bullets</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dialog-docbrowser1.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Bullets</phrase> + </textobject> + </mediaobject> + </screenshot> + + <para>All documents are grouped into some categories, and the main + advantage is that you can search for packages names or keywords. + &kile; will then show only the results.</para> + + <screenshot> + <screeninfo>Bullets</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dialog-docbrowser2.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Bullets</phrase> + </textobject> + </mediaobject> + </screenshot> + + <para>A mouse double click or the <keycap>Space</keycap> key will start the + viewer for this document. This can be a arbitrary document, not only a + DVI, PS, PDF or HTML document. &kile; will take &konqueror; settings to + start a appropriate viewer.</para> + + + </sect1> + + <sect1 id="help_userdefined"> + + <title>User Defined Help</title> + + <para>Beside this static &tetex;/&texlive; documentation, &kile; supports also + another variable way for user-help documents. In <guimenu>Help</guimenu> + menu &kile; has a special <guimenu>User help</guimenu> + submenu, where the user can add documents of his own choice. + These can be the most important documents of &tetex;/&texlive; documentation, or even + self written documents. It is even possible to choose some Web URLs.</para> + + <para>Go to + <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure Kile...</guisubmenu> + <guimenuitem>Kile</guimenuitem><guilabel>Help</guilabel></menuchoice> + and choose <guibutton>Configure</guibutton> button + to configure this <guimenu>User help</guimenu> menu. You can add, + remove or navigate menu entries, and also insert separators to get + a better structure.</para> + + <para>Pressing the <guibutton>Add</guibutton> button will open + another dialog, where you must edit the name of the menu entry, + and choose the corresponding file or Web &url;. If you choose a Web &url;, + &konqueror; is started and you should copy the final &url;.</para> + + <screenshot> + <screeninfo>Bullets</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dialog-addhelp.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Bullets</phrase> + </textobject> + </mediaobject> + </screenshot> + + </sect1> + +</chapter> + +<chapter id="credits"> + + <title>Credits and License</title> + + <para>&kile; is an open-source user-friendly &latex; / &tex; source code editor. It will run on systems + with the &kde; Desktop Environment installed. &kde; is available for several architectures + with Linux and other Unix-like systems installed. &kile; is also part of the Fink project, + which means you can run &kile; on a Mac with OS-X.</para> + + <para>Many thanks are owed to those who strive to continue the &kile; project, and the many + hours of contributions made by those who sacrifice their time to develop tools we can all + use under the <acronym>GNU</acronym> license. Up-to-date information about contributors can be found in + the <guimenuitem>About &kile;</guimenuitem> dialog from the <guimenu>Help</guimenu> menu. + </para> + + <para>Contributions among others from: Rob Lensen, Roland Schulz, Michael Margraf, Holger Danielsson</para> + + <para>Many thanks to all those involved!</para> + + &underFDL; <!-- FDL: do not remove --> + &underGPL; <!-- GPL License --> + +</chapter> + + +&documentation.index; + +</book> diff --git a/doc/en/latex_example.png b/doc/en/latex_example.png Binary files differnew file mode 100644 index 0000000..d5c8774 --- /dev/null +++ b/doc/en/latex_example.png diff --git a/doc/en/latexhelp.html b/doc/en/latexhelp.html new file mode 100644 index 0000000..18767d1 --- /dev/null +++ b/doc/en/latexhelp.html @@ -0,0 +1,3633 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> +<meta name="generator" content= +"HTML Tidy for Linux/x86 (vers 1st January 2004), see www.w3.org"> +<meta http-equiv="Content-Type" content= +"text/html; charset=us-ascii"> +<title>Kile : LaTex Reference</title> + +<style type="text/css"> +<!-- +h3.fn,span.fn {font-family:sans-serif; margin-left: 1cm; text-indent: -1cm; } +a:link {font-family:sans-serif; color: #004faf; text-decoration: none } +a:visited {font-family:sans-serif; color: #004faf; text-decoration: none } +body {font-family:sans-serif; background: white; color: black; } +P { font-family:sans-serif; } +OL { font-family:sans-serif; } +UL { font-family:sans-serif; } +LI { font-family:sans-serif; } +TD { font-family:sans-serif; } +DD { font-family:sans-serif; } +DL { font-family:sans-serif; } +DT { font-family:sans-serif; } +H1 { font-family:sans-serif; } +H2 { font-family:sans-serif; background:#3f5881; } +CODE { font-family:monospace; } +--> +</style> +</head> +<body bgcolor="#FFFFFF"> +<h1 align="center"><a name="top">LaTeX Reference</a></h1> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="center"><b><font size="+2" color="white">Alphabetical +Index</font></b></td> +</tr> +<tr bgcolor="#F0F0F0"> +<td align="center" colspan="0"><b> <a href= +"#index0">#</a> <a href="#indexa">A</a> + <a href="#indexb">B</a> <a href= +"#indexc">C</a> <a href="#indexd">D</a> + <a href="#indexe">E</a> <a href= +"#indexf">F</a> <a href="#indexh">H</a> + <a href="#indexi">I</a> <a href= +"#indexk">K</a> <a href="#indexl">L</a> + <a href="#indexm">M</a> <a href= +"#indexn">N</a> <a href="#indexo">O</a> + <a href="#indexp">P</a> <a href= +"#indexq">Q</a> <a href="#indexr">R</a> + <a href="#indexs">S</a> <a href= +"#indext">T</a> <a href="#indexu">U</a> + <a href="#indexv">V</a> <a href= +"#indexw">W</a> </b></td> +</tr> +</table> +<hr> +<br> +<br> +<!-- INDEX BY SUBJECT --> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="center"><b><font size="+2" color="white">Index by +subject</font></b></td> +</tr> +</table> +<table> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC3">Counters</a></b></td> +<td>Internal counters used by LaTeX.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC4" href="#SEC4">\addtocounter</a></li> +<li><a name="TOC5" href="#SEC5">\alph</a></li> +<li><a name="TOC6" href="#SEC6">\arabic</a></li> +<li><a name="TOC7" href="#SEC7">\fnsymbol</a></li> +<li><a name="TOC8" href="#SEC8">\newcounter</a></li> +<li><a name="TOC9" href="#SEC9">\refstepcounter</a></li> +<li><a name="TOC10" href="#SEC10">\roman</a></li> +<li><a name="TOC11" href="#SEC11">\stepcounter</a></li> +<li><a name="TOC12" href="#SEC12">\setcounter</a></li> +<li><a name="TOC13" href="#SEC13">\usecounter</a></li> +<li><a name="TOC14" href="#SEC14">\value</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC15">Cross References</a></b></td> +<td>Automatic referencing.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC16" href="#SEC16">\label</a></li> +<li><a name="TOC17" href="#SEC17">\pageref</a></li> +<li><a name="TOC18" href="#SEC18">\ref</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC19">Definitions</a></b></td> +<td>Define your own commands etc.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC20" href="#SEC20">\newcommand</a></li> +<li><a name="TOC21" href="#SEC21">\newenvironment</a></li> +<li><a name="TOC22" href="#SEC22">\newtheorem</a></li> +<li><a name="TOC23" href="#SEC23">\newfont</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC24">Document Classes</a></b></td> +<td>Some of the various classes available.</td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC30">Environments</a></b></td> +<td>Such as enumerate & itemize.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<div style="margin-left: 2em"> +<ul> +<li><a name="TOC31" href="#SEC31">array</a></li> +<li><a name="TOC32" href="#SEC32">center</a> +<ul> +<li><a name="TOC33" href="#SEC33">\centering</a></li> +</ul> +</li> +<li><a name="TOC34" href="#SEC34">description</a></li> +<li><a name="TOC35" href="#SEC35">enumerate</a></li> +<li><a name="TOC36" href="#SEC36">eqnarray</a></li> +<li><a name="TOC37" href="#SEC37">equation</a></li> +<li><a name="TOC38" href="#SEC38">figure</a></li> +<li><a name="TOC39" href="#SEC39">flushleft</a> +<ul> +<li><a name="TOC40" href="#SEC40">\raggedright</a></li> +</ul> +</li> +<li><a name="TOC41" href="#SEC41">flushright</a> +<ul> +<li><a name="TOC42" href="#SEC42">\raggedleft</a></li> +</ul> +</li> +<li><a name="TOC43" href="#SEC43">itemize</a></li> +<li><a name="TOC44" href="#SEC44">letter</a></li> +<li><a name="TOC45" href="#SEC45">list</a></li> +<li><a name="TOC46" href="#SEC46">minipage</a></li> +<li><a name="TOC47" href="#SEC47">picture</a> +<ul> +<li><a name="TOC48" href="#SEC48">\circle</a></li> +<li><a name="TOC49" href="#SEC49">\dashbox</a></li> +<li><a name="TOC50" href="#SEC50">\frame</a></li> +<li><a name="TOC51" href="#SEC51">\framebox</a></li> +<li><a name="TOC52" href="#SEC52">\line</a></li> +<li><a name="TOC53" href="#SEC53">\linethickness</a></li> +<li><a name="TOC54" href="#SEC54">\makebox</a></li> +<li><a name="TOC55" href="#SEC55">\multiput</a></li> +<li><a name="TOC56" href="#SEC56">\oval</a></li> +<li><a name="TOC57" href="#SEC57">\put</a></li> +<li><a name="TOC58" href="#SEC58">\shortstack</a></li> +<li><a name="TOC59" href="#SEC59">\vector</a></li> +</ul> +</li> +<li><a name="TOC60" href="#SEC60">quotation</a></li> +<li><a name="TOC61" href="#SEC61">quote</a></li> +<li><a name="TOC62" href="#SEC62">tabbing</a></li> +<li><a name="TOC63" href="#SEC63">table</a></li> +<li><a name="TOC64" href="#SEC64">tabular</a> +<ul> +<li><a name="TOC65" href="#SEC65">\cline</a></li> +<li><a name="TOC66" href="#SEC66">\hline</a></li> +<li><a name="TOC67" href="#SEC67">\multicolumn</a></li> +<li><a name="TOC68" href="#SEC68">\vline</a></li> +</ul> +</li> +<li><a name="TOC69" href="#SEC69">thebibliography</a> +<ul> +<li><a name="TOC70" href="#SEC70">\bibitem</a></li> +<li><a name="TOC71" href="#SEC71">\cite</a></li> +<li><a name="TOC72" href="#SEC72">\nocite</a></li> +<li><a name="TOC73" href="#SEC73">Using BibTeX</a></li> +</ul> +</li> +<li><a name="TOC74" href="#SEC74">theorem</a></li> +<li><a name="TOC75" href="#SEC75">titlepage</a></li> +<li><a name="TOC76" href="#SEC76">verbatim</a> +<ul> +<li><a name="TOC77" href="#SEC77">\verb</a></li> +</ul> +</li> +<li><a name="TOC78" href="#SEC78">verse</a></li> +</ul> +</div> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC79">Footnotes</a></b></td> +<td>How to produce footnotes.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC80" href="#SEC80">\footnote</a></li> +<li><a name="TOC81" href="#SEC81">\footnotemark</a></li> +<li><a name="TOC82" href="#SEC82">\footnotetext</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC25">Layout</a></b></td> +<td>Controlling the page layout.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC26" href="#SEC26">\flushbottom</a></li> +<li><a name="TOC27" href="#SEC27">\onecolumn</a></li> +<li><a name="TOC28" href="#SEC28">\raggedbottom</a></li> +<li><a name="TOC29" href="#SEC29">\twocolumn</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC83">Lengths</a></b></td> +<td>The length commands.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC84" href="#SEC84">\newlength</a></li> +<li><a name="TOC85" href="#SEC85">\setlength</a></li> +<li><a name="TOC86" href="#SEC86">\addtolength</a></li> +<li><a name="TOC87" href="#SEC87">\settodepth</a></li> +<li><a name="TOC88" href="#SEC88">\settoheight</a></li> +<li><a name="TOC89" href="#SEC89">\settowidth</a></li> +<li><a name="TOC90" href="#SEC90">Predefined lengths</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC91">Letters</a></b></td> +<td>The letter class.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC92" href="#SEC92">\address</a></li> +<li><a name="TOC93" href="#SEC93">\cc</a></li> +<li><a name="TOC94" href="#SEC94">\closing</a></li> +<li><a name="TOC95" href="#SEC95">\encl</a></li> +<li><a name="TOC96" href="#SEC96">\location</a></li> +<li><a name="TOC97" href="#SEC97">\makelabels</a></li> +<li><a name="TOC98" href="#SEC98">\name</a></li> +<li><a name="TOC99" href="#SEC99">\opening</a></li> +<li><a name="TOC100" href="#SEC100">\ps</a></li> +<li><a name="TOC101" href="#SEC101">\signature</a></li> +<li><a name="TOC102" href="#SEC102">\startbreaks</a></li> +<li><a name="TOC103" href="#SEC103">\stopbreaks</a></li> +<li><a name="TOC104" href="#SEC104">\telephone</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC105">Line & Page +Breaking</a></b></td> +<td>How to insert pagebreaks etc.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC106" href="#SEC106">\\</a></li> +<li><a name="TOC107" href="#SEC107">\-</a></li> +<li><a name="TOC108" href="#SEC108">\cleardoublepage</a></li> +<li><a name="TOC109" href="#SEC109">\clearpage</a></li> +<li><a name="TOC110" href="#SEC110">\enlargethispage</a></li> +<li><a name="TOC111" href="#SEC111">\fussy</a></li> +<li><a name="TOC112" href="#SEC112">\hyphenation</a></li> +<li><a name="TOC113" href="#SEC113">\linebreak</a></li> +<li><a name="TOC114" href="#SEC114">\newline</a></li> +<li><a name="TOC115" href="#SEC115">\newpage</a></li> +<li><a name="TOC116" href="#SEC116">\nolinebreak</a></li> +<li><a name="TOC117" href="#SEC117">\nopagebreak</a></li> +<li><a name="TOC118" href="#SEC118">\pagebreak</a></li> +<li><a name="TOC119" href="#SEC119">\sloppy</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC120">Making +Paragraphs</a></b></td> +<td>Paragraph commands.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC121" href="#SEC121">\indent</a></li> +<li><a name="TOC122" href="#SEC122">\noindent</a></li> +<li><a name="TOC123" href="#SEC123">\par</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC124">Margin Notes</a></b></td> +<td>Putting remarks in the margin.</td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC125">Math Formulae</a></b></td> +<td>How to create mathematical formulae.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC126" href="#SEC126">Subscripts & +Superscripts</a></li> +<li><a name="TOC127" href="#SEC127">Math Symbols</a></li> +<li><a name="TOC128" href="#SEC128">Spacing in Math Mode</a></li> +<li><a name="TOC129" href="#SEC129">Math Miscellany</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC130">Modes</a></b></td> +<td>Paragraph, Math or LR modes.</td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC131">Page Styles</a></b></td> +<td>Various styles of page layout.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC132" href="#SEC132">\maketitle</a></li> +<li><a name="TOC133" href="#SEC133">\author</a></li> +<li><a name="TOC134" href="#SEC134">\date</a></li> +<li><a name="TOC135" href="#SEC135">\thanks</a></li> +<li><a name="TOC136" href="#SEC136">\title</a></li> +<li><a name="TOC137" href="#SEC137">\pagenumbering</a></li> +<li><a name="TOC138" href="#SEC138">\pagestyle</a></li> +<li><a name="TOC139" href="#SEC139">\markboth</a></li> +<li><a name="TOC140" href="#SEC140">\markright</a></li> +<li><a name="TOC141" href="#SEC141">\thispagestyle</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC142">Sectioning</a></b></td> +<td>How to section properly.</td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC143">Spaces & +Boxes</a></b></td> +<td>All the associated commands.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC144" href="#SEC144">\dotfill</a></li> +<li><a name="TOC145" href="#SEC145">\hfill</a></li> +<li><a name="TOC146" href="#SEC146">\hrulefill</a></li> +<li><a name="TOC147" href="#SEC147">\hspace</a></li> +<li><a name="TOC148" href="#SEC148">\addvspace</a></li> +<li><a name="TOC149" href="#SEC149">\bigskip</a></li> +<li><a name="TOC150" href="#SEC150">\medskip</a></li> +<li><a name="TOC151" href="#SEC151">\smallskip</a></li> +<li><a name="TOC152" href="#SEC152">\vfill</a></li> +<li><a name="TOC153" href="#SEC153">\vspace</a></li> +<li><a name="TOC154" href="#SEC154">\fbox</a></li> +<li><a name="TOC155" href="#SEC155">\framebox</a></li> +<li><a name="TOC156" href="#SEC156">lrbox</a></li> +<li><a name="TOC157" href="#SEC157">\makebox</a></li> +<li><a name="TOC158" href="#SEC158">\mbox</a></li> +<li><a name="TOC159" href="#SEC159">\newsavebox</a></li> +<li><a name="TOC160" href="#SEC160">\parbox</a></li> +<li><a name="TOC161" href="#SEC161">\raisebox</a></li> +<li><a name="TOC162" href="#SEC162">\rule</a></li> +<li><a name="TOC163" href="#SEC163">\savebox</a></li> +<li><a name="TOC164" href="#SEC164">\sbox</a></li> +<li><a name="TOC165" href="#SEC165">\usebox</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC166">Special +Characters</a></b></td> +<td>Special reserved characters.</td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC167">Splitting the +Input</a></b></td> +<td>Dealing with big files by splitting.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC168" href="#SEC168">\include</a></li> +<li><a name="TOC169" href="#SEC169">\includeonly</a></li> +<li><a name="TOC170" href="#SEC170">\input</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC171">Starting & +Ending</a></b></td> +<td>The formal start & end layouts.</td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC172">Table of +Contents</a></b></td> +<td>How to create a table of contents.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC173" href="#SEC173">\addcontentsline</a></li> +<li><a name="TOC174" href="#SEC174">\addtocontents</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC175">Terminal +Input/Output</a></b></td> +<td>User interaction.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC176" href="#SEC176">\typein</a></li> +<li><a name="TOC177" href="#SEC177">\typeout</a></li> +</ul> +</td> +<td> </td> +</tr> +<tr bgcolor="#F0F0FA"> +<td align="left"><b><a href="#SEC178">Typefaces</a></b></td> +<td>Such as bold, italics etc.</td> +</tr> +<tr bgcolor="#F0F0F0"> +<td> +<ul> +<li><a name="TOC179" href="#SEC179">\Styles</a></li> +<li><a name="TOC180" href="#SEC180">Sizes</a></li> +<li><a name="TOC181" href="#SEC181">Low-level font +commands</a></li> +</ul> +</td> +<td> </td> +</tr> +</table> +<!-- ALPHABETICAL INDEX --> +<hr> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="center"><b><a name="alpha"><font size="+2" color= +"white">Alphabetical index</font></a></b></td> +</tr> +</table> +<table> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> # </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="index0" href="#IDX259">$</a></li> +<li><a href="#SEC128">\!</a></li> +<li><a href="#IDX134">\' (tabbing)</a></li> +<li><a href="#SEC125">\(</a></li> +<li><a href="#SEC125">\)</a></li> +<li><a href="#IDX132">\+</a></li> +<li><a href="#SEC128">\,</a></li> +<li><a href="#SEC107">\- (hyphenation)</a></li> +<li><a href="#IDX133">\- (tabbing)</a></li> +<li><a href="#SEC128">\;</a></li> +<li><a href="#IDX131">\<</a></li> +<li><a href="#IDX129">\=</a></li> +<li><a href="#IDX130">\></a></li> +<li><a href="#SEC125">\[</a></li> +<li><a href="#SEC106">\\</a></li> +<li><a href="#SEC125">\]</a></li> +<li><a href="#IDX135">\` (tabbing)</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> A </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexa" href="#IDX139">\a</a></li> +<li><a href="#SEC173">\addcontentsline</a></li> +<li><a href="#SEC92">\address</a></li> +<li><a href="#SEC174">\addtocontents</a></li> +<li><a href="#SEC4">\addtocounter</a></li> +<li><a href="#SEC86">\addtolength</a></li> +<li><a href="#SEC148">\addvspace</a></li> +<li><a href="#SEC5">\alph</a></li> +<li><a href="#SEC5">\Alph</a></li> +<li><a href="#IDX314">\appendix</a></li> +<li><a href="#SEC6">\arabic</a></li> +<li><a href="#SEC31">array (environment)</a></li> +<li><a href="#SEC133">\author</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> B </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexb" href="#IDX346">\backslash</a></li> +<li><a href="#SEC30">\begin</a></li> +<li><a href="#IDX380">\bfseries</a></li> +<li><a href="#SEC70">\bibitem</a></li> +<li><a href="#SEC73">\bibliography</a></li> +<li><a href="#SEC73">\bibliographystyle</a></li> +<li><a href="#SEC149">\bigskip</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> C </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexc" href="#IDX80">\caption</a></li> +<li><a href="#SEC93">\cc</a></li> +<li><a href="#IDX275">\cdots</a></li> +<li><a href="#SEC32">center</a></li> +<li><a href="#SEC33">\centering</a></li> +<li><a href="#SEC142">\chapter</a></li> +<li><a href="#SEC48">\circle</a></li> +<li><a href="#SEC71">\cite</a></li> +<li><a href="#SEC108">\cleardoublepage</a></li> +<li><a href="#SEC109">\clearpage</a></li> +<li><a href="#SEC65">\cline</a></li> +<li><a href="#SEC94">\closing</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> D </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexd" href="#SEC49">\dashbox</a></li> +<li><a href="#SEC134">\date</a></li> +<li><a href="#IDX276">\ddots</a></li> +<li><a href="#IDX193">\depth</a></li> +<li><a href="#SEC34">description</a></li> +<li><a href="#SEC24">\documentclass</a></li> +<li><a href="#SEC144">\dotfill</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> E </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexe" href="#IDX376">\emph</a></li> +<li><a href="#SEC95">\encl</a></li> +<li><a href="#SEC30">\end</a></li> +<li><a href="#SEC110">\enlargethispage</a></li> +<li><a href="#SEC35">enumerate</a></li> +<li><a href="#SEC36">eqnarray</a></li> +<li><a href="#SEC37">equation</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> F </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexf" href="#SEC154">\fbox</a></li> +<li><a href="#SEC38">figure</a></li> +<li><a href="#SEC26">\flushbottom</a></li> +<li><a href="#SEC39">flushleft</a></li> +<li><a href="#SEC41">flushright</a></li> +<li><a href="#SEC7">\fnsymbol</a></li> +<li><a href="#IDX416">\fontencoding</a></li> +<li><a href="#IDX417">\fontfamily</a></li> +<li><a href="#IDX418">\fontseries</a></li> +<li><a href="#IDX419">\fontshape</a></li> +<li><a href="#IDX420">\fontsize</a></li> +<li><a href="#SEC80">\footnote</a></li> +<li><a href="#SEC81">\footnotemark</a></li> +<li><a href="#IDX406">\footnotesize</a></li> +<li><a href="#SEC82">\footnotetext</a></li> +<li><a href="#IDX277">\frac</a></li> +<li><a href="#SEC50">\frame</a></li> +<li><a href="#SEC51">\framebox</a></li> +<li><a href="#SEC111">\fussy</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> H </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexh" href="#IDX192">\height</a></li> +<li><a href="#SEC145">\hfill</a></li> +<li><a href="#SEC66">\hline</a></li> +<li><a href="#SEC146">\hrulefill</a></li> +<li><a href="#SEC147">\hspace</a></li> +<li><a href="#IDX413">\Huge</a></li> +<li><a href="#IDX412">\huge</a></li> +<li><a href="#SEC112">\hyphenation</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> I </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexi" href="#SEC168">\include</a></li> +<li><a href="#SEC169">\includeonly</a></li> +<li><a href="#SEC121">\indent</a></li> +<li><a href="#SEC170">\input</a></li> +<li><a href="#SEC43">\item</a></li> +<li><a href="#SEC43">itemize</a></li> +<li><a href="#IDX375">\itshape</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> K </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexk" href="#IDX136">\kill</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> L </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexl" href="#SEC16">\label</a></li> +<li><a href="#IDX409">\large</a></li> +<li><a href="#IDX411">\LARGE</a></li> +<li><a href="#IDX410">\Large</a></li> +<li><a href="#IDX278">\ldots</a></li> +<li><a href="#IDX74">\lefteqn</a></li> +<li><a href="#SEC44">letter</a></li> +<li><a href="#SEC52">\line</a></li> +<li><a href="#SEC113">\linebreak</a></li> +<li><a href="#SEC53">\linethickness</a></li> +<li><a href="#SEC45">list</a></li> +<li><a href="#IDX358">\listoffigures</a></li> +<li><a href="#IDX359">\listoftables</a></li> +<li><a href="#IDX204">\location</a></li> +<li><a href="#SEC156">lrbox</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> M </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexm" href="#SEC157">\makebox</a></li> +<li><a href="#SEC54">\makebox (picture)</a></li> +<li><a href="#SEC97">\makelabels</a></li> +<li><a href="#SEC132">\maketitle</a></li> +<li><a href="#SEC139">\markboth</a></li> +<li><a href="#SEC140">\markright</a></li> +<li><a href="#IDX394">\mathbf</a></li> +<li><a href="#IDX399">\mathcal</a></li> +<li><a href="#IDX397">\mathit</a></li> +<li><a href="#IDX398">\mathnormal</a></li> +<li><a href="#IDX393">\mathrm</a></li> +<li><a href="#IDX395">\mathsf</a></li> +<li><a href="#IDX396">\mathtt</a></li> +<li><a href="#IDX400">\mathversion</a></li> +<li><a href="#SEC158">\mbox</a></li> +<li><a href="#IDX378">\mdseries</a></li> +<li><a href="#SEC150">\medskip</a></li> +<li><a href="#SEC46">minipage</a></li> +<li><a href="#SEC67">\multicolumn</a></li> +<li><a href="#SEC55">\multiput</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> N </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexn" href="#SEC98">\name</a></li> +<li><a href="#SEC20">\newcommand</a></li> +<li><a href="#SEC8">\newcounter</a></li> +<li><a href="#SEC21">\newenvironment</a></li> +<li><a href="#SEC23">\newfont</a></li> +<li><a href="#SEC84">\newlength</a></li> +<li><a href="#SEC114">\newline</a></li> +<li><a href="#SEC115">\newpage</a></li> +<li><a href="#SEC159">\newsavebox</a></li> +<li><a href="#SEC22">\newtheorem</a></li> +<li><a href="#SEC72">\nocite</a></li> +<li><a href="#IDX360">\nofiles</a></li> +<li><a href="#SEC122">\noindent</a></li> +<li><a href="#SEC116">\nolinebreak</a></li> +<li><a href="#SEC117">\nopagebreak</a></li> +<li><a href="#IDX392">\normalfont</a></li> +<li><a href="#IDX408">\normalsize</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> O </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexo" href="#SEC27">\onecolumn</a></li> +<li><a href="#SEC99">\opening</a></li> +<li><a href="#SEC56">\oval</a></li> +<li><a href="#IDX279">\overbrace</a></li> +<li><a href="#IDX280">\overline</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> P </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexp" href="#SEC118">\pagebreak</a></li> +<li><a href="#SEC137">\pagenumbering</a></li> +<li><a href="#SEC17">\pageref</a></li> +<li><a href="#SEC138">\pagestyle</a></li> +<li><a href="#SEC123">\par</a></li> +<li><a href="#SEC142">\paragraph</a></li> +<li><a href="#SEC160">\parbox</a></li> +<li><a href="#SEC47">picture</a></li> +<li><a href="#SEC100">\ps</a></li> +<li><a href="#IDX137">\pushtabs</a></li> +<li><a href="#SEC57">\put</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> Q </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexq" href="#SEC60">quotation</a></li> +<li><a href="#SEC61">quote</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> R </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexr" href="#SEC28">\raggedbottom</a></li> +<li><a href="#SEC42">\raggedleft</a></li> +<li><a href="#SEC40">\raggedright</a></li> +<li><a href="#SEC161">\raisebox</a></li> +<li><a href="#SEC18">\ref</a></li> +<li><a href="#SEC9">\refstepcounter</a></li> +<li><a href="#IDX373">\rmfamily</a></li> +<li><a href="#SEC10">\roman</a></li> +<li><a href="#SEC10">\Roman</a></li> +<li><a href="#SEC162">\rule</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> S </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexs" href="#SEC163">\savebox</a></li> +<li><a href="#SEC164">\sbox</a></li> +<li><a href="#IDX405">\scriptsize</a></li> +<li><a href="#IDX388">\scshape</a></li> +<li><a href="#SEC142">\section</a></li> +<li><a href="#IDX421">\selectfont</a></li> +<li><a href="#SEC12">\setcounter</a></li> +<li><a href="#SEC85">\setlength</a></li> +<li><a href="#SEC87">\settodepth</a></li> +<li><a href="#SEC88">\settoheight</a></li> +<li><a href="#SEC89">\settowidth</a></li> +<li><a href="#IDX386">\sffamily</a></li> +<li><a href="#SEC58">\shortstack</a></li> +<li><a href="#SEC101">\signature</a></li> +<li><a href="#SEC119">\sloppy</a></li> +<li><a href="#IDX384">\slshape</a></li> +<li><a href="#IDX407">\small</a></li> +<li><a href="#SEC151">\smallskip</a></li> +<li><a href="#IDX281">\sqrt</a></li> +<li><a href="#SEC102">\startbreaks</a></li> +<li><a href="#SEC11">\stepcounter</a></li> +<li><a href="#SEC103">\stopbreaks</a></li> +<li><a href="#SEC142">\subparagraph</a></li> +<li><a href="#SEC142">\subsection</a></li> +<li><a href="#SEC142">\subsubsection</a></li> +<li><a href="#IDX347">\symbol</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> T </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indext" href="#SEC62">tabbing</a></li> +<li><a href="#SEC63">table</a></li> +<li><a href="#IDX357">\tableofcontents</a></li> +<li><a href="#SEC64">tabular</a></li> +<li><a href="#SEC104">\telephone</a></li> +<li><a href="#IDX380">\textbf</a></li> +<li><a href="#IDX375">\textit</a></li> +<li><a href="#IDX378">\textmd</a></li> +<li><a href="#IDX392">\textnormal</a></li> +<li><a href="#IDX373">\textrm</a></li> +<li><a href="#IDX388">\textsc</a></li> +<li><a href="#IDX386">\textsf</a></li> +<li><a href="#IDX384">\textsl</a></li> +<li><a href="#IDX389">\texttt</a></li> +<li><a href="#IDX381">\textup</a></li> +<li><a href="#SEC135">\thanks</a></li> +<li><a href="#SEC69">thebibliography</a></li> +<li><a href="#SEC74">theorem</a></li> +<li><a href="#SEC141">\thispagestyle</a></li> +<li><a href="#IDX404">\tiny</a></li> +<li><a href="#SEC136">\title</a></li> +<li><a href="#SEC75">titlepage</a></li> +<li><a href="#IDX165">\today</a></li> +<li><a href="#IDX194">\totalheight</a></li> +<li><a href="#IDX389">\ttfamily</a></li> +<li><a href="#SEC29">\twocolumn</a></li> +<li><a href="#SEC176">\typein</a></li> +<li><a href="#SEC177">\typeout</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> U </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexu" href="#IDX282">\underbrace</a></li> +<li><a href="#IDX283">\underline</a></li> +<li><a href="#IDX381">\upshape</a></li> +<li><a href="#SEC165">\usebox</a></li> +<li><a href="#SEC13">\usecounter</a></li> +<li><a href="#IDX422">\usefont</a></li> +<li><a href="#IDX46">\usepackage</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> V </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexv" href="#SEC14">\value</a></li> +<li><a href="#IDX284">\vdots</a></li> +<li><a href="#SEC59">\vector</a></li> +<li><a href="#SEC77">\verb</a></li> +<li><a href="#SEC76">verbatim</a></li> +<li><a href="#SEC78">verse</a></li> +<li><a href="#SEC152">\vfill</a></li> +<li><a href="#SEC68">\vline</a></li> +<li><a href="#SEC153">\vspace</a></li> +</ul> +</td> +</tr> +<tr valign="top"> +<td bgcolor="#3F5881"><b><font size="+2" color= +"white"> W </font></b></td> +<td bgcolor="#F0F0F0"> +<ul> +<li><a name="indexw" href="#SEC90">\width</a></li> +</ul> +</td> +</tr> +</table> +<br> +<br> +<hr> +<!-- HELP CONTENTS --> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC3">Counters</a></font></b></td> +</tr> +</table> +<p>Everything LaTeX numbers for you has a counter associated with +it. The name of the counter is the same as the name of the +environment or command that produces the number, except with no +<code>\</code>. (enumi - enumiv are used for the nested enumerate +environment.) Below is a list of the counters used in LaTeX's +standard document classes to control numbering.</p> +<pre> + part paragraph figure enumi + chapter subparagraph table enumii + section page footnote enumiii + subsection equation mpfootnote enumiv + subsubsection +</pre> +<ul> +<li><a href="#SEC4">\addtocounter</a>: Add a quantity to a +counter.</li> +<li><a href="#SEC5">\alph</a>: Print value of a counter using +letters.</li> +<li><a href="#SEC6">\arabic</a>: Print value of a counter using +numerals.</li> +<li><a href="#SEC7">\fnsymbol</a>: Print value of a counter using +symbols.</li> +<li><a href="#SEC8">\newcounter</a>: Define a new counter.</li> +<li><a href="#SEC9">\refstepcounter</a>: Add to counter, resetting +subsidiary counters.</li> +<li><a href="#SEC10">\roman</a>: Print value of a counter using +roman numerals.</li> +<li><a href="#SEC12">\setcounter</a>: Set the value of a +counter.</li> +<li><a href="#SEC11">\stepcounter</a>: Add to counter, resetting +subsidiary counters.</li> +<li><a href="#SEC13">\usecounter</a>: Use a specified counter in a +list environment.</li> +<li><a href="#SEC14">\value</a>: Use the value of a counter in an +expression.</li> +</ul> +<h3><a name="SEC4" href="#TOC4">\addtocounter</a></h3> +<p><code>\addtocounter{counter}{value}</code></p> +<p>The <code>\addtocounter</code> command increments the +<code>counter</code> by the amount specified by the +<code>value</code> argument. The <code>value</code> argument can be +negative.</p> +<h3><a name="SEC5" href="#TOC5">\alph</a></h3> +<p><code>\alph{counter}</code></p> +<p>This command causes the value of the <code>counter</code> to be +printed in alphabetic characters. The <code>\alph</code> command +uses lower case alphabetic alphabetic characters, i.e., <code>a, b, +c...</code> while the <code>\Alph</code> command uses upper case +alphabetic characters, i.e., <code>A, B, C...</code>.</p> +<h3><a name="SEC6" href="#TOC6">\arabic</a></h3> +<p><code>\arabic{counter}</code></p> +<p>The <code>\arabic</code> command causes the value of the +<code>counter</code> to be printed in Arabic numbers, i.e., +<code>3</code>.</p> +<h3><a name="SEC7" href="#TOC7">\fnsymbol</a></h3> +<p><code>\fnsymbol{counter}</code></p> +<p>The <code>\fnsymbol</code> command causes the value of the +<code>counter</code> to be printed in a specific sequence of nine +symbols that can be used for numbering footnotes.</p> +<p>eg. From 1-9:</p> +<p>NB. <code>counter</code> must have a value between 1 and 9 +inclusive.</p> +<h3><a name="SEC8" href="#TOC8">\newcounter</a></h3> +<p><code>\newcounter{foo}[counter]</code></p> +<p>The <code>\newcounter</code> command defines a new counter named +<code>foo</code>. The counter is initialized to zero.</p> +<p>The optional argument <code>[counter]</code> causes the counter +<code>foo</code> to be reset whenever the counter named in the +optional argument is incremented.</p> +<h3><a name="SEC9" href="#TOC9">\refstepcounter</a></h3> +<p><code>\refstepcounter{counter}</code></p> +<p>The <code>\refstepcounter</code> command works like +<code>\stepcounter</code> See section <a href= +"#SEC11">\stepcounter</a>, except it also defines the current +<code>\ref</code> value to be the result of +<code>\thecounter</code>.</p> +<h3><a name="SEC10" href="#TOC10">\roman</a></h3> +<p><code>\roman{counter}</code></p> +<p>This command causes the value of the <code>counter</code> to be +printed in Roman numerals. The <code>\roman</code> command uses +lower case Roman numerals, i.e., <code>i, ii, iii...</code>, while +the <code>\Roman</code> command uses upper case Roman numerals, +i.e., <code>I, II, III...</code>.</p> +<h3><a name="SEC11" href="#TOC11">\stepcounter</a></h3> +<p><code>\stepcounter{counter}</code></p> +<p>The <code>\stepcounter</code> command adds one to the +<code>counter</code> and resets all subsidiary counters.</p> +<h3><a name="SEC12" href="#TOC12">\setcounter</a></h3> +<p><code>\setcounter{counter}{value}</code></p> +<p>The <code>\setcounter</code> command sets the value of the +<code>counter</code> to that specified by the <code>value</code> +argument.</p> +<h3><a name="SEC13" href="#TOC13">\usecounter</a></h3> +<p><code>\usecounter{counter}</code></p> +<p>The <code>\usecounter</code> command is used in the second +argument of the <code>list</code> environment to allow the counter +specified to be used to number the list items.</p> +<h3><a name="SEC14" href="#TOC14">\value</a></h3> +<p><code>\value{counter}</code></p> +<p>The <code>\value</code> command produces the value of the +<code>counter</code> named in the mandatory argument. It can be +used where LaTeX expects an integer or number, such as the second +argument of a <code>\setcounter</code> or +<code>\addtocounter</code> command, or in:</p> +<pre> + \hspace{\value{foo}\parindent} +</pre> +<p>It is useful for doing arithmetic with counters.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC15">Cross References</a></font></b></td> +</tr> +</table> +<p>One reason for numbering things like figures and equations is to +refer the reader to them, as in "See Figure 3 for more +details."</p> +<ul> +<li><a href="#SEC16">\label</a>: Assign a symbolic name to a piece +of text.</li> +<li><a href="#SEC17">\pageref</a>: Refer to a page number.</li> +<li><a href="#SEC18">\ref</a>: Refer to a section, figure or +similar.</li> +</ul> +<h3><a name="SEC16" href="#TOC16">\label</a></h3> +<p><code>\label{key}</code></p> +<p>A <code>\label</code> command appearing in ordinary text assigns +to the <code>key</code> the number of the current sectional unit; +one appearing inside a numbered environment assigns that number to +the <code>key</code>.</p> +<p>A <code>key</code> can consist of any sequence of letters, +digits, or punctuation characters. Upper and lowercase letters are +different.</p> +<p>To avoid accidentally creating two labels with the same name, it +is common to use labels consisting of a prefix and a suffix +separated by a colon. The prefixes conventionally used are</p> +<ul> +<li><code>cha</code> for chapters</li> +<li><code>sec</code> for lower-level sectioning commands</li> +<li><code>fig</code> for figures</li> +<li><code>tab</code> for tables</li> +<li><code>eq</code> for equations</li> +</ul> +<p>Thus, a label for a figure would look like +<code>fig:bandersnatch</code>.</p> +<h3><a name="SEC17" href="#TOC17">\pageref</a></h3> +<p><code>\pageref{key}</code></p> +<p>The <code>\pageref</code> command produces the page number of +the place in the text where the corresponding <code>\label</code> +command appears. ie. where <code>\label{key}</code> appears.</p> +<h3><a name="SEC18" href="#TOC18">\ref</a></h3> +<p><code>\ref{key}</code></p> +<p>The <code>\ref</code> command produces the number of the +sectional unit, equation number, ... of the corresponding +<code>\label</code> command.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC19">Definitions</a></font></b></td> +</tr> +</table> +<ul> +<li><a href="#SEC20">\newcommand</a>: Define a new command.</li> +<li><a href="#SEC21">\newenvironment</a>: Define a new +environment.</li> +<li><a href="#SEC22">\newtheorem</a>: Define a new theorem-like +environment.</li> +<li><a href="#SEC23">\newfont</a>: Define a new font name.</li> +</ul> +<h3><a name="SEC20" href="#TOC20">\newcommand</a></h3> +<pre> + \newcommand{cmd}[args]{definition} + \newcommand{cmd}[args][default]{definition} + \renewcommand{cmd}[args]{definition} + \renewcommand{cmd}[args][default]{definition} +</pre> +<p>These commands define (or redefine) a command.</p> +<dl> +<dt><code>cmd</code></dt> +<dd>A command name beginning with a <code>\</code>. For +<code>\newcommand</code> it must not be already defined and must +not begin with <code>\end</code>; for <code>\renewcommand</code> it +must already be defined.</dd> +<dt><code>args</code></dt> +<dd>An integer from 1 to 9 denoting the number of arguments of the +command being defined. The default is for the command to have no +arguments.</dd> +<dt><code>def</code></dt> +<dd>If this optional parameter is present, it means that the +command's first argument is optional. The default value of the +optional argument is <code>def</code>.</dd> +<dt><code>definition</code></dt> +<dd>The text to be substituted for every occurrence of +<code>cmd</code>; a parameter of the form <code>#n</code> in +<code>cmd</code> is replaced by the text of the nth argument when +this substitution takes place.</dd> +</dl> +<h3><a name="SEC21" href="#TOC21">\newenvironment</a></h3> +<pre> + \newenvironment{nam}[args]{begdef}{enddef} + \newenvironment{nam}[args][default]{begdef}{enddef} + \renewenvironment{nam}[args]{begdef}{enddef} +</pre> +<p>These commands define or redefine an environment.</p> +<dl> +<dt><code>nam</code></dt> +<dd>The name of the environment. For <code>\newenvironment</code> +there must be no currently defined environment by that name, and +the command <code>\nam</code> must be undefined. For +<code>\renewenvironment</code> the environment must already be +defined.</dd> +<dt><code>args</code></dt> +<dd>An integer from 1 to 9 denoting the number of arguments of the +newly-defined environment. The default is no arguments.</dd> +<dt><code>default</code></dt> +<dd>If this is specified, the first argument is optional, and +<code>default</code> gives the default value for that +argument.</dd> +<dt><code>begdef</code></dt> +<dd>The text substituted for every occurrence of +<code>\begin{nam}</code>; a parameter of the form <code>#n</code> +in <code>cmd</code> is replaced by the text of the nth argument +when this substitution takes place.</dd> +<dt><code>enddef</code></dt> +<dd>The text substituted for every occurrence of +<code>\end{nam}</code>. It may not contain any argument +parameters.</dd> +</dl> +<h3><a name="SEC22" href="#TOC22">\newtheorem</a></h3> +<pre> + \newtheorem{env_name}{caption}[within] + \newtheorem{env_name}[numbered_like]{caption} +</pre> +<p>This command defines a theorem-like environment.</p> +<dl> +<dt><code>env_name</code></dt> +<dd>The name of the environment to be defined. A string of letters. +It must not be the name of an existing environment or counter.</dd> +<dt><code>caption</code></dt> +<dd>The text printed at the beginning of the environment, right +before the number. This may simply say "Theorem", for example.</dd> +<dt><code>within</code></dt> +<dd>The name of an already defined counter, usually of a sectional +unit. Provides a means of resetting the new theorem counter +<strong>within</strong> the sectional unit.</dd> +<dt><code>numbered_like</code></dt> +<dd>The name of an already defined theorem-like environment.</dd> +</dl> +<p>The <code>\newtheorem</code> command may have at most one +optional argument.</p> +<h3><a name="SEC23" href="#TOC23">\newfont</a></h3> +<p><code>\newfont{cmd}{font_name}</code></p> +<p>Defines the command name <code>cmd</code>, which must not be +currently defined, to be a declaration that selects the font named +<code>font_name</code> to be the current font.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC24">Document Classes</a></font></b></td> +</tr> +</table> +<p>Valid LaTeX document classes include:</p> +<ul> +<li>article</li> +<li>report</li> +<li>letter</li> +<li>book</li> +<li>slides</li> +</ul> +<p>Other document classes are often available. They are selected +with the following command:</p> +<p><code>\documentclass [options] {class}</code></p> +<p>All the standard classes (except slides) accept the following +options for selecting the typeface size (10 pt is default):</p> +<p>10pt, 11pt, 12pt</p> +<p>All classes accept these options for selecting the paper size +(default is letter):</p> +<p>a4paper, a5paper, b5paper, letterpaper, legalpaper, +executivepaper</p> +<p>Miscellaneous options:</p> +<ul> +<li>landscape -- selects landscape format. Default is +portrait.</li> +<li>titlepage, notitlepage -- selects if there should be a separate +title page.</li> +<li>leqno -- equation number on left side of equations. Default is +right side.</li> +<li>fleqn -- displayed formulas flush left. Default is +centred.</li> +<li>openbib -- use "open" bibliography format.</li> +<li>draft, final -- mark/do not mark overfull boxes with a rule. +Default is final.</li> +</ul> +<p>These options are not available with the slides class:</p> +<ul> +<li>oneside, twoside -- selects one- or twosided layout. Default is +oneside, except for the book class.</li> +<li>openright, openany -- determines if a chapter should start on a +right-hand page. Default is openright for book.</li> +<li>onecolumn, twocolumn -- one or two columns. Defaults to one +column.</li> +</ul> +<p>The slides class offers the option <code>clock</code> for +printing the time at the bottom of each note.</p> +<p>If you specify more than one option, they must be separated by a +comma.</p> +<p>Additional packages are loaded by a</p> +<p><code><a name="IDX46">\usepackage[options]{pkg}</a></code></p> +<p>command. If you specify more than one package, they must be +separated by a comma.</p> +<p>Any options given in the <code>\documentclass</code> command +that are unknown by the selected document class are passed on to +the packages loaded with <code>\usepackage</code>.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC25">Layout</a></font></b></td> +</tr> +</table> +<p>Miscellaneous commands for controlling the general layout of the +page.</p> +<ul> +<li><a href="#SEC26">\flushbottom</a>: Make all text pages the same +height.</li> +<li><a href="#SEC27">\onecolumn</a>: Use one-column layout.</li> +<li><a href="#SEC28">\raggedbottom</a>: Allow text pages of +differing height.</li> +<li><a href="#SEC29">\twocolumn</a>: Use two-column layout.</li> +</ul> +<h3><a name="SEC26" href="#TOC26">\flushbottom</a></h3> +<p>The <code>\flushbottom</code> declaration makes all text pages +the same height, adding extra vertical space when necessary to fill +out the page.</p> +<p>This is the standard if twocolumn mode is selected.</p> +<h3><a name="SEC27" href="#TOC27">\onecolumn</a></h3> +<p>The <code>\onecolumn</code> declaration starts a new page and +produces single-column output.</p> +<h3><a name="SEC28" href="#TOC28">\raggedbottom</a></h3> +<p>The <code>\raggedbottom</code> declaration makes all pages the +height of the text on that page. No extra vertical space is +added.</p> +<h3><a name="SEC29" href="#TOC29">\twocolumn</a></h3> +<p><code>\twocolumn[text]</code></p> +<p>The <code>\twocolumn</code> declaration starts a new page and +produces two-column output. If the optional <code>text</code> +argument is present, it is typeset in one-column mode.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC30">Environments</a></font></b></td> +</tr> +</table> +<p>LaTeX provides a number of different paragraph-making +environments. Each environment begins and ends in the same +manner.</p> +<pre> + \begin{environment-name} + . + . + . + \end{environment-name} +</pre> +<ul> +<li><a href="#SEC31">array</a>: Math arrays.</li> +<li><a href="#SEC32">center</a>: Centred lines.</li> +<li><a href="#SEC34">description</a>: Labelled lists.</li> +<li><a href="#SEC35">enumerate</a>: Numbered lists.</li> +<li><a href="#SEC36">eqnarray</a>: Sequences of aligned +equations.</li> +<li><a href="#SEC37">equation</a>: Displayed equation.</li> +<li><a href="#SEC38">figure</a>: Floating figures.</li> +<li><a href="#SEC39">flushleft</a>: Flushed left lines.</li> +<li><a href="#SEC41">flushright</a>: Flushed right lines.</li> +<li><a href="#SEC43">itemize</a>: Bulleted lists.</li> +<li><a href="#SEC44">letter</a>: Letters.</li> +<li><a href="#SEC45">list</a>: Generic list environment.</li> +<li><a href="#SEC46">minipage</a>: Miniature page.</li> +<li><a href="#SEC47">picture</a>: Picture with text, arrows, lines +and circles.</li> +<li><a href="#SEC60">quotation</a>: Indented environment with +paragraph indentation.</li> +<li><a href="#SEC61">quote</a>: Indented environment with no +paragraph indentation.</li> +<li><a href="#SEC62">tabbing</a>: Align text arbitrarily.</li> +<li><a href="#SEC63">table</a>: Floating tables.</li> +<li><a href="#SEC64">tabular</a>: Align text in columns.</li> +<li><a href="#SEC69">thebibliography</a>: Bibliography or reference +list.</li> +<li><a href="#SEC74">theorem</a>: Theorems, lemmas, etc.</li> +<li><a href="#SEC75">titlepage</a>: For hand crafted title +pages.</li> +<li><a href="#SEC76">verbatim</a>: Simulating typed input.</li> +<li><a href="#SEC78">verse</a>: For poetry and other things.</li> +</ul> +<h3><a name="SEC31" href="#TOC31">array</a></h3> +<pre> +\begin{array}{col1col2...coln} +column 1 entry & column 2 entry ... & column n entry \\ + . + . + . +\end{array} +</pre> +<p>Math arrays are produced with the array environment. It has a +single mandatory argument describing the number of columns and the +alignment within them. Each column, <code>coln</code>, is specified +by a single letter that tells how items in that row should be +formatted.</p> +<ul> +<li><code>c</code> -- for centred</li> +<li><code>l</code> -- for flush left</li> +<li><code>r</code> -- for flush right</li> +</ul> +<p>Column entries must be separated by an <code>&</code>. +Column entries may include other LaTeX commands. Each row of the +array must be terminated with the string <code>\\</code>.</p> +<p>Note that the <code>array</code> environment can only be used in +math mode, so normally it is used inside an <code>equation</code> +environment.</p> +<h3><a name="SEC32" href="#TOC32">center</a></h3> +<pre> + \begin{center} + Text on line 1 \\ + Text on line 2 \\ + . + . + . + \end{center} +</pre> +<p>The <code>center</code> environment allows you to create a +paragraph consisting of lines that are centred within the left and +right margins on the current page. Each line must be terminated +with the string <code>\\</code>.</p> +<ul> +<li><a href="#SEC33">\centering</a>: The declaration form of the +<code>center</code> environment.</li> +</ul> +<h4><a name="SEC33" href="#TOC33">\centering</a></h4> +<p>This declaration corresponds to the <code>center</code> +environment. This declaration can be used inside an environment +such as <code>quote</code> or in a <code>parbox</code>. The text of +a figure or table can be centred on the page by putting a +<code>\centering</code> command at the beginning of the figure or +table environment.</p> +<p>Unlike the <code>center</code> environment, the +<code>\centering</code> command does not start a new paragraph; it +simply changes how LaTeX formats paragraph units. To affect a +paragraph unit's format, the scope of the declaration must contain +the blank line or <code>\end</code> command (of an environment like +quote) that ends the paragraph unit.</p> +<h3><a name="SEC34" href="#TOC34">description</a></h3> +<pre> + \begin{description} + \item [label] First item + \item [label] Second item + . + . + . + \end{description} +</pre> +<p>The <code>description</code> environment is used to make +labelled lists. The <code>label</code> is bold face and flushed +right.</p> +<h3><a name="SEC35" href="#TOC35">enumerate</a></h3> +<p><a name="IDX69"></a> <a name="IDX70"></a></p> +<pre> + \begin{enumerate} + \item First item + \item Second item + . + . + . + \end{enumerate} +</pre> +<p>The <code>enumerate</code> environment produces a numbered list. +Enumerations can be nested within one another, up to four levels +deep. They can also be nested within other paragraph-making +environments.</p> +<p>Each item of an enumerated list begins with an +<code>\item</code> command. There must be at least one +<code>\item</code> command within the environment.</p> +<p>The <code>enumerate</code> environment uses the +<code>enumi</code> through <code>enumiv</code> counters (see +section <a href="#SEC3">Counters</a>). The type of numbering can be +changed by redefining <code>\theenumi</code> etc.</p> +<h3><a name="SEC36" href="#TOC36">eqnarray</a></h3> +<p><a name="IDX71"></a> <a name="IDX72"></a> <a name= +"IDX73"></a></p> +<pre> + \begin{eqnarray} + math formula 1 \\ + math formula 2 \\ + . + . + . + \end{eqnarray} +</pre> +<p>The <code>eqnarray</code> environment is used to display a +sequence of equations or inequalities. It is very much like a +three-column <code>array</code> environment, with consecutive rows +separated by <code>\\</code> and consecutive items within a row +separated by an <code>&</code>.</p> +<p>An equation number is placed on every line unless that line has +a <code>\nonumber</code> command.</p> +<p>The command <code><a name="IDX74">\lefteqn</a></code> is used +for splitting long formulas across lines. It typesets its argument +in display style flush left in a box of zero width.</p> +<h3><a name="SEC37" href="#TOC37">equation</a></h3> +<p><a name="IDX75"></a> <a name="IDX76"></a> <a name= +"IDX77"></a></p> +<pre> + \begin{equation} + math formula + \end{equation} +</pre> +<p>The <code>equation</code> environment centres your equation on +the page and places the equation number in the right margin.</p> +<h3><a name="SEC38" href="#TOC38">figure</a></h3> +<p><a name="IDX78"></a> <a name="IDX79"></a></p> +<pre> + \begin{figure}[placement] + + body of the figure + + <a name="IDX80">\caption{figure title}</a> + \end{figure} +</pre> +<p>Figures are objects that are not part of the normal text, and +are usually "floated" to a convenient place, like the top of a +page. Figures will not be split between two pages.</p> +<p>The optional argument <code>[placement]</code> determines where +LaTeX will try to place your figure. There are four places where +LaTeX can possibly put a float:</p> +<ol> +<li><code>h</code> (Here) - at the position in the text where the +figure environment appears.</li> +<li><code>t</code> (Top) - at the top of a text page.</li> +<li><code>b</code> (Bottom) - at the bottom of a text page.</li> +<li><code>p</code> (Page of floats) - on a separate float page, +which is a page containing no text, only floats.</li> +</ol> +<p>The standard report and article classes use the default +placement <code>tbp</code>.</p> +<p>The body of the figure is made up of whatever text, LaTeX +commands, etc. you wish. The <code>\caption</code> command allows +you to title your figure.</p> +<h3><a name="SEC39" href="#TOC39">flushleft</a></h3> +<p><a name="IDX81"></a> <a name="IDX82"></a> <a name= +"IDX83"></a></p> +<pre> + \begin{flushleft} + Text on line 1 \\ + Text on line 2 \\ + . + . + . + \end{flushleft} +</pre> +<p>The <code>flushleft</code> environment allows you to create a +paragraph consisting of lines that are flushed left, to the +left-hand margin. Each line must be terminated with the string +<code>\\</code>.</p> +<ul> +<li><a href="#SEC40">\raggedright</a>: The declaration form of the +<code>flushleft</code> environment.</li> +</ul> +<h4><a name="SEC40" href="#TOC40">\raggedright</a></h4> +<p><a name="IDX84"></a> <a name="IDX85"></a> <a name="IDX86"></a> +<a name="IDX87"></a></p> +<p>This declaration corresponds to the <code>flushleft</code> +environment. This declaration can be used inside an environment +such as <code>quote</code> or in a <code>parbox</code>.</p> +<p>Unlike the <code>flushleft</code> environment, the +<code>\raggedright</code> command does not start a new paragraph; +it simply changes how LaTeX formats paragraph units. To affect a +paragraph unit's format, the scope of the declaration must contain +the blank line or <code>\end</code> command (of an environment like +quote) that ends the paragraph unit.</p> +<h3><a name="SEC41" href="#TOC41">flushright</a></h3> +<p><a name="IDX88"></a> <a name="IDX89"></a> <a name= +"IDX90"></a></p> +<pre> + \begin{flushright} + Text on line 1 \\ + Text on line 2 \\ + . + . + . + \end{flushright} +</pre> +<p>The <code>flushright</code> environment allows you to create a +paragraph consisting of lines that are flushed right, to the +right-hand margin. Each line must be terminated with the string +<code>\\</code>.</p> +<ul> +<li><a href="#SEC42">\raggedleft</a>: The declaration form of the +<code>flushright</code> environment.</li> +</ul> +<h4><a name="SEC42" href="#TOC42">\raggedleft</a></h4> +<p><a name="IDX91"></a> <a name="IDX92"></a> <a name="IDX93"></a> +<a name="IDX94"></a></p> +<p>This declaration corresponds to the <code>flushright</code> +environment. This declaration can be used inside an environment +such as <code>quote</code> or in a <code>parbox</code>.</p> +<p>Unlike the <code>flushright</code> environment, the +<code>\raggedleft</code> command does not start a new paragraph; it +simply changes how LaTeX formats paragraph units. To affect a +paragraph unit's format, the scope of the declaration must contain +the blank line or <code>\end</code> command (of an environment like +quote) that ends the paragraph unit.</p> +<h3><a name="SEC43" href="#TOC43">itemize</a></h3> +<p><a name="IDX95"></a> <a name="IDX96"></a> <a name= +"IDX97"></a></p> +<pre> + \begin{itemize} + \item First item + \item Second item + . + . + . + \end{itemize} +</pre> +<p>The <code>itemize</code> environment produces a "bulleted" list. +Itemizations can be nested within one another, up to four levels +deep. They can also be nested within other paragraph-making +environments.</p> +<p>Each item of an <code>itemized</code> list begins with an +<code>\item</code> command. There must be at least one +<code>\item</code> command within the environment.</p> +<p>The <code>itemize</code> environment uses the <code>itemi</code> +through <code>itemiv</code> counters (see section <a href= +"#SEC3">Counters</a>). The type of numbering can be changed by +redefining <code>\theitemi</code> etc.</p> +<h3><a name="SEC44" href="#TOC44">letter</a></h3> +<p><a name="IDX98"></a></p> +<p>This environment is used for creating letters. See section +<a href="#SEC91">Letters</a>.</p> +<h3><a name="SEC45" href="#TOC45">list</a></h3> +<p><a name="IDX99"></a> <a name="IDX100"></a></p> +<p>The <code>list</code> environment is a generic environment which +is used for defining many of the more specific environments. It is +seldom used in documents, but often in macros.</p> +<pre> + \begin{list}{label}{spacing} + \item First item + \item Second item + . + . + . + \end{list} +</pre> +<p>The <code>{label}</code> argument specifies how items should be +labelled. This argument is a piece of text that is inserted in a +box to form the label. This argument can and usually does contain +other LaTeX commands.</p> +<p>The <code>{spacing}</code> argument contains commands to change +the spacing parameters for the list. This argument will most often +be null, i.e., <code>{}</code>. This will select all default +spacing which should suffice for most cases.</p> +<h3><a name="SEC46" href="#TOC46">minipage</a></h3> +<p><a name="IDX101"></a> <a name="IDX102"></a> <a name= +"IDX103"></a> <a name="IDX104"></a></p> +<pre> + \begin{minipage}[position]{width} + text + \end{minipage} +</pre> +<p>The <code>minipage</code> environment is similar to a +<code>\parbox</code> command. It takes the same optional +<code>position</code> argument and mandatory <code>width</code> +argument. You may use other paragraph-making environments inside a +minipage.</p> +<p>Footnotes in a <code>minipage</code> environment are handled in +a way that is particularly useful for putting footnotes in figures +or tables. A <code>\footnote</code> or <code>\footnotetext</code> +command puts the footnote at the bottom of the minipage instead of +at the bottom of the page, and it uses the <code>mpfootnote</code> +counter instead of the ordinary <code>footnote</code> counter See +section <a href="#SEC3">Counters</a>.</p> +<p>NOTE: Don't put one minipage inside another if you are using +footnotes; they may wind up at the bottom of the wrong +minipage.</p> +<h3><a name="SEC47" href="#TOC47">picture</a></h3> +<p><a name="IDX105"></a> <a name="IDX106"></a> <a name= +"IDX107"></a></p> +<pre> + \begin{picture}(width,height)(x offset,y offset) + . + . + picture commands + . + . + \end{picture} +</pre> +<p>The <code>picture</code> environment allows you to create just +about any kind of picture you want containing text, lines, arrows +and circles. You tell LaTeX where to put things in the picture by +specifying their coordinates. A coordinate is a number that may +have a decimal point and a minus sign -- a number like +<code>5</code>, <code>2.3</code> or <code>-3.1416</code>. A +coordinate specifies a length in multiples of the unit length +<code>\unitlength</code>, so if <code>\unitlength</code> has been +set to <code>1cm</code>, then the coordinate 2.54 specifies a +length of 2.54 centimetres. You can change the value of +<code>\unitlength</code> anywhere you want, using the +<code>\setlength</code> command, but strange things will happen if +you try changing it inside the picture environment.</p> +<p>A position is a pair of coordinates, such as +<code>(2.4,-5)</code>, specifying the point with x-coordinate +<code>2.4</code> and y-coordinate <code>-5</code>. Coordinates are +specified in the usual way with respect to an origin, which is +normally at the lower-left corner of the picture. Note that when a +position appears as an argument, it is not enclosed in braces; the +parentheses serve to delimit the argument.</p> +<p>The <code>picture</code> environment has one mandatory argument, +which is a <code>position</code>. It specifies the size of the +picture. The environment produces a rectangular box with width and +height determined by this argument's x- and y-coordinates.</p> +<p>The <code>picture</code> environment also has an optional +<code>position</code> argument, following the <code>size</code> +argument, that can change the origin. (Unlike ordinary optional +arguments, this argument is not contained in square brackets.) The +optional argument gives the coordinates of the point at the +lower-left corner of the picture (thereby determining the origin). +For example, if <code>\unitlength</code> has been set to +<code>1mm</code>, the command</p> +<pre> + \begin{picture}(100,200)(10,20) +</pre> +<p>produces a picture of width 100 millimeters and height 200 +millimeters, whose lower-left corner is the point (10,20) and whose +upper-right corner is therefore the point (110,220). When you first +draw a picture, you will omit the optional argument, leaving the +origin at the lower-left corner. If you then want to modify your +picture by shifting everything, you just add the appropriate +optional argument.</p> +<p>The environment's mandatory argument determines the nominal size +of the picture. This need bear no relation to how large the picture +really is; LaTeX will happily allow you to put things outside the +picture, or even off the page. The picture's nominal size is used +by LaTeX in determining how much room to leave for it.</p> +<p>Everything that appears in a picture is drawn by the +<code>\put</code> command. The command</p> +<pre> + \put (11.3,-.3){...} +</pre> +<p>puts the object specified by <code>...</code> in the picture, +with its reference point at coordinates (11.3,-.3). The reference +points for various objects will be described below.</p> +<p>The <code>\put</code> command creates an <strong>LR +box</strong>. You can put anything in the text argument of the +<code>\put</code> command that you'd put into the argument of an +<code>\mbox</code> and related commands. When you do this, the +reference point will be the lower left corner of the box.</p> +<p>Picture commands:</p> +<ul> +<li><a href="#SEC48">\circle</a>: Draw a circle.</li> +<li><a href="#SEC49">\dashbox</a>: Draw a dashed box.</li> +<li><a href="#SEC50">\frame</a>: Draw a frame around an +object.</li> +<li><a href="#SEC51">\framebox (picture)</a>: Draw a box with a +frame around it.</li> +<li><a href="#SEC52">\line</a>: Draw a straight line.</li> +<li><a href="#SEC53">\linethickness</a>: Set the line +thickness.</li> +<li><a href="#SEC54">\makebox (picture)</a>: Draw a box of the +specified size.</li> +<li><a href="#SEC55">\multiput</a>: Draw multiple instances of an +object.</li> +<li><a href="#SEC56">\oval</a>: Draw an ellipse.</li> +<li><a href="#SEC57">\put</a>: Place an object at a specified +place.</li> +<li><a href="#SEC58">\shortstack</a>: Make a pile of objects.</li> +<li><a href="#SEC59">\vector</a>: Draw a line with an arrow.</li> +</ul> +<h4><a name="SEC48" href="#TOC48">\circle</a></h4> +<p><a name="IDX108"></a></p> +<p><code>\circle[*]{diameter}</code></p> +<p>The <code>\circle</code> command produces a circle with a +diameter as close to the specified one as possible. If the +<code>*</code>-form of the command is used, LaTeX draws a solid +circle.</p> +<p>Note that only circles up to 40 pt can be drawn.</p> +<h4><a name="SEC49" href="#TOC49">\dashbox</a></h4> +<p><a name="IDX109"></a></p> +<p>Draws a box with a dashed line.</p> +<p><code>\dashbox{dash_length}(width,height){...}</code></p> +<p>The <code>\dashbox</code> has an extra argument which specifies +the width of each dash. A dashed box looks best when the +<code>width</code> and <code>height</code> are multiples of the +<code>dash_length</code>.</p> +<h4><a name="SEC50" href="#TOC50">\frame</a></h4> +<p><a name="IDX110"></a></p> +<p><code>\frame{...}</code></p> +<p>The <code>\frame</code> command puts a rectangular frame around +the object specified in the argument. The reference point is the +bottom left corner of the frame. No extra space is put between the +frame and the object.</p> +<h4><a name="SEC51" href="#TOC51">\framebox</a></h4> +<p><a name="IDX111"></a></p> +<p><code>\framebox(width,height)[position]{...}</code></p> +<p>The <code>\framebox</code> command is exactly the same as the +<code>\makebox</code> command, except that it puts a frame around +the outside of the box that it creates.</p> +<p>The <code>framebox</code> command produces a rule of thickness +<code>\fboxrule</code>, and leaves a space <code>\fboxsep</code> +between the rule and the contents of the box.</p> +<h4><a name="SEC52" href="#TOC52">\line</a></h4> +<p><a name="IDX112"></a></p> +<p><code>\line(x slope,y slope){length}</code></p> +<p>The <code>\line</code> command draws a line of the specified +<code>length</code> and <code>slope</code>.</p> +<p>Note that LaTeX can only draw lines with slope = x/y, where x +and y have integer values from -6 through 6.</p> +<h4><a name="SEC53" href="#TOC53">\linethickness</a></h4> +<p><a name="IDX113"></a></p> +<p><code>\linethickness{dimension}</code></p> +<p>Declares the thickness of horizontal and vertical lines in a +picture environment to be <code>dimension</code>, which must be a +positive length. It does not affect the thickness of slanted lines +and circles, or the quarter circles drawn by <code>\oval</code> to +form the corners of an oval.</p> +<h4><a name="SEC54" href="#TOC54">\makebox</a></h4> +<p><a name="IDX114"></a></p> +<p><code>\makebox(width,height)[position]{...}</code></p> +<p>The <code>\makebox</code> command for the picture environment is +similar to the normal <code>\makebox</code> command except that you +must specify a <code>width</code> and <code>height</code> in +multiples of <code>\unitlength</code>.</p> +<p>The optional argument, <code>[position]</code>, specifies the +quadrant that your text appears in. You may select up to two of the +following:</p> +<ul> +<li><code>t</code> - Moves the item to the top of the +rectangle</li> +<li><code>b</code> - Moves the item to the bottom</li> +<li><code>l</code> - Moves the item to the left</li> +<li><code>r</code> - Moves the item to the right</li> +</ul> +<p>See section <a href="#SEC157">\makebox</a>.</p> +<h4><a name="SEC55" href="#TOC55">\multiput</a></h4> +<p><a name="IDX115"></a></p> +<p><code>\multiput(x coord,y coord)(delta x,delta y){number of +copies}{object}</code></p> +<p>The <code>\multiput</code> command can be used when you are +putting the same object in a regular pattern across a picture.</p> +<h4><a name="SEC56" href="#TOC56">\oval</a></h4> +<p><a name="IDX116"></a></p> +<p><code>\oval(width,height)[portion]</code></p> +<p>The <code>\oval</code> command produces a rectangle with rounded +corners. The optional argument, <code>[portion]</code>, allows you +to select part of the oval.</p> +<ul> +<li><code>t</code> - Selects the top portion</li> +<li><code>b</code> - Selects the bottom portion</li> +<li><code>r</code> - Selects the right portion</li> +<li><code>l</code> - Selects the left portion</li> +</ul> +<p>Note that the "corners" of the oval are made with quarter +circles with a maximum radius of 20 pt, so large "ovals" will look +more like boxes with rounded corners.</p> +<h4><a name="SEC57" href="#TOC57">\put</a></h4> +<p><a name="IDX117"></a></p> +<p><code>\put(x coord,y coord){ ... }</code></p> +<p>The <code>\put</code> command places the item specified by the +mandatory argument at the given coordinates.</p> +<h4><a name="SEC58" href="#TOC58">\shortstack</a></h4> +<p><a name="IDX118"></a></p> +<p><code>\shortstack[position]{... \\ ... \\ ...}</code></p> +<p>The <code>\shortstack</code> command produces a stack of +objects. The valid positions are:</p> +<ul> +<li><code>r</code> - Moves the objects to the right of the +stack</li> +<li><code>l</code> - Moves the objects to the left of the +stack</li> +<li><code>c</code> - Moves the objects to the center of the stack +(default)</li> +</ul> +<h4><a name="SEC59" href="#TOC59">\vector</a></h4> +<p><a name="IDX119"></a></p> +<p><code>\vector(x slope,y slope){length}</code></p> +<p>The <code>\vector</code> command draws a line with an arrow of +the specified length and slope. The <code>x</code> and +<code>y</code> values must lie between -4 and +4, inclusive.</p> +<h3><a name="SEC60" href="#TOC60">quotation</a></h3> +<p><a name="IDX120"></a> <a name="IDX121"></a> <a name= +"IDX122"></a></p> +<pre> + \begin{quotation} + text + \end{quotation} +</pre> +<p>The margins of the <code>quotation</code> environment are +indented on the left and the right. The text is justified at both +margins and there is paragraph indentation. Leaving a blank line +between text produces a new paragraph.</p> +<h3><a name="SEC61" href="#TOC61">quote</a></h3> +<p><a name="IDX123"></a> <a name="IDX124"></a> <a name= +"IDX125"></a></p> +<pre> + \begin{quote} + text + \end{quote} +</pre> +<p>The margins of the <code>quote</code> environment are indented +on the left and the right. The text is justified at both margins. +Leaving a blank line between text produces a new paragraph.</p> +<h3><a name="SEC62" href="#TOC62">tabbing</a></h3> +<p><a name="IDX126"></a> <a name="IDX127"></a> <a name= +"IDX128"></a></p> +<pre> + \begin{tabbing} + text \= more text \= still more text \= last text \\ + second row \> \> more \\ + . + . + . + \end{tabbing} +</pre> +<p>The <code>tabbing</code> environment provides a way to align +text in columns. It works by setting tab stops and tabbing to them +much the way you do with an ordinary typewriter.</p> +<p>It is best suited for cases where the width of each column is +constant and known in advance.</p> +<p>This environment can be broken across pages, unlike the +<code>tabular</code> environment.</p> +<p>The following commands can be used inside a <code>tabbing</code> +environment:</p> +<dl> +<dt><code><a name="IDX129">\=</a></code></dt> +<dd>Sets a tab stop at the current position.</dd> +<dt><code><a name="IDX130">\></a></code></dt> +<dd>Advances to the next tab stop.</dd> +<dt><code><a name="IDX131">\<</a></code></dt> +<dd>This command allows you to put something to the left of the +local margin without changing the margin. Can only be used at the +start of the line.</dd> +<dt><code><a name="IDX132">\+</a></code></dt> +<dd>Moves the left margin of the next and all the following +commands one tab stop to the right.</dd> +<dt><code><a name="IDX133">\-</a></code></dt> +<dd>Moves the left margin of the next and all the following +commands one tab stop to the left.</dd> +<dt><code><a name="IDX134">\'</a></code></dt> +<dd>Moves everything that you have typed so far in the current +column, i.e. everything from the most recent <code>\></code>, +<code>\<</code>, <code>\'</code>, <code>\\</code>, or +<code>\kill</code> command, to the right of the previous column, +flush against the current column's tab stop.</dd> +<dt><code><a name="IDX135">\`</a></code></dt> +<dd>Allows you to put text flush right against any tab stop, +including tab stop 0. However, it can't move text to the right of +the last column because there's no tab stop there. The +<code>\`</code> command moves all the text that follows it, up to +the <code>\\</code> or <code>\end{tabbing}</code> command that ends +the line, to the right margin of the tabbing environment. There +must be no <code>\></code> or <code>\'</code> command between +the <code>\`</code> and the command that ends the line.</dd> +<dt><code><a name="IDX136">\kill</a></code></dt> +<dd>Sets tab stops without producing text. Works just like +<code>\\</code> except that it throws away the current line instead +of producing output for it. The effect of any <code>\=</code>, +<code>\+</code> or <code>\-</code> commands in that line remain in +effect.</dd> +<dt><code><a name="IDX137">\pushtabs</a></code></dt> +<dd>Saves all current tab stop positions. Useful for temporarily +changing tab stop positions in the middle of a <code>tabbing</code> +environment.</dd> +<dt><code><a name="IDX138">\pushtabs</a></code></dt> +<dd>Restores the tab stop positions saved by the last +<code>\pushtabs</code>.</dd> +<dt><code><a name="IDX139">\a</a></code></dt> +<dd>In a <code>tabbing</code> environment, the commands +<code>\=</code>, <code>\'</code> and <code>\`</code> do not produce +accents as normal. Instead, the commands <code>\a=</code>, +<code>\a'</code> and <code>\a`</code> are used.</dd> +</dl> +<p>This example typesets a Pascal function in a traditional +format:</p> +<pre> + \begin{tabbing} + function \= fact(n : integer) : integer;\\ + \> begin \= \+ \\ + \> if \= n $>$ 1 then \+ \\ + fact := n * fact(n-1) \- \\ + else \+ \\ + fact := 1; \-\- \\ + end;\\ + \end{tabbing} +</pre> +<h3><a name="SEC63" href="#TOC63">table</a></h3> +<p><a name="IDX140"></a> <a name="IDX141"></a> <a name= +"IDX142"></a></p> +<pre> + \begin{table}[placement] + + body of the table + + \caption{table title} + \end{table} +</pre> +<p>Tables are objects that are not part of the normal text, and are +usually "floated" to a convenient place, like the top of a page. +Tables will not be split between two pages.</p> +<p>The optional argument <code>[placement]</code> determines where +LaTeX will try to place your table. There are four places where +LaTeX can possibly put a float:</p> +<ul> +<li><code>h</code> : Here - at the position in the text where the +table environment appears.</li> +<li><code>t</code> : Top - at the top of a text page.</li> +<li><code>b</code> : Bottom - at the bottom of a text page.</li> +<li><code>p</code> : Page of floats - on a separate float page, +which is a page containing no text, only floats.</li> +</ul> +<p>The standard <code>report</code> and <code>article</code> +classes use the default placement <code>[tbp]</code>.</p> +<p>The body of the table is made up of whatever text, LaTeX +commands, etc., you wish. The <code>\caption</code> command allows +you to title your table.</p> +<h3><a name="SEC64" href="#TOC64">tabular</a></h3> +<p><a name="IDX143"></a> <a name="IDX144"></a> <a name= +"IDX145"></a></p> +<pre> + \begin{tabular}[pos]{cols} + column 1 entry & column 2 entry ... & column n entry \\ + . + . + . + \end{tabular} +</pre> +<p>or</p> +<pre> + \begin{tabular*}{width}[pos]{cols} + column 1 entry & column 2 entry ... & column n entry \\ + . + . + . + \end{tabular*} +</pre> +<p>These environments produce a box consisting of a sequence of +rows of items, aligned vertically in columns. The mandatory and +optional arguments consist of:</p> +<dl> +<dt><code>width</code></dt> +<dd>Specifies the width of the <code>tabular*</code> environment. +There must be rubber space between columns that can stretch to fill +out the specified width.</dd> +<dt><code>pos</code></dt> +<dd>Specifies the vertical position; default is alignment on the +center of the environment. +<ul> +<li><code>t</code> - align on top row</li> +<li><code>b</code> - align on bottom row</li> +</ul> +</dd> +<dt><code>cols</code></dt> +<dd>Specifies the column formatting. It consists of a sequence of +the following specifiers, corresponding to the sequence of columns +and intercolumn material. +<ul> +<li><code>l</code> - A column of left-aligned items.</li> +<li><code>r</code> - A column of right-aligned items.</li> +<li><code>c</code> - A column of centred items.</li> +<li><code>|</code> - A vertical line the full height and depth of +the environment.</li> +<li><code>@{text}</code> - This inserts <code>text</code> in every +row. An @-expression suppresses the intercolumn space normally +inserted between columns; any desired space between the inserted +text and the adjacent items must be included in text. An +<code>\extracolsep{wd}</code> command in an @-expression causes an +extra space of width <code>wd</code> to appear to the left of all +subsequent columns, until countermanded by another +<code>\extracolsep</code> command. Unlike ordinary intercolumn +space, this extra space is not suppressed by an @-expression. An +<code>\extracolsep</code> command can be used only in an +@-expression in the <code>cols</code> argument.</li> +<li><code>p{wd}</code> - Produces a column with each item typeset +in a parbox of width <code>wd</code>, as if it were the argument of +a <code>\parbox[t]{wd}</code> command. However, a <code>\\</code> +may not appear in the item, except in the following situations: +<ol> +<li>inside an environment like <code>minipage</code>, +<code>array</code>, or <code>tabular</code>.</li> +<li>inside an explicit <code>\parbox</code>.</li> +<li>in the scope of a <code>\centering</code>, +<code>\raggedright</code>, or <code>\raggedleft</code> declaration. +The latter declarations must appear inside braces or an environment +when used in a <code>p</code>-column element.</li> +</ol> +</li> +<li><code>*{num}{cols}</code> - Equivalent to <code>num</code> +copies of <code>cols</code>, where <code>num</code> is any positive +integer and <code>cols</code> is any list of column-specifiers, +which may contain another <code>*-expression</code>.</li> +</ul> +</dd> +</dl> +<p>These commands can be used inside a <code>tabular</code> +environment:</p> +<ul> +<li><a href="#SEC65">\cline</a>: Draw a horizontal line spanning +some columns.</li> +<li><a href="#SEC66">\hline</a>: Draw a horizontal line spanning +all columns.</li> +<li><a href="#SEC67">\multicolumn</a>: Make an item spanning +several columns.</li> +<li><a href="#SEC68">\vline</a>: Draw a vertical line.</li> +</ul> +<h4><a name="SEC65" href="#TOC65">\cline</a></h4> +<p><a name="IDX146"></a></p> +<p><code>\cline{i-j}</code></p> +<p>The <code>\cline</code> command draws horizontal lines across +the columns specified, beginning in column <code>i</code> and +ending in column <code>j</code>, which are identified in the +mandatory argument.</p> +<h4><a name="SEC66" href="#TOC66">\hline</a></h4> +<p><a name="IDX147"></a></p> +<p>The <code>\hline</code> command will draw a horizontal line the +width of the table. It's most commonly used to draw a line at the +top, bottom, and between the rows of the table.</p> +<h4><a name="SEC67" href="#TOC67">\multicolumn</a></h4> +<p><a name="IDX148"></a></p> +<p><code>\multicolumn{cols}{pos}{text}</code></p> +<p>The <code>\multicolumn</code> is used to make an entry that +spans several columns. The first mandatory argument, +<code>cols</code>, specifies the number of columns to span. The +second mandatory argument, <code>pos</code>, specifies the +formatting of the entry; <code>c</code> for centred, <code>l</code> +for flushleft, <code>r</code> for flushright. The third mandatory +argument, <code>text</code>, specifies what text is to make up the +entry.</p> +<h4><a name="SEC68" href="#TOC68">\vline</a></h4> +<p><a name="IDX149"></a></p> +<p>The <code>\vline</code> command will draw a vertical line +extending the full height and depth of its row. An +<code>\hfill</code> command can be used to move the line to the +edge of the column. It can also be used in an @-expression.</p> +<h3><a name="SEC69" href="#TOC69">thebibliography</a></h3> +<p><a name="IDX150"></a> <a name="IDX151"></a></p> +<pre> + \begin{thebibliography}{widest-label} + \bibitem[label]{cite_key} + . + . + . + \end{thebibliography} +</pre> +<p>The <code>thebibliography</code> environment produces a +bibliography or reference list. In the <code>article</code> class, +this reference list is labelled "References"; in the +<code>report</code> class, it is labelled "Bibliography".</p> +<ul> +<li><code>widest-label</code>: Text that, when printed, is +approximately as wide as the widest item label produces by the +<code>\bibitem</code> commands.</li> +</ul> +<ul> +<li><a href="#SEC70">\bibitem</a>: Specify a bibliography +item.</li> +<li><a href="#SEC71">\cite</a>: Refer to a bibliography item.</li> +<li><a href="#SEC72">\nocite</a>: Include an item in the +bibliography.</li> +<li><a href="#SEC73">Using BibTeX</a>: Automatic generation of +bibliographies.</li> +</ul> +<h4><a name="SEC70" href="#TOC70">\bibitem</a></h4> +<p><a name="IDX152"></a></p> +<p><code>\bibitem[label]{cite_key}</code></p> +<p>The <code>\bibitem</code> command generates an entry labelled by +<code>label</code>. If the <code>label</code> argument is missing, +a number is generated as the <code>label</code>, using the +<code>enumi</code> counter. The <code>cite_key</code> is any +sequence of letters, numbers, and punctuation symbols not +containing a comma. This command writes an entry on the +<tt>`.aux'</tt> file containing <code>cite_key</code> and the +item's <code>label</code>. When this <tt>`.aux'</tt> file is read +by the <code>\begin{document}</code> command, the item's +<code>label</code> is associated with <code>cite_key</code>, +causing the reference to <code>cite_key</code> by a +<code>\cite</code> command to produce the associated +<code>label</code>.</p> +<h4><a name="SEC71" href="#TOC71">\cite</a></h4> +<p><a name="IDX153"></a></p> +<p><code>\cite[text]{key_list}</code></p> +<p>The <code>key_list</code> argument is a list of citation keys. +This command generates an in-text citation to the references +associated with the keys in <code>key_list</code> by entries on the +<tt>`.aux'</tt> file read by the <code>\begin{document}</code> +command.</p> +<p>The optional <code>text</code> argument will appear after the +citation, i.e. <code>\cite[p. 2]{knuth}</code> might produce +`[Knuth, p. 2]'.</p> +<h4><a name="SEC72" href="#TOC72">\nocite</a></h4> +<p><a name="IDX154"></a></p> +<p><code>\nocite{key_list}</code></p> +<p>The <code>\nocite</code> command produces no text, but writes +<code>key_list</code>, which is a list of one or more citation +keys, on the <tt>`.aux'</tt> file.</p> +<h4><a name="SEC73" href="#TOC73">Using BibTeX</a></h4> +<p><a name="IDX155"></a> <a name="IDX156"></a> <a name= +"IDX157"></a> <a name="IDX158"></a> <a name="IDX159"></a></p> +<p>If you use the BibTeX program by Oren Patashnik (highly +recommended if you need a bibliography of more than a couple of +titles) to maintain your bibliography, you don't use the +<code>thebibliography</code> environment. Instead, you include the +lines</p> +<pre> + \bibliographystyle{style} + \bibliography{bibfile} +</pre> +<p>where <code>style</code> refers to a file +<code>style.bst</code>, which defines how your citations will look. +The standard styles distributed with BibTeX are:</p> +<dl> +<dt><code>alpha</code></dt> +<dd>Sorted alphabetically. Labels are formed from name of author +and year of publication.</dd> +<dt><code>plain</code></dt> +<dd>Sorted alphabetically. Labels are numeric.</dd> +<dt><code>unsrt</code></dt> +<dd>Like <code>plain</code>, but entries are in order of +citation.</dd> +<dt><code>abbrv</code></dt> +<dd>Like <code>plain</code>, but more compact labels.</dd> +</dl> +<p>In addition, numerous other BibTeX style files exist tailored to +the demands of various publications.</p> +<p>The argument to <code>\bibliography</code> refers to the file +<code>bibfile.bib</code>, which should contain your database in +BibTeX format. Only the entries referred to via <code>\cite</code> +and <code>\nocite</code> will be listed in the bibliography.</p> +<h3><a name="SEC74" href="#TOC74">theorem</a></h3> +<p><a name="IDX160"></a> <a name="IDX161"></a></p> +<pre> + \begin{theorem} + theorem text + \end{theorem} +</pre> +<p>The <code>theorem</code> environment produces "Theorem x" in +boldface followed by your theorem text.</p> +<h3><a name="SEC75" href="#TOC75">titlepage</a></h3> +<p><a name="IDX162"></a> <a name="IDX163"></a> <a name= +"IDX164"></a></p> +<pre> + \begin{titlepage} + text + \end{titlepage} +</pre> +<p>The <code>titlepage</code> environment creates a title page, +i.e. a page with no printed page number or heading. It also causes +the following page to be numbered page one. Formatting the title +page is left to you. The <code><a name="IDX165">\today</a></code> +command comes in handy for title pages.</p> +<p>Note that you can use the <code>\maketitle</code> (see section +<a href="#SEC132">\maketitle</a>) command to produce a standard +title page.</p> +<h3><a name="SEC76" href="#TOC76">verbatim</a></h3> +<p><a name="IDX166"></a> <a name="IDX167"></a> <a name= +"IDX168"></a> <a name="IDX169"></a> <a name="IDX170"></a></p> +<pre> + \begin{verbatim} + text + \end{verbatim} +</pre> +<p>The <code>verbatim</code> environment is a paragraph-making +environment that gets LaTeX to print exactly what you type in. It +turns LaTeX into a typewriter with carriage returns and blanks +having the same effect that they would on a typewriter.</p> +<ul> +<li><a href="#SEC77">\verb</a>: The macro form of the +<code>verbatim</code> environment.</li> +</ul> +<h4><a name="SEC77" href="#TOC77">\verb</a></h4> +<p><a name="IDX171"></a> <a name="IDX172"></a></p> +<p><code>\verb char literal_text char</code></p> +<p><code>\verb*char literal_text char</code></p> +<p>Typesets <code>literal_text</code> exactly as typed, including +special characters and spaces, using a typewriter +(<code>\tt</code>) type style. There may be no space between +<code>\verb</code> or <code>\verb*</code> and <code>char</code> +(space is shown here only for clarity). The <code>*-form</code> +differs only in that spaces are printed as `\verb*| |'.</p> +<h3><a name="SEC78" href="#TOC78">verse</a></h3> +<p><a name="IDX173"></a> <a name="IDX174"></a></p> +<pre> + \begin{verse} + text + \end{verse} +</pre> +<p>The <code>verse</code> environment is designed for poetry, +though you may find other uses for it.</p> +<p>The margins are indented on the left and the right. Separate the +lines of each stanza with <code>\\</code>, and use one or more +blank lines to separate the stanzas.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC79">Footnotes</a></font></b></td> +</tr> +</table> +<p><a name="IDX175"></a></p> +<p>Footnotes can be produced in one of two ways. They can be +produced with one command, the <code>\footnote</code> command. They +can also be produced with two commands, the +<code>\footnotemark</code> and the <code>\footnotetext</code> +commands. See the specific command for information on why you would +use one over the other.</p> +<ul> +<li><a href="#SEC80">\footnote</a>: Insert a footnote.</li> +<li><a href="#SEC81">\footnotemark</a>: Insert footnote mark +only.</li> +<li><a href="#SEC82">\footnotetext</a>: Insert footnote text +only.</li> +</ul> +<h3><a name="SEC80" href="#TOC80">\footnote</a></h3> +<p><a name="IDX176"></a></p> +<p><code>\footnote[number]{text}</code></p> +<p>The <code>\footnote</code> command places the numbered footnote +<code>text</code> at the bottom of the current page. The optional +argument, <code>number</code>, is used to change the default +footnote number. This command can only be used in outer paragraph +mode; i.e., you cannot use it in sectioning commands like +<code>\chapter</code>, in figures, tables or in a +<code>tabular</code> environment.</p> +<h3><a name="SEC81" href="#TOC81">\footnotemark</a></h3> +<p><a name="IDX177"></a></p> +<p>The <code>\footnotemark</code> command puts the footnote +<code>number</code> in the text. This command can be used in inner +paragraph mode. The text of the footnote is supplied by the +<code>\footnotetext</code> command.</p> +<p>This command can be used to produce several consecutive footnote +markers referring to the same footnote by using</p> +<p><code>\footnotemark[\value{footnote}]</code></p> +<p>after the first <code>\footnote</code> command.</p> +<h3><a name="SEC82" href="#TOC82">\footnotetext</a></h3> +<p><a name="IDX178"></a></p> +<p><code>\footnotetext[number]{text}</code></p> +<p>The <code>\footnotetext</code> command produces the +<code>text</code> to be placed at the bottom of the page. This +command can come anywhere after the <code>\footnotemark</code> +command. The <code>\footnotetext</code> command must appear in +outer paragraph mode.</p> +<p>The optional argument, <code>number</code>, is used to change +the default footnote number.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC83">Lengths</a></font></b></td> +</tr> +</table> +<p><a name="IDX179"></a></p> +<p>A <code>length</code> is a measure of distance. Many LaTeX +commands take a length as an argument.</p> +<ul> +<li><a href="#SEC84">\newlength</a>: Define a new length.</li> +<li><a href="#SEC85">\setlength</a>: Set the value of a +length.</li> +<li><a href="#SEC86">\addtolength</a>: Add a quantity to a +length.</li> +<li><a href="#SEC87">\settodepth</a>: Set a length to the depth of +something.</li> +<li><a href="#SEC88">\settoheight</a>: Set a length to the height +of something.</li> +<li><a href="#SEC89">\settowidth</a>: Set a length to the width of +something.</li> +<li><a href="#SEC90">Predefined lengths</a>: Lengths that are, +like, predefined.</li> +</ul> +<h3><a name="SEC84" href="#TOC84">\newlength</a></h3> +<p><a name="IDX180"></a> <a name="IDX181"></a></p> +<p><code>\newlength{\gnat}</code></p> +<p>The <code>\newlength</code> command defines the mandatory +argument, <code>\gnat</code>, as a <code>length</code> command with +a value of <code>0in</code>. An error occurs if a +<code>\gnat</code> command already exists.</p> +<h3><a name="SEC85" href="#TOC85">\setlength</a></h3> +<p><a name="IDX182"></a> <a name="IDX183"></a></p> +<p><code>\setlength{\gnat}{length}</code></p> +<p>The <code>\setlength</code> command is used to set the value of +a <code>length</code> command. The <code>length</code> argument can +be expressed in any terms of length LaTeX understands, i.e., inches +(<code>in</code>), millimeters (<code>mm</code>), points +(<code>pt</code>), etc.</p> +<h3><a name="SEC86" href="#TOC86">\addtolength</a></h3> +<p><a name="IDX184"></a> <a name="IDX185"></a></p> +<p><code>\addtolength{\gnat}{length}</code></p> +<p>The <code>\addtolength</code> command increments a "length +command" by the amount specified in the <code>length</code> +argument. It can be a negative amount.</p> +<h3><a name="SEC87" href="#TOC87">\settodepth</a></h3> +<p><a name="IDX186"></a></p> +<p><code>\settodepth{\gnat}{text}</code></p> +<p>The <code>\settodepth</code> command sets the value of a +<code>length</code> command equal to the depth of the +<code>text</code> argument.</p> +<h3><a name="SEC88" href="#TOC88">\settoheight</a></h3> +<p><a name="IDX187"></a></p> +<p><code>\settoheight{\gnat}{text}</code></p> +<p>The <code>\settoheight</code> command sets the value of a +<code>length</code> command equal to the height of the +<code>text</code> argument.</p> +<h3><a name="SEC89" href="#TOC89">\settowidth</a></h3> +<p><a name="IDX188"></a></p> +<p><code>\settowidth{\gnat}{text}</code></p> +<p>The <code>\settowidth</code> command sets the value of a +<code>length</code> command equal to the width of the +<code>text</code> argument.</p> +<h3><a name="SEC90" href="#TOC90">Predefined lengths</a></h3> +<p><a name="IDX189"></a> <a name="IDX190"></a></p> +<p><code><a name="IDX191">\width</a></code></p> +<p><code><a name="IDX192">\height</a></code></p> +<p><code><a name="IDX193">\depth</a></code></p> +<p><code><a name="IDX194">\totalheight</a></code></p> +<p>These length parameters can be used in the arguments of the +box-making commands See section <a href="#SEC143">Spaces & +Boxes</a>. They specify the natural width etc. of the text in the +box. <code>\totalheight</code> equals <code>\height</code> + +<code>\depth</code>. To make a box with the text stretched to +double the natural size, e.g., say</p> +<p><code>\makebox[2\width]{Get a stretcher}</code></p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC91">Letters</a></font></b></td> +</tr> +</table> +<p><a name="IDX195"></a> <a name="IDX196"></a></p> +<p>You can use LaTeX to typeset letters, both personal and +business. The <code>letter</code> document class is designed to +make a number of letters at once, although you can make just one if +you so desire.</p> +<p>Your <tt>`.tex'</tt> source file has the same minimum commands +as the other document classes, i.e., you must have the following +commands as a minimum:</p> +<pre> + \documentclass{letter} + \begin{document} + ... letters ... + \end{document} +</pre> +<p>Each letter is a <code>letter</code> environment, whose argument +is the name and address of the recipient. For example, you might +have:</p> +<pre> + \begin{letter}{Mr. Joe Smith\\ 2345 Princess St. + \\ Edinburgh, EH1 1AA} + ... + \end{letter} +</pre> +<p>The letter itself begins with the <code>\opening</code> command. +The text of the letter follows. It is typed as ordinary LaTeX +input. Commands that make no sense in a letter, like +<code>\chapter</code>, do not work. The letter closes with a +<code>\closing</code> command.</p> +<p>After the <code>closing</code>, you can have additional +material. The <code>\cc</code> command produces the usual "cc: +...". There's also a similar <code>\encl</code> command for a list +of enclosures. With both these commands, use <code>\\</code> to +separate the items.</p> +<p>These commands are used with the <code>letter</code> class:</p> +<ul> +<li><a href="#SEC92">\address</a>: Your return address.</li> +<li><a href="#SEC93">\cc</a>: Cc list.</li> +<li><a href="#SEC94">\closing</a>: Saying goodbye.</li> +<li><a href="#SEC95">\encl</a>: List of enclosed material.</li> +<li><a href="#SEC96">\location</a>: Your organization's +address.</li> +<li><a href="#SEC97">\makelabels</a>: Making address labels.</li> +<li><a href="#SEC98">\name</a>: Your name, for the return +address.</li> +<li><a href="#SEC99">\opening</a>: Saying hello.</li> +<li><a href="#SEC100">\ps</a>: Adding a postscript.</li> +<li><a href="#SEC101">\signature</a>: Your signature.</li> +<li><a href="#SEC102">\startbreaks</a>: Allow page breaks.</li> +<li><a href="#SEC103">\stopbreaks</a>: Disallow page breaks.</li> +<li><a href="#SEC104">\telephone</a>: Your phone number.</li> +</ul> +<h3><a name="SEC92" href="#TOC92">\address</a></h3> +<p><a name="IDX197"></a></p> +<p><code>\address{Return address}</code></p> +<p>The return address, as it should appear on the letter and the +envelope. Separate lines of the address should be separated by +<code>\\</code> commands. If you do not make an +<code>\address</code> declaration, then the letter will be +formatted for copying onto your organization's standard letterhead. +If you give an <code>\address</code> declaration, then the letter +will be formatted as a personal letter.</p> +<h3><a name="SEC93" href="#TOC93">\cc</a></h3> +<p><a name="IDX198"></a> <a name="IDX199"></a></p> +<p><code>\cc{Kate Schechter\\Rob McKenna}</code></p> +<p>Generate a list of other persons the letter was sent to. Each +name is printed on a separate line.</p> +<h3><a name="SEC94" href="#TOC94">\closing</a></h3> +<p><a name="IDX200"></a> <a name="IDX201"></a></p> +<p><code>\closing{text}</code></p> +<p>The letter closes with a <code>\closing</code> command, +i.e.,</p> +<pre> + \closing{Best Regards,} +</pre> +<h3><a name="SEC95" href="#TOC95">\encl</a></h3> +<p><a name="IDX202"></a> <a name="IDX203"></a></p> +<p><code>\encl{CV\\Certificates}</code></p> +<p>Generate a list of enclosed material.</p> +<h3><a name="SEC96" href="#TOC96">\location</a></h3> +<p><a name="IDX204"></a></p> +<p><code>\location{address}</code></p> +<p>This modifies your organization's standard address. This only +appears if the <code>firstpage</code> pagestyle is selected.</p> +<h3><a name="SEC97" href="#TOC97">\makelabels</a></h3> +<p><a name="IDX205"></a></p> +<p><code>\makelabels{number}</code></p> +<p>If you issue this command in the preamble, LaTeX will create a +sheet of address labels. This sheet will be output before the +letters.</p> +<h3><a name="SEC98" href="#TOC98">\name</a></h3> +<p><a name="IDX206"></a></p> +<p><code>\name{June Davenport}</code></p> +<p>Your name, used for printing on the envelope together with the +return address.</p> +<h3><a name="SEC99" href="#TOC99">\opening</a></h3> +<p><a name="IDX208"></a></p> +<p><code>\opening{text}</code></p> +<p>The letter begins with the <code>\opening</code> command. The +mandatory argument, <code>text</code>, is whatever text you wish to +start your letter, i.e.,</p> +<pre> + \opening{Dear Joe,} +</pre> +<h3><a name="SEC100" href="#TOC100">\ps</a></h3> +<p><a name="IDX209"></a></p> +<p><code>\ps</code></p> +<p>Use this command before a postscript.</p> +<h3><a name="SEC101" href="#TOC101">\signature</a></h3> +<p><a name="IDX210"></a></p> +<p><code>\signature{Harvey Swick}</code></p> +<p>Your name, as it should appear at the end of the letter +underneath the space for your signature. Items that should go on +separate lines should be separated by <code>\\</code> commands.</p> +<h3><a name="SEC102" href="#TOC102">\startbreaks</a></h3> +<p><a name="IDX211"></a></p> +<p><code>\startbreaks</code></p> +<p>Used after a <code>\stopbreaks</code> command to allow page +breaks again.</p> +<h3><a name="SEC103" href="#TOC103">\stopbreaks</a></h3> +<p><a name="IDX212"></a></p> +<p><code>\stopbreaks</code></p> +<p>Inhibit page breaks until a <code>\startbreaks</code> command +occurs.</p> +<h3><a name="SEC104" href="#TOC104">\telephone</a></h3> +<p><a name="IDX213"></a></p> +<p><code>\telephone{number}</code></p> +<p>This is your telephone number. This only appears if the +<code>firstpage</code> pagestyle is selected.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC105">Line & Page Breaking</a></font></b></td> +</tr> +</table> +<p><a name="IDX214"></a> <a name="IDX215"></a> <a name= +"IDX216"></a></p> +<p>The first thing LaTeX does when processing ordinary text is to +translate your input file into a string of glyphs and spaces. To +produce a printed document, this string must be broken into lines, +and these lines must be broken into pages. In some environments, +you do the line breaking yourself with the <code>\\</code> command, +but LaTeX usually does it for you.</p> +<ul> +<li><a href="#SEC106">\\</a>: Start a new line.</li> +<li><a href="#SEC107">\- (hyphenation)</a>: Insert explicit +hyphenation.</li> +<li><a href="#SEC108">\cleardoublepage</a>: Start a new right-hand +page.</li> +<li><a href="#SEC109">\clearpage</a>: Start a new page.</li> +<li><a href="#SEC110">\enlargethispage</a>: Enlarge the current +page a bit.</li> +<li><a href="#SEC111">\fussy</a>: Be fussy about line +breaking.</li> +<li><a href="#SEC112">\hyphenation</a>: Tell LaTeX how to hyphenate +a word.</li> +<li><a href="#SEC113">\linebreak</a>: Break the line.</li> +<li><a href="#SEC114">\newline</a>: Break the line +prematurely.</li> +<li><a href="#SEC115">\newpage</a>: Start a new page.</li> +<li><a href="#SEC116">\nolinebreak</a>: Don't break the current +line.</li> +<li><a href="#SEC117">\nopagebreak</a>: Don't make a page break +here.</li> +<li><a href="#SEC118">\pagebreak</a>: Please make a page break +here.</li> +<li><a href="#SEC119">\sloppy</a>: Be sloppy about line +breaking.</li> +</ul> +<h3><a name="SEC106" href="#TOC106">\\</a></h3> +<p><a name="IDX217"></a> <a name="IDX218"></a></p> +<p><code>\\[*][extra-space]</code></p> +<p>The <code>\\</code> command tells LaTeX to start a new line. It +has an optional argument, <code>extra-space</code>, that specifies +how much extra vertical space is to be inserted before the next +line. This can be a negative amount.</p> +<p>The <code>\\*</code> command is the same as the ordinary +<code>\\</code> command except that it tells LaTeX not to start a +new page after the line.</p> +<h3><a name="SEC107" href="#TOC107">\-</a></h3> +<p><a name="IDX219"></a> <a name="IDX220"></a></p> +<p>The <code>\-</code> command tells LaTeX that it may hyphenate +the word at that point. LaTeX is very good at hyphenating, and it +will usually find all correct hyphenation points. The +<code>\-</code> command is used for the exceptional cases.</p> +<p>Note that when you insert <code>\-</code> commands in a word, +the word will only be hyphenated at those points and not at any of +the hyphenation points that LaTeX might otherwise have chosen.</p> +<h3><a name="SEC108" href="#TOC108">\cleardoublepage</a></h3> +<p><a name="IDX221"></a> <a name="IDX222"></a></p> +<p>The <code>\cleardoublepage</code> command ends the current page +and causes all figures and tables that have so far appeared in the +input to be printed. In a two-sided printing style, it also makes +the next page a right-hand (odd-numbered) page, producing a blank +page if necessary.</p> +<h3><a name="SEC109" href="#TOC109">\clearpage</a></h3> +<p><a name="IDX223"></a> <a name="IDX224"></a></p> +<p>The <code>\clearpage</code> command ends the current page and +causes all figures and tables that have so far appeared in the +input to be printed.</p> +<h3><a name="SEC110" href="#TOC110">\enlargethispage</a></h3> +<p><a name="IDX225"></a> <a name="IDX226"></a></p> +<p><code>\enlargethispage{size}</code></p> +<p><code>\enlargethispage*{size}</code></p> +<p>Enlarge the <code>\textheight</code> for the current page by the +specified amount; e.g. <code>\enlargethispage{\baselineskip}</code> +will allow one additional line.</p> +<p>The starred form tries to squeeze the material together on the +page as much as possible. This is normally used together with an +explicit <code>\pagebreak</code>.</p> +<h3><a name="SEC111" href="#TOC111">\fussy</a></h3> +<p><a name="IDX227"></a></p> +<p><code>\fussy</code></p> +<p>This declaration (which is the default) makes TeX more fussy +about line breaking. This can avoids too much space between words, +but may produce overfull boxes.</p> +<p>This command cancels the effect of a previous +<code>\sloppy</code> command. section <a href= +"#SEC119">\sloppy</a></p> +<h3><a name="SEC112" href="#TOC112">\hyphenation</a></h3> +<p><a name="IDX228"></a> <a name="IDX229"></a></p> +<p><code>\hyphenation{words}</code></p> +<p>The <code>\hyphenation</code> command declares allowed +hyphenation points, where <code>words</code> is a list of words, +separated by spaces, in which each hyphenation point is indicated +by a <code>-</code> character.</p> +<h3><a name="SEC113" href="#TOC113">\linebreak</a></h3> +<p><a name="IDX230"></a> <a name="IDX231"></a></p> +<p><code>\linebreak[number]</code></p> +<p>The <code>\linebreak</code> command tells LaTeX to break the +current line at the point of the command. With the optional +argument, <code>number</code>, you can convert the +<code>\linebreak</code> command from a demand to a request. The +number must be a number from 0 to 4. The higher the number, the +more insistent the request is.</p> +<p>The <code>\linebreak</code> command causes LaTeX to stretch the +line so it extends to the right margin.</p> +<h3><a name="SEC114" href="#TOC114">\newline</a></h3> +<p><a name="IDX232"></a> <a name="IDX233"></a></p> +<p>The <code>\newline</code> command breaks the line right where it +is. It can only be used in paragraph mode.</p> +<h3><a name="SEC115" href="#TOC115">\newpage</a></h3> +<p><a name="IDX234"></a> <a name="IDX235"></a></p> +<p>The <code>\newpage</code> command ends the current page.</p> +<h3><a name="SEC116" href="#TOC116">\nolinebreak</a></h3> +<p><a name="IDX236"></a></p> +<p><code>\nolinebreak[number]</code></p> +<p>The <code>\nolinebreak</code> command prevents LaTeX from +breaking the current line at the point of the command. With the +optional argument, <code>number</code>, you can convert the +<code>\nolinebreak</code> command from a demand to a request. The +number must be a number from 0 to 4. The higher the number, the +more insistent the request is.</p> +<h3><a name="SEC117" href="#TOC117">\nopagebreak</a></h3> +<p><a name="IDX237"></a></p> +<p><code>\nopagebreak[number]</code></p> +<p>The <code>\nopagebreak</code> command prevents LaTeX from +breaking the current page at the point of the command. With the +optional argument, <code>number</code>, you can convert the +<code>\nopagebreak</code> command from a demand to a request. The +number must be a number from 0 to 4. The higher the number, the +more insistent the request is.</p> +<h3><a name="SEC118" href="#TOC118">\pagebreak</a></h3> +<p><a name="IDX238"></a> <a name="IDX239"></a></p> +<p><code>\pagebreak[number]</code></p> +<p>The <code>\pagebreak</code> command tells LaTeX to break the +current page at the point of the command. With the optional +argument, <code>number</code>, you can convert the +<code>\pagebreak</code> command from a demand to a request. The +number must be a number from 0 to 4. The higher the number, the +more insistent the request is.</p> +<h3><a name="SEC119" href="#TOC119">\sloppy</a></h3> +<p><a name="IDX240"></a></p> +<p><code>\sloppy</code></p> +<p>This declaration makes TeX less fussy about line breaking. This +can prevent overfull boxes, but may leave too much space between +words.</p> +<p>Lasts until a <code>\fussy</code> command is issued. section +<a href="#SEC111">\fussy</a>.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC120">Making Paragraphs</a></font></b></td> +</tr> +</table> +<p><a name="IDX241"></a> <a name="IDX242"></a></p> +<p>A paragraph is ended by one or more completely blank lines -- +lines not containing even a <code>%</code>. A blank line should not +appear where a new paragraph cannot be started, such as in math +mode or in the argument of a sectioning command.</p> +<ul> +<li><a href="#SEC121">\indent</a>: Indent this paragraph.</li> +<li><a href="#SEC122">\noindent</a>: Do not indent this +paragraph.</li> +<li><a href="#SEC123">\par</a>: Another way of writing a blank +line.</li> +</ul> +<h3><a name="SEC121" href="#TOC121">\indent</a></h3> +<p><a name="IDX243"></a> <a name="IDX244"></a></p> +<p><code>\indent</code></p> +<p>This produces a horizontal space whose width equals the width of +the paragraph indentation. It is used to add paragraph indentation +where it would otherwise be suppressed.</p> +<h3><a name="SEC122" href="#TOC122">\noindent</a></h3> +<p><a name="IDX245"></a> <a name="IDX246"></a></p> +<p><code>\noindent</code></p> +<p>When used at the beginning of the paragraph, it suppresses the +paragraph indentation. It has no effect when used in the middle of +a paragraph.</p> +<h3><a name="SEC123" href="#TOC123">\par</a></h3> +<p><a name="IDX247"></a> <a name="IDX248"></a></p> +<p>Equivalent to a blank line; often used to make command or +environment definitions easier to read.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC124">Margin Notes</a></font></b></td> +</tr> +</table> +<p><a name="IDX249"></a> <a name="IDX250"></a> <a name= +"IDX251"></a></p> +<p>The command <code>\marginpar[left]{right}</code> creates a note +in the margin. The first line will be at the same height as the +line in the text where the <code>\marginpar</code> occurs.</p> +<p>When you only specify the mandatory argument <code>right</code>, +the text will be placed</p> +<ul> +<li>in the right margin for one-sided layout</li> +<li>in the outside margin for two-sided layout</li> +<li>in the nearest margin for two-column layout.</li> +</ul> +<p>By issuing the command <code>\reversemarginpar</code>, you can +force the marginal notes to go into the opposite (inside) +margin.</p> +<p>When you specify both arguments, <code>left</code> is used for +the left margin, and <code>right</code> is used for the right +margin.</p> +<p>The first word will normally not be hyphenated; you can enable +hyphenation by prefixing the first word with a +<code>\hspace{0pt}</code> command.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC125">Math Formulae</a></font></b></td> +</tr> +</table> +<p><a name="IDX252"></a> <a name="IDX253"></a> <a name= +"IDX254"></a> <a name="IDX255"></a> <a name="IDX256"></a> <a name= +"IDX257"></a> <a name="IDX258"></a> <a name="IDX259"></a></p> +<p>There are three environments that put LaTeX in math mode:</p> +<dl> +<dt><code>math</code></dt> +<dd>For Formulae that appear right in the text.</dd> +<dt><code>displaymath</code></dt> +<dd>For Formulae that appear on their own line.</dd> +<dt><code>equation</code></dt> +<dd>The same as the displaymath environment except that it adds an +equation number in the right margin.</dd> +</dl> +<p>The <code>math</code> environment can be used in both paragraph +and LR mode, but the <code>displaymath</code> and +<code>equation</code> environments can be used only in paragraph +mode. The <code>math</code> and <code>displaymath</code> +environments are used so often that they have the following short +forms:</p> +<pre> + \(...\) instead of \begin{math}...\end{math} + + \[...\] instead of \begin{displaymath}...\end{displaymath} +</pre> +<p>In fact, the <code>math</code> environment is so common that it +has an even shorter form:</p> +<pre> + $ ... $ instead of \(...\) +</pre> +<p><a name="IDX260"></a></p> +<ul> +<li><a href="#SEC126">Subscripts & Superscripts</a>: Also known +as exponent or index.</li> +<li><a href="#SEC127">Math Symbols</a>: Various mathematical +squiggles.</li> +<li><a href="#SEC128">Spacing in Math Mode</a>: Thick, medium, thin +and negative spaces.</li> +<li><a href="#SEC129">Math Miscellany</a>: Stuff that doesn't fit +anywhere else.</li> +</ul> +<h3><a name="SEC126" href="#TOC126">Subscripts & +Superscripts</a></h3> +<p><a name="IDX261"></a> <a name="IDX262"></a> <a name= +"IDX263"></a> <a name="IDX264"></a></p> +<p>To get an expression <i>exp</i> to appear as a subscript, you +just type <code>_{</code><i>exp</i><code>}</code>. To get +<i>exp</i> to appear as a superscript, you type +<code>^{</code><i>exp</i><code>}</code>. LaTeX handles +superscripted superscripts and all of that stuff in the natural +way. It even does the right thing when something has both a +subscript and a superscript.</p> +<h3><a name="SEC127" href="#TOC127">Math Symbols</a></h3> +<p><a name="IDX265"></a> <a name="IDX266"></a> <a name= +"IDX267"></a></p> +<p>LaTeX provides almost any mathematical symbol you're likely to +need. The commands for generating them can be used only in math +mode. For example, if you include <code>$\pi$</code> in your +source, you will get the symbol in your output.</p> +<h3><a name="SEC128" href="#TOC128">Spacing in Math Mode</a></h3> +<p><a name="IDX268"></a> <a name="IDX269"></a></p> +<p>In a <code>math</code> environment, LaTeX ignores the spaces you +type and puts in the spacing that it thinks is best. LaTeX formats +mathematics the way it's done in mathematics texts. If you want +different spacing, LaTeX provides the following four commands for +use in math mode:</p> +<p><a name="IDX270"></a> <a name="IDX271"></a> <a name= +"IDX272"></a> <a name="IDX273"></a></p> +<ol> +<li><code>\;</code> - a thick space</li> +<li><code>\:</code> - a medium space</li> +<li><code>\,</code> - a thin space</li> +<li><code>\!</code> - a negative thin space</li> +</ol> +<h3><a name="SEC129" href="#TOC129">Math Miscellany</a></h3> +<p><a name="IDX274"></a></p> +<dl> +<dt><code><a name="IDX275">\cdots</a></code></dt> +<dd>Produces a horizontal ellipsis where the dots are raised to the +center of the line. eg.</dd> +<dt><code><a name="IDX276">\ddots</a></code></dt> +<dd>Produces a diagonal ellipsis. eg.</dd> +<dt><code><a name="IDX277">\frac{num}{den}</a></code></dt> +<dd>Produces the fraction <code>num</code> divided by +<code>den</code>. eg.</dd> +<dt><code><a name="IDX278">\ldots</a></code></dt> +<dd>Produces an ellipsis. This command works in any mode, not just +math mode. eg.</dd> +<dt><code><a name="IDX279">\overbrace{text}</a></code></dt> +<dd>Generates a brace over text. eg.</dd> +<dt><code><a name="IDX280">\overline{text}</a></code></dt> +<dd>Causes the argument text to be overlined. eg.</dd> +<dt><code><a name="IDX281">\sqrt[root]{arg}</a></code></dt> +<dd>Produces the square root of its argument. The optional +argument, <code>root</code>, determines what root to produce, i.e., +the cube root of <code>x+y</code> would be typed as +<code>$\sqrt[3]{x+y}$</code>. eg.</dd> +<dt><code><a name="IDX282">\underbrace{text}</a></code></dt> +<dd>Generates text with a brace underneath. eg.</dd> +<dt><code><a name="IDX283">\underline{text}</a></code></dt> +<dd>Causes the argument text to be underlined. This command can +also be used in paragraph and LR modes. eg.</dd> +<dt><code><a name="IDX284">\vdots</a></code></dt> +<dd>Produces a vertical ellipsis. eg.</dd> +</dl> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC130">Modes</a></font></b></td> +</tr> +</table> +<p><a name="IDX285"></a> <a name="IDX286"></a> <a name= +"IDX287"></a> <a name="IDX288"></a> <a name="IDX289"></a></p> +<p>When LaTeX is processing your input text, it is always in one of +three modes:</p> +<ul> +<li>Paragraph mode</li> +<li>Math mode</li> +<li>Left-to-right mode, called LR mode for short</li> +</ul> +<p>LaTeX changes mode only when it goes up or down a staircase to a +different level, though not all level changes produce mode changes. +Mode changes occur only when entering or leaving an environment, or +when LaTeX is processing the argument of certain text-producing +commands.</p> +<p>"Paragraph mode" is the most common; it's the one LaTeX is in +when processing ordinary text. In that mode, LaTeX breaks your text +into lines and breaks the lines into pages. LaTeX is in "math mode" +when it's generating a mathematical formula. In "LR mode", as in +paragraph mode, LaTeX considers the output that it produces to be a +string of words with spaces between them. However, unlike paragraph +mode, LaTeX keeps going from left to right; it never starts a new +line in LR mode. Even if you put a hundred words into an +<code>\mbox</code>, LaTeX would keep typesetting them from left to +right inside a single box, and then complain because the resulting +box was too wide to fit on the line.</p> +<p>LaTeX is in LR mode when it starts making a box with an +<code>\mbox</code> command. You can get it to enter a different +mode inside the box - for example, you can make it enter math mode +to put a formula in the box. There are also several text-producing +commands and environments for making a box that put LaTeX in +paragraph mode. The box make by one of these commands or +environments will be called a <code>parbox</code>. When LaTeX is in +paragraph mode while making a box, it is said to be in "inner +paragraph mode". Its normal paragraph mode, which it starts out in, +is called "outer paragraph mode".</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC131">Page Styles</a></font></b></td> +</tr> +</table> +<p><a name="IDX290"></a> <a name="IDX291"></a></p> +<p>The <code>\documentclass</code> command determines the size and +position of the page's head and foot. The page style determines +what goes in them.</p> +<ul> +<li><a href="#SEC132">\maketitle</a>: Generate a title page.</li> +<li><a href="#SEC137">\pagenumbering</a>: Set the style used for +page numbers.</li> +<li><a href="#SEC138">\pagestyle</a>: Change the headings/footings +style.</li> +<li><a href="#SEC141">\thispagestyle</a>: Change the +headings/footings style for this page.</li> +</ul> +<h3><a name="SEC132" href="#TOC132">\maketitle</a></h3> +<p><a name="IDX292"></a> <a name="IDX293"></a></p> +<p><code>\maketitle</code></p> +<p>The <code>\maketitle</code> command generates a title on a +separate title page - except in the <code>article</code> class, +where the title normally goes at the top of the first page. +Information used to produce the title is obtained from the +following declarations:</p> +<p>See section <a href="#SEC131">Page Styles</a> for the commands +to give the information.</p> +<ul> +<li><a href="#SEC133">\author</a>: Who wrote this stuff?</li> +<li><a href="#SEC134">\date</a>: The date the document was +created.</li> +<li><a href="#SEC135">\thanks</a>: A special form of footnote.</li> +<li><a href="#SEC136">\title</a>: How to set the document +title.</li> +</ul> +<h3><a name="SEC133" href="#TOC133">\author</a></h3> +<p><a name="IDX294"></a> <a name="IDX295"></a></p> +<p><code>\author{names}</code></p> +<p>The <code>\author</code> command declares the author(s), where +<code>names</code> is a list of authors separated by +<code>\and</code> commands. Use <code>\\</code> to separate lines +within a single author's entry -- for example, to give the author's +institution or address.</p> +<h3><a name="SEC134" href="#TOC134">\date</a></h3> +<p><a name="IDX296"></a> <a name="IDX297"></a></p> +<p><code>\date{text}</code></p> +<p>The <code>\date</code> command declares <i>text</i> to be the +document's date. With no <code>\date</code> command, the current +date is used.</p> +<h3><a name="SEC135" href="#TOC135">\thanks</a></h3> +<p><a name="IDX298"></a> <a name="IDX299"></a></p> +<p><code>\thanks{text}</code></p> +<p>The <code>\thanks</code> command produces a +<code>\footnote</code> to the title.</p> +<h3><a name="SEC136" href="#TOC136">\title</a></h3> +<p><a name="IDX300"></a> <a name="IDX301"></a></p> +<p><code>\title{text}</code></p> +<p>The <code>\title</code> command declares <code>text</code> to be +the title. Use <code>\\</code> to tell LaTeX where to start a new +line in a long title.</p> +<h3><a name="SEC137" href="#TOC137">\pagenumbering</a></h3> +<p><a name="IDX302"></a> <a name="IDX303"></a></p> +<p><code>\pagenumbering{num_style}</code></p> +<p>Specifies the style of page numbers. Possible values of +<code>num_style</code> are:</p> +<ul> +<li><code>arabic</code> - Arabic numerals</li> +<li><code>roman</code> - Lowercase Roman numerals</li> +<li><code>Roman</code> - Uppercase Roman numerals</li> +<li><code>alph</code> - Lowercase letters</li> +<li><code>Alph</code> - Uppercase letters</li> +</ul> +<h3><a name="SEC138" href="#TOC138">\pagestyle</a></h3> +<p><a name="IDX304"></a></p> +<p><code>\pagestyle{option}</code></p> +<p>The <code>\pagestyle</code> command changes the style from the +current page on throughout the remainder of your document.</p> +<p>The valid options are:</p> +<ul> +<li><code>plain</code> - Just a plain page number.</li> +<li><code>empty</code> - Produces empty heads and feet - no page +numbers.</li> +<li><code>headings</code> - Puts running headings on each page. The +document style specifies what goes in the headings.</li> +<li><code>myheadings</code> - You specify what is to go in the +heading with the <code>\markboth</code> or the +<code>\markright</code> commands.</li> +</ul> +<ul> +<li><a href="#SEC139">\markboth</a>: Set left and right +headings.</li> +<li><a href="#SEC140">\markright</a>: Set right heading only.</li> +</ul> +<h3><a name="SEC139" href="#TOC139">\markboth</a></h3> +<p><a name="IDX305"></a></p> +<pre> +\markboth{left head}{right head} +</pre> +<p>The <code>\markboth</code> command is used in conjunction with +the page style <code>myheadings</code> for setting both the left +and the right heading. You should note that a "left-hand heading" +is generated by the last <code>\markboth</code> command before the +end of the page, while a "right-hand heading" is generated by the +first <code>\markboth</code> or <code>\markright</code> that comes +on the page if there is one, otherwise by the last one before the +page.</p> +<h3><a name="SEC140" href="#TOC140">\markright</a></h3> +<p><a name="IDX306"></a></p> +<pre> +\markright{right head} +</pre> +<p>The <code>\markright</code> command is used in conjunction with +the page style <code>myheadings</code> for setting the right +heading, leaving the left heading unchanged. You should note that a +"left-hand heading" is generated by the last <code>\markboth</code> +command before the end of the page, while a "right-hand heading" is +generated by the first <code>\markboth</code> or +<code>\markright</code> that comes on the page if there is one, +otherwise by the last one before the page.</p> +<h3><a name="SEC141" href="#TOC141">\thispagestyle</a></h3> +<p><a name="IDX307"></a></p> +<p><code>\thispagestyle{option}</code></p> +<p>The <code>\thispagestyle</code> command works in the same manner +as the <code>\pagestyle</code> command except that it changes the +style for the current page only.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC142">Sectioning</a></font></b></td> +</tr> +</table> +<p><a name="IDX308"></a> <a name="IDX309"></a> <a name= +"IDX310"></a> <a name="IDX311"></a> <a name="IDX312"></a> <a name= +"IDX313"></a></p> +<p>Sectioning commands provide the means to structure your text +into units.</p> +<ul> +<li><code>\part</code></li> +<li><code>\chapter</code> (report and book class only)</li> +<li><code>\section</code></li> +<li><code>\subsection</code></li> +<li><code>\subsubsection</code></li> +<li><code>\paragraph</code></li> +<li><code>\subparagraph</code></li> +</ul> +<p>All sectioning commands take the same general form, i.e.,</p> +<p><code>\chapter[optional]{title}</code></p> +<p>In addition to providing the heading in the text, the mandatory +argument of the sectioning command can appear in two other +places:</p> +<ol> +<li>The table of contents</li> +<li>The running head at the top of the page</li> +</ol> +<p>You may not want the same thing to appear in these other two +places as appears in the text heading. To handle this situation, +the sectioning commands have an <code>optional</code> argument that +provides the text for these other two purposes.</p> +<p>All sectioning commands have <code>*</code>-forms that print a +<i>title</i>, but do not include a number and do not make an entry +in the table of contents.</p> +<p><a name="IDX315"></a></p> +<p><code><a name="IDX314">\appendix</a></code></p> +<p>The <code>\appendix</code> command changes the way sectional +units are numbered. The <code>\appendix</code> command generates no +text and does not affect the numbering of parts. The normal use of +this command is something like</p> +<pre> +\chapter{The First Chapter} +... +\appendix +\chapter{The First Appendix} +</pre> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC143">Spaces & Boxes</a></font></b></td> +</tr> +</table> +<p><a name="IDX316"></a> <a name="IDX317"></a></p> +<p>All the predefined length parameters See section <a href= +"#SEC90">Predefined lengths</a> can be used in the arguments of the +box-making commands.</p> +<ul> +<li style="list-style: none">Horizontal space</li> +<li><a href="#SEC144">\dotfill</a>: Stretchable horizontal +dots.</li> +<li><a href="#SEC145">\hfill</a>: Stretchable horizontal +space.</li> +<li><a href="#SEC146">\hrulefill</a>: Stretchable horizontal +rule.</li> +<li><a href="#SEC147">\hspace</a>: Fixed horizontal space. Vertical +space</li> +<li><a href="#SEC148">\addvspace</a>: Fixed vertical space.</li> +<li><a href="#SEC149">\bigskip</a>: Fixed vertical space.</li> +<li><a href="#SEC150">\medskip</a>: Fixed vertical space.</li> +<li><a href="#SEC151">\smallskip</a>: Fixed vertical space.</li> +<li><a href="#SEC152">\vfill</a>: Stretchable vertical space.</li> +<li><a href="#SEC153">\vspace</a>: Fixed vertical space. Boxes</li> +<li><a href="#SEC154">\fbox</a>: Framebox.</li> +<li><a href="#SEC155">\framebox</a>: Framebox, adjustable +position.</li> +<li><a href="#SEC156">lrbox</a>: An environment like \sbox.</li> +<li><a href="#SEC157">\makebox</a>: Box, adjustable position.</li> +<li><a href="#SEC158">\mbox</a>: Box.</li> +<li><a href="#SEC159">\newsavebox</a>: Declare a name for saving a +box.</li> +<li><a href="#SEC160">\parbox</a>: Box with text in paragraph +mode.</li> +<li><a href="#SEC161">\raisebox</a>: Raise or lower text.</li> +<li><a href="#SEC162">\rule</a>: Lines and squares.</li> +<li><a href="#SEC163">\savebox</a>: Like \makebox, but save the +text for later use.</li> +<li><a href="#SEC164">\sbox</a>: Like \mbox, but save the text for +later use.</li> +<li><a href="#SEC165">\usebox</a>: Print saved text.</li> +</ul> +<h3><a name="SEC144" href="#TOC144">\dotfill</a></h3> +<p><a name="IDX318"></a></p> +<p>The <code>\dotfill</code> command produces a "rubber length" +that produces dots instead of just spaces.</p> +<h3><a name="SEC145" href="#TOC145">\hfill</a></h3> +<p><a name="IDX319"></a></p> +<p>The <code>\hfill</code> fill command produces a "rubber length" +which can stretch or shrink horizontally. It will be filled with +spaces.</p> +<h3><a name="SEC146" href="#TOC146">\hrulefill</a></h3> +<p><a name="IDX320"></a></p> +<p>The <code>\hrulefill</code> fill command produces a "rubber +length" which can stretch or shrink horizontally. It will be filled +with a horizontal rule.</p> +<h3><a name="SEC147" href="#TOC147">\hspace</a></h3> +<p><a name="IDX321"></a></p> +<p><code>\hspace[*]{length}</code></p> +<p>The <code>\hspace</code> command adds horizontal space. The +length of the space can be expressed in any terms that LaTeX +understands, i.e., points, inches, etc. You can add negative as +well as positive space with an <code>\hspace</code> command. Adding +negative space is like backspacing.</p> +<p>LaTeX removes horizontal space that comes at the end of a line. +If you don't want LaTeX to remove this space, include the optional +<code>*</code> argument. Then the space is never removed.</p> +<h3><a name="SEC148" href="#TOC148">\addvspace</a></h3> +<p><a name="IDX322"></a> <a name="IDX323"></a> <a name= +"IDX324"></a></p> +<p><code>\addvspace{length}</code></p> +<p>The <code>\addvspace</code> command normally adds a vertical +space of height length. However, if vertical space has already been +added to the same point in the output by a previous +<code>\addvspace</code> command, then this command will not add +more space than needed to make the natural length of the total +vertical space equal to <code>length</code>.</p> +<h3><a name="SEC149" href="#TOC149">\bigskip</a></h3> +<p><a name="IDX325"></a></p> +<p>The <code>\bigskip</code> command is equivalent to +<code>\vspace{bigskipamount}</code> where +<code>bigskipamount</code> is determined by the document class.</p> +<h3><a name="SEC150" href="#TOC150">\medskip</a></h3> +<p><a name="IDX326"></a></p> +<p>The <code>\medskip</code> command is equivalent to +<code>\vspace{medskipamount}</code> where +<code>medskipamount</code> is determined by the document class.</p> +<h3><a name="SEC151" href="#TOC151">\smallskip</a></h3> +<p><a name="IDX327"></a></p> +<p><code>\smallskip</code></p> +<p>The <code>\smallskip</code> command is equivalent to +<code>\vspace{smallskipamount}</code> where +<code>smallskipamount</code> is determined by the document +class.</p> +<h3><a name="SEC152" href="#TOC152">\vfill</a></h3> +<p><a name="IDX328"></a></p> +<p>The <code>\vfill</code> fill command produces a rubber length +which can stretch or shrink vertically.</p> +<h3><a name="SEC153" href="#TOC153">\vspace</a></h3> +<p><a name="IDX329"></a></p> +<p><code>\vspace[*]{length}</code></p> +<p>The <code>\vspace</code> command adds vertical space. The length +of the space can be expressed in any terms that LaTeX understands, +i.e., points, inches, etc. You can add negative as well as positive +space with an <code>\vspace</code> command.</p> +<p>LaTeX removes vertical space that comes at the end of a page. If +you don't want LaTeX to remove this space, include the optional +<code>*</code> argument. Then the space is never removed.</p> +<h3><a name="SEC154" href="#TOC154">\fbox</a></h3> +<p><a name="IDX330"></a></p> +<p><code>\fbox{text}</code></p> +<p>The <code>\fbox</code> command is exactly the same as the +<code>\mbox</code> command, except that it puts a frame around the +outside of the box that it creates.</p> +<h3><a name="SEC155" href="#TOC155">\framebox</a></h3> +<p><a name="IDX331"></a></p> +<p><code>\framebox[width][position]{text}</code></p> +<p>The <code>\framebox</code> command is exactly the same as the +<code>\makebox</code> command, except that it puts a frame around +the outside of the box that it creates.</p> +<p>The framebox command produces a rule of thickness +<code>\fboxrule</code>, and leaves a space <code>\fboxsep</code> +between the rule and the contents of the box.</p> +<h3><a name="SEC156" href="#TOC156">lrbox</a></h3> +<p><a name="IDX332"></a></p> +<p><code>\begin{lrbox}{cmd} text \end{lrbox}</code></p> +<p>This is the environment form of <code>\sbox</code>.</p> +<p>The text inside the environment is saved in the box +<code>cmd</code>, which must have been declared with +<code>\newsavebox</code>.</p> +<h3><a name="SEC157" href="#TOC157">\makebox</a></h3> +<p><a name="IDX333"></a></p> +<p><code>\makebox[width][position]{text}</code></p> +<p>The <code>\makebox</code> command creates a box just wide enough +to contain the <code>text</code> specified. The width of the box is +specified by the optional <code>width</code> argument. The position +of the text within the box is determined by the optional +<code>position</code> argument.</p> +<ul> +<li><code>c</code> -- centred (default)</li> +<li><code>l</code> -- flushleft</li> +<li><code>r</code> -- flushright</li> +<li><code>s</code> -- stretch from left to right margin. The text +must contain stretchable space for this to work.</li> +</ul> +<p>See section <a href="#SEC54">\makebox</a>.</p> +<h3><a name="SEC158" href="#TOC158">\mbox</a></h3> +<p><a name="IDX334"></a></p> +<p><code>\mbox{text}</code></p> +<p>The <code>\mbox</code> command creates a box just wide enough to +hold the text created by its argument.</p> +<p>Use this command to prevent text from being split across +lines.</p> +<h3><a name="SEC159" href="#TOC159">\newsavebox</a></h3> +<p><a name="IDX335"></a></p> +<p><code>\newsavebox{cmd}</code></p> +<p>Declares <code>cmd</code>, which must be a command name that is +not already defined, to be a bin for saving boxes.</p> +<h3><a name="SEC160" href="#TOC160">\parbox</a></h3> +<p><a name="IDX336"></a></p> +<p> +<code>\parbox[position][height][inner-pos]{width}{text}</code></p> +<p>A <code>parbox</code> is a box whose contents are created in +<code>paragraph</code> mode. The <code>\parbox</code> has two +mandatory arguments:</p> +<ul> +<li><code>width</code> - specifies the width of the parbox, +and</li> +<li><code>text</code> - the text that goes inside the parbox.</li> +</ul> +<p>LaTeX will position a <code>parbox</code> so its center lines up +with the center of the text line. The optional <i>position</i> +argument allows you to line up either the top or bottom line in the +parbox (default is top).</p> +<p>If the <i>height</i> argument is not given, the box will have +the natural height of the text.</p> +<p>The <i>inner-pos</i> argument controls the placement of the text +inside the box. If it is not specified, <i>position</i> is +used.</p> +<ul> +<li><code>t</code> -- text is placed at the top of the box.</li> +<li><code>c</code> -- text is centred in the box.</li> +<li><code>b</code> -- text is placed at the bottom of the box.</li> +<li><code>s</code> -- stretch vertically. The text must contain +vertically stretchable space for this to work.</li> +</ul> +<p>A <code>\parbox</code> command is used for a parbox containing a +small piece of text, with nothing fancy inside. In particular, you +shouldn't use any of the paragraph-making environments inside a +<code>\parbox</code> argument. For larger pieces of text, including +ones containing a paragraph-making environment, you should use a +<code>minipage</code> environment See section <a href= +"#SEC46">minipage</a>.</p> +<h3><a name="SEC161" href="#TOC161">\raisebox</a></h3> +<p><a name="IDX337"></a></p> +<p> +<code>\raisebox{distance}[extend-above][extend-below]{text}</code></p> +<p>The <code>\raisebox</code> command is used to raise or lower +text. The first mandatory argument specifies how high the text is +to be raised (or lowered if it is a negative amount). The text +itself is processed in <code>LR mode</code>.</p> +<p>Sometimes it's useful to make LaTeX think something has a +different size than it really does - or a different size than LaTeX +would normally think it has. The <code>\raisebox</code> command +lets you tell LaTeX how tall it is.</p> +<p>The first optional argument, <code>extend-above</code>, makes +LaTeX think that the text extends above the line by the amount +specified. The second optional argument, <code>extend-below</code>, +makes LaTeX think that the text extends below the line by the +amount specified.</p> +<h3><a name="SEC162" href="#TOC162">\rule</a></h3> +<p><a name="IDX338"></a></p> +<p><code>\rule[raise-height]{width}{thickness}</code></p> +<p>The <code>\rule</code> command is used to produce horizontal +lines. The arguments are defined as follows:</p> +<ul> +<li><code>raise-height</code> - specifies how high to raise the +rule (optional)</li> +<li><code>width</code> - specifies the length of the rule +(mandatory)</li> +<li><code>thickness</code> - specifies the thickness of the rule +(mandatory)</li> +</ul> +<h3><a name="SEC163" href="#TOC163">\savebox</a></h3> +<p><a name="IDX339"></a></p> +<pre> + \savebox{cmd}[width][pos]{text} +</pre> +<p>This command typeset <code>text</code> in a box just as for +<code>\makebox</code>. However, instead of printing the resulting +box, it saves it in bin <code>cmd</code>, which must have been +declared with <code>\newsavebox</code>.</p> +<h3><a name="SEC164" href="#TOC164">\sbox</a></h3> +<p><a name="IDX340"></a></p> +<p><code>\sbox{text}</code></p> +<p>This commands typeset <code>text</code> in a box just as for +<code>\mbox</code>. However, instead of printing the resulting box, +it saves it in bin <code>cmd</code>, which must have been declared +with <code>\newsavebox</code>.</p> +<h3><a name="SEC165" href="#TOC165">\usebox</a></h3> +<p><a name="IDX341"></a></p> +<p><code>\usebox{cmd}</code></p> +<p>Prints the box most recently saved in bin <code>cmd</code> by a +<code>\savebox</code> command.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC166">Special Characters</a></font></b></td> +</tr> +</table> +<p><a name="IDX342"></a> <a name="IDX343"></a> <a name= +"IDX344"></a> <a name="IDX345"></a></p> +<p>The following characters play a special role in LaTeX and are +called "special printing characters", or simply "special +characters".</p> +<pre> + # $ % & ~ _ ^ \ { } +</pre> +<p>Whenever you put one of these special characters into your file, +you are doing something special. If you simply want the character +to be printed just as any other letter, include a <code>\</code> in +front of the character. For example, <code>\$</code> will produce +<code>$</code> in your output.</p> +<p>One exception to this rule is the <code>\</code> itself because +<code>\\</code> has its own special meaning. A <code>\</code> is +produced by typing <code><a name="IDX346">$\backslash$</a></code> +in your file.</p> +<p>Also, <code>\~</code> means `place a tilde accent over the +following letter', so you will probably want to use +<code>\verb</code> instead.</p> +<p><a name="IDX348"></a></p> +<p>In addition, you can access any character of a font once you +know its number by using the <code><a name= +"IDX347">\symbol</a></code> command. For example, the character +used for displaying spaces in the <code>\verb*</code> command has +the code decimal 32, so it can be typed as +<code>\symbol{32}</code>.</p> +<p>You can also specify octal numbers with <code>'</code> or +hexadecimal numbers with <code>"</code>, so the previous example +could also be written as <code>\symbol{'40}</code> or +<code>\symbol{"20}</code>.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC167">Splitting the Input</a></font></b></td> +</tr> +</table> +<p><a name="IDX349"></a> <a name="IDX350"></a></p> +<p>A large document requires a lot of input. Rather than putting +the whole input in a single large file, it's more efficient to +split it into several smaller ones. Regardless of how many separate +files you use, there is one that is the root file; it is the one +whose name you type when you run LaTeX.</p> +<ul> +<li><a href="#SEC168">\include</a>: Conditionally include a +file.</li> +<li><a href="#SEC169">\includeonly</a>: Determine which files are +included.</li> +<li><a href="#SEC170">\input</a>: Unconditionally include a +file.</li> +</ul> +<h3><a name="SEC168" href="#TOC168">\include</a></h3> +<p><a name="IDX351"></a></p> +<p><code>\include{file}</code></p> +<p>The <code>\include</code> command is used in conjunction with +the <code>\includeonly</code> command for selective inclusion of +files. The <code>file</code> argument is the first name of a file, +denoting <tt>`file.tex'</tt>. If <code>file</code> is one the file +names in the file list of the <code>\includeonly</code> command or +if there is no <code>\includeonly</code> command, the +<code>\include</code> command is equivalent to</p> +<pre> +\clearpage \input{file} \clearpage +</pre> +<p>except that if the file <tt>`file.tex'</tt> does not exist, then +a warning message rather than an error is produced. If the file is +not in the file list, the <code>\include</code> command is +equivalent to <code>\clearpage</code>.</p> +<p>The <code>\include</code> command may not appear in the preamble +or in a file read by another <code>\include</code> command.</p> +<h3><a name="SEC169" href="#TOC169">\includeonly</a></h3> +<p><a name="IDX352"></a></p> +<p><code>\includeonly{</code><i>file_list</i><code>}</code></p> +<p>The <code>\includeonly</code> command controls which files will +be read in by an <code>\include</code> command. <i>file_list</i> +should be a comma-separated list of filenames. Each filename must +match exactly a filename specified in a <code>\include</code> +command. This command can only appear in the preamble.</p> +<h3><a name="SEC170" href="#TOC170">\input</a></h3> +<p><a name="IDX353"></a></p> +<p><code>\input{file}</code></p> +<p>The <code>\input</code> command causes the indicated +<code>file</code> to be read and processed, exactly as if its +contents had been inserted in the current file at that point. The +file name may be a complete file name with extension or just a +first name, in which case the file <tt>`file.tex'</tt> is used.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC171">Starting & Ending</a></font></b></td> +</tr> +</table> +<p><a name="IDX354"></a> <a name="IDX355"></a></p> +<p>Your input file must contain the following commands as a +minimum:</p> +<pre> + \documentclass{class} + \begin{document} + ... your text goes here ... + \end{document} +</pre> +<p>where the <code>class</code> selected is one of the valid +classes for LaTeX. See section <a href="#SEC24">Document +Classes</a> for details of the various document classes available +locally.</p> +<p>You may include other LaTeX commands between the +<code>\documentclass</code> and the <code>\begin{document}</code> +commands (i.e., in the `preamble').</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC172">Table of Contents</a></font></b></td> +</tr> +</table> +<p><a name="IDX356"></a></p> +<p>A table of contents is produced with the <code><a name= +"IDX357">\tableofcontents</a></code> command. You put the command +right where you want the table of contents to go; LaTeX does the +rest for you. It produces a heading, but it does not automatically +start a new page. If you want a new page after the table of +contents, include a <code>\newpage</code> command after the +<code>\tableofcontents</code> command.</p> +<p>There are similar commands <code><a name= +"IDX358">\listoffigures</a></code> and <code><a name= +"IDX359">\listoftables</a></code> for producing a list of figures +and a list of tables, respectively. Everything works exactly the +same as for the table of contents.</p> +<p>NOTE: If you want any of these items to be generated, you cannot +have the <code><a name="IDX360">\nofiles</a></code> command in your +document.</p> +<ul> +<li><a href="#SEC173">\addcontentsline</a>: Add an entry to table +of contents etc.</li> +<li><a href="#SEC174">\addtocontents</a>: Add text directly to +table of contents file etc.</li> +</ul> +<h3><a name="SEC173" href="#TOC173">\addcontentsline</a></h3> +<p><a name="IDX361"></a></p> +<p><code>\addcontentsline{file}{sec_unit}{entry}</code></p> +<p>The <code>\addcontentsline</code> command adds an entry to the +specified list or table where:</p> +<ul> +<li><code>file</code> is the extension of the file on which +information is to be written: <code>toc</code> (table of contents), +<code>lof</code> (list of figures), or <code>lot</code> (list of +tables).</li> +<li><code>sec_unit</code> controls the formatting of the entry. It +should be one of the following, depending upon the value of the +file argument: +<ol> +<li><code>toc</code> -- the name of the sectional unit, such as +part or subsection.</li> +<li><code>lof</code> -- figure</li> +<li><code>lot</code> -- table</li> +</ol> +</li> +<li><code>entry</code> is the text of the entry.</li> +</ul> +<h3><a name="SEC174" href="#TOC174">\addtocontents</a></h3> +<p><a name="IDX362"></a></p> +<p><code>\addtocontents{file}{text}</code></p> +<p>The <code>\addtocontents</code> command adds text (or formatting +commands) directly to the file that generates the table of contents +or list of figures or tables.</p> +<ul> +<li><code>file</code> is the extension of the file on which +information is to be written: <code>toc</code> (table of contents), +<code>lof</code> (list of figures), or <code>lot</code> (list of +tables).</li> +<li><code>text</code> is the information to be written.</li> +</ul> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC175">Terminal Input/Output</a></font></b></td> +</tr> +</table> +<p><a name="IDX363"></a> <a name="IDX364"></a></p> +<ul> +<li><a href="#SEC176">\typein</a>: Read text from the +terminal.</li> +<li><a href="#SEC177">\typeout</a>: Write text to the +terminal.</li> +</ul> +<h3><a name="SEC176" href="#TOC176">\typein</a></h3> +<p><a name="IDX365"></a></p> +<p><code>\typein[cmd]{msg}</code></p> +<p>Prints <code>msg</code> on the terminal and causes LaTeX to stop +and wait for you to type a line of input, ending with return. If +the <code>cmd</code> argument is missing, the typed input is +processed as if it had been included in the input file in place of +the <code>\typein</code> command. If the <code>cmd</code> argument +is present, it must be a command name. This command name is then +defined or redefined to be the typed input.</p> +<h3><a name="SEC177" href="#TOC177">\typeout</a></h3> +<p><a name="IDX366"></a></p> +<p><code>\typeout{msg}</code></p> +<p>Prints <code>msg</code> on the terminal and in the +<code>log</code> file. Commands in <code>msg</code> that are +defined with <code>\newcommand</code> or <code>\renewcommand</code> +are replaced by their definitions before being printed.</p> +<p>LaTeX's usual rules for treating multiple spaces as a single +space and ignoring spaces after a command name apply to +<code>msg</code>. A <code>\space</code> command in <code>msg</code> +causes a single space to be printed. A <code>^^J</code> in +<code>msg</code> prints a newline.</p> +<table width="100%"> +<tr bgcolor="#3F5881"> +<td align="left"><b><font size="+2" color="white"> <a name= +"SEC178">Typefaces</a></font></b></td> +</tr> +</table> +<p><a name="IDX367"></a> <a name="IDX368"></a></p> +<p>The <code>typeface</code> is specified by giving the "size" and +"style". A typeface is also called a "font".</p> +<ul> +<li><a href="#SEC179">Styles</a>: Select roman, italics etc.</li> +<li><a href="#SEC180">Sizes</a>: Select point size.</li> +<li><a href="#SEC181">Low-level font commands</a>: Commands for +wizards.</li> +</ul> +<h3><a name="SEC179" href="#TOC179">\Styles</a></h3> +<p><a name="IDX369"></a> <a name="IDX370"></a> <a name= +"IDX371"></a></p> +<p>The following type style commands are supported by LaTeX.</p> +<p>These commands are used like <code>\textit{italics text}</code>. +The corresponding command in parenthesis is the "declaration form", +which takes no arguments. The scope of the declaration form lasts +until the next type style command or the end of the current +group.</p> +<p>The declaration forms are cumulative; i.e., you can say +<code>\sffamily\bfseries</code> to get sans serif boldface.</p> +<p>You can also use the environment form of the declaration forms; +e.g. <code>\begin{ttfamily}...\end{ttfamily}</code>.</p> +<dl> +<dt><code><a name="IDX373">\textrm (\rmfamily)</a></code></dt> +<dd><a name="IDX372"></a> Roman.</dd> +<dt><code><a name="IDX375">\textit (\itshape)</a></code></dt> +<dd><a name="IDX374"></a></dd> +<dt><code><a name="IDX376">\emph</a></code></dt> +<dd>Emphasis (toggles between \textit and \textrm).</dd> +<dt><code><a name="IDX378">\textmd (\mdseries)</a></code></dt> +<dd><a name="IDX377"></a> Medium weight (default). The opposite of +boldface.</dd> +<dt><code><a name="IDX380">\textbf (\bfseries)</a></code></dt> +<dd><a name="IDX379"></a> Boldface.</dd> +<dt><code><a name="IDX381">\textup (\upshape)</a></code></dt> +<dd><a name="IDX382"></a> Upright (default). The opposite of +slanted.</dd> +<dt><code><a name="IDX384">\textsl (\slshape)</a></code></dt> +<dd><a name="IDX383"></a> Slanted.</dd> +<dt><code><a name="IDX386">\textsf (\sffamily)</a></code></dt> +<dd><a name="IDX385"></a> Sans serif.</dd> +<dt><code><a name="IDX388">\textsc (\scshape)</a></code></dt> +<dd><a name="IDX387"></a> Small caps.</dd> +<dt><code><a name="IDX389">\texttt (\ttfamily)</a></code></dt> +<dd><a name="IDX390"></a> Typewriter.</dd> +<dt><code><a name="IDX392">\textnormal +(\normalfont)</a></code></dt> +<dd><a name="IDX391"></a> Main document font.</dd> +<dt><code><a name="IDX393">\mathrm</a></code></dt> +<dd>Roman, for use in math mode.</dd> +<dt><code><a name="IDX394">\mathbf</a></code></dt> +<dd>Boldface, for use in math mode.</dd> +<dt><code><a name="IDX395">\mathsf</a></code></dt> +<dd>Sans serif, for use in math mode.</dd> +<dt><code><a name="IDX396">\mathtt</a></code></dt> +<dd>Typewriter, for use in math mode.</dd> +<dt><code><a name="IDX397">\mathit</a></code></dt> +<dd>Italics, for use in math mode, e.g. variable names with several +letters.</dd> +<dt><code><a name="IDX398">\mathnormal</a></code></dt> +<dd>For use in math mode, e.g. inside another type style +declaration.</dd> +<dt><code><a name="IDX399">\mathcal</a></code></dt> +<dd>`Calligraphic' letters, for use in math mode.</dd> +</dl> +<p>In addition, the command <code><a name= +"IDX400">\mathversion{bold}</a></code> can be used for switching to +bold letters and symbols in formulas. +<code>\mathversion{normal}</code> restores the default.</p> +<h3><a name="SEC180" href="#TOC180">Sizes</a></h3> +<p><a name="IDX401"></a> <a name="IDX402"></a> <a name= +"IDX403"></a></p> +<p>The following standard type size commands are supported by +LaTeX.</p> +<p>The commands as listed here are "declaration forms". The scope +of the declaration form lasts until the next type style command or +the end of the current group.</p> +<p>You can also use the environment form of these commands; e.g. +<code>\begin{tiny}...\end{tiny}</code>.</p> +<dl> +<dt><code><a name="IDX404">\tiny</a></code></dt> +<dt><code><a name="IDX405">\scriptsize</a></code></dt> +<dt><code><a name="IDX406">\footnotesize</a></code></dt> +<dt><code><a name="IDX407">\small</a></code></dt> +<dt><code><a name="IDX408">\normalsize</a></code></dt> +<dd>(default)</dd> +<dt><code><a name="IDX409">\large</a></code></dt> +<dt><code><a name="IDX410">\Large</a></code></dt> +<dt><code><a name="IDX411">\LARGE</a></code></dt> +<dt><code><a name="IDX412">\huge</a></code></dt> +<dt><code><a name="IDX413">\Huge</a></code></dt> +</dl> +<h3><a name="SEC181" href="#TOC181">Low-level font +commands</a></h3> +<p><a name="IDX414"></a> <a name="IDX415"></a></p> +<p>These commands are primarily intended for writers of macros and +packages. The commands listed here are only a subset of the +available ones. For full details, you should consult Chapter 7 of +<cite>The LaTeX Companion</cite>.</p> +<dl> +<dt><code><a name="IDX416">\fontencoding{enc}</a></code></dt> +<dd>Select font encoding. Valid encodings include <code>OT1</code> +and <code>T1</code>.</dd> +<dt><code><a name="IDX417">\fontfamily{family}</a></code></dt> +<dd>Select font family. Valid families include: +<ul> +<li><code>cmr</code> for Computer Modern Roman</li> +<li><code>cmss</code> for Computer Modern Sans Serif</li> +<li><code>cmtt</code> for Computer Modern Typewriter</li> +</ul> +and numerous others.</dd> +<dt><code><a name="IDX418">\fontseries{series}</a></code></dt> +<dd>Select font series. Valid series include: +<ul> +<li><code>m</code> Medium (normal)</li> +<li><code>b</code> Bold</li> +<li><code>c</code> Condensed</li> +<li><code>bc</code> Bold condensed</li> +<li><code>bx</code> Bold extended</li> +</ul> +and various other combinations.</dd> +<dt><code><a name="IDX419">\fontshape{shape}</a></code></dt> +<dd>Select font shape. Valid shapes are: +<ul> +<li><code>n</code> Upright (normal)</li> +<li><code>it</code> Italic</li> +<li><code>sl</code> Slanted (oblique)</li> +<li><code>sc</code> Small caps</li> +<li><code>ui</code> Upright italics</li> +<li><code>ol</code> Outline</li> +</ul> +The two last shapes are not available for most font families.</dd> +<dt><code><a name="IDX420">\fontsize{size}{skip}</a></code></dt> +<dd>Set font size. The first parameter is the font size to switch +to; the second is the <code>\baselineskip</code> to use. The unit +of both parameters defaults to pt. A rule of thumb is that the +baselineskip should be 1.2 times the font size.</dd> +<dt><code><a name="IDX421">\selectfont</a></code></dt> +<dd>The changes made by calling the four font commands described +above do not come into effect until <code>\selectfont</code> is +called.</dd> +<dt><code><a name= +"IDX422">\usefont{enc}{family}{series}{shape}</a></code></dt> +<dd>Equivalent to calling <code>\fontencoding</code>, +<code>\fontfamily</code>, <code>\fontseries</code> and +<code>\fontshape</code> with the given parameters, followed by +<code>\selectfont</code>.</dd> +</dl> +<address> +<hr> +<div align="center"> +<table width="100%" cellspacing="0" border="0"> +<tr> +<td>LaTeX Reference</td> +<td></td> +<td align="right"> +<div align="right">Kile</div> +</td> +</tr> +</table> +</div> +</address> +</body> +</html> diff --git a/doc/en/psutils1.png b/doc/en/psutils1.png Binary files differnew file mode 100644 index 0000000..9fd015c --- /dev/null +++ b/doc/en/psutils1.png diff --git a/doc/en/psutils15.png b/doc/en/psutils15.png Binary files differnew file mode 100644 index 0000000..3ce1fd7 --- /dev/null +++ b/doc/en/psutils15.png diff --git a/doc/en/psutils16.png b/doc/en/psutils16.png Binary files differnew file mode 100644 index 0000000..a7c59bb --- /dev/null +++ b/doc/en/psutils16.png diff --git a/doc/en/psutils2.png b/doc/en/psutils2.png Binary files differnew file mode 100644 index 0000000..9a09321 --- /dev/null +++ b/doc/en/psutils2.png diff --git a/doc/en/psutils3.png b/doc/en/psutils3.png Binary files differnew file mode 100644 index 0000000..b738969 --- /dev/null +++ b/doc/en/psutils3.png diff --git a/doc/en/psutils5.png b/doc/en/psutils5.png Binary files differnew file mode 100644 index 0000000..9b31a89 --- /dev/null +++ b/doc/en/psutils5.png diff --git a/doc/en/psutils6.png b/doc/en/psutils6.png Binary files differnew file mode 100644 index 0000000..0ff695f --- /dev/null +++ b/doc/en/psutils6.png diff --git a/doc/en/psutils7.png b/doc/en/psutils7.png Binary files differnew file mode 100644 index 0000000..d8ba340 --- /dev/null +++ b/doc/en/psutils7.png diff --git a/doc/en/psutils8.png b/doc/en/psutils8.png Binary files differnew file mode 100644 index 0000000..a752a5c --- /dev/null +++ b/doc/en/psutils8.png diff --git a/doc/en/quickpreview.png b/doc/en/quickpreview.png Binary files differnew file mode 100644 index 0000000..039f82c --- /dev/null +++ b/doc/en/quickpreview.png diff --git a/doc/en/select.png b/doc/en/select.png Binary files differnew file mode 100644 index 0000000..e2f1acc --- /dev/null +++ b/doc/en/select.png diff --git a/doc/en/snap_autocomplete.png b/doc/en/snap_autocomplete.png Binary files differnew file mode 100644 index 0000000..fdee5d9 --- /dev/null +++ b/doc/en/snap_autocomplete.png diff --git a/doc/en/snap_compile_error.png b/doc/en/snap_compile_error.png Binary files differnew file mode 100644 index 0000000..24001cf --- /dev/null +++ b/doc/en/snap_compile_error.png diff --git a/doc/en/snap_editusertag.png b/doc/en/snap_editusertag.png Binary files differnew file mode 100644 index 0000000..f2b4289 --- /dev/null +++ b/doc/en/snap_editusertag.png diff --git a/doc/en/snap_encoding.png b/doc/en/snap_encoding.png Binary files differnew file mode 100644 index 0000000..6dbe7af --- /dev/null +++ b/doc/en/snap_encoding.png diff --git a/doc/en/snap_kdvi_settings.png b/doc/en/snap_kdvi_settings.png Binary files differnew file mode 100644 index 0000000..77a3ef2 --- /dev/null +++ b/doc/en/snap_kdvi_settings.png diff --git a/doc/en/snap_projectview.png b/doc/en/snap_projectview.png Binary files differnew file mode 100644 index 0000000..8b11723 --- /dev/null +++ b/doc/en/snap_projectview.png diff --git a/doc/en/snap_projectview_add.png b/doc/en/snap_projectview_add.png Binary files differnew file mode 100644 index 0000000..9c84e71 --- /dev/null +++ b/doc/en/snap_projectview_add.png diff --git a/doc/en/snap_ref_choose.png b/doc/en/snap_ref_choose.png Binary files differnew file mode 100644 index 0000000..f4c9a0a --- /dev/null +++ b/doc/en/snap_ref_choose.png diff --git a/doc/en/snap_ref_select.png b/doc/en/snap_ref_select.png Binary files differnew file mode 100644 index 0000000..1843630 --- /dev/null +++ b/doc/en/snap_ref_select.png diff --git a/doc/en/snap_sidebarmenu.png b/doc/en/snap_sidebarmenu.png Binary files differnew file mode 100644 index 0000000..a7ce8a3 --- /dev/null +++ b/doc/en/snap_sidebarmenu.png diff --git a/doc/en/snap_structview_label.png b/doc/en/snap_structview_label.png Binary files differnew file mode 100644 index 0000000..8646059 --- /dev/null +++ b/doc/en/snap_structview_label.png diff --git a/doc/en/snap_usertag.png b/doc/en/snap_usertag.png Binary files differnew file mode 100644 index 0000000..818c5fe --- /dev/null +++ b/doc/en/snap_usertag.png diff --git a/doc/en/texgroup.png b/doc/en/texgroup.png Binary files differnew file mode 100644 index 0000000..845e82b --- /dev/null +++ b/doc/en/texgroup.png |
