User Guide

Author KTTV Team
Date created 18.3.1999
Reference
Project KTTV
CVS $Id: userguide.html,v 1.48 2000/01/05 16:50:40 martin Exp $

Table of Contents

Introduction
Terminology
    General notions
    Text editor terminology
    Slide terminology
General operations
    Files
    Creating HTML documents
    Printing the document
    Common editing commands ­ clipboard
Editing text
    Styles
    Moving along the document
    Basic editing
    Horizontal rule
    Lists
    Tables
    Links
    Using links
Editing the slide
    Elements
    Creating elements
    Creating elements using the pattern set
    Moving
    Rotating
    Scaling
    Futher editing commands
    Patterns
    Managing the Presentation
Presentation mode






Introduction

Kolik třešní, tolik višní.   
Příliš višní, katar břišní.   

Naše motto      

Kttv is a program which should facilitate preparing of lectures and presentations, especially in situations, where it is need to publish lecture notes and pictures in various ways. Basic conception of kttv is that prepared document can be viewed, printed to PostScript or (almost without any change) shown at the Web. You can also choose some slides in document for projection and that's why it enables the same document as a presentation as well as lecture notes.

Main application kttv can be used for creating documents as well as for their viewing and/or presentation. In a case you want to presentate document on the WWW, it is possible for kttv to create .png files from the slides together with appropriate inline references by <IMG> tag, which means that whole document can be viewed with a common WWW browser without any changes or information loose.


Terminology

Note to the format of folowing text: Menu commands or keyboard commands have this format (e. g. Help, <F1>, <Ctrl S>), supposing it is clear that it's a command or hot key and this font face wouldn't be confusing. Nested menus are separated by a slash (File/Open). Bold font indicates important notions, which are commonly used in this guide.

General notions

Document
is a result of the work in kttv. It is formatted text (hypertext including links) with embedded slides ­ vector pictures. Documents are saved into files with extension .kttv.
Presentation
enables choosing slides, which can be viewed separately. Typical use is at the lectures, where lecturer creates a presentation from the whole text. Presentation is the part of appropriate documtent. Each document can have at most one presentation.
Pattern set
is a collection of more complicated graphical objects, which can be inserted into slides. Typically pattern set groups similar objects (such as marks in technical drawings, electrical schemes, UML components etc.). User can edit them, create new ones etc. Pattern sets are saved to separate files.

Text editor terminology

Text attributes
determine the overall look of the writ. Kttv supports subset of text attributes according to HTML3 spec, namely bold font, italics, teletype (typewriter-like fixed width font), underlined and striked through along with upper and lower indices with at most two levels of nesting. Setting up font color is also supported. Any conjunction of attributes is possible in (almost) any text in kttv document (exceptions are explicitly stated later in the userguide).
Paragraph style
defines initial setings of attributes alignment and formatting of a paragraph. User can later change any of these for current paragraph.

Slide terminology

Element
Any object in the slide is called element. Anchor, rectangle, ellipse, polyline, textbox, bezier curve and group are elements. Elements are specified by key points or floating points.
Key point
Each point determined only by its position is called key point.
Floating point
Each point, which position is derived from position of another point is floating point. We say, that the floating point is attached to another key/floating point.
Anchor
is an element specified by just one point. You can use it in groups to attach another points to it. In the presentation and in the print, the anchor is invisible.
Group
is an element containing one or more elements. The have their own z-order in the group. When you apply a tranformation on the group, each element in the group is transformed.
Selection (selected elements)
When an element is selected, you can see its key/floating points and the centre. The centre is used when you rotate or scale the selection. You can apply edit commands on one element or on the whole selection.

General operations

Files

After executing kttv the main window with menu and main toolbar is shown. Command File/Open opens existing document or File/New creates new document. It is possible to open more than one document. Each document has its own window. This is the window of text editor with possibility of inserting slides. If you open the same document twice, you will edit each one independently as two different data. The command File/Save and File/Save as saves document into the file. To close the application use the command File/Exit.

Creating HTML documents

