# TexMakerX : User manual

## Contents :

- 0. What's new

- 0.1 Version 1.8.1 -> Version 1.9

- 1. Configuring TexMakerX

- 1.1 Configuring the editor
- 1.2 Configuring the latex related commands
- 1.3 Configuring some general issues
- 1.3.1 Configuring the spell checker
- 1.3.2 Configuring the thesaurus
- 1.4 Configuring the autocompletion
- 1.5 Configuring shortcuts

- 2. Editing a TeX document

- 2.1 Usual commands
- 2.2.1 Setting the preamble of a TeX document
- 2.2.2 Using Templates to start a new document
- 2.3 Structure of a document
- 2.4 Browsing your document
- 2.5 Formatting your text
- 2.6 Spacings
- 2.7 Inserting a list
- 2.8 Inserting a table
- 2.9 Inserting a "tabbing" environment
- 2.10 Inserting a picture
- 2.11 Cross References and notes
- 2.12 Inserting math formulae
- 2.13 Auto completion
- 2.14 Thesaurus

- 3. Compiling a document

- 3.1 Compiling
- 3.2 The log files

- 4. Other features

- 4.1 About documents separated in several files
- 4.2 Bibliography
- 4.3 Personal tags and tools
- 4.4 Pstricks support
- 4.5 Metapost support
- 4.6 The "Convert to Html" command
- 4.7 "Forward/Inverse search" with TexMakerX
- 4.8 Synopsis of the TexMakerX command
- 4.9 Keyboard shortcuts

# 0. What's new

## 0.1 Version 1.8.1 -> Version 1.9

TexMakerX has been diligently extended for the last months. The subsequent list gives a probably incomplete overview of new and changed functionality:

- First steps for dynamic syntax highlighting have been implemented. For example references in in commands like \label or \ref are checked and are marked especially if the reference does not exist (in case of referencing) or if it has been defined multiple times.

- The word completion system has been extended. It now uses “kile”-word lists which extend the number of known commands considerably. The key Tab can be used to complete common word bases in the present suggestion list like it is done in bash shells. Furthermore it can also complete normal text by proposing earlier used text parts. The two modes are distinguished by a backslash as starting letter. And finally “User Tags” (user defined text blocks) can be inserted by using user defined abbreviations which replaced in the completion process. The old behavior of using key sequences for inserting user tags certainly is still available. And lastly user defined latex commands are automatically scanned and can be used for command completion.

- Apart from using wizards, new documents can be created by using templates. User can add own templates which can be edited or removed later on if necessary.

- The symbol panel was extended. It was also extended by “kile” symbol list. It also can insert “tags” from textual lists. And finally the column count automatically adapts to the available horizontal space. Not to mention that unwanted symbol lists can be hidden.

- The symbol list selector was moved to the left edge to give more room for the symbols, like it was done in texmaker.

- Hover help was implemented. Hovering the cursor over standard latex commands will present tool tip help. If it is hovers over references, the corresponding text passage which contains the label is shown as tool tip.

- A preview for selected text can be shown either in the status panel or as tool tip.

- The status/log/error panel can also be used in a tabbed manner if desired.

- The online spell checker handles escaped chars like “a or \”{a} now correctly. It also refrain from spell checking in (some) latex command options like \ref{label} and some more.

- The context menu of the structure view gives some useful option like selecting a complete section or indenting a section which means changing \section to \subsection and accordingly all included headings as well.

- A thesaurus was added. It allows search for word parts as well.

- For sure, lots of bugs have been squashed !

# 1. Configuring TexMakerX

Before using TexMakerX, you should configure the editor and latex related commands via the "Configure TexMakerX" command in the "Options" menu ("Preferences" under macosx).

## 1.1 Configuring the editor

You can should set the default encoding for new files ("Configure TexMakerX" -> "Editor" -> "Editor Font Encoding") if you don't want utf8 as encoding. Don't forget to set the same encoding in the preamble of your documents. (e.g. \usepackage[utf8]{inputenc}, if you use utf-8).
TexMakerX can auto detect utf-8 and latin1 encoded files, but if you use a different encoding in your existing documents you have to specify it in the configuration dialog before opening them. (and then you also have to disable the auto detection)

