1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
|
<html>
<head><title>TeXShell help (Start)</title>
</head>
<body>
<a name="main">
<h1>TeXShell (J. Pnisch)</h1>
</a>
If you are using the internal help, you can navigate with the following
keys:
<dl>
<code><dt>Tab</code>
<dd> Select next link.
<code><dt>Shift-Tab</code> <dd>Select prev. link.
<code><dt>Enter</code> <dd>Goto this link.
<code><dt>Page-Up</code> <dd>Page up.
<code><dt>Page-Down</code> <dd>Page down.
<code><dt>i</code> <dd>Help index.
<code><dt>m</code> <dd>Goto the start screen (Main)
<code><dt>Ctrl-c</code> <dd>Copy the sample into the Paste Buffer.
<code><dt>Escape</code> <dd>Leave the help screen.
</dl>
<p>
You can find help to the following topics:
<ul>
<li><a href="#call">Starting TeXShell</a>
<li><a href="#steps">Working with TeXShell</a>
<li><a href="tedit.html#main">TeX Editor</a>
<li><a href="#keys">Using keys</a>
<li><a href="#config">Settings</a>
<li><a href="#globopt">Global settings</a>
<li><a href="#template">Document templates</a>
<li><a href="#project">Project management</a>
<li><a href="latex/index.html">LaTeX syntax</a>
<li><a href="#files">Configuration files</a>
</ul>
<a name="call">
<h1>Starting TeXShell</h1>
</a>
You can start the TeXShell by calling the command
<pre>
ts [primary file]
</pre>
If there are no dots in the file name, the extension .tex will be added
automatically. But if you work with files like a.b.c.tex, you must
specify the full file name!
<p>
-> <a href="#main">Start</a>
<a name="steps">
<h1>Working with TeXShell</h1>
</a>
<ol>
<li> Select Primary file with <code>F13</code> or <code>Shift-F3</code>.
<li> Edit the primary file with <code>Alt-0</code>. If it is a new file,
you can use a <a href="#templates">template</a>.
<li> You can open some more files for edit with <code>F3</code>. Changing
between them is possible with <code>Alt-[Window number]</code>.
<li> Compose the Primary file with <code>F6</code>. If an error occurs,
you can return to the right place in Editor by pressing <code>e</code>.
<li> View the dvi file with <code>F8</code>. If the viewer needs a
PostScript file, it will be generated automatically by dvips.
<li> Print the dvi file with <code>F9</code>. Close the printing dialog
with <code>Ctrl-Enter</code>.
<li> Finish working with <code>Alt-x</code>.
</ol>
-> <a href="#main">Start</a>
<a name="keys">
<h1>Using keys</h1>
</a>
<dl>
<code><dt>F1</code>
<dd> Help
<code><dt>Shift-F3, F13</code>
<dd> Select Primary file. If nessecary, changing working directory.
<code><dt>F3</code>
<dd> Open editor after selecting the file.
<code><dt>Alt-0</code>
<dd> Edit Primary file.
<code><dt>Alt-1 ... Alt-9</code>
<dd> Select edit window (only internal editor).
<code><dt>F4</code>
<dd> Open project window.
<code><dt>F5</code>
<dd> Start graphics editor.
<code><dt>F6</code>
<dd> Compose the document (Primary file).
<code><dt>F7</code>
<dd> Generate references (makeindex, bibtex etc.).
<code><dt>F8</code>
<dd> Viewer
<code><dt>F9</code>
<dd> Print the document.
<code><dt>F11</code>
<dd> Utilities.
<code><dt>Alt-F5</code>
<dd> Show terminal window (back with <code>Alt-[Number]</code>).
<code><dt>Ctrl-F2...Ctrl-F10</code>
<dd> Select and configure the used command for the F# operations.
<code><dt>Alt-x</code>
<dd> Exit
</dl>
<p>
-> <a href="#dlgkeys">Dialog keys</a><br>
-> <a href="#teditkeys">Keys for the internal editor</a><br>
-> <a href="#main">Start</a>
<a name="dlgkeys">
<h1>Dialog keys</h1>
</a>
<dl>
<code><dt>Tab, Enter</code>
<dd> Next Field
<code><dt>Shift-Tab</code>
<dd> Previous Field
<code><dt>Ctrl-Enter</code>
<dd> OK
<code><dt>Escape</code>
<dd> Cancel the dialog
<code><dt>Alt-[Letter]</code>
<dd> Select the action with the underlined letter.
</dl>
<p>
The file dialog will be finished with <code>Enter</code>, if you have
selected a file.
<br>
If an extension is specified, it will be added to a specified filename
without extension automatically.
<p>
-> <a href="#main">Start</a>
<a name="config">
<h1>Action settings</h1>
</a>
The <code>Ctrl-Function key</code> shows the Settings dialog for the
specified action. You can add new functions with <code>Alt-i</code>
or <code>Alt-a</code>, or edit defined functions with <code>Alt-e</code>:
<dl>
<strong><dt>Name</strong>
<dd> Short name for the action.
<strong><dt>Exec Proc</strong>
<dd> Tcl procedure for executing the program:
<dl>
<code><dt>exwin</code>
<dd> Program runs in the terminal window.
<code><dt>exbg</code>
<dd> Program runs in background.
<dd> Programm luft im Hintergrund
<code><dt>tedit</code>
<dd> Internal Editor
</dl>
<strong><dt>Options</strong>
<dd> Program options starting with the name of the executable (exwin and exbg).
This options can include <a href="#varparams">variable parameters</a>
for file names, printing options etc.<br>
If you want to use pipe, you have to call a shell for executing:<br>
Eg. showing the log file: <code>sh -c "cat %r.log | more"</code>
</dl>
<p>
-> <a href="#varparams">Variable parameters</a><br>
-> <a href="#main">Start</a>
<a name="varparams">
<h1>Variable Parameters for Programs</h1>
</a>
There are two kinds of variable parameters.
<p>
% parameters are always used by TeXShell.
!?...! includes an option which is used only if there is a valid value.
There position of this variable value is marked with % sign.
<dl>
<code><dt>%p</code>
<dd> Primary file (full file name). If it is not set, the previous
edited file will be used.
<code><dt>%r</code>
<dd> Root name of the primary file. All characters after the last
dot will be cutted. (e.g. <code>"xdvi %r.dvi"</code> or
<code>"xdvi %r"</code>)
<code><dt>%e</code>
<dd> Edit file (Full name). A file selection dialog will be opened.
Default extension is <code>.tex</code> and can changed in the
file dialog.
(eg. <code>"vi %e.tex"</code>)
<code><dt>%o</code>
<dd> Other file (root name). A file selection dialog will be opened.
You must specify the extension. (e.g. <code>"xfig %o.fig"</code>)
<code><dt>%g</code>
<dd> Geometry for the <code>-geometry</code> option generated by TeXShell.
<code><dt>!i..%..!</code>
<dd> Option for line selection of the used editor. The position for
the number is marked with %.
<code><dt>!0..%..!</code>
<dd> First page for printing.
<code><dt>!9..%..!</code>
<dd> Last page for printing.
<code><dt>!l...!</code>
<dd> Print driver option for landscape printing.
<code><dt>!o...!</code>
<dd> Option for printing odd pages.
<code><dt>!e...!</code>
<dd> Option for printing even pages.
</dl>
<p>
-> <a href="#main">Start</a>
<a name="globopt">
<h1>Global Options</h1>
</a>
You can call the dialog for the global Options with the menu
<code>Options|Global settings ...</code>. All options will be
saved when the program is finished.
<dl>
<code><dt>Window position</code>
<dd> The dialog shows the actual position of the TS main window
without decoration. You can change this value. After closing
the dialog the window will moved to the new position. At the
end of the program this value will be saved and used in future.
<code><dt>Edit options</code>
<dd> You can configure automatic line wrap, auto save, and the
autosave interval.
</dl>
<p>
-> <a href="#main">Start</a>
<a name="template">
<h1>Document Templates</h1>
</a>
You can create templates for often used document structures.
These are TeX files with the extension <code>.tpl</code> and two special
comment lines:
<pre>
%! Description of the template
%! Cursor position line for editing (without these lines)
Document template (line 1)
...
</pre>
Save the templates in the global TeX directory or in <code>$HOME/.ts</code>.
If you open a new primary file for editing, you get a dialog for selecting
a template. After creating new templates, you must include them with
the <code>Rescan</code> button.
<p>
-> <a href="#main">Start</a>
<a name="files">
<h1>Files</h1>
</a>
There are global and local configuration files. The directory of global
files is specified in the Makefile and hard compiled in ts (Default:
<code>/usr/local/lib/ts</code>). Local configuration files and templates
are saved in <code>$HOME/.ts</code>.
<h2>Global files</h2>
<dl>
<code><dt>texshell.cfg</code>
<dd>Global configuration file. It is used, if you have not your own
config file which is created after the first use.<p>
If you want to create a new one, make the wished configuration and
overwrite the global config file with your own.
<code><dt>help/*.html</code>
<dd>Help files in HTML 2.0. Language selection is made during installation.
there is no support for user dependent language yet.
<code><dt>templates/*.tpl</code>
<dd>Global template files. Every user of ts can select these patterns.
</dl>
<h2>Local files</h2>
<dl>
<code><dt>ts.cfg</code>
<dd>User configuration file. If not changed, a copy of the global config
file.
<code><dt>templates.idx</code>
<dd>Index of the templates file. It is created during the first program
start. When you create new templates, you have to rebuild this file
with the <code>Rescan</code> button of the template selection dialog.
<code><dt>*.tpl</code>
<dd>User specific template files.
<code><dt>includes.cfg</code>
<dd>Scan patterns for project included files.
<code><dt>apps.cfg</code>
<dd>Used editors for special files.
</dl>
<p>
-> <a href="#main">Start</a>
<a name="project">
<h1>Project Management</h1>
</a>
By pressing <code>F4</code>, the project window is opened. The file
<code>includes.cfg</code> contains the regular expressions for scanning
the primary file.
<p>
The first char of a line indicates whether the founded fill should be scan
recursively or not,
the second char is a space, and the rest of the line is a regular expression
for an included file. It's first group builds the command, the second the
filename.
<p>
The scanning will be cutted after 10 recursions. You can select an existing
file and open for editing. Create the non-existing files by calling the
appropriate editor explicitly.
<p>
The used editor will by selected under control of <code>apps.cfg</code>.
<p>
-> <a href="#main">Start</a>
</body>
</html>
|