Just in case you want to present your document on the WWW (or give it to kttv non-equipped individual), kttv provides you a handy capability of making .PNG files from all slides in the document. Just select in menu File/Save with images: Kttv creates PNG files from slides, together with appropriate links within the main document file, so your slides will appear in exact places and the same size as before. A <IMG> tag is safely ignored by kttv, so you need not be afraid of compatibility of such document and the original one.

Printing the document

You can print the document using the toolbar or menu command File/Print in the main application window. The output is in PostScript. It can be written to a file or directly sent to the printer. You can choose the way of printing in the dialog window opened just after the clicking the command. You have more options there --- you can set the range of printing, number of copies and even the spooling command (lpr is the default choice). For printing in czech encoding, a filter iso1to2 is supplied with kttv

Pagebreaks are computed according to the paper size and the document margins every time you change the document. While editing, you can see them as dashed lines. The paper size and the margins can be set using File/Page Setup. When you change it, the document is reformatted according to the new settings. Page setup is saved in the document file.

If you want to see, how would the document look on the paper, you can click File/Print Preview. It opens a dialog with preview. You can set zoom, see the next or the previous page or print the document there.

Společné editační příkazy ­ schránka a undo

Clipboard

A clipboard can be very usefull for editing slides and text paragraphs. It can be used for moving and copying parts of text and slide elements and even parts of tables. It is possible to copy (Shift-Ins) or cut (Shift-Del) selected portions of documents to clipboard and then paste them back (Ctrl-Ins). Clipboard is also used for creating new patterns in Pattern dialog.


Editing text

Note: when not stated otherwise, all menu as well as toolbar commands in this chapter are invoked from the text dialog.

As already mentioned, after document window is opened it is in state of text editing. Text is divided into paragraphs, each of them has its own style. For the sake of utmost compatibility paragraph styles are derived from HTML styles. New paragraph is created by pressing <Enter> key, its style can be set up either in toolbar or from menu. Alignment of a paragraph (left, right or center) can be a part of a style and can also be set up manually from toolbar or by menu command (explained later). Default style and alignment are deduced from the predecessor of current paragraph using following rules:


To change style or alignment of an already existing paragraph it need not to be selected, command is simply applied to active (e.g. with cursor on it) paragraph.

Styles

Common paragraph style is standard text aligned to left and formatted according to actual width of the paragraph. There are (as well as in HTML) 6 kinds of headlines, headline 1 beeing the biggest, headline 6 the smallest, each of them having its own initial setup of attributes. Paragraph can also be preformatted, i.e. no formatting is done for this one and its initial font is fixed width font.

Moving along the document

The most frequent way of moving over the document (over the text part to be precious) is of course with text cursor using common cursor movement keys and also <Pg Up>, <Pg Down>, <Home> and <End>. For more complicated movements following shortcuts are defined:

<Ctrl Left>, <Ctrl Right>skip word forward and backward

As document kttv can not only contain text but also inserted "blocks" of a different kind (slides, tables, horizontal rules) text cursor has the functionality to insert text paragraphs before, after or in between these blocks too. When moving over the text these blocks behave almost like they would be paragraphs containing one "letter" of a special kind. Up/down movement will place cursor before such a block, left/right movement before and after it. Then one can insert new paragraph simply by pressing the <Enter> key, pressing <Delete> or <Backspace> will remove the block (and place it into the undo clipboard). The exception is the table where cursor jumps from positions "outside" the table into it and moves over text in cells.

Another way of moving the text cursor is with mouse. Clicking the mouse cursor anywhere upon the text (where cursor looks like I-beam) causes the text cursor to move to this location. You can also view the document (i.e. without moving the text cursor) by drawing any of the scrollbars with mouse. When user presses a key that should cause some text cursor movement, inserting a letter, etc. document will scroll so that the cursor is fully visible.

Note also that text in textboxes in slides behave like whole document, i.e. cursor can move into and from textbox only by mouse.

When user holds <Shift> key while moving in text (or holding left button while moving the mouse) such part of the text will be selected and highlighted. Following editing command (explained later) will be applied onto the selection. Moving the text cursor without selecting will cancel currently active selection (if any).

Mouse selection is not implemented.

Basic editing