- "Show Line State Change" sets yellow markers left to the text to show which lines have been changed and are still unsaved. That marker turns grreen if they are saved.
- "Show modify time" prints the time since the last key stroke in the status panel.
- The selection box "Keep indentation" let you select, wether indented lines are followed by lines of the same indentation after pressing Enter or letting TexMakerX do automatic indentation.

## 1.2 Configuring the latex related commands

TexMakerX can't compile yours documents if the paths to the LaTeX related commands are wrong.
The default settings should work with the recent and standard LaTeX distributions, but you could have to modify them ("Configure TexMakerX" -> "Commands"). To change a command, just click on the button at the end of the corresponding line and select the command in the file browser : TexMakerX will adapt automatically the syntax of the command.
The % character represents the name of the file without the extension and the @ character will be replaced by the current line number. If you need more options (e.g. absolute paths) use ? and look at the instruction on the bottom of the configuration dialog.

## 1.3 Configuring some general issues

This panel allows the setting of some general aspects.

- The "style" and "color scheme" of TexMakerX can be selected. The modern variant is closer to texmaker 1.9.
- The symbol list can either appear "tabbed" (old behaviour, tabbed activated) or can have small symbol tabs besides the symbol lists which leaves more room for the symbols.
- Also the log viewer can appear tabbed which allows faster chnage between error table, log view and previewer ...
- The language of the menus can be changed directly to ignore system settings.

## 1.3.1 Configuring the spell checker

The spell checker uses the OpenOffice.org dictionaries. Only GPL French and British dictionaries are distributed with TexMakerX.
Users can download others dictionaries here : http://wiki.services.openoffice.org/wiki/Dictionaries
To configure the spell checker : "Configure TexMakerX" -> "Editor" -> "Spelling dictionary" -> click on the button at the end of the line to select the dictionary with the file browser. If you specify a non existing file the edit gets red.
Warning : spell checking with Ctrl+Shift+F7 starts at the cursor position and not at the beginning of the document.
If the interactive spell checker is enabled (default), any wrong spelled word is underlined with a red wave. Click on it with the right mouse to open an menu with a list of possible corrections. There you can also move it to the ignore list. If your dictionary is very large (> 5MB), opening the context menu and showing possible suggestions can take some seconds. If you don't need the suggestion, you can press shift while right clicking and don't have to wait.
The ignore list is normally saved in the same directory as the dictionary with the extension .ign. If this isn't possible (e.g. missing access) the list is stored in the user configuration directory.

## 1.3.2 Configuring the thesaurus

The thesaurus uses OpenOffice.org 2.x databases. Only GPL French and US-English and German databases are distributed with TexMakerX.
Users can download others databases here : http://wiki.services.openoffice.org/wiki/Dictionaries

## 1.4 Configuring the autocompletion

TexMakerX has taken up completion word list from kile which extended the number of known commands for completion considerably. This probably not every command is useful in your document if the corresponding latex package is not used, TexMakerX allows to select the valid word list under "Configure TexMakerX" -> "Editor" -> "". The names of the word lists corresponds to the package for which they are made. The list latex.cwl contains the standard latex commands.
Concerning auto completion, TexMakerX allows to adapt the behaviour to your liking. Following options are available:

- Completion enabled: self explanatory
- Case sensitive: let's you complete e.g. \Large from \la ...
- in first character: ?
- Auto Complete Common Prefix: if only one item is in the list or all items in the completion list share common starting characters, the common characters are directly inserted, like pressing the key Tab.
- Complete selected text when non-word character is pressed: when in completion mode, pressing a non-word character like space, leads to accepting the selected word. This may speed up typing.
- Enable ToolTip-Help: show tool tips on selected latex commands in the completion list.
- Use Placeholders: if the completed commands have options which need to be filled out, "place holder" are put at this positions and they can be jumped to by using Ctrl+Right/Ctrl+Left.

## 1.5 Configuring shortcuts

