From 8362bf63dea22bbf6736609b0f49c152f975eb63 Mon Sep 17 00:00:00 2001 From: tpearson Date: Wed, 20 Jan 2010 01:29:50 +0000 Subject: Added old abandoned KDE3 version of koffice git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/koffice@1077364 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- kexi/doc/handbook/docbook-status.txt | 163 +++++++ .../doc/handbook/html.tmp/01_01_00_what_is_db.html | 34 ++ .../handbook/html.tmp/01_02_00_db_spreadsheet.html | 206 +++++++++ kexi/doc/handbook/html.tmp/01_03_00_design.html | 8 + kexi/doc/handbook/html.tmp/01_04_00_who_needs.html | 24 + .../handbook/html.tmp/01_05_00_db_software.html | 54 +++ .../html.tmp/02_00_00_idx_intro_to_kexi.html | 7 + .../handbook/html.tmp/02_01_00_what_is_kexi.html | 25 + .../html.tmp/02_02_00_features_of_kexi.html | 15 + .../handbook/html.tmp/02_03_00_is_kexi_for_me.html | 12 + .../handbook/html.tmp/02_04_00_differences.html | 103 +++++ .../html.tmp/04_00_00_idx_basics_kexi.html | 3 + .../handbook/html.tmp/04_01_00_project_files.html | 13 + .../handbook/html.tmp/04_02_00_running_kexi.html | 25 + .../html.tmp/04_03_00_creating_database.html | 18 + .../html.tmp/04_04_00_project_opening.html | 59 +++ .../handbook/html.tmp/04_05_00_help_on_help.html | 10 + .../04_06_00_main_application_elements.html | 21 + .../html.tmp/04_06_01_project_navigator.html | 33 ++ .../handbook/html.tmp/04_06_02_object_windows.html | 35 ++ .../html.tmp/04_06_03_property_editor.html | 44 ++ .../05_00_00_idx_building_simple_database.html | 18 + .../html.tmp/05_01_00_table_designing.html | 109 +++++ .../05_02_00_entering_data_into_tables.html | 38 ++ .../html.tmp/05_03_00_query_designing.html | 37 ++ .../handbook/html.tmp/05_04_00_form_designing.html | 510 +++++++++++++++++++++ .../05_05_00_data_entering_into_forms.html | 12 + .../handbook/html.tmp/08_00_00_kexi_tuning.html | 11 + kexi/doc/handbook/html.tmp/08_01_00_mdi.html | 20 + .../handbook/html.tmp/08_02_00_dock_undock.html | 32 ++ kexi/doc/handbook/html.tmp/08_03_00_conf_keys.html | 32 ++ kexi/doc/handbook/translation-status.txt | 111 +++++ 32 files changed, 1842 insertions(+) create mode 100644 kexi/doc/handbook/docbook-status.txt create mode 100644 kexi/doc/handbook/html.tmp/01_01_00_what_is_db.html create mode 100644 kexi/doc/handbook/html.tmp/01_02_00_db_spreadsheet.html create mode 100644 kexi/doc/handbook/html.tmp/01_03_00_design.html create mode 100644 kexi/doc/handbook/html.tmp/01_04_00_who_needs.html create mode 100644 kexi/doc/handbook/html.tmp/01_05_00_db_software.html create mode 100644 kexi/doc/handbook/html.tmp/02_00_00_idx_intro_to_kexi.html create mode 100644 kexi/doc/handbook/html.tmp/02_01_00_what_is_kexi.html create mode 100644 kexi/doc/handbook/html.tmp/02_02_00_features_of_kexi.html create mode 100644 kexi/doc/handbook/html.tmp/02_03_00_is_kexi_for_me.html create mode 100644 kexi/doc/handbook/html.tmp/02_04_00_differences.html create mode 100644 kexi/doc/handbook/html.tmp/04_00_00_idx_basics_kexi.html create mode 100644 kexi/doc/handbook/html.tmp/04_01_00_project_files.html create mode 100644 kexi/doc/handbook/html.tmp/04_02_00_running_kexi.html create mode 100644 kexi/doc/handbook/html.tmp/04_03_00_creating_database.html create mode 100644 kexi/doc/handbook/html.tmp/04_04_00_project_opening.html create mode 100644 kexi/doc/handbook/html.tmp/04_05_00_help_on_help.html create mode 100644 kexi/doc/handbook/html.tmp/04_06_00_main_application_elements.html create mode 100644 kexi/doc/handbook/html.tmp/04_06_01_project_navigator.html create mode 100644 kexi/doc/handbook/html.tmp/04_06_02_object_windows.html create mode 100644 kexi/doc/handbook/html.tmp/04_06_03_property_editor.html create mode 100644 kexi/doc/handbook/html.tmp/05_00_00_idx_building_simple_database.html create mode 100644 kexi/doc/handbook/html.tmp/05_01_00_table_designing.html create mode 100644 kexi/doc/handbook/html.tmp/05_02_00_entering_data_into_tables.html create mode 100755 kexi/doc/handbook/html.tmp/05_03_00_query_designing.html create mode 100644 kexi/doc/handbook/html.tmp/05_04_00_form_designing.html create mode 100644 kexi/doc/handbook/html.tmp/05_05_00_data_entering_into_forms.html create mode 100644 kexi/doc/handbook/html.tmp/08_00_00_kexi_tuning.html create mode 100644 kexi/doc/handbook/html.tmp/08_01_00_mdi.html create mode 100644 kexi/doc/handbook/html.tmp/08_02_00_dock_undock.html create mode 100644 kexi/doc/handbook/html.tmp/08_03_00_conf_keys.html create mode 100644 kexi/doc/handbook/translation-status.txt (limited to 'kexi/doc/handbook') diff --git a/kexi/doc/handbook/docbook-status.txt b/kexi/doc/handbook/docbook-status.txt new file mode 100644 index 00000000..a4c16d2f --- /dev/null +++ b/kexi/doc/handbook/docbook-status.txt @@ -0,0 +1,163 @@ +----------------------------------------------------- +Contents: + Source HTML view of the manual (as per translation from Polish) + Docbook view of the manual as per SVN. +----------------------------------------------------- + +Changelog: +2005-12-05 mart + initial checkin +2006-01-11 jstaniek + update for chapter numbers, more TODOs added + +HTML view of the Manual: + +The chapter numbers in section headings here refer to +the Chapters in the HTML manual at + http://iidea.pl/~js/kexi/manual/en/ + +The original Polish version can be found here: +http://iidea.pl/~js/kexi/manual/pl/html/contents.html + +Icons and polish screenshots can be found here: +http://www.iidea.pl/~js/kexi/manual/en/kexi-docs-03.zip + +Chapter numbers in each descriptions refers to docbook version. + +HTML Chapter 1: +Has moved to Appendix A. +Needs writing. + +HTML Chapter 2: +Largely irrelevant marketing. + +Useful parts are now in Chapter 1 +(some bits missing - I'll sort them). + +Last Section (Different datatypes) is now moved to Appendix B. +(There are some discrepancies between HTML and reality, take +care when editting) + +HTML Chapter 4: +Has become Chapter 2. + +HTML Chapter 5: +Has become Chapter 3. + +HTML Chapter 6: +Will become Chapter 4. + +HTML Chapter 7: +Will become Chapter 5. + +HTML Chapter 8: +Has become Chapter 6. + +HTML Appendix A. Menu items + B. Keyboard Shortcuts +Will become Chapter 7. + +HTML Appendix C, D, E: +Will become Appendix C, D, E. + + +----------------------------------------------------- + +Docbook version: + +The chapter numbers here refer to the Docbooked manual. + +The names refer to the person working on that part of the manual. +Please contact them if you'd like to help. + + +Chapter 1: Introduction (Martin) +New text based on +02_00_00_idx_intro_to_kexi.html Done/Removed +02_01_00_what_is_kexi.html Done/Removed +02_02_00_features_of_kexi.html Done/Removed +02_03_00_is_kexi_for_me.html Done/Removed +Some work still required: + Use tag for mailing lists (they currently won't show in a printed doc) + Check source text once more for any relevant missing info. + +Chapter 2: Kexi Basics (Raphael) +The Kexi main window stuff is text I've written can be mered with 4.6 in HTML + +04_00_00_idx_basics_kexi.html Removed. (It's empty) +04_01_00_project_files.html Done. +04_02_00_running_kexi.html Ignoring for now. +04_03_00_creating_database.html Done. TODO: polish source changed - UPDATE! +04_04_00_project_opening.html Done. TODO: polish source changed - UPDATE! +04_05_00_help_on_help.html Done. +04_06_00_main_application_elements.html + Merge with "Kexi Main Window" section in docbook. + Done. +04_06_01_project_navigator.html Done. +04_06_02_object_windows.html Done. +04_06_03_property_editor.html Done. + +Chapter 3: Building Simple Databases (Raphael) +05_00_00_idx_building_simple_database.html Done. +05_01_00_table_designing.html Done. +05_02_00_entering_data_into_tables.html Done. +05_03_00_query_designing.html Done. +05_04_00_form_designing.html Done. +05_05_00_data_entering_into_forms.html Done. + +Chapter 4. Advanced database topics +06_01_00_kexi_project_sharing.html NOT READY FOR CONVERSION YET +06_02_00_idx_designing_advanced_objects.html NOT READY FOR CONVERSION YET +06_04_00_using_CLI.html NOT READY FOR CONVERSION YET + +Chapter 5. Working with external data +07_01_00_data_formats.html NOT READY FOR CONVERSION YET +07_02_00_data_import.html NOT READY FOR CONVERSION YET +07_02_01_data_import_csv.html NOT READY FOR CONVERSION YET +07_02_02_data_pasting_csv.html NOT READY FOR CONVERSION YET +07_03_00_db_project_import.html NOT READY FOR CONVERSION YET +07_04_00_data_export.html NOT READY FOR CONVERSION YET +07_04_01_data_export_csv.html NOT READY FOR CONVERSION YET +07_04_02_data_copying_csv.html NOT READY FOR CONVERSION YET +07_05_00_project_export.html NOT READY FOR CONVERSION YET +07_06_00_working_with_multiple_projects.html NOT READY FOR CONVERSION YET + + +Chapter 6: Configuring Kexi (Martin): +08_00_00_kexi_tuning.html Removed. (It's basically a chapter TOC) +08_01_00_mdi.html Done. +08_02_00_dock_undock.html Done. +08_03_00_conf_keys.html TODO + +Chapter 7: Command Reference +aa_00_00_menu.html NOT READY FOR CONVERSION YET (MERGE DOCS WITH docbook version) +ab_00_00_shortcuts.html NOT READY FOR CONVERSION YET (MERGE DOCS WITH docbook version) + +Anne-Marie wrote this text (updated by jstaniek), +since the Polish version has not been translated into English yet. +WILL BE REPALCED BY HTML Appendix A. and B. + +Appendix A (Raphael): +01_01_00_what_is_db.html Done. +01_02_00_db_spreadsheet.html Done. +01_03_00_design.html Done. +01_04_00_who_needs.html Done. +01_05_00_db_software.html Done. + +Appendix B: +02_04_00_differences.html 1/2 Done. Another table to go. + +Appendix C: Widgets Reference +ac_00_00_widgets.html NOT READY FOR CONVERSION YET +TODO + +Appendix D: Specifications +ad_01_01_csv_format.html NOT READY FOR CONVERSION YET +TODO + +Appendix E: Example database projects +ae_00_00_example_projects.html NOT READY FOR CONVERSION YET +TODO + +Appendix E: Support +ah_00_00_web_pages.html NOT READY FOR CONVERSION YET +ag_00_00_technical_support.html NOT READY FOR CONVERSION YET diff --git a/kexi/doc/handbook/html.tmp/01_01_00_what_is_db.html b/kexi/doc/handbook/html.tmp/01_01_00_what_is_db.html new file mode 100644 index 00000000..dd4bff42 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/01_01_00_what_is_db.html @@ -0,0 +1,34 @@ +