Next to simple typing editor knows popular <Backspace> and <Delete> keys for deleting the text before and after the cursor (or text in selection if there is one). Also famous <Insert> key toggles insert and overwrite mode which is indicated in status bar. In following table commands for changing attributes and styles are given (word "toolbar" indicates that function is also accessible via toolbar):

<Ctrl b>, Text/Attributes/Bold, toolbartoggles bold
<Ctrl i>, Text/Attributes/Italic, toolbartoggles italics
<Ctrl u>, Text/Attributes/Underlined, toolbartoggles underlined text
<Ctrl s>, Text/Attributes/Striked through, toolbartoggles striked through text
Text/Attributes/TeleType, toolbartoggles "teletype" writ (typewriter-like)
Common/Change color (in "Common" dialog), toolbarshows color selector dialog and uses chosen colors as foreground and background colors
Text/Style, toolbarchanges style of current paragraph (or paragraphs in selection)
Text/Alignment, toolbarchanges alignment of current paragraph (or paragraphs in selection)
Text/Index/Upper index, Text/Index/Lower index, toolbar starts writing upper/lower index of a current text (only two levels of nesting are supported)
Text/Index/End index, toolbar, <Esc> ends writing in index level and returns one level back (in indices)

When selection is active, previous commands will be applied either precisely to selected text or to all paragraphs affected by the selection (styles, alignment). When choosing attribute that is partly in selection, first command will set the attribute to the whole text and second command (more precisely when text in whole selection has this attribute set) will unset it. "End index" command will shrink all indices in selection one level down.

Popular and very useful "Find and replace" function is not implemented and will not be in the first release. It even has no support in existing code (on the other hand there are no known obstacles there either).

Horizontal rule

An user can insert an horizontal rule into document - a shadowed line together with small gap over and under the rule. Very usefull object for dividing sections of the document. It looks like this:


A horizontal rule can be created under an actual paragraph by selecting Common/New Horiz. rule from submenu "Dialogs/Common tools" or by pressing <Ctrl h>

Lists - numbered, unnumbered

You can use in your documents several types of lists. There are three main types: Unnumbered lists, numbered lists and definition lists. Items in the first one are preceded by mark (black bullet, small circle or black square - or nothing), second one uses automatic counting and prepends nuber of the item at the beginning of the line. You can choose between arabic and greek nubers, or it is possible to use latin alphabet (greek and latin counting exists in two variants with either big or small letters). Lists can be nested.

New list can be inserted from toolbar "Common tools", by selecting "New bullet list", or clicking on the icon. A dialog box will appear, in which you can select the type and the variant of a new list. Next item in the list will be created simply after pressing <Enter>.

It is possible to change the type of a list previously created. To achieve this, place the cursor inside some list and from main menu select Dialogs/List dialog. After that you can change the list properties and after closing, the type of the list will change accordingly.

Tables

KTTV supports simple tables with some styles of frame and inner rules (according to HTML). New table can be inserted by pressing a corresponding button on the toolbar. You can choose a number of rows and columns and style of frames and rules in the dialog witch is displayed before the table is created. Frame and inner rules in existing table can be changed by pressing <Alt+T>.

It is possible to insert new rows and columns to the table. To create new row press <Ctrl+Enter>. New row will be created below the row with cursor. To create new column press <Alt+Enter>. New column will be created behind the column with cursor. Its width is the avarage width of other columns if the table can be enlarged by this width otherwise widths of columns are reduced. Analogically you can delete column or row by pressing <Alt+Delete> and <Ctrl+Delete>.

Height of the row is determined by the highest cell in the row. Column width is read from HTML file or when a new table is created, the table is uniformly divided into columns. To change the column width, drag the rule to the right of the column (column widht can't be less than margins around the column and total table width can't be greater than paper width, outer cell or text box).

Links

KTTV supports both links to other document and links to a different location in the active document, just like in HTML. Every link must point to a KTTV document located on the local drive. It's not possible to use a link that points either to a HTML document or to the Web. If you use such a link, the opening of the document may fail.