Shortcuts can be changed by double clicking on "Current Shortcut" or "Additional Shortcut". A shortcut can be selected from the driop down list or put in as text directly. If a shortcut should be set to default value or removed completely, the items "<default>" or "<none>" at the top of the list can be selected.

# 2. Editing a TeX document

## 2.1 Usual commands

The standard commands (cut, copy, find...) can be launched via the "Edit" menu and the "Edit" tool bar.

## 2.2.1 Setting the preamble of a TeX document

To define the preamble of your document, you can use the "Quick start" wizard ("Wizard" menu).

This dialog allows you to set the main features of your document (class, paper size, encoding...).
Note : You can add other options by clicking the "+" buttons. All yours settings are recorded.

You can also type your own preamble model in the editor : with the "Copy/paste" or "Save As" commands, you can use it for a new document.

## 2.2.2 Using Templates to start a new document

For new documents, templates can be used by using the command "File/New from template". A dialogue gives a selection of templates.

New templates can be added by using the command "File/Make Template" on a opened document which you like to have has a template. User added templates can be edited or deleted by using the context menu in the template selection dialogue. Built-in templates can not be changed.

## 2.3 Structure of a document

To define a new part (section,subsection...) in your document with TexMakerX, just use this combo box in the tool bar :

This will cause a dialog to pop up which allows you to define the style of the part (section,subsection...).
Note : the "Structure View" is automatically updated.

## 2.4 Browsing your document

The "Structure View" (left panel) lets you quickly reach any part of your document. All you need to do is to click on any item (label, section...) and you will be taken to the beginning of the corresponding area in the editor. The mechanism for jumping to a line does not anymore only consider line numbers but really remembers text lines. Thus adding and removing lines will not lead to jumps to wrong locations.

The "Structure View" is automatically updated when you save or compile your document. You can also use the "Refresh Structure" ("Edit" menu) command at any moment.

Apart from labels,sections and includes, comments starting with %TODO are also scanned for and presented as section of its owhn in the structure view. This can be used to create a kind of permanent bookmark in the text or just to note where some changes are still necessary.

The structure view also offers a context menu which allows to copy/cut all text which belongs to a section (including subsection) and paste it before or after a section. Section can be indented/unindented which means that the hiearachy level is changed by one, i.e. \section is changed to \subsection, and all subsections are treated accordingly

For each file, three bookmarks can be used to speed up navigation : just click on a line number to add or remove a bookmark. When you have already defined three bookmarks, you must remove one of them to add a new bookmark. To jump to the line corresponding to a bookmark in the editor, just click on the buttons in the status bar.

## 2.5 Formatting your text

You can quickly set the format of a part of your text with this tool bar :

Additional option: a selected text can be directly framed by certain environments. Example: while clicking on the button "Bold" after having selected the word "Hello" , you will obtain the code: \textbf{Hello}.
This option is available for all the environments indicated by "[selection]" in the "LaTeX" menu.

## 2.6 Spacings

The usual "spacing" commands are available in the "LaTeX" and "Math" menus. To insert quickly the "new line" LaTeX command, you can use the corresponding command in the toolbar (shortcut : Ctrl+Alt+return)

## 2.7 Inserting a list

The usual list environments code can be insert quickly via the "LaTeX-List" menu.
Note : the shortcut for the \item command is Ctrl+Alt+H.

## 2.8 Inserting a table

With the "Tabular" wizard ("Wizard" menu), the LaTeX code for a tabular environment can be quickly inserted :

You can set the main features of your table.
Note : this dialog allows you to type directly the code in the cells.
The corresponding LaTeX code is automatically inserted in the editor.

## 2.9 Inserting a "tabbing" environment

To help you to insert a "tabbing" code, you can use the "Tabbing" wizard ("Wizard" menu) :

## 2.10 Inserting a picture

To insert a picture in your document, just use the "\includegraphics" command in the "LaTeX" menu. Then, click on the "browser" button in the dialog to select the graphic file.
Note : you can insert a "figure" LaTeX environment ("LaTeX - Environments" menu) before inserting the picture.

