summaryrefslogtreecommitdiff
path: root/support/cms4talks/Manual/manual.html
blob: 3ba615900e44e69fd2eb76c9c14d3f0c27bd099e (plain)
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
"http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> 
<HTML> 

<HEAD> 

<TITLE> CMS4talks - manual </TITLE>

<META NAME="keywords" CONTENT="SlidePool manual">

<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">

<!--SCRIPT type="text/javascript"> function windowTitle() {
    parent.document.title="CMS4talks manual";
}
</SCRIPT>

<NOSCRIPT> </NOSCRIPT-->

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();"> 

<a name="topofpage"> <img src="CMS4talks.gif" alt="">

<h1>

CMS4talks - <i>user manual</i>

</h1> <p STYLE="page-break-before: always"></p> 

<a href="#general">general Overview</a><br> 

<a href="#inst">Installation</a><br> 

<a href="#slideex">enhance(d) Slide Extraction</a><br>

<a href="#talkeditgui">edit Talks</a><br>

<a href="#slideeditgui">edit Slides</a><br>

<a href="#workingcollection">The Working Collection</a><br>

<a href="#searchfunction">The Search Function</a><br>


<hr> 

<a name="inst">

<h3>Installation</h3> 

<ul> 

<li>Get your copy of cms4talks.zip and unzip it to a favoured but 
empty directory.</li>

<li>Make sure your system satisfies the <a 
href="index.html#requirements">requirements</a>.</li>

<li>Ensure that you have the mysql-connector.jar in the classpath 
for your Java Runtime Environment. The file comes along with the 
installation and lies in the directory You have chosen for 
<i>CMS</i>4talks. So if <i>X:\prgs\CMS4talks</i> is Your 
directory then simply add 
<i>;"X:\prgs\CMS4talks\mysql-connector.jar"</i> to Your 
classpath.</li>

<li>Run "java Install" in your command prompt and follow the 
instructions.</li>

<li>It is save to delete all files with suffix <i>.java</i> if 
You don't want to proceed with the development of 
<i>CMS</i>4talks.</li>

</ul>

Now you can start working with <i>CMS</i>4<i>talks</i>.

<hr>

<a name="general">

<h2>general Overwiew</h2>

<h3>The Main Window</h3> 

After typing java CMS4talks (Be aware of case sensitivity!) you 
will see the main window.<br> 

<img src="images/main.gif"><br>

Lets introduce the buttons (klick on the links for further 
details): 

<ul> 

<li><a href="#addtalk">add talk</a> - add a talk</li> 

<li><a href="#addtalks">add talks</a> - add a whole directory of 
talks</li>

<li><a href="#prefpaths">Preferences: package paths</a> - manage 
the list of directories containing packages </li>

<li><a href="#prefcommands">Preferences: preferred slide 
commands</a> - manage the list of directories containing packages 
</li>

<li><a href="#workingcoll">show working collection</a></li>

<li><a href="#talklist">show talk list</a></li>


</ul> 

<a name="addtalk">

<h3>add a talk</h3> 

After clicking this button a filechooser will pop up and ask you 
for a filename. Specify any talk and press "OK". The chosen file 
will be analyzed and if CMS4talks finds one and only one known 
command that describes slides, the talk will be automatically 
processed, i.e. the slides will be extracted and added to the 
database, as well as a talk representation within CMS4talks will 
be generated.

<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<p STYLE="page-break-before: always"></p>


<a name="addtalks">

<h3>add talks</h3> 

After clicking this button a directorychooser will pop up and ask 
you for a directory. Specify any directory. All files in this 
directory will be analyzed and if they contain slide specifying 
commands or tags, they will be processed as if they where chosen 
by hands.

<a name="prefpaths">

<h3>preferred package paths</h3> 

If you click here a list of paths will pop upp. You can simply 
add or delete arbitrarily paths.<br> <img 
src="images/prefpaths.gif"><br> 

For succesfully examining given TeX-files CMS4talks needs to know 
where all your packages are being found. All packages in a 
TeX-file will be checked for new commands. All of them which are 
includes in the <a href="#prefcommands">preferred slide commands 
list</a>, whill be handled as commands specifying slides.

<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<p STYLE="page-break-before: always"></p>
 
<a name="prefcommands">

<h3>preferred slide commands list</h3> 

If you click here a list of slide specifying TeX-commands will 
pop upp. You can simply add or delete them or change their 
priority.<br> <img src="images/prefcommands.gif"><br> 

For succesfully examining given TeX-files CMS4talks needs to know 
which commands specify individual slides.<br>

Lern more about slide commands and enhanced slide extraction <a 
href="#slideex">here</a>. 

<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<p STYLE="page-break-before: always"></p>

<a name="workingcoll">

<h3>show working collection</h3> 

