Ben
Lamb

    kde@zurgy.org

# Basic Usage

## Starting &kivio;

Like other &koffice; applications, on startup &kivio; presents a startup dialog. The dialog offers a choice of creating a new document, opening a saved document or choosing a document from a list of recently saved files.

If you're new to &kivio; begin by creating an empty document by double-clicking on the Empty Document template.

&kivio;'s main window contains a view of the current document. The page outline and margins are shown, as is a grid. Surrounding this view are horizontal and vertical rules. By default a tools toolbar is placed on the left-hand side and beneath the document view is a page selector. Beneath that is the status bar which shows the current position of the mouse pointer as a location on the page.

At the top of the window are the two main toolbars. These contain buttons for the most commonly used features of &kivio;.

## Using Stencils

Diagrams are created by placing different pre-drawn shapes and stencils on the page. Stencils can represent many different things and &kivio; comes with a wide selection. For ease of reference they are grouped into collections known as stencil sets. To use a stencil set select Tools Add Stencil Set. The stencil sets have been sub-divided into several groups; a sub-menu lists these. The shapes in the stencil set are shown on the left-hand side of the document view.

Stencils are grouped into stencil sets for organizational purposes only; it is perfectly okay to add several stencil sets to a document and &kivio; allows you to mix and match stencils from different sets freely.

To place a stencil onto the document simply drag it from the stencil area to the page.

### Selecting Stencils

&kivio; identifies the stencil currently being edited by displaying eight green squares on the corners and edges of a square around the stencil. Stencils shown in this manner are described as being selected. The green rectangles are known as handles. To change the currently selected stencil move the mouse pointer over the stencil you wish to select and press the &LMB;. To select all the stencils on the current page select Edit Select All. To deselect all stencils select Edit Deselect.

### Moving Stencils

To move a stencil to another position on the page, select the stencil. Note the pointer will change to a hand icon. Hold down the &LMB; and move the mouse to the new position. Release the mouse button to place the stencil at the new position.

### Resizing a Stencil

Select the stencil, and then move the mouse pointer over one of the handles. Note the mouse pointer change. Hold down the &LMB; and move the mouse. The coordinates of the stencil will be adjusted continuously as the mouse is moved. When you are happy with the new size release the mouse button to give the stencil its new final size.

### Undoing a Mistake

If at any time you are unhappy with a change you have made to the document you can select Edit Undo to revert the change. There is also an icon on the toolbar.

If you undo an action and decide that was a mistake, select Edit Redo to restore the change. &kivio; stores multiple actions to undo/redo several changes.

### Limitations of the Stencils

Note that stencils cannot currently be rotated.

### Labeling Stencils

A lot of stencils in the Flowcharting Collections, Geographic Collections, Hardware Collections, Miscellaneous Collections and UML Collections can contain text to describe their function. To add text to a stencil move the mouse pointer over the stencil and double-click it or open the context menu with the &RMB; and select Edit Text.... A dialog box will appear prompting for some text. Enter some text and click OK. The text should be shown inside the stencil.

The item Edit Text... in the menu is disabled, if a stencil cannot be labeled.

The font, size, alignment and style of the text can be adjusted by selecting Format Text.... Alternatively use the buttons on the Format toolbar. The adjustments will only affect the currently selected stencil.

### Selecting Several Stencils

There are two ways to select multiple stencils in &kivio;.

1. Click once inside the first stencil you wish to select. Hold down &Ctrl; as you click inside subsequent stencils. All the stencils will be shown with handles around them.

2. Move the mouse pointer to a blank area of the document near the stencils you want to select.

   Hold down the &LMB; and move the mouse to the other side of the stencils you want to select, drawing a rectangle around them.

   The rectangle must completely encompass the stencils for them to be selected.

### Adjusting the Fill Color and Line Color

Stencils can be filled with a solid color and the color of the outline can be changed. Select a stencil then select Format Stencils & Connectors....

### Adjusting the Line Thickness

The width of a stencil's border can be adjusted by selecting Format Stencils & Connectors.... The line width can be entered in centimeters or increased/decreased using the arrows of the spin box. Or use the Line Width button on the Format toolbar. Select a width from the drop down box or select Custom... to open enter the width in the spin box.

### Connecting Shapes Together

&kivio;'s connector tool allows lines to be drawn between shapes. The lines remain connected to the shapes even when the shapes are moved to new positions on the page.

To draw a connector select Tools Straight Connector or Tools Polyline Connector.

The Polyline Connector tool is also available from the Tools toolbar; by default shown on the top side of the window. Click on this tool to begin using it; the mouse pointer will change shape.

Notice that all stencils have little blue crosses around their edges. These crosses mark points where connectors can be attached.