## 2.11 Cross References and notes

This toolbox in the toolbar allows you to insert quickly the label, cite, ref, footnote... code.
Note : the labels used in your documents are displayed in the "Structure View".

Additional option:for the \ref command, a dialog box allows you to select directly the label.

## 2.12 Inserting math formulae

You can toggle in the "in-line math" environment with the "f(x)" button in the toolbar (shortcut : Ctrl+Alt+M) or with the "Math" menu. The shortcut for the "display math" environment is : Alt+Shift+M.
The "Math" toolbar allows you to insert the most currents mathematical forms (frac, sqrt...) like the \left and \right tags.

With the "symbols panels" in the structure view, you can insert the code of 400 mathematical symbols.

You can also define the format of your mathematical text via the "Math" menu.
For the "array" environments, a wizard (like the "Tabular" wizard) is available in the "Wizard" menu. With this wizard, you can select the environment : array, matrix, pmatrix.... The cells can be directly completed.

## 2.13 Auto Completion

Whenever you press \ followed by a letter, a list of possible LaTex tags is shown where you select the right one. If you write additional letters the list is filtered, so that only the tags starting with the already written text are shown. If the list contains words which all start with the same letter combination, you can press Tab to complete all common letters. If only one element is present in the list, Tab selects this one to do the completion, like Enter. This behaviour is similar to tab completion in bash shells. You can also press Ctrl+Space to open this list whenever you want.
If a tag has different options, a short descriptive text is inserted into your text, telling you the meaning of each option. You can press Ctrl+Left, Ctrl+Right to select all positions.
Furthermore normal text can be completed by starting to type a word and pressing Ctrl+Space. All apropriate words in the current document are used as possible suggestions.
If a enviroment is to be inserted, typing in the beginning of the environment name and pressing Ctrl+Alt+Space gives suggestions for adequate enviroments which are inserted completely with \begin{env}..\end{env}
And finally user tags can be assigned a abbreviation which can also be used with completion. Just type in the start of the abbreviation and start the completion with Ctrl+Space. The abbreviation should show up in the completion list, especially marked with “abbreviation (template)”.

## 2.14 Thesaurus

TexMakerX has integrated a simple thesaurus. OpenOffice 2.x databases are used for this. By placing the cursor on a word and activating the thesaurus (Ctrl+Shift+F8 or Edit/Thesaurus), it tries to find synonyms for this word. Please be patient if you start the thesaurus at first time since loading the database just occurs then and can take a few moments.

The first line to the left contains the word, for which a synonym is searched for. The list below gives a list of word classes. The can be chosen to reduce the number of suggestions. The column to the right contains the list of suggested synonyms. A selected word from this list apears in the first line to the right as proposition for replacement of the text. This word can be changed manually. It is also used to do further investigations for words and their synonyms which "start with" or "contain" that word. With "lookup" it can be directly used to look for a synonym for that word.

# 3. Compiling a document

## 3.1 Compiling

The easiest way to compile a document is to use the "Quick Build" command ("Quick" button - shortcut : F1). You can define the sequence of commands used by the "Quick Build" command via the "Configure TexMakerX" dialog.
You can also launch each command one by one (shortcuts : F2...F12 - see the "Tools" menu).
Note : the "Clean" command in the "Tools menu" allows you to erase the files (dvi, toc, aux...) generated by a LaTeX compilation (except the ps and pdf files).
Warning : all yours files must have an extension and you can't compile an "untitled" file or a file with a space in his name.

## 3.2 The log files

With the "Quick Build" command, the log file is automatically displayed in the "Messages / Log file" pannel. While clicking on a number in the "Line" column, the cursor is placed on the corresponding line in the editor and the error is displayed.
Remark : a summary of the latex errors and warnings is displayed before the full log file.

The "Next Latex Error"and "Previous LaTeX Error" commands allow to get to the errors detected during compilation.

Lines with errors, warnings, bad boxes will be highlighted with red, yellow or blue background and you can jump between them using Ctrl+Up/Down. (Ctrl+Shift for errors only, Ctrl+Alt for warnings only, Alt+Shift for bad boxes only)
A tool tip will show more details of the mistake if you jump to a line (it is also shown if you move the mouse over the mark left from the line numbers).