During a CMS4talks session you may want to gather a collection of 
some slides. The working collection is a sort of clipboard where 
you easily can acces often used slides.

<a name="talklist">

<h3>show talk list</h3> 

After clicking here a list of all talks contained in CMS4talks 
database appears. It will look similar to the example shown.<br>
<img src="images/talklistgui.gif"><br>Push &quot;edit&quot; to 
edit selected talk.

<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<p STYLE="page-break-before: always"></p>

<hr>

<a name="slideex">

<h2>enhance(d) Slide Extraction</h2> 

In your LaTeX-talk slides can be defined in two way. One way is 
that slides are defined between two tags like<br>

<i>\begin{slide}</i> and<br>

<i>\end{slide}</i> or they can be defined in a defined command 
that has the slide and sometimes even the title or some more 
information as its arguments. An example with two arguments could 
be <br>

<i>\creatslide{this is a sample title}{this is the slide`s text 
source}</i>.

For determining in which way slides are defined in your talks 
CMS4talks will ask you every time you want to add a talk. You can 
avoid being asked in most of the times if you provide CMS4talks 
some information:<br>

All talks which shall be loades will parsed an all packages which 
are used within the talk are searched. They will be searched in 
the <a href="#prefpaths">preferred paths list</a>. So keep this 
list up to date.<p> 

If you add a talk, all new defined commands and redefined 
commands within the used packages as well as within the talk 
itself will be compared to the <a href="#prefcommands">preferred 
commands list</a>.<br>

If only one of the commands is found in this list, then the slide 
defining command is well defined for this talk, and can be added 
to the system immediately without asking for the right command.

While adding a whole directory (&quot;add talks&quot;) you won't 
be asked for the proper command. Therefore using this function 
requires preferably complete <a href="#prefpaths">preferred paths 
list</a> and <a href="#prefcommands">preferred commands list</a>.

<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<p STYLE="page-break-before: always"></p>

<hr>

<a name="talkeditgui">

<h2>edit Talks</h2> 

Choosing a talk in the talk list, will pop up a window similar to 
this one:<br>

<img src="images/talkeditgui.gif">

<p>

Lets describe the buttons and functions:

<ul> 

<li>undo all changes - loads talk again from database</li> 

<li>save changes - saves the changes you made in this 
window<br><b>NOTE:</b>It ist possible to open the same talk in 
several different windows, saving won't recognize that. </li> 

<li>save as new - saves a new copy(version) of this talk</li> 



<li><a href="#etg_1st">1st slide</a> - attach talk`s first 
slide</li> 

<li><a href="#etg_go">go</a> - go to talk`s first slide</li> 

<li><a href="#etg_ex">export</a> - export this talk to disk</li> 

</ul> 

<a name="etg_1st">

<h3>Attach first Slide to Talk</h3> 

Every talk that is added to cms4talk via &quot;add talk&quot; or 
&quot;add talks&quot; should automatically have its first slide 
attached to the talk edit window. If you rearange a talk you can 
attach any other slide as first slide to this talk and it is as 
easy as this: Select in the <a href="#workingcollection">working 
collection</a> the desired slide and push &quot;1st slide&quot; 
in the talk edit window. <b>NOTE:</b>Don`t forget to save changes.

<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<p STYLE="page-break-before: always"></p>


<a name="etg_go">

<h3>Go to Talk`s first Slide</h3> 

If there is a first slide attached to the talk, pushing this 
button will open a slide edit window with the talk`s first slide.

<a name="etg_ex">

<h3>Export a Talk to Disk</h3> 

Having edited some slides and rearanged a talk or created a new 
talk, you might want to export it to disk (e.g. for further 
finetuning within your TeX-system and .ps-processing...).<br> 
Clicking &quot;export&quot; will open a filechooser. Select a 
filename and CMS4talks will write the entire talk to disk. If you 
set up the slide order properly the ordering of the slides in 
this talk will be as excepted. Nevertheless if some cycles appear 
(e.g. if you attach a talk`s first slide to some later slides as 
next slide) CMS4talk will recognize that and finish before 
cycling.<p> Learn more about the slide order <a 
href="#slideorder">here</a>.

<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<p STYLE="page-break-before: always"></p>

<hr>

<a name="slideeditgui">

<h2>edit Slides</h2> 

Choosing a slide from a list of search results, the working 
collection or a talk window, will pop up a window similar to 
this:<br> 

<img src="images/slideeditgui.gif">

<p>

Lets describe some buttons and functions:

<ul> 

<li>undo all changes - loads slide again from database</li> 

<li>save changes - saves the changes you made in this 
window<br><b>NOTE:</b>It ist possible to open the same slide in 
several different windows, saving won't recognize that. </li> 

<li>save as new - saves a new copy(version) of this slide</li> 


<li>go - go to next/previous slide</li>


<li>add this slide to working collection - adds this slide to the 
working collection</li> 

<li><a href="#seg_go">go</a> - go to next/previous slide</li>

<li><a href="#seg_prev">prev:</a> - attach previous slide</li>

<li><a href="#seg_next">next:</a> - attach next slide</li>

<li><a href="#seg_talk">talk:</a> - attach talk</li>

<li><a href="#seg_go">remove</a> - detach next/previous slide</li>

</ul> 


<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<p STYLE="page-break-before: always"></p>


<a name="seg_go"> 

<h3>Go to next/previous slide</h3>

Push this button to go to previous/next slide. It will appear in 
the same slide edit window.

<hr>

<a name="slideorder">

<h2>Setting up the Slide Order</h2> 

With the possibility of assigning successors and predecessors to 
all slides you can arrange slides in any order. Keep in mind that 
a wise order is the assumption for success in <a 
href="#etg_ex"exporting</a> talks.


<a name="seg_prev"> 

<h3>Attach previous Slide</h3>

If you rearange the slides´ order you can attach any other slide 
as previous slide to this slide, and it is as easy as this: 
Select in the <a href="#workingcollection">working collection</a> 
the desired slide and push &quot;prev:&quot;. <b>NOTE:</b>Don`t 
forget to save changes.

<a name="seg_next"> 

<h3>Attach next Slide</h3>

You can assign the next slide in the same manner as previous 
slides are assigned.


<h3>Hint:</h3>

Having the possibility of assigning the next as well as the 
previous slide might be confusing because in fact it is redundant 
having both possibilities. Open the file <i>preferences.ini</i> 
you find in the directory where <i>CMS</i>4<i>talks</i> is 
installed and change the entry <i>true</i> in line #20 to 
<i>false</i>. In future versions this setting may be altered more 
comfortably .

<a name="seg_talk"> 

<h3>Attach Talk</h3>

You can assign a talk slide in the same manner as slides are 
assigned. You simply chose the talk to be attached from the list 
of talks. This function enhances the export to disk: If a slide 
has more than one predecessor, the exporting algorithm first 
checks if there is a predecessing slide which belongs to the 
"right" talk, and choses this slide in that case.


<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<p STYLE="page-break-before: always"></p>

<hr>

<a name="workingcollection">

<h2>The Working Collection</h2> 

During a <i>CMS</i>4<i>talks</i>-session you probably don't want 
to search often used slides again and again. You can store a list 
of slides in the Working Collection, which looks like that:<br>

<img src="images/workingcollection.gif"><p>

It looks like a list of search results without the choose button. 
And indeed it is implemented just like that.<br> As we have 
already learned, there are some functions which get their slides 
from the working collection. E.g. see sections<br> <a 
href="#etg_1st">&quot;Attach first Slide to Talk&quot;</a> and <a 
href="#seg_prev">&quot;Attach previous Slide&quot;</a>.

<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<p STYLE="page-break-before: always"></p>


<hr>

<a name="searchfunction">

<h2>The Search Function</h2> 

Clicking the &quot;search for slides&quot;-button opens a new 
search results window. It looks similar to this:<br> <img 
src="images/foundgui.gif"><p> 

The following buttons are found:

<ul> 

<li>refine... - starts a search within the already present 
results<br>i.e. all entries matching the new starts will be 
remained</li>

<li>exclude... - excludes all results from the already present 
ones which match this search</li>

<li>add... - searches further and adds matches to the list of 
results</li>

<li>edit - opens the selected slide in a new slide edit 
window</li>

<li>choose - adds the selected file to the <a 
href="workingcollection">Working Collection</a>
</li>

</ul> 

Clicking one of the three firstnamed buttons opens a small dialog 
prompting for what you want to search (or exclude). 

<h4>Wildcards</h4> 

You can chose between the search for keywords or for incomplete 
words using wildcards. The wildcard character * will allow you to 
search incomplete words like you know it from google e.g. <br>
 
You can chose also another wildcard %. Using this wildcard the 
search will be automatically performed in fulltextmode i.e. the 
search will take long time, as the index cannot be used.<br>

In general searches are performed case sensitive. If a search 
does not lead to any results, there will be automatically 
performed a case insensitive search.<br>

Though forcing case insensitive search e.g. for the word 
<i>Sweden</i> can be indirectly done searching for <i>swedeN</i>.


<p STYLE="page-break-before: always" align="right"><a 
href="#topofpage"><img src="images/top.gif"></a>Go to <a 
href="#topofpage">top</a> of page.</p> 

<hr>

<p align="right"> <a 
href="mailto:jonReplacewithAtinformatik.uni-kiel.de"><img 
src="images/copyleft.gif"></a></p>




 </BODY> </HTML>