Copyright © 2003, 2000 Ben Lamb
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
Kivio is the KOffice flowchart and diagram creation tool.
Table of Contents
Kivio is the KOffice flowchart and diagram creation tool. It allows you to create accurate scale diagrams by arranging pre-drawn shapes, stencils, on a page. The stencils might represent stages of a process, office furniture or components on an electronic circuit. Kivio comes with a large collection of different stencils, these are grouped into collections, known as stencil sets, by subject area.
This document describes the features of Kivio and how to use them. There are often several ways to perform a particular task. Where possible the appropriate menu option is described as this is the easiest to explain without the aid of screenshots. Users are encouraged to explore the menus and to try right-clicking on stencils to reveal shortcut menus.
Kivio is a volunteer project. Your contributions are welcome. If you find a bug whilst using the software please report it by selecting Help->Report a Bug.
Contributions to the documentation, stencils, translations into other languages and the code itself are welcome, please see the KOffice website for more information about how to contribute.
Like other KOffice applications on startup Kivio presents a Create Document dialog. The three tabs offer 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 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.
Diagrams are created by placing different pre-drawn shapes called stencils on the page. Stencils can represent many different things and Kivio comes with a wide selection. For ease of reference they grouped into collections known as stencil sets. To use a stencil set select File->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.
Kivio identifies the stencil currently being edited by displaying six green rectangles 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 left mouse button. To select all the stencils in the current document select Edit->Select All. To deselect all stencils select Edit->Select None.
To move a stencil to another position on the page. Move the mosue pointer over the stencil, note the pointer will change to a cross with four arrows. Hold down the left mouse button and move the stencil to the new position. Release the mouse button.
Move the mouse pointer over one of the handles and note the mouse pointer change. Hold down the left mouse button and move the mouse, the size of the stencil will be adjusted continuously as the mouse is moved. When you are happy with the new size release the mouse button.
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 restore the change. Kivio stores multiple actions to undo/redo several changes.
Stencils can contain text to describe their function. To add text to a stencil move the mouse pointer over the stencil and double-click. A dialog box will appear prompting for some text. Enter some text and click OK, the text should be shown inside the stencil.
The font, size, alignment and style of the text can be adjusted by selecting Format->Text. Alternatively by using the buttons on the Format toolbar. The adjustments will only affect the currently selected stencil.
There are two ways to select multiple stencils in Kivio.
1. Click once inside the first stencil you wish to select. Hold down shift 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 left mouse button and move the mouse to the other side of the stencils you want to select, drawing a square around them. The square must completely emcompass the stencils for them to be selected.
Stencils can be filled with a solid color and the color of the outline can be changed. Select a stencil then select Format->Stencils and Connectors.
There is also a Set Background Color button on the Format toolbar. Clicking on the arrow to the right-hand side of this button will produce a drop-down color selector, clicking on the button itself will display a color palette allowing you to choose any color. A similar toolbar button exists to adjust the line color.
The width of a stencil's border can be adjusted by selecting Format->Stencils and Connectors or by using the Line Thickness spinbox on the Format toolbar. The line width can be entered in millimeters or increased/decreased using the arrows next to the text box.
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.
The Connector tool is available from the Tools toolbar, by default shown on the left-hand 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 left mouse button 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.
Connectors may also be labelled with text. To add text to a connector simply double click on it and 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.
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 Edit->Group Selected Stencils.
The procedure can be reversed by selecting a group of stencils and select Edit->Ungroup Selected 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 Edit->Bring to Front or Edit->Send to Back.
Send to Back will cause the stencil to be obscured by any stencil which overlaps. Bring to Front will cause the stencil to obscure any stencil which overlaps it.
A stencil's properties may be “locked” to prevent accidental changes. To alter a stencil's protection using the Protection docker. This can be displayed by selecting View->Docker->Protection. Select the stencil or stencils you wish to protect and then tick the properties you want to protect on the protection docker.
The protections available are: width, height, aspect ratio, X position, Y position and deletion. Deletion prevents a stencil from being deleted from the document.
For accurately specifying the dimensions of a stencil use the Geometry docker. To display the docker select View->Docker->Stencil Geometry Panel. The panel contains four text boxes for specifying the horziontal and vertical position of the stencil and the width and height.
Although the measurements are displayed in points it is possible to enter other units into the textbox. For example, entering 2.5cm will be convertedinto points. Millimeters (mm) and inches (in) are also accepted.
To adjust the zoom level select View->Zoom Level. This sub-menu contains a list of percentages from 33% to 500%, selecting one of these will adjust the magnifcation to show that percentage of the document.
There is also a list of zoom levels on the Edit toolbar, by default shown at the top of the screen.
A second method of controlling in the magnification is to use the Zoom tool. This is available on the left-hand tools menu. 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 magnication, i.e. zoom out.
Alternatively holding down the left mouse button and draging out a box, then releasing the mouse button will increase the magnification so that that portion of the document fills the available space.
The pan tool lets you move the document around adjusting the portion that is visible. Very useful when working at high magnifications where the entire document is not completely visible. The pan tool shares a button with the zoom tool on the Tools toolbar. Once activated the mouse pointer turns into a hand. To move the document move the mouse over the currently visible portion, hold down the left mouse button and drag.
The Bird's Eye docker provides a quick way of adjusting the zoom level and moving around the document. To enable it select View->Docker->Bird's Eye.
The docker has five buttons along the top, they are: Zoom In, Zoom Out,
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 docker there is a slider for adjusting the zoom level and a box showing the current zoom level.
All dockers can have a handle on one edge which enables them to be moved around and positioned on any edge of the main view. The can also float anywhere on the screen. If not floating they shrink when not in use to remain unobtrusive, however, this behavior can be toggled by clicking on the icon that looks like a small pin. Next to this is a button marked with a cross that removes the docker.
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 set-ups.
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
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 selecting View->Remove Split.
The View Manager allows you to store the current display settings, including zoom level and position. You can then adjust the view but revert back to the previous settings with a single mouse click. A number of different settings can be stored and given names for ease of reference.
To display the View Manager choose View->Docker->View Manager. The docker contains five buttons and a list of stored views.
The first button, Add Current View, stores the current display settings. Once the settings have been stored you can modify the display settings. To revert to any of the stored settings click on its name in the list.
By default Kivio labels the settings with the page number and the magnification level, to enter a more descriptive name click on the middle button, Rename Item, this lets you enter your own text.
The second button, Remove Item, removes the currently selected set of stored settings.
The final two buttons, Move Item Up and Move Item Down, allow the order of the settings in list to be adjusted.
To open a previously saved document select File->Open, a standard KDE file dialog box will appear.
Recently used documents are listed under File->Open Recent.
To save the current document select File->Save or File->Save As to give an existing file a different name.
It is possible to save the document in a format that can be opened by earlier versions of Kivio. Select the version you require from the Filter combo box in the Save file dialog.
A Kivio document can contain several pages of diagrams.
To add additional pages to a document select Page->Insert Page. The selector beneath the document view shows tabs for all the pages in the document that have not been hidden.
The names given to each page can be adjusted by double-clicking on the page name on the page selector, a dialog box will appear allowing the name to be edited.
The order of the pages can be adjusted by dragging the tabs on the page selector bar.
The arrow buttons on the page selector bar are for scrolling through the page tabs, they do not cycle through the pages themselves.
If you have a lot of pages in a document and you do not want to see them all on the page selector you can hide pages by selecting Page->Hide Page. This will remove the currently selected page from the page selector bar.
To reveal a hidden page select Page->Show Page and choose the page you want to see from the list box.
Individual pages can be exported as bitmap graphics files. To export the current page select Page->Export Page. A standard KDE file dialog box appears. The export format is determiend by the name you give the file, it must end with one of the extensions listed below.
The following formats are supported:
Windows Bitmap (.bmp)
Encapsulated Postscript (.eps)
JPEG (.jpeg)
.krl
.pmb
PCX (.pcx)
Portable Grayscale Map .pgm
Portable Pixmap File .ppm
Targa (.tga)
.xbm
.xpm
.xv
Kivio displays a regularly spaced grid over the document to aid stencil positioning. The visibility of the grid can be toggled by selecting View->Show Grid.
Objects edges are snapped to the nearest point on the grid regardless of whether it is visible. To toggle this behavior select View->Snap Grid.
To customise the grid select Settings->Configure Kivio... and click on the Grid on the icon list.
This dialog box will let you adjust the color the grid is drawn in, the horizontal and vertical spacing and the snap distance.
Tip: It is possible to have a non-square grid by specifying different horizontal and vertical spacings.
The text tool can be used to add text to a document that is not associated with any object. This is useful for noting general information about a drawing.
To add freestanding text make sure no object is selected by selecting Edit->Select None, then activate the text tool by selecting Tools->Edit Stencil Text. The mouse pointer will change to indicate the text tool is activated.
Drag a box to contain the text. A dialog box will appear prompting for the text, enter some text and click OK. The formatting of the text can be adjusted by selecting Format->Text or by using the toolbars.
Guides are lines used to help you position stencils. Not only can you use guides as a visual reference when aligning items but, optionally, Kivio will snap stencils to guides. This means that as soon as the edge of a stencil is within a certain distance to a guide it will immediately move to the guide's position.
To add a guide move the mouse pointer over either the horizontal or vertical ruler, depending on the type of guide you require. Hold down the left mouse button and drag the mouse over the document and release the mouse button where you want to position the guide. As you drag the mouse the guide will move accordingly.
Once a guide is in place you can reposition it by moving the mouse over it, holding down the left mouse button and dragging. Release the mouse button when the guide is in its new position.
Kivio allows complex diagrams to be split into multiple layers. The visibility of layers can be turned on and off. This functionality is useful if you have a basic diagram, for example a floorplan, and need to create several versions of it for different audiences. The information for each audience can be placed in a different layer. Each page of the document has its own set of layers.
To adjust the current page's layers select View->Docker->Layer Manager. The Layer Manager docker allows layers to be created, deleted and renamed. It can also be used to adjust layer visibility, drawing order and select the current layer.
Kivio has the concept of the currently active layer which is the one affected by any editing actions. By default a page contains only one layer which is the active layer.
Using the layer docker you can add new layers by clicking the New Layer button, the first from the left. Layers can be deleted by clicking the second button, Remove Layer. Kivio numbers the layers consecutively, to rename a layer select it in the list and click Rename Layer.
Layers are drawn in the order they are listed. The drawing occurs from the top down so objects in the layer at the bottom of the list are drawn on top of objects in all the other layers. The order of the list can be changed by selecting a layer and using the Move Layer Up and Move Layer Down buttons to change its position.
Each layer is listed with four small icons next to its name. From left to right they represent: Visibility - shown as a small eye. Clicking on the icon will toggle the layer's visibility.
The Align tool rearranges a group of stencils so that they are aligned on one edge or on an invisible centerline. To use the tool select several stencils, then select Format->Align & Distribute.... If the stencils are arranged in a horizontal row you the choice of aligning along the top or bottom edges or the centerline. For stencils that are arranged in a vertical row the choice is left or right edge or the centerline.
The distribute tool arranges a group of stencils so that there is an even amount of spacing between each stencil.
First select the stencils you want to rearrange, then select Format->Align & Distribute... and click on the Distribute tab in the tabbed window that appears.
You can choose whether the items should be spaced so that there is equal spacing between two edges, for example, the distance between the lefthand edge of each stencil should be the same. Or, whether the gap between each item should be identical. Choose the Spacing option if you desire this.
The second choice is whether the spacing should use the entire extent of the page or just the extent of the selection. If the latter is chosen the stencils will not occupy any more space than they did originally.
The option to use the extent of the page takes the page margins into consideration.
Kivio
Program copyright 2000-2003 The Kivio Team
Current maintainer is Peter Simonsonn <psn@linux.se>.
Contributors
Ian Reinhart Geiser <geiseri@kde.org>
Laurent Montel <montel@kde.org>
Frauke Oster <frauke@frsv.de>
Dave Marotti <lndshark@verticaladdiction.net>
The Kompany.com - "Where Open Source is at Home™" <info@thekompany.com>
Current documentation is maintained by Ben Lamb <kde@zurgy.org>
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.