1.1. What is a database?

+

+You can define a database as a collection of data on one topic. It is organised in a way allowing to easily browse the information, make changes or add new items. +

+

+Look at this diagram for one of the above examples: a simple phone book. + +
+
A diagram of a phone number database

+ +The above picture shows a set of two contacts each of which is presented on a separate card. It appears that such a card can constitute a single line in a table: +

+ +

+ + + + + +
Contacts
NameTel No.
Joan699 23 43 12
Adam711 19 77 21
+

+ +

+Terms and definitions: A single data which constitutes a part of a greater collection can be called a line or more professionally a record. The collection is narmally called a table. Moreover, the most natural name for the table is one describing the data it offers/stores which is Contacts. Furthermore, each line in the table consists of columns often also called fields. In the table Contacts there are two columns (fields): Name and Tel No.. + +

+

+For simple uses a single table can make up a database. Many people consider these two equivalent. As you will see, for real databases we usually need more than one table. +

+

+To sum up, you have already got a simple database with one table Contacts. + + +

\ No newline at end of file diff --git a/kexi/doc/handbook/html.tmp/01_02_00_db_spreadsheet.html b/kexi/doc/handbook/html.tmp/01_02_00_db_spreadsheet.html new file mode 100644 index 00000000..e7959df7 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/01_02_00_db_spreadsheet.html @@ -0,0 +1,206 @@ +

1.2. A database and a spreadsheet

+

+It is very likely that you have already used spreadsheet applications like KSpread, OpenOffice.org Calc or Microsoft Excel. If so, you will probably wonder: since both spreadsheets and databases have tables, why should I use the latter? +

+

+While comparing spreadsheets and databases you may encounter the following issues which you will later see in greater detail: +

+ + + +

How is a database different from a spreadsheet?

+

+Gradually exceeding the capacity of a mobile phone, expand your table Contacts adding a column (field) Address. Add more telephone numbers (office, home) for each person and add surnames to names. To make it simpler we assume the following: +

+ + +

+ + + + + + + + +
Contacts
Name and surnameTelAddress
Joan Smith699 23 43 12Western Gate 1, Warsaw
Adam Willson711 19 77 21London, Frogs Drive 5
Joan Smith110 98 98 00Western Gate 1
Smith Joan312 43 42 22Warsaw, Western Gate 1
ADAM Willson231 83 02 04Frogs Drive 5, London
+

+ +

+Such a table can be made both in a spreadsheet and in a database. +Using a spreadsheet is very easy, of couse. What problems do we encounter at this stage? + + + +

Referential data integrity

+

+Suppose you are using a spreadsheet and you need to change the address of at least one person. You have a small problem: you often have to change the address in many lines. For example, Joan takes three lines. A real problem will arise if you forget to change one of the lines - the address asigned to this person will be ambiguous, hence your data loses integrity. +

+

+Moreover there is no simple way of deleting a chosen person from the table since you have to remember about deleting all the lines releted to him or her. +

+ + +

Data redundancy

+

+This is directly connected to the previous problem. In fields Name and surname and Address the same data is entered many times. This is typical of spreadsheets, ineffective way of storing data because the database grows unnecessarily, thus requiring more computer resources (larger size of data and slower access). +

+

How can you solve these problems with a database? You can split information into smaller chunks by creating additional table Persons with only two columns: Name and suname and Address: +

+

+

+ + + + + +
Persons
Name and surnameAddress
Joan SmithWestern Gate 1, Warsaw
Adam WillsonFrogs Drive 5, London
+

+

+Each line in the table Persons corresponds to a single person. +Table Contacts is from now in a relation to the table Persons (see next paragraph). +

+ + +

Data integrity and validity

+

+Note the way data is entered in fields Name and surname and Address. People entering data can be fallible, sometimes even negligent. In our sample data we have both different sequence of entering name and surname (Joan Smith and Smith Joan; Adam and ADAM) and many more ways of entering the same address. Surely you can think of many other ways. +

+

The above problem shows that e.g. when searching the telephone number of a person whose address is "Western Gate 1, Warsaw" you will not get a full result. You will get only one line instead of three. Moreover You will also not find all the telephone numbers searching for the value "Joan Smith" in the field Name and surname, because "Smith Joan" will not fit to "Joan Smith". +

+

How can you solve these problems using a database? You can do this by changing the design of the table Persons by: +

+

+

    +

  1. Dividing data in the field Name and surname into two separate fields: Name and Surname. +

    2. +

  2. Dividing data in the field Address into three separate fields Street, House number and Town. +

    3. +

  3. Guaranteeing data correctness: by ensuring that no fields are empty, e.g. you must always enter house number. +

    +
+

+

+A modified table looks something like this: +

+

+ + + + + + + +
Persons
NameSurnameStreetHouse numberCity
JoanSmithWestern Gate1Warsaw
AdamWillsonFrogs Drive5London
Conditions
required
field		required
field		required
field		required
field		required
field
+

+

+Thanks to introducing conditions required field we can be sure that the entered data is complete. In case of other tables you may of course allow omitting certain fields while entering data. +

+ + +

Limiting data view

+

+Spreadsheet displays all lines and columns of the table which is bothersome in case of very large data sheets. You may of course filter and sort lines in spreadsheets, however you must be extra careful while doing so. Spreadsheet users are in risk of forgetting that their data view has been filtered what can lead to mistakes. For example, while calculating sums you may think you have 100 rows of data while in fact there are 20 rows more hidden. +

+

If you want to work on a small subset of data, e.g. to send it for others to edit, you can copy and paste it to another spreadsheet and after editing paste the changed data back to the main spreadsheet. Such "manual" editing may cause data loss or incorect calculations. +

+

To limit the data view database applications offer queries, forms and reports. +

+

A very practical way of limitting is the following extended version of the previously described table Persons: +

+

+ + + + + +
Persons
NameSurnameStreetHouse numberCityIncome
JoanSmithWestern Gate1Warsaw2300
AdamWillsonFrogs Drive5London1900
+