A link target can be a non-empty part of the text within one paragraph. It's not possible to place two or more link targets at the same text. The text of a link target also cannot be a link source. Every link target must have a document-unique name. If you copy and paste a link target, its name automatically changes to be unique. For example, if you copy a link target named 'Summary' to the clipboard and paste it to a different location in the same document, the copy of this link target will be named 'Summary-1'.

Rules of usage of a link source are very similar. A link source must have defined a name of the target document and/or a name of the link target in that document. If no document is specified, the link points to the current document.

To create a link source, select a text in a paragraph and click the Link source icon on the toolbar. In the dialog box, enter the name of the target document. In the box below, a list of available link target should appear. If you want the link to point to an exactg place in the target document, select a link target from the list or type its name to the Name field.

When creating or editing a link source, the information entered is not validated. You can enter a document or link target name, that does not exist.

To create a link target, select a text in a paragraph and click the Link target icon on the toolbar. Enter a unique name of this link target. When you click OK, this name is validated. If such a name already exists in this document, a warning message will appear and you must enter a unique name.

To edit a link source or target, place the cursor inside the text of the link and click the appropriate icon on the toolbar. Then edit the information and click OK.

To remove a link source or target, click the Remove button in the dialog box.

Using links

To use a link, double-click it. If this link points to a different document, the document will be shown. (Either an existing window of this document will be activated or the document will be opened.) If the link contains the link target specification, the cursor will be placed at the begging of this target.

You can go back to the origin of a previously used link using the Back button on the toolbar. This button allows you to go back as many links as you used. To go forward again using the same links as before, click the Forward button.

Note, that if you change or move some of the links you have used, this will not affect the behaviour of the Back and Forward buttons.


Editing the slide

New slide can be created using (Common tools)/Common/New slide or appropriate toolbar button. The Slide properties dialog appears, in which the user can set the size and look of the new slide. New slide is placed after the paragraph containing the cursor.

Use Dialogs/Slide tools from the main kttv window to have the slide tools dialog open. Using it, you can switch between various modes --- inserting, selecting and moving, selecting and rotating and selecting and scaling ones.

Elements

You already know, what the elements are. Here, you can find their behaviour.

Anchor
When you edit a slide, you can see anchors as black&white asterisks, in the final presentation, they are invisible. The anchor is used for attaching to any place in the slide. It can be moved or rotated; scaling changes the distance from the centre.
Rectangle
is specified by 4 key points or 2 floating points. It can be moved, rotated or scaled.
Ellipse
is drawn inside a rectangle. See rectangle.
Polyline/polygon
Polyline is an open polygon. Polyline/polygon is specified by 1 or more points. They can be moved, rotated or scaled. Polygon can be filled.
Bezier curve
consists of 1 point and cubic bezier segments. The segment is specified by 3 points. The curve can be open or closed. It can be moved, rotated or scaled. The closed bezier curve can be filled.
Text box
is the only way, how to get a text into the slide. You can insert tables, definition lists and even another slide there too! The text box can be moved or scaled, but it can't be rotated.
Group
consists of one or more elements. The transformations are distributed to its elements. It means, if the group contains a text box, it shouldn't be rotated.

Creating elements

If you want to create elements, you have to choose from (Slide tools)/Slide/Insert/ which element to create. You can do it using the toolbar or using the keyboard as well. After it, you are in the inserting mode.

You can click in the slide to specify the key points. When you are inserting an anchor, an ellipse, a rectangle or a text box, it turns to the seleting and moving mode after it. When you are inserting a polygon, a polyline or a bezier curve, you have to change mode to stop inserting points. These elements are created using the current color setting (the color selector is in the Common tools dialog) and the current style and line width setting.

Groups are made from selection by (Slide tools)/Slide/Group or appropriate toolbar button or key.

Creating elements using the pattern set

The other way to create elements is to use the pattern set. You choose an element in the patterns dialog, copy it to the clipboard and then, you can paste it to the slide as many times as you want.

Moving

To switch to the selecting and moving mode, use (Slide tools)/Slide/Move or appropriate toolbar or key.

In all these selecting and <operation> modes, you can select elements by clicking the left mouse button on the bound of the element. If you hold the button, you can directly apply the operation. To select more elements, hold the <Shift> key and select by clicking. To deselect all the elements, click besides the lines of the selected elements.