To connect two stencils move to one of the connection points on the first stencil, hold down the &LMB; and drag a line to one of the connection points on the second stencil. The green square at the end of the line will change to red when it is over a connection point indicating that the line is attached to a stencil.

When you have finished using the connector tool, click on the Arrow tool to regain normal selection functionality.

A stencil can have multiple connectors attached to it, even at the same connection point.

Various properties of the connector can be adjusted including line thickness and color, this is done in the same way as for stencils.

Straight Connectors may also be labeled with text. To add text to a straight connector open the context menu with the &RMB; and select Edit Text.... Enter the text in the dialog that appears. The text will be shown with a green handle next to it. Use this to modify the position of the text.

Arrowheads can be added to either end of a connector. Select the connector and then select Format Arrowheads....

Limitations: Connectors do not currently reroute around stencils, you need to adjust them manually. Text is always displayed horizontally; rotated text is not currently possible.

### Grouping Stencils

Several stencils may be semi-permanently grouped together. Once this has been done any changes made to one stencil will affect the others in the group.

To make a group select the stencils and select Format Group Selection.

The procedure can be reversed by selecting a group of stencils and select Format Ungroup.

### Overlaying Stencils

Stencils can be positioned on top of one another. A stencil drawn on top of another stencil will obscure the stencil underneath it. To adjust the drawing order select one of the stencils and select either Format Bring to Front or Format Send to Back.

Send to Back will cause the stencil to be obscured by any stencil which overlaps it. Bring to Front will cause the stencil to obscure any stencil which it overlaps.

### Locking Stencils

A stencil's properties may be locked to prevent accidental changes. To alter a stencil's protection use the protection palette. This can be displayed by selecting View Palettes Show Protection. Select the stencil or stencils you wish to protect and then tick the properties you want to protect on the protection palette.

The protections available are: Width, Height, Aspect ratio, X position, Y position and Deletion. Deletion prevents a stencil from being deleted from the document.

### Stencil Geometry

For accurately specifying the dimensions of a stencil use the Geometry palette. To display the palette select View Palettes Show Geometry. The palette contains four spin boxes for specifying the horizontal (X:) and vertical (Y:) position of the stencil and the Width: and Height:.

Although the measurements are displayed in centmeters it is possible to enter other units into the textbox. For example, entering 2.5 mm will be converted into centimeter. Points (pt) and inches (in) are also accepted.

## Viewing the Document

### Zooming In and Out

To adjust the zoom level select View Zoom Level. This submenu contains a list of percentages from 33% to 500%; selecting one of these magnify the document by that percentage.

There is also a list of zoom levels in a spin box on the Edit toolbar, by default shown at the top of the screen.

A second method of controlling the magnification is to use the zoom tool. This is available on the Tools toolbar. This tool can be used in two ways. Clicking on the document with the zoom tool active will increase the magnification. Holding down the &Shift; key whilst clicking will decrease the magnification, &ie; zoom out.

Alternatively, holding down the &LMB; and dragging out a box then releasing the mouse button will increase the magnification so that that portion of the document fills the available space.

### Panning the Document

The Pan Document tool lets you move the document around, adjusting the portion that is visible. This is very useful when working at high magnifications where the entire document is not completely visible. To pan a document select Pan Document from the Tools toolbar or Tools Pan Document in the menu. Once activated the mouse pointer turns into a hand. To move the document move the mouse over the currently visible portion, hold down the &LMB; and drag.

### The Overview

The Overview palette provides a quick way of adjusting the zoom level and moving around the document. To enable it select View Palettes Overview.

A miniature representation of the document itself is shown underneath. A red rectangle indicates the portion that is currently visible. Clicking anywhere on this representation pans the view to that area. The rectangle can also be dragged.

At the bottom of the palette there is a slider and two buttons to zoom 25% in or out.

### Using Palettes

All palettes have a handle on the top side which enables them to be moved around and positioned on any edge of the main view. They can also float anywhere on the screen. To hide or show a palette select it from View Palettes.

### Multiple Views

It is possible to have multiple views of the same document displayed simultaneously.

Select New View from the View menu and a new &kivio; window showing the same document will appear. This is very useful for multiple monitor setups.

The additional windows can be closed and &kivio; will only prompt you to save the document when the last window is closed. All windows pertaining to a particular document can be closed simultaneously by selecting View Close All Views.

### Split Views

It is also possible to split the window into two or more portions which can be used to view two areas of a document at once. To split a window select View Split View. The orientation of the split can be changed from horizontal to vertical using View Splitter Orientation. To restore the window to its original state select View Remove View.

### Customizing the Display

The View menu contains options for toggling the display of page margins, rulers, guides and the grid.