+ +

+Let's assume that the newly introduced column Income contains confidential data. How can you share e.g. contact details of the persons with your coworkers but without revealing their income? It is possible if you share only a query and not the whole table. The query could select all columns except for the column Income. In database world such a query is often known as a view +

+ + +

Performance and capacity

+

+Your computer is probably quite fast, however you will easily see that it doesn't help with slow, large spreadsheets. Their low efficiency is first of all due to lack of indexes accelertaing the process of data search (databases do offer them). Moreover if you use things like system clipboard, even copying data may become troublesome with time. +

+

Spreadsheets containing large data sets may take ages to open. Spreadsheet loads lots of data to the computer's memory while opening. Most of the data loaded are probably useless/unneccessary for you at the moment. Databases unlike spreadsheets load data from computer storage only when needed. +

+

+In most cases you will not have to worry how the database stores its data. This means that unlike spreadsheets, databases do not care about: +

+ +

+

+Together with Limiting data view described in the previous paragraph these qualities constitute the advantage of databases. +

+ + +

Data entry +

+

+The latest editions of applications for creating spreadsheets enable you to design data-entry forms. Such forms are most useful if your data cannot be conveniently displayed in tabular view, e.g. if the text occupies too many lines or if all the columns do not fit on the screen. +

+

+In this case the very way the spreadsheet works is problematic. Fields for data entry are placed loosely within the spreadsheet and very often are not secure against the user's (intentional or accidental) intervention. +

+ + +

Reports

+

+Databases enable grouping, limiting and summing up data in a form of a report. Spreadsheets are usually printed in a form of small tables without fully automatic control over page divisions and the layout of fields. +

+ + +

Programming

+

+Applications for creating databases often contain full programming languages. Newer spreadsheets have this capability too, however calculations come down to modifying the spreadsheet's fields and simple data copying, regardless of the relevance an integrity rules mentioned in previous paragraphs. +

+

+Data processing within a spreadsheet is usually done via a graphical user's interface which may slow down the data processing speed. Databases are capable of working in background, outside of graphical interfaces. +

+ + +

Multiuse

+

It is hard to imagine a multiuse of one spreadsheet. Even if it is technically possible in the case of the latest applications, it requires a lot of discipline, attention and knowledge from the users, and these cannot be guaranteed. +

+

A classical way to sharing data saved in a spreadsheet with other person is to send a file as a whole (usually using e-mail) or providing a spreadsheet file in a computer network. This way of work is ineffective for larger groups of people - data that could be needed in a particular time may be currently locked by another person. +

+

+On the other hand, databases have been designed mainly with multiuser access in mind. Even for simplest version locking at particular table row's level is possible, what enables easy sharing of table data. +

+ + +

Security

+

+Securing a spreadsheet or its particular sections with a password is only symbolic activity. +After providing a spreadsheet file in computer network, every person being able to copy the file can try to break the password. It is sometimes not so hard as the password is stored in the same file as the spreadsheet. +

+

Features for edit locking or copy locking of a spreadsheet (or its part) is equally easy to break. +

+

+Databases (except these saved in a file instead of a server) do not need to be available in a single file. You're accessing them using a computer network, usually by providing a user name and a password. You are gaining access only to these areas (tables, forms or even selected rows and columns) whose were assigned to you by setting appropriate access rights. +

+

+Access rights can affect ability of data editing or only data reading. If any data is not avaliable to you, it will not be even sent to your computer, so there is no possibility of making a copy of the data in such easy way as in case of spreadsheet files. +

diff --git a/kexi/doc/handbook/html.tmp/01_03_00_design.html b/kexi/doc/handbook/html.tmp/01_03_00_design.html new file mode 100644 index 00000000..63650191 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/01_03_00_design.html @@ -0,0 +1,8 @@ +

1.3. Database design

+ +

+Database design needs careful planning. Note that Contacts table redesign proposed in this section 1.2 can generate problems when the table is filled with data. For exampe, renaming a field is a simple task, but splitting Address field into two separate fields requires careful and tedious work. +

+

+To avoid such situations, rethink your database project before you create it in your computer, and before you and others will start to use it. Thus, by investing some time initially, you will most probably save your time on everyday use. +

diff --git a/kexi/doc/handbook/html.tmp/01_04_00_who_needs.html b/kexi/doc/handbook/html.tmp/01_04_00_who_needs.html new file mode 100644 index 00000000..33a5f379 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/01_04_00_who_needs.html @@ -0,0 +1,24 @@ +

1.4. Who needs databases?

+ +

+Stick to spreadsheets if: +

+

+

+ +

+Consider using databases if: +

+ diff --git a/kexi/doc/handbook/html.tmp/01_05_00_db_software.html b/kexi/doc/handbook/html.tmp/01_05_00_db_software.html new file mode 100644 index 00000000..0f1c08cc --- /dev/null +++ b/kexi/doc/handbook/html.tmp/01_05_00_db_software.html @@ -0,0 +1,54 @@ +

1.5. Software for database construction

+

+So far you have learnt the general characteristics of databases without going into much +detail about specific applications for designing them. +

+

+The first databases were built together with large mainframe computers in the 60s, e.g. IBM System/360. +Those were not the days of PCs, therefore these databases required a highly specialized personnel. +Although the old computers' hardware was unreliable, they were immeasurably slower and had less +storage capacity, one feature of databases still remains most attractive: the data access by many +users through network. +

+ +

+In the 70s scientists formed the theory of relational databases +(terms like: table, record, column (field) and relationality and many others). +On the basis of this theory IBM DB2 and Oracle databases were created, +which have been developed and used till today. In the late 70s the first PCs +were constructed. Their users could (gradually) utilize many types of applications, +including those for database construction. +

+

When it comes to large databases in companies, the situation hasn't changed: +they still require powerful computers or computer complexes called clusters. +This goes, however, beyond the topic of this manual. +

+

+In the area of "accessible" databases with graphic user interface +for PCs you can choose from the following: +

+

+

+

diff --git a/kexi/doc/handbook/html.tmp/02_00_00_idx_intro_to_kexi.html b/kexi/doc/handbook/html.tmp/02_00_00_idx_intro_to_kexi.html new file mode 100644 index 00000000..7b9fc659 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/02_00_00_idx_intro_to_kexi.html @@ -0,0 +1,7 @@ +

2. Introduction to Kexi

+

+In this chapter you will learn what Kexi application is and how it can be of use to you. You will be able to decide which areas of your work can be simplified or automatized using Kexi. +

+

+Perhaps you already know some tools for creating databases or at least spreadsheets. If so, here you can learn about the basic differences between Kexi and other popular applications. +

diff --git a/kexi/doc/handbook/html.tmp/02_01_00_what_is_kexi.html b/kexi/doc/handbook/html.tmp/02_01_00_what_is_kexi.html new file mode 100644 index 00000000..9cfbe28d --- /dev/null +++ b/kexi/doc/handbook/html.tmp/02_01_00_what_is_kexi.html @@ -0,0 +1,25 @@ +

2.1. What is Kexi?

+

+Briefly speaking, Kexi is the application for creating databases and for data management. It enables you: +

+

+

+

+

+Kexi is a member of a PlusOfficePL family of products offered by OpenOffice Polska together with technical support. Kexi należ±cy do rodziny programów PlusOfficePL, oferowanej wraz ze wsparciem technicznym przez firmę OpenOffice Polska. +

+

+The motto of Kexi application is "Database creation for everyone". Introduction of this product was motivated by the lack of software Rapid Application Development tools similiar to Microsoft Access, FoxPro, Oracle Forms or FileMaker, that would be available for all contemporary hardware and system platforms. Kexi was made to fill this gap. +

+

+Kexi is the first large KDE application available for Microsoft Windows, which makes it easier for the user to transfer data between platforms, integrate and migrate for more cost-efficient systems like Linux. +

+

+Kexi is also one of the products of an international K Desktop Environment project, a graphic environment for Unix/Linux systems. The KDE project involves many companies (including the largest ones such as Novell and IBM), organisations and independent authors. +

diff --git a/kexi/doc/handbook/html.tmp/02_02_00_features_of_kexi.html b/kexi/doc/handbook/html.tmp/02_02_00_features_of_kexi.html new file mode 100644 index 00000000..9666e8d1 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/02_02_00_features_of_kexi.html @@ -0,0 +1,15 @@ +

2.2. Kexi Features

+

+Kexi has many features that distinguish it from the competition: +

+

+

+

\ No newline at end of file diff --git a/kexi/doc/handbook/html.tmp/02_03_00_is_kexi_for_me.html b/kexi/doc/handbook/html.tmp/02_03_00_is_kexi_for_me.html new file mode 100644 index 00000000..4cb22f17 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/02_03_00_is_kexi_for_me.html @@ -0,0 +1,12 @@ +

2.3. Is Kexi for me?

+

+Kexi is designed to serve both beginners (when it comes to databases) as well as more advanced users who know a great deal about databases. If you belong to the latter group, you will probably want to skip the sections of this documentation you are familiar with. However you will surely benefit from reading chapter 2.4 intended especially for experts. +