When the element is selected, you can see its key/floating points. The key points are drawn as squares with a point in it, the floating point is a square with a smaller square in it. When there is a X in the square, it means a virtual point --- it can be moved, but you cannot attach it or attach another points to it.

When you click on the bound of the element, you move whole element, when on the point, you move just it. When you want to work with all the selection, click on the bound of the selection.

Rotating

This mode is very similar to the selection and moving one. Choose it by (Slide tools)/Slide/Rotate.

Here, the centre is significant. Elements rotate around it. The centre is shown as a circle with a point inside.

You cannot rotate points alone (as in moving mode), you can rotate only whole elements. The other behavior is similar to the selection and moving mode.

Scaling

This mode is analogical to the rotating one.

Further editing commands

Creating a group
(Slide tool)/Slide/Group creates a group from selected elements. Note: The z-order in the group is set according to the order of selecting of the elements!
Ungroup
(Slide tool)/Slide/Ungroup dismisses one level of grouping among the selected elements. It means, that if there is a group A containing group B selected, after ungrup, B will be still a group but A won't exist any more.
Order
(Slide tool)/Slide/Order/ changes the z-order of the selected elements. You can move the higher, lower, to the front or to the back.

Patterns

Dialogs/Patterns shows or hides a window for pattern sets.

In the pattern window use the choice bar to select a set of patterns with which you currently want to work. That set is displayed below: a list of pattern titles on the left and a preview of the currently selected pattern on the right.

Use the Scale pattern to fit window checkbox to scale the pattern. If it is unchecked, the pattern is displayed the same size as if in a slide. If it is checked, the pattern is scaled to fit the preview window.

The Copy to Clipboard button copies the currently selected pattern to the slide clipboard.

The Paste from Clipboard button creates a new pattern from the contents of the slide clipboard. You are asked for the title of the pattern. The pattern is placed to the selected set. If the slide clipboard is empty or no pattern set is open, nothing happens.

(Patterns)/File/New creates a new pattern set. Enter a title of the set or use Cancel.

(Patterns)/File/Open opens a pattern set from a file using a standard file dialog.

(Patterns)/File/Save saves the currently selected pattern set. If the set is still unnamed, a standard file dialog appears. Otherwise it may happen that somebody has changed the file on the disk while you made changes to the open pattern set. In that case, you are asked whether you want to overwrite the file.

(Patterns)/File/Save as saves the currently selected pattern set under a different file name. If the file already exists, you must confirm that you want to overwrite it.

When you exit the program, it checks whether there are any pattern set with unsaved changes and offers to save them. If you cancel the saving, the program is not exitted.

Managing the Presentation

Slide/Presentation opens the dialogue box of the presentation manager. It is a tool which allows an user to create an presentation - an sequence of the slides. It is possible to choose which slides will belong to the presentation and in what order they'll be shown.

There are two list boxes in the presentation manager window. The right one covers all slides, which currently are in the presentation, within the left one the user can see the rest of them. Slides are manipulated using buttons <- (append the chosen slide to the presentation), -> (delete the chosen slide from the presentation and return it to the pool of unused slides on the right) and at last ->> together with <<- for adding/deleting all slides respectively. In the presentation (left) list can user in addition affect an order of slides with buttons Up and Down.
There are only names of the slides shown in listbox during presentation design process, but by selecting the slide in either left or right listbox, a slide preview panel is shown under each listbox, that helps the user to determine exact look of the slide.

Presentation is stored by pressing Ok button, Cancel button closes the window without applying changes.


Presentation Mode

By the term "presentation" we understand an sequence of slides, created in the Presentation manager. "Showing the presentation" means screen all chosen slides in a given order, usually in full-screen mode. An user can begin the presentation by selecting File/Run presentation from the main menu. There are following possibilities of controling a presentation flow:

ActionKeyboard/mouse shortcuts
Forward by one slideSpace
right arrow
left mouse button
Backward by one slideBackspace
left arrow
right mouse button
To the start of a presentationHome key
To the end of a presentationEnd key
End presentationEscape key