# 4. Other features

## 4.1 About documents separated in several files

TexMakerX allows you to work onto documents separated in several files.
To include a TeX file into your document, just use the "\include{file}" command in the "LaTeX" menu. The file will appear in the "Structure View". With a click on his name, TexMakerX will open it.

Then, you can define your "master document" with the "Options" menu. All the commands of the "Tools" menu will apply only to this document even when working on the "children" documents (you can even close the "master" document).
Note : you can leave the "master" mode with the "Options" menu.

## 4.2 Bibliography

For the "bib" files , the "Bibliography" menu enables you to directly insert the entries corresponding to the standard types of document.
Note: the optional fields can be automatically deleted with the "Clean" command of the "Bibliography" menu.

## 4.3 Personals tags and tools

TexMakerX allows you to insert your own tags (shortcuts : Shift+F1...Shift+F10). These tags are defined with the "User - User Tags" menu.
Note : if the code of the menu is "%environment", TexMakerX will directly insert:
\begin{environment }
\end{environment }
If you write %| somewhere the cursor will be placed at that place in the inserted text. (A second %| will select everything between them).
Write %<something%> to mark it as descriptive text which can be selected by Ctrl+Left/Right.

You can also launch your own commands (shortcuts : Alt+Shift+F1...Alt+Shift+F5). These commands are defined with the "User - User Commands" menu.

## 4.4 Pstricks support

The main pstricks commands can be inserted with the "Pstricks" panel in the "Structure View".

## 4.5 Metapost support

The metapost keywords can be inserted with the "Metapost" panel in the "Structure View" and the "mpost" command can be launched via the "Tools" menu.

## 4.6 The "Convert to Html" command

This command (from the "Tools" menu ) produces a set of html pages from a LaTeX source file with one image for each html page. Each page in the slide presentation corresponds to one of the postscript pages you would obtain running LaTeX.
The command also produces an index page corresponding to the table of contents you would obtain with LaTeX. Each item of the index page includes a link to the corresponding html page.