+

+If you have only used spreadsheets for data processing so far, you should read chapter 1.2. Database and spreadsheet. +If you feel that while using spreadsheets some activities, like entering the data, are too tedious and time-consuming, and final result contains hard-to-find errors, then Kexi could be a good solution for you. +Even if you use only a small part of functions provided by Kexi, your data stored in a form of database will probably be more legible and easier to comprehend for your coworkers. +

+

+If you have previously used applications with a graphic user interface (which is highly probable), using Kexi should be easy since it is in many ways similar. +

diff --git a/kexi/doc/handbook/html.tmp/02_04_00_differences.html b/kexi/doc/handbook/html.tmp/02_04_00_differences.html new file mode 100644 index 00000000..6e0c3ccd --- /dev/null +++ b/kexi/doc/handbook/html.tmp/02_04_00_differences.html @@ -0,0 +1,103 @@ +

2.4. Differences between Kexi and other applications

+ +

2.4.1. Terminology used in Kexi and in other database applications

+

+English terms are bracketed. +

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Kexi MS Access dBase i FoxPro Paradox
Database (Database) Database Catalog (Catalog) Directory of Related files (Directory of Related files)
Table (Table) Table Database file
(Database file)		 Table
Datasheet (Datasheet) Datasheet BROWSE Command View Command
Table design (Table design) Table design MODIFY STRUCTURE Command Modify Restructure Command
Primary key
(Primary key)		 Primary key Unique Index Key field
Index (Index) Index Index Tools QuerySpeed
Validation rule Validation rule PICTURE/VALID Clause ValChecks
Query (Query) Query Query, QBE, View Query
Form (Form) Form Screen Forms
Subform (Subform) Subform Multiple File Screen Multiple-record selection
"Open a form" Command
(Open a form		 Open a form Command SET FORMAT TO, EDIT Command Image PickForm
Find command
(Find command)		 Find command LOCATE AND SEEK Command Zoom
List box, combo box List box, combo box Pick list Lookup
Macro (Macro) Macro - -
Script (Script) Script Program file Script
+

+ +

+As you can see from the table above the terminology used in Kexi is close to the one used in MS Access application. +

+ +

2.4.2. Basic data types used in Kexi and in other database applications

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Kexi MS Access dBase i FoxPro Paradox
Text (Text) Text Character Alphanumeric
Long text (Long text) Memo Memo Memo
Date, Time (Date, Time) Date, Time Date DateTime
Object (Object) OLE Object (OLE Object) General OLE, Graphical, Binary
Yes/No (Yes/No) Yes/No Logical Logical
Integer number (Integer number) Number (Integer) Numeric Integer
Big Integer number (Big integer number) Liczba całkowita długa (Long integer) Numeric Long Integer
Floating-point number:
Single/Double precision
(Floating-point number)		 Single/Double precision number
(Single/Double precision number)		 Float Number
+

+ + \ No newline at end of file diff --git a/kexi/doc/handbook/html.tmp/04_00_00_idx_basics_kexi.html b/kexi/doc/handbook/html.tmp/04_00_00_idx_basics_kexi.html new file mode 100644 index 00000000..9b6c3196 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/04_00_00_idx_basics_kexi.html @@ -0,0 +1,3 @@ +

4. Kexi usage basics

+ + diff --git a/kexi/doc/handbook/html.tmp/04_01_00_project_files.html b/kexi/doc/handbook/html.tmp/04_01_00_project_files.html new file mode 100644 index 00000000..4ecab5b8 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/04_01_00_project_files.html @@ -0,0 +1,13 @@ +

4.1. Project files

+

Many applications such as OpenOffice.org or Microsoft Excel create files which are called documents. Kexi also creates files but we will call them Kexi projects or Kexi database files. +

+ +

Notes

+ +

+ +
Kexi project file on the desktop

+The name of the Kexi database file has extention .kexi both on MS Windows and Linux. +

diff --git a/kexi/doc/handbook/html.tmp/04_02_00_running_kexi.html b/kexi/doc/handbook/html.tmp/04_02_00_running_kexi.html new file mode 100644 index 00000000..fdf05130 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/04_02_00_running_kexi.html @@ -0,0 +1,25 @@ +

4.2. Running Kexi

+ +

4.2.1. Linux or Unix operating systems

+

+In the K menu of the K Desktop Environment click Office folder and then click Kexi entry. +

+

+You may also run Kexi from command line (e.g. using Konsole application or hotkey Alt+F2) and entering: +

+
+kexi
+
+

+See chapter 6.4. Using the command line. +

+ +

4.2.2. Microsoft Windows operating systems

+

+Choose Applications from menu Start and Kexi folder. Click Kexi shortcut. +

+ +

4.2.3. Mac OS X operating systems

+

+In folder Applications click icon Kexi. +

diff --git a/kexi/doc/handbook/html.tmp/04_03_00_creating_database.html b/kexi/doc/handbook/html.tmp/04_03_00_creating_database.html new file mode 100644 index 00000000..aa27e210 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/04_03_00_creating_database.html @@ -0,0 +1,18 @@ +

4.3. Creating a new database project

+
    +

  1. +Run Kexi (see Running Kexi). You will see the following window: + +
    +
    Kexi startup window

    + +

    2. +

  2. Click Ok button to run the creation of a new project.

    3. +

  3. Click Cancel button or press Escape to close window. You will see an empty application window (only menu). +

    4. +
+ +

+

+ + diff --git a/kexi/doc/handbook/html.tmp/04_04_00_project_opening.html b/kexi/doc/handbook/html.tmp/04_04_00_project_opening.html new file mode 100644 index 00000000..65da0854 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/04_04_00_project_opening.html @@ -0,0 +1,59 @@ +

4.4. Opening an existing Kexi database file

+

+To open an existing Kexi database file: +

+

+

+

+ + +

4.4.1. Opening a database file in Open Existing Project window

+

+

    +

  1. +Run Kexi application (see Running Kexi). You should see "Choose Project" startup dialog window. Choose Open Existing Project tab. You will see following dialog: +
    +
    Startup window: Open Existing Project tab

    +

    2. +

  2. From Look in drop down, pick a folder containing a file you are looking for. +

    3. +

  3. Pick a file, you want to open ir enter its name using the File name box. +

    4. +

  4. Click OK button. +

    5. +
+

Notes

+

+

+

+ + +

4.4.2. Opening an existing Kexi database file by clicking on .kexi file's icon

+

+Click file's icon using your file manager or desktop: +

+ +

+Kexi will open this database project automatically. +

+ +

Notes

+

+

+

diff --git a/kexi/doc/handbook/html.tmp/04_05_00_help_on_help.html b/kexi/doc/handbook/html.tmp/04_05_00_help_on_help.html new file mode 100644 index 00000000..cd1d1339 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/04_05_00_help_on_help.html @@ -0,0 +1,10 @@ +

4.5. Using built-in help

+

Following ways to get built-in help in Kexi are available: +

+

diff --git a/kexi/doc/handbook/html.tmp/04_06_00_main_application_elements.html b/kexi/doc/handbook/html.tmp/04_06_00_main_application_elements.html new file mode 100644 index 00000000..7411b12b --- /dev/null +++ b/kexi/doc/handbook/html.tmp/04_06_00_main_application_elements.html @@ -0,0 +1,21 @@ +

4.6. Main application elements

+

+
+
Kexi's main window

+ +Main elements of Kexi application's window are: +

+

diff --git a/kexi/doc/handbook/html.tmp/04_06_01_project_navigator.html b/kexi/doc/handbook/html.tmp/04_06_01_project_navigator.html new file mode 100644 index 00000000..c0df2e29 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/04_06_01_project_navigator.html @@ -0,0 +1,33 @@ +

4.6.1. Project Navigator pane

+

+Project Navigator pane is one of the most frequently used elements of the Kexi main window. +The pane contains a list of all objects created within the currently opened Kexi database project. The objects are splitted into groups: tables, queries, forms. +
+

+ +

+Project Navigator pane also contains a small toolbar for most frequently used commands (from left to right): Open selected object, Design selected object, Create a new object, and Delete selected object. +

+

+ +
A toolbar in the Project Navigator pane

+

+

+

+

+For each object on the list context menu is available using the &RMB;. For example, this is context menu for persons table: +
+
Project Navigator pane's context menu

+ +Commands of this menu is documented in Appendix A.10. +

+See also a list of available shortcuts in Appendix B.2. Project Navigator pane . +

+ +

+Double clicking with &LMB; on the object's name on the list allows to open the object in Data View. If the object's window was alread opened, the action just activates the window without switching it's view mode. +

+

+Note that your operating system can be set up to handle single clicks instead of double clicks. In this case it is enough to single click on the object name to open it's window. + +

diff --git a/kexi/doc/handbook/html.tmp/04_06_02_object_windows.html b/kexi/doc/handbook/html.tmp/04_06_02_object_windows.html new file mode 100644 index 00000000..42bd0a08 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/04_06_02_object_windows.html @@ -0,0 +1,35 @@ +

4.6.2. Database object windows

+ +

Opening object's window

+

+To open a database object in a window: +

    +

  1. Select the object in Project Navigator pane

    2. +

  2. Click Open button on the Project Navigator pane's toolbar.

    3. +
+ +

Commands related to object windows

+ +
Closing an object window
+

+When the IDEAl user interface mode (the default) is used, each window has it's own tab. Move the mouse pointer to the tab. You will see close button. Click it to close the tab. +

+

+In the Childframe on the right hand of each opened window there are buttons you can use to control the window. Click the first one on the right hand to close the window. +

+

+Alternatively, regardless of the user interface mode you are using, you can select Window ->Close from the Menubar. +

+ +
Window's buttons for Childframe user interface mode
+

+
+
Window's buttons

+Other button's (from right to left) can be used to: maximize, minimize and undock the window. +

+

+There's a small icon on the left hand of the window which can be clicked to show a context menu with commands related to the window. +

+

+See also 8.2. Docking and undocking of the windows. +

diff --git a/kexi/doc/handbook/html.tmp/04_06_03_property_editor.html b/kexi/doc/handbook/html.tmp/04_06_03_property_editor.html new file mode 100644 index 00000000..d823c056 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/04_06_03_property_editor.html @@ -0,0 +1,44 @@ +

4.6.3. Property Editor pane

+

+The Property Editor pane allows to change properties of object displayed in the active window. Depending on the context, the pane is consisted of one or more tabs. The first, always visible, Propertiestab contains the list of available properties. +

+

+ +
Property Editor

+

+

+Rules for using the Property Editor: +

+

+

+

+

+Property Editor pane is empty if: +

+

+ + + +

+See also the list of keyboard shortcuts available for the Property Editor pane in appendix B.3. Property Editor pane. +

diff --git a/kexi/doc/handbook/html.tmp/05_00_00_idx_building_simple_database.html b/kexi/doc/handbook/html.tmp/05_00_00_idx_building_simple_database.html new file mode 100644 index 00000000..77be8d8c --- /dev/null +++ b/kexi/doc/handbook/html.tmp/05_00_00_idx_building_simple_database.html @@ -0,0 +1,18 @@ + +

5. Building Simple Databases

+

+ To learn basics of Kexi usage, first you could build a simple database utilizing most elementary Kexi's features. To make things simpler, advanced database design topics will not be covered here. +

+

+Start by creating a new empty Phone Book. See chapter 4.3. Creating a new database project for information how to do this. +

+

+Having a new empty database project, perform the following steps: +

    +
  1. Design database tables. Read section 5.1.
    2. +
  2. Enter data to tables. Read section 5.2
    3. +
  3. Design database queries. Read section 5.3
    4. +
  4. Design forms. Read section 5.4
    5. +
+ +

diff --git a/kexi/doc/handbook/html.tmp/05_01_00_table_designing.html b/kexi/doc/handbook/html.tmp/05_01_00_table_designing.html new file mode 100644 index 00000000..14c0b511 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/05_01_00_table_designing.html @@ -0,0 +1,109 @@ + +

5.1. Designing Database Tables

+ +

+First, there will be two tables added to your database: persons and phone_numbers. These are exactly the same tables as described in chapter 1.2. A database and a spreadsheet. A layout for Persons can be found in section Data integrity and validity in that chapter. +

+ +

+

    +

  1. +Select Insert->Table from the Menubar. You can also use button + Create object: table on the Project Navigator's toolbar (see section 4.6.1. Project Navigator pane). +

    2. +

  2. +Table Designer's window will appear. Looking at the top of designer's window you will notice that Kexi proposed you a generic name like template for the new table. The table design is not saved yet so you will be able to assign more proper name later. Moreover, because of the same reason, the table name is not yet visible in the Project navigator. +

    3. +
+ + +

5.1.1. Table Designer window

+ +

+Table Designer window consists of following columns: +

+

+

+In Table designer window, every row corresponds to a single table field. You can recognize you are in design mode because the Switch to Design View mode button is toggled on within the main Kexi toolbar (see the figure below). +

+

+To start entering the Persons table design: +

    +
  1. +

    In the first row click on the cell in Field name column and enter name field name. +
    +
    Entering names for table fields

    +

    + +

    Notes about field names

    +

    +

      +
    • You must not left name for any of your fields empty.
      • +
    • Field names could not contain natonal character (like ±, ¶, Ü), special characters or space characters. The names must only contain roman letters, numbers and underscore sign "_". Use the latter instead of spaces or dashes.
      • +
    • Field names must be started with a roman letter or underscore sign "_", never with a number.
      • +
    • It does not matter whether you are using small or capital letters. For Kexi databases, "Persons" is the same ad "persons" name.
      • +
    +

    +
    2. +

  2. +Use down arrow key to move to next row. In the Data Type column, Text type appeared automatically. This is what you actually expected since a person's name should be in fact of type text. +

    3. +

  3. +In a similar way, enter the following fields into the table design: +

      +
    • surname
      • +
    • street
      • +
    • house_number
      • +
    • city
      • +
    +

    4. +

  4. +All above fields except house_number are of type text. Change house_number field's type to integer number. To do this, click on a cell in the Data Type column, house_number row and then click on drop down list's button (you can also press F4 or Alt+Down arrow keys). The list of data types will appear. Select Integer number type. +
    +
    Changing data type of a filed to integer number

    +Since now, house_number field only acepts numbers. +

    5. + +

  5. +Persons table desgin is ready. Click Switch to Data View button on the toolbar to finish designing and switch to Data View for the table. This allows you entering data into the table. +

    6. +

  6. +As the design is not yet saved in the database, "Save Object As" dialog window appears. You need to specify the name for the new table. +
    +
    Entering table name before saving its design

    + +Kexi offers a generic name like Table1. To change the name, enter Persons into the Caption field and press Enter key or click OK button. Caption field will be used to displaying the table to database end-users, e.g. as a form. Unlike the name, the caption can contain any characters including spaces a special characters. +
    +
    +Note that filling Caption field automatically fills Name field. For your convenience the rule for using only latin letters, digits and the "_" character is kept. You can alter contents of the Name field if you want to. + +
    +
    Example of automatically filled Name field

    +

    7. +

  7. +You are asked about an agreement for automatic adding of primary key to the table. The idea of primary keys is described in chapter 6. Click Add primary key button to continue. +
    +
    A question about automatic adding a primary key

    +

    8. +

  8. +Persons table has been created and opened in Data View. Its name appears in the Project Navigator pane. +
    +
    Persons table in the Project Navigator pane

    +

    9. +

  9. +Create phone_numbers table, in a similar way as persons table. +

    10. +

  10. +Create person field of type Integer number and phone of type Text. Do not use a number type here because phone number can have many different forms and prefixes. +

    11. +

  11. +Click Switch to Data View button on the toolbar and enter Phones caption for the table. As for your previous table, allow Kexi to automatically create primary key. +

    12. +
diff --git a/kexi/doc/handbook/html.tmp/05_02_00_entering_data_into_tables.html b/kexi/doc/handbook/html.tmp/05_02_00_entering_data_into_tables.html new file mode 100644 index 00000000..2a4edfa2 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/05_02_00_entering_data_into_tables.html @@ -0,0 +1,38 @@ + +

5.2. Entering Data Into Tables

+

+You have designed two Persons and phone_numbers tables. Both contain no data yet. You can enter some. In this chapter you will learn how to do this fast and effectively. +

+

+

    +

  1. +Start with persons table. Open it in Data View using Project Navigtor. +Current cell is marked with (usually black) rectangle, a cursor. Contents of the cell, if exists, is highlighted with a diferent color. Current row, i.e. the one you have placed your rectangular cursor in, is marked on the left hand using with an arrow symbol . +

    +

    You can navigate through table cells using mouse or arrow keys, Page Down, Page Down, Home, End keys. To learn more about available of the key bindings for the data table view, see the section B.4. Data Table in the Appendix B. Key Bindings. +

    +

    +Initially, after opening table Persons, the cursor is placed in the id column. The column has autonumber property defined, marked with blue (autonumber) text in the last row. That means you do not have to enter values there by hand when entering data for a new row because the cell will be filled automatically with successive numbers. +
    +
    Data entry

    +

    2. +

  2. +Inserting new rows and entering data for them in &kexi; is different from the way of doing this in spreadsheets. +To enter data for a new row, you need to use the arrow keys or mouse, to move your cursor to the special empty last row marked with ,,plus'' sign. Place your cursor in (second) name column and enter a person's name. Also enter surname, street, house number and city. When done, move down arrow or mouse button to the last empty row to accept new row inserting. You can insert rows you can see in the figure and add more your own. +

    Details About Actions Available While Entering Data Into Tables

    +
      +
    • When you started entering data by entering the first character, editing of the current row is started. On the left hand of the data table, pencil symbol appears.
      • +
    • +Double clicking a cell with &RMB; or pressing Enter or F2 key also starts editing of the current row.
      • +
    • Pressing Esc key when, a contents of a cell is edited, cancels changes made to this cell. However pencil symbol will not disappear because you can still move to different cell of the edited row to change its contents. To cancel changes made to entire edited row, press Esc key again.
      • +
    • Instead of pressing Esc key, you can click toolbar button or select Data->Cancel Row Changes from the menubar.
      • +
    • Click Shift+Enter keys to accept changes made to all cells in the currently edited row. You can also click toolbar button or select Data->Save Row from the menubar.
      • +
    +

    3. +

  3. +Fill the phone_numbers table with data, e.g. similar to provided in the figure below. In the persons column you need to provide a number of the person existing in the persons table. +
    +
    Example contents of the phone_numbers table

    +

    4. +
+

diff --git a/kexi/doc/handbook/html.tmp/05_03_00_query_designing.html b/kexi/doc/handbook/html.tmp/05_03_00_query_designing.html new file mode 100755 index 00000000..5a483c76 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/05_03_00_query_designing.html @@ -0,0 +1,37 @@ + +

5.3. Designing Database Queries

+

+A database's primary purpose is to store and help extracting information you are looking for. Unlike databases written on a paper sheets, Kexi database allows you to specify for much more search criterias. Results are returend faster without much dependency of. This all is a power of databases, however to be able to perform efffective queries in your database, you need to learn how to tell the database what are you looking for. +

+

+With database queries you can limit data coming from a table to a predefined set of rows and columns as well as dynamically join data coming from multiple tables. +

+

+To see how queries work in practice you will create contacts query joining data from two tables persons and phone_numbers designed in chapter 5.1 and filled with data in chapter 5.2. +

+ +

+

    +

  1. +Create a new empty query by selecting Insert->Query from the menubar. Design window will appear similar to the one presented oi the figure below. The window is horizontally splitted into two areas: query relationships on the top and query columns below. + +

    2. +

  2. +Select table persons in the drop down list Table: located at the top of the window and click Add button. A graphical representation of the table will appear in the the relations area. Do the same for phone_numbers table to insert it too, as in the figure below. +
    +
    contacts query design

    +

    3. +

  3. +Add query relationship using mouse drag & drop technique: click the field id in the table persons table, drag it and drop onto the person field of the phone_numbers table. This will join both fields by creating a new relationship. +

    4. +

  4. +Doube-clik the name field in the persons table, to add the field as a query column. In a similar way, add surname, street, house_number, city fields from the persons table and phone from the phone_numbers table. +

    5. +

  5. +Query design is now ready to test it. Click Switch to data view button on the toolbar, to switch from design to viewing the data provided as query results. +
    +
    Contacts query results

    +

    6. +
  6. Save the query design for later use by clicking Save button on the toolbar. You can also use File->Save from the menubar or press Ctrl+S keys. Because the query design has not been saved yet, you will be asked to specify a name for it. Enter Contacts text in the caption field. +
+

diff --git a/kexi/doc/handbook/html.tmp/05_04_00_form_designing.html b/kexi/doc/handbook/html.tmp/05_04_00_form_designing.html new file mode 100644 index 00000000..9cb671d1 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/05_04_00_form_designing.html @@ -0,0 +1,510 @@ +

5.4. Designing Forms

+

+

+ + +

5.4.1. Most important terms

+

+

+

+ + + +

5.4.2. Forms versus tables

+

+In chapter 5.2 you learned about how to enter data directly into tables using their data sheet view. However, in many cases forms are better suited for data entry: +

+

+ + +

5.4.3. Working with form design

+

+As with table or query design, you are able to use Data View and Design View. Form designing is performed in Design View. We will ofter refer to form design window as to Form Designer. +

+
    +
  1. +To create a new empty form, select Insert -> Form from the Menubar. Optionally, you can use New Form command from drop-down button on the Project Navigator's toolbar. +
    2. +
  2. +A new window with empty rectangular from surface will appear. Beyond the form surface outer area is placed, separated from the surface using borders. You can move the borders to resize the form surface. +The surface is covered with a grid painted using dots which simplifies accurate widgets positioning.

    +
    +
    A window with design of a new form

    +

    +
    3. +
+ +

+As with table design, Form Designer provides Property pane. To save some space on the screen, the pane has been splitted with three tabs related to the currently selected form: +

    +
  1. Property tab containing a list of properties for the currently selected widgets
    2. +
  2. Data source tab containing properties related specifically to data source of the currently selected widget or the form itself.
    3. +
  3. Widgets tab containing a hierarchy of all widgets of the form. The list simplifies widgets lookup by name and navigation between them.
    4. +
+There is information about currently selected widget's name and type displayed on the first and second tab. +

+

+Additional toolbars are also available: +

+ + + + +

5.4.4. Using the "Widgets" tab

+

+The "Widgets" tab in the Property pane provides a list of form widgets and their hierarchy. Each widget is presented within the hierarchy beside other widgets being on the same level (the same parent container). Child widgets (inside containers) are presented using indented names. +

+ +

+On the picture below, the form (a container) contains two widgets: "groupBox2" and "options" command button. In turn, "groupBox2" (being a container itself) contains two check box widgets.

+ + +
Using the "Widgets" tab

+ +Each widget has displayed its name and type. The type has also an icon displayed - the same as the one displayed on the toolbar used while form designing is performed. +

+ +

Notes

+ + + +

5.4.5. Inserting widgets - text fields

+

Let's create a form providing information about persons, i.e. a form connected it with Persons table. +

+

+If the form being designed should present data obtained from the database, you need to place appropriate fields on it. To do this, use Widgets toolbar containing a set of togglable buttons. Each button corresponds with a single widget type. +

+ +

+

    +
  1. +Click Text Box button on the Widgets toolbar.
    2. +
  2. Click on the form surface with &LMB;. New text box widget will be placed in the point where you clicked. Before you release &LMB; you can drag your mouse to specify a desired size for the widget.
    3. +
  3. If needed, move the inserted widget using drag & drop to a desired position. You can resize the widget afterwards by dragging one of the small boxes appearing near its corners. Note that the boxes are only visible when the widget is selected. If you select another widget or the form surface, the boxes disappear.
    4. +
  4. Click Text Box toolbar button again and click on the form surface to insert another widget. Repeat this action once again until you get three text boxes inserted in your form. For sake of simplicity we will limit ourselves to three data fields.
    5. +
+

+ +

Notes

+

+

+

+ + +

5.4.6. Assigning data sources

+

+The fields you inserted have no data source assigned yet, so these are not able to display information from the database. To assign data source, Data Source tab of the Property pane. +

+ +

+The very first step is to specify the form's data source, i.e. a place the displayed data will be fetched from. As mentioned above, you will use table persons as a data source for your new form. +

+ +

+

    +
  1. Click on the form's surface, as you will alter its properties.
    2. +
  2. Switch to the Data Source tab and enter persons table name in the Form's data source drop down list. Alternatively, you can select this name from the drop down list.
    +
    +
    Entering form's data source name

    +
    3. +
+

+ +

+You have assigned form's data source. Now you need to do specify field widget's data source. +

+ +

+

    +
  1. Click the first text field widget at the top of the form.
    2. +
  2. In the Data Source tab of the property pane enter field name name in the data source drop down list. Alternatively, you can select this name from the drop down list.
    +
    +
    Entering field's data source "name"

    +
    3. +
  3. Click next text field widget and enter surname as the data source.
    4. +
  4. Enter data sources for street, house_number and city text fields in a similar way.
    5. +
+

+

+You can now save the form's design (this is not mandatory to test the form in action). To save, click the Save object changes toolbar button or use the File -> Save menu command. Upon saving you will be asked for entering the form's name. Enter Persons as caption and click OK button. Form's name will be filled automatically. +

+

+It is right moment for testing your form. Click the Switch to data view toolbar button. Unless you made a mistake when while entering data sources, you should see form's fields filled with data from the persons table.
+
+
The Persons form in data view after inserting text fields and assigning data sources

+

+ +

Notes

+

+

+

+ + + +

5.4.7. Inserting text labels

+

+To make it easier for the form's user to identify meaning of every field widget, these should have added text labels with appropriate titles. To create text labels Label widget is used. +

+

+Insert three text label widgets onto the form, placing them on the left hand of the text fields (or on the right hand if your operating system uses right-to-left layout). On inserting every new label, a text cursor appears inside where you can enter desired title. Enter consecutively: Name, Surname and Street. Additionally, on the top of the form insert another label displaying name of the form, i.e. "Persons". Enlarge this label's size and set larger font using Format -> Font menu command. +

+

+
+
Ready to use form after adding text labels

+

+ + + + +

5.4.8. Actions

+ +

+Action is a single activity isolates in the application, available for user to execute. It can be also executed automatically as an reaction for a given event (e.g. after opening a form). +

+ + + +

Assigning actions to form buttons

+

+Most actions can be assigned to form button. Assigned action is executed after button is clicked. +

+

+To assign action: +

    +
  1. Switch to form's design view if you have not done yet.
    2. +
  2. Select the existing button widget by clicking on it or put a new button widget onto the form. If you inserted a new button, enter its title and press Enter key.
    3. +
  3. Click the button widget with the &RMB; to display context menu.
    4. +
  4. From the context menu select Assign action... command.
    5. +
  5. An Assigning Action to Command Button dialog window will appear presenting a list of available actions. One of the actions is selected if the widget already has action assigned. Otherwise the Action type drop down list has No type item selected.
    6. +
  6. From the Action type drop down list select Application item. Available application-wide actions will be listed.
    7. +
  7. Select one of the actions on the list (e.g. "Delete Row").
    8. +
  8. Click OK button or press Enter key to accept your selection.
    9. +
+

+

+ +
Assigning "Delete Row" action to a form's button

+

+ +

+After switching to the form's data view you can try whether the action works. For example, if you assigned "Delete Row" action, clicking the button, the current database row will be deleted, similarly to executing Edit > Delete Row menu command (depending on your settings you may be asked to confirm the removal). +

+

Notes

+
    +
  • To remove action assignment, select No type item from the Action type drop down list of the Assigning Action to Command Button dialog window.
    • +
  • Action only work in the form's data view. Not every action's assignment is reasonable. For example, Font... actions is not available in the form's data view, so having it assigned to the button has no effect.
    • +
+ + +

5.4.9. Widget layouts

+

+In most cases form widgets should be reasonable placed and aligned. Positioning, aligning and resizing widgets by hand is not easy and these parameters are not adjusted when the user resizes the form. In fact the situation is even worse because you cannot assume a given form requires a given space because users have different font sizes and display resolutions. +

+

+The following example presents a form where text fields and labels were placed by hand. Some of them cannot fit in the form's window. +
+
An example form with widgets that cannot not fit in the window

+

+

+Using special tool called widget layouts can help to automatically lay out the form widgets. Widget layout is an action of grouping two or more widgets so these are well positioned and have appropriate sizes. +

+

+Using layout in this form improves alignment. Moreover, its space is better developed. Text fields are closer each other, spacing is constant. +
+
+
Example form with layout used

+

+

+There are two methods to create widget layout. +

    +
  • Select two or more widgets that should be placed in a common layout, and select one of the layout types from the context menu item Layout Widgets.
    • +
  • Click a container widget (or a form surface itself), where widgets are inserted and select one of the layout types from the context menu item Layout Widgets. All widgets existing within the container or within the form, being on the same level will be put into a single common layout.
    • +
+In each of these cases you can also use Format -> Layout Widgets menu. +

+

+ +
Selecting widgets that will be put into a layout
+
+
Four widgets are selected

+

+
Using the context menu for putting the widgets into a grid layout

+

+

+Widget layout is presented in the design view using a blue, green or red box drawn with broken line. This line is displayed only in the form's design view. +

+

+
+
+
Widgets within a grid layout

+

+

+Besides the grid type, there are other widget layout types. +

    +
  • vertical +
    +
    +
    Vertical widget layout

    +
    • +
  • horizontal +
    +
    +
    Horizontal widget layout

    +
    • + +
+

+ + +

Springs in widget layouts

+

+A spring in widget layouts is a special, invisible element allowing to adjust widget's position and size within layouts. Such a spring stretches or squeezes a widget on the right, top, bottom or left hand, so it can have desired size and position. +

+

To use a spring: +

    +
  1. Select spring icon on the Widgets toolbar.
    2. +
  2. Click on a selected point of the form to insert the spring.
    3. +
+

+

+For the following example, the spring has been inserted on the left hand of the text label "Persons". The label is thus displayed on the right hand of the form. To make the spring work, it has been put into a common horizontal layout with the label. +
+
Horizontal layout containing a spring and a text label

+

+

+To make springs work you need to create a global widget layout i.e. a layout for the form itself. Then, springs can use edges of the form as a boundary for expanding. +

+ + +

Advanced widget layouts

+

+Widget layouts can be combined (or nested). On the following example you can identify two nested layouts: +

+

+

    +
  1. horizontal layout with a spring, aligning the "Persons" text label to the right
    2. +
  2. grid layout grouping widgets on the whole form
    3. +
+

+

+ +
Two widget layouts combined: horizontal layout inside of a grid layout

+

+

+The horizontal layout is treat in the example as a single widget by the grid layout - it takes exactly one "cell" of the grid. +After opening a form designed this way in the data view, you can notice (by resizing the form) that: +

+
    +
  • "Persons" text label thanks to the spring used is constantly aligned to the to the right side of the form
    • +
  • text fields take all of the available width thanks to putting them into the grid layout
    • +
  • all the form's widgets are pushed to the top thanks to the spring used at the bottom of the form
    • +
+

+ +
The form using the two layouts displayed in data view

+

+ + +

Removing widget layouts

+

+To remove widget layout without removing widgets, perform one of these actions: +

    +
  • click with the &RMB; on the layout's border and select Break Layout command from the context menu
    • +
  • click with the &LMB; on the layout's border and select Format -> Break Layout menu command
    • +
+

+ +

Notes

+

Removing widget layout using the Break Layout command will not remove widgets contained in the layout. If you want to remove the widgets as well, just select the layout by clicking on its border and press Delete key or use Edit -> Delete menu command or context menu command. +

+ + +

Size policies for widgets within a layout

+

+Instead of setting a fixed size for your widgets, in &kexi; you can choose between various widget's size policies. A size policy is a flexible strategy for controlling how a widget is stretched (or shrunk) depending on other neighbouring widgets and space available within the form. +

+

+After putting widgets into a layout, typically each widget gets a proportional (Preferred) size policy. These widgets will be automatically resized with preferred settings, depending on their type and size of the entire layout itself. For example, three buttons put into the horizontal layout will be resized to fit their visible text. +

+

+For each widget inserted into the form, there are settings for size policy available in the Property Editor. The settings are presented as a group of properties called Size Policy. + +
+
A group of properties for defining a widget's size policy

+ +This group of properties contains: +

+ +
Values of size policies
+

+There are following values available on the drop down list for Horizontal Size Policy and Vertical Size Policy properties visible in the Property Editor: +

+ +Different widget types have various default size policies; for example, button widgets have default size policy set to Minimum (in both directions), while text field widgets have vertical size policy set to Fixed. +

+

+The most frequently used size policies are Preferred, Minimum and Maximum. +

+ +
Vertical and horizontal stretch
+

+Vertical Stretch and Horizontal Stretch properties accept integer values greater or equal to 0. These properties allow to fine-tune the behavior of size policies. Default value for the properties is 0. Greater value of the stretch means that the widget will be expanded more than other widgets having smaller stretch value set. For example, the following image presents two buttons where the first button has Vertical Stretch set to 0 and the second button has Vertical Stretch set to 1. + +
+
Size of button widgets affected by setting Vertical Stretch property of the second button to 1

+ +

+ + +

5.4.10. Setting widgets size and position by hand

+

+In case when your form has no main layout set for auto-positioning and auto-resizing its widgets, you will probably want to align widget's position and size so the form can look cleaner and be easier to use. The &kexi; form designer simplifies this task by offering the following groups of commands: +

+ +

+ +

+There are also additional commands available: + Bring Widget to Front (i.e. above all other widgets) and Send Widget to Back (i.e. below all other widgets). These two commands are rarely used, as it is not common to place one widget on top of other (with an exception when a container widget contains other widget inside). Also note that clicking a widget with mouse button is enough to bring the widget to front. +

+ + +

5.4.11. Setting the tab order

+ +

+Widget's focus determines widget's activity available using keyboard. Focus is related to widgets displayed in form's data view. Exactly one form widget can have focus at the same time. Most frequent use of focus is text entry (when a given text field is active, i.e. it is focused). Other example is a button widget - when focused, it is possible to "press" it using the Enter or Space key instead of a mouse button. +

+

There are a few methods of making the widgets active (moving the focus to the widget): clicking with a mouse button, rotating the mouse wheel over the widget, or using the Tab key. The latter method is often used because of it's speed and convenience for users. Availability of the focusing methods is controlled by Focus Policy property of a given widget. +

+

+There is relationship between focusing (activating) widgets using Tab key and tab order setting of a form. After pressing the Tab key, the next widget should be focused, so the form should know about the tab order.

+

+To alter table order for a form's widget: +

    +
  1. switch to design view of the form
    2. +
  2. execute Edit -> Edit Tab Order menu command. +Edit Tab Order will appear with settings for this form. + +
    +
    A window for editing tab order for a form

    + +

    +The window contains a list with two columns: the first column displays widget names, the second - types of the widgets. To make it easier to recognize meaning of the names and types for the user, icons related to the types are also displayed. The list contains only widgets having focus policy allowing to use the Tab key. +The window allows you to change tab order or set the automatic tab order. +

    +
    3. +

  3. +To change tab order, either: +

      +
    • Click a selected widget name on the widgets list and drag it to a desired position (up or down) using the mouse. +
      • +
    • Click a selected widget name on the widgets list and use Move Up or Move Down buttons, to move the widgets to a desired position.
      • +
    • Click the Handle tab stops automatically check box to set the automatic tab order for the form. If this option has been switched on, any changes made to the list of widgets by hand are not taken into account - &kexi; will be handling the tab orders on its own. The automatic ordering means that the top-left widget will be focused first (or the top-right if your operating system uses right-to-left layout), and the order comes from the left to right (from the right to left, appropriately) and from the top to bottom. +
      +
      Automatic tab order for a form

      +
      • +
    +

    +
    4. +
  4. +Click the OK button to accept the changes or Cancel button to dismiss the changes. +
    5. +
diff --git a/kexi/doc/handbook/html.tmp/05_05_00_data_entering_into_forms.html b/kexi/doc/handbook/html.tmp/05_05_00_data_entering_into_forms.html new file mode 100644 index 00000000..2b324ab0 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/05_05_00_data_entering_into_forms.html @@ -0,0 +1,12 @@ +

5.5. Entering data using forms

+

+Data entering and editing is usually database application user's task, not developer's. In practice it is desirable to check the form in terms of valid data entry, and see whether the form works as expected. +

+

+To test your form, switch to its data view. A single database row (record) of data will be displayed and a text cursor will be set inside the first data field. You can move between fields using &RMB; or Tab and Shift+Tab keys. While editing, there will be pencil icon visible near the record navigator. After entering row's (record) data you can press Shift+Enter keys or toolbar button to accept changes made to the current row. Clicking toolbar button discards changes made to the current row and restores contents of the data fields. You can use record navigator's button to move to a new row. All the navigator's functions are also available in similar way as in the data table view. + +

+

+

+ + diff --git a/kexi/doc/handbook/html.tmp/08_00_00_kexi_tuning.html b/kexi/doc/handbook/html.tmp/08_00_00_kexi_tuning.html new file mode 100644 index 00000000..ad577cbb --- /dev/null +++ b/kexi/doc/handbook/html.tmp/08_00_00_kexi_tuning.html @@ -0,0 +1,11 @@ +

8. Adjusting Kexi application to your needs

+

+Kexi application has a customizable user interface allowing the user to adjust it to his preferences. +

+

+

+

diff --git a/kexi/doc/handbook/html.tmp/08_01_00_mdi.html b/kexi/doc/handbook/html.tmp/08_01_00_mdi.html new file mode 100644 index 00000000..65b36b81 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/08_01_00_mdi.html @@ -0,0 +1,20 @@ +

8.1. Changing the graphical interface mode

+

+MDI (Multiple Document Interface) modes enable the user to choose the way to manage the aplication's widows. You can choose one of two modes according to your preferences - it will be also used next time you run the application. +

+

+The change of MDI mode is possible using the MDI mode command from the Window menu bar. +Following modes are available: +

+

diff --git a/kexi/doc/handbook/html.tmp/08_02_00_dock_undock.html b/kexi/doc/handbook/html.tmp/08_02_00_dock_undock.html new file mode 100644 index 00000000..934d1f49 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/08_02_00_dock_undock.html @@ -0,0 +1,32 @@ +

8.2. Docking and undocking of the windows

+ +

+To undock a window you must drag it from the inside of the Kexi application and drop it so that you can e.g. maximize or move it freely. This is particularly useful when working on a small screen or when working with large datasheets. Undocking can also be used when working on two display monitors connected to one computer: you can move selected windows to the other display. +

+

+Docking is a command opposite to undocking: the window is placed back inside the application. +

+

+Docking in windows is available only in childframe mode of the graphic interface. The command is always available in case of panes. +

+

+The Dock/undock command is also available: +

+

diff --git a/kexi/doc/handbook/html.tmp/08_03_00_conf_keys.html b/kexi/doc/handbook/html.tmp/08_03_00_conf_keys.html new file mode 100644 index 00000000..1622a154 --- /dev/null +++ b/kexi/doc/handbook/html.tmp/08_03_00_conf_keys.html @@ -0,0 +1,32 @@ +

8.3. Keyboard shortcuts (key bindings) configuration

+

+This option allows to change the shortcuts in Kexi application. To do this, use the Configure Shortcuts command from the Settings menu. + +
+
Shortcuts configuration dialog box

+To confirm the introduced changes click OK button. Changes are permanent which means that they will also be available next time you run Kexi application. +

+

+Available actions: +

+

diff --git a/kexi/doc/handbook/translation-status.txt b/kexi/doc/handbook/translation-status.txt new file mode 100644 index 00000000..acc00d00 --- /dev/null +++ b/kexi/doc/handbook/translation-status.txt @@ -0,0 +1,111 @@ +Kexi Handbook: README +--------------------- + +0. Notes +- For more info contact Jaroslaw Staniek, js at iidea.pl (project maintainer) +- Original html content is strored temporary in html.tmp/ subdirectory. +- For now let's LEAVE and tags untouched - enclose them with + comments. We will prepare english screenshots later; for now only polish version exists. + Do not remove any existing comments. +- Development version of this handbook generated out of the docbook sources: + http://docs.kde.org/development/en/koffice/kexi/index.html +- For steps (e.g. in tutorial) rather use tag instead of . + subtag is available as well for <procedure>. Details: + http://www.docbook.org/tdg/en/html/procedure.html + +1. States: +-DONE +-MOVED +-empty means "translation not ready" + +2. TODOs +-add a documentation for form's Auto Fields +-add "File types supported by Kexi" (describe .kexis, .kexic, .kexi -- appendix?) + +3. Translation status: +Note: the numbering is taken from original Polish HTML version: + http://kexi.pl/doc/pl/contents.html + +DONE 1. Introduction to databases +DONE 1.1. What is a database? +DONE 1.2. A database and a spreadsheet +DONE 1.3. Database design +DONE 1.4. Who needs a database? +DONE 1.5. Database creation software +DONE 2. Introduction to Kexi +DONE 2.1. What is Kexi? +DONE 2.2. Kexi features +DONE 2.3. Is Kexi for me? +DONE 2.4. Differences between Kexi and other applications +WILL BE MOVED to Appendix: 3. Kexi Installation +DONE 4. Kexi usage basics +DONE 4.1. Project files +DONE 4.2. Running Kexi +DONE 4.3. Creating a new database project +DONE 4.4. Opening an existing Kexi database file +DONE 4.4.1. Using "Open Existing Project" window +DONE 4.4.2. By clicking on .kexi file's icon +DONE 4.5. Using built-in help +DONE 4.6. Main application elements +DONE 4.6.1. Project Navigator pane +DONE 4.6.2. Database object windows +DONE 4.6.3. Property pane +DONE 5. Building simple databases +DONE 5.1. Designing database tables +DONE 5.1.1. Table Designer window + TODO: update recent changes made to 05_01_00_table_designing.html +DONE 5.2. Entering data into tables + TODO: update recent changes made to 05_02_00_data_entering_into_tables.html +DONE 5.3. Designing database queries + TODO: update recent changes made to 05_03_00_query_designing.html +DONE 5.4. Designing forms +DONE 5.4.1. Most important terms +DONE 5.4.2. Forms versus tables +DONE 5.4.3. Working with form design +DONE 5.4.4. Using the "Widgets" tab +DONE 5.4.5. Inserting widgets - text fields +DONE 5.4.6. Assigning data sources +DONE 5.4.7. Inserting text labels +DONE 5.4.8. Actions +DONE * Assigning actions to form buttons +DONE 5.4.9. Widget layouts +DONE * Springs in widget layouts +DONE * Advanced widget layouts +DONE * Removing widget layouts +DONE * Size policies for widgets within a layout +DONE 5.4.10. Setting widgets size and position by hand +DONE 5.4.11. Setting the tab order +DONE 5.5. Entering data using forms +6. Advanced database topics + 6.1. Sharing a Kexi database project with others + 6.1.1. File-based database + 6.1.2. Server database + 6.2. Designing advanced objects + 6.3. Database administration + 6.3.1. Security in file-based databases + 6.3.2. Security in server databases + 6.3.3. Database file compacting + 6.4. Using the command line +7. Work with external data + 7.1. Data importing + 7.1.1. Importing CSV files + 7.1.2. Pasting CSV data from the clipboard + 7.2. Importing external database projects + 7.3. Data exporting + 7.3.1. Exporting data to CSV files + 7.3.2. copying CSV data to the clipboard + 7.4. Exporting database projects + 7.5. Working with multiple database projects +DONE 8. Adjusting Kexi application to your needs +DONE 8.1. Changing the graphical interface mode +DONE 8.2. Docking and undocking of the windows +DONE 8.3. Keyboard shortcuts (key bindings) configuration + Table of Contents + Index + Appendices + A. Menu items + B. Keyboard Shortcuts + C. Form and Report widgets + D. Specifications + E. Example database projects + F. Web pages about Kexi -- cgit v1.2.1