You can create links in the html pages by using the \ttwplink{}{} command in the tex file.
Synopsis :
\ttwplink{http://www.mylink.com}{my text} (external link)
\ttwplink{page3.html}{my text} (internal link)
\ttwplink{name_of_a_label}{my text} (internal link)
Warning : You can't use this command with the hyperref package (and some others packages). This command can only be used with the "Convert to html" tool.

## 4.7 "Forward/Inverse search" with TexMakerX

Some dvi viewers can jump to (and visually highlight) a position in the DVI file that corresponds to a certain line number in the (La)TeX source file.
To use this feature, you can use the @ character (=line number) and ?c:ame (=complete absolute filename of currently opened file) placeholder in the syntax of the dvi viewer command ("Configure TexMakerX" -> "Commands").
Examples ("Forward search"):

- To launch yap from TexMakerX : "C:/Program Files/MiKTeX 2.7/miktex/bin/yap.exe" -1 -s @?c:m.tex %.dvi
- To launch xdvi from TexMakerX : xdvi %.dvi -sourceposition @:?c:m.tex
- To launch kdvi from TexMakerX : kdvi "file:%.dvi#src:@ ?c:m.tex"
- To jump to a position in a running Acrobat Reader (Windows only): dde://acroview/control/[DocOpen("?am.pdf")][FileOpen("?am.pdf")][DocGotoNameDest("?am.pdf","jump-position")]jump-position can be defined with the hyperref package
- To jump to a line in a running Sumatra (Windows only): dde://SUMATRA/control/[ForwardSearch("?m.pdf","?c:m.tex",@,0,0,1)]

For the opposite operation ("Inverse search") :

- To launch TexMakerX from yap or Sumatra: "C:\Program Files\TexMakerX\TexMakerX.exe" "%f" -line %l (the program arguments : "%f" -line %l )
- To launch TexMakerX from xdvi : xdvi -editor "TexMakerX %f -line" %.dvi -sourceposition @:%.tex
- To launch TexMakerX from skim : Command: /applications/texmakerx.app/contents/macos/texmakerx
  Parameters:"%file" -line %line

## 4.8 Synopsis of the TexMakerX command

TexMakerX file [-master] [-line xx] [--start-always]
With the "-master" option, the document will be automatically defined as a "master" document.
With the "-line xx" option, TexMakerX will ask you if you want to jump to the xx line after loading the document.
With the "--start-always" option, TexMakerX will start, even if another instance of it is already running

## 4.9 Keyboard shortcuts

Defaults keyboard shortcuts :

- "File" menu :
  - New : Ctrl+N
  - Open : Ctrl+O
  - Save : Ctrl+S
  - Save as: Ctrl+Alt+S
  - Save all: Ctrl+Shift+Alt+S
  - Close : Ctrl+W
  - Print : Ctrl+P
  - Exit : Ctrl+Q
- "Edit" menu :
  - Undo : Ctrl+Z
  - Redo : Ctrl+Y
  - Copy : Ctrl+C
  - Cut : Ctrl+X
  - Paste : Ctrl+V
  - Paste as latex: Ctrl+Shift+V
  - Select all : Ctrl+A
  - Remove line : Ctrl+K
  - Show preview : Alt+P
  - Find : Ctrl+F
  - Find next : Ctrl+M
  - Replace : CTrl+R
  - Goto line : Ctrl+G
  - Jump to last change: Ctrl+H
  - Jump to previous change: Ctrl+Shift+H
  - Set Bookmark 0..9: Ctrl+Shift+0..9
  - Jump to Bookmark 0..9: Ctrl+0..9
  - Next Marker: Ctrl+Down
  - Previous Marker: Ctrl+Shift+Up
  - Next Latex Error: Ctrl+Shift+Down
  - Previous Latex Error: Ctrl+Shift+Up
  - Next Latex Warning: Ctrl+Alt+Down
  - Previous Latex Warning: Ctrl+Alt+Up
  - Next Latex Bad Box: Shift+Alt+Down
  - Previous Latex Bad Box: Shift+Alt+Up
  - Go to definition: Ctrl+Alt+F
  - Check spelling (from cursor) : Ctrl+Shift+F7
  - Open Thesaurus : Ctrl+Shift+F8
  - Refresh Structure View : F12
  - Remove placeholders : Ctrl+Shift+K
- "Tools" menu :
  - Quick build : F1
  - Latex : F2
  - View dvi : F3
  - Dvi->PS : F4
  - View PS : F5
  - Pdflatex : F6
  - View Pdf : F7
  - PS->Pdf : F8
  - Dvi->Pdf : F9
  - Bibtex : F11
  - Make index : F12
- * "LaTeX" menu :
  - * item : Ctrl+Shift+I
  - * Italic : Ctrl+I
  - * Slanted : Ctrl+Shift+S
  - * Bold : Ctrl+O
  - * Typewriter : Ctrl+Shift+T
  - * Small caps : Ctrl+Shift+C
  - * Emphasis : Ctrl+Shift+E
  - * New line : Ctrl+Return
  - * begin{environment} : Ctrl+E
  - * Insert reference to next label : Ctrl+Alt+R
- * "Math" menu :
  - * Inline math mode : Ctrl+Shift+M
  - * Display math mode : Alt+Shift+M
  - * Numbered equations : Ctrl+Shift+N
  - * Subscript : Ctrl+Shift+D
  - * Superscript : CTrl+Shift+U
  - * Frac : Alt+Shift+F
  - * Dfrac : Ctrl+Shift+F
  - * Sqrt : Ctrl+Shift+Q
  - * Left : Ctrl+Shift+L
  - * Right : Ctrl+Shift+R
- "User" menu :
  - User tags : Shift+F1...Shift+F10
  - User commands : Shift+Alt+F1...Shift+Alt+F10
- "View" menu :
  - Next Document : Alt+PgUp
  - Previous Document : Alt+PgDown
  - View log : F10