TDE
/
koffice
mirror of https://mirror.git.trinitydesktop.org/gitea/TDE/koffice
0
0
Fork 0
Code Issues Releases Wiki Activity

Added old abandoned KDE3 version of koffice

Browse Source 
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/koffice@1077364 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
v3.5.13-sru
tpearson 15 years ago
commit 8362bf63de
10386 changed files with 2065153 additions and 0 deletions
Show Stats Download Patch File Download Diff File

1
AUTHORS
Unescape View File

@ -0,0 +1 @@
See in the each subdirectory for the authors of each KOffice application/filter.

340
COPYING
Unescape View File

@ -0,0 +1,340 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) 19yy <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19yy name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.

486
COPYING.LIB
Unescape View File

@ -0,0 +1,486 @@
NOTE! The LGPL below is copyrighted by the Free Software Foundation, but
the instance of code that it refers to (parts of koffice) are copyrighted
by the authors who actually wrote it.
---------------------------------------------------------------------------
GNU LIBRARY GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1991 Free Software Foundation, Inc.
51 Franklin Street, Suite 330
Boston, MA 02110-1301, USA.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the library GPL. It is
numbered 2 because it goes with version 2 of the ordinary GPL.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Library General Public License, applies to some
specially designated Free Software Foundation software, and to any
other libraries whose authors decide to use it. You can use it for
your libraries, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if
you distribute copies of the library, or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link a program with the library, you must provide
complete object files to the recipients so that they can relink them
with the library, after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
Our method of protecting your rights has two steps: (1) copyright
the library, and (2) offer you this license which gives you legal
permission to copy, distribute and/or modify the library.
Also, for each distributor's protection, we want to make certain
that everyone understands that there is no warranty for this free
library. If the library is modified by someone else and passed on, we
want its recipients to know that what they have is not the original
version, so that any problems introduced by others will not reflect on
the original authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that companies distributing free
software will individually obtain patent licenses, thus in effect
transforming the program into proprietary software. To prevent this,
we have made it clear that any patent must be licensed for everyone's
free use or not licensed at all.
Most GNU software, including some libraries, is covered by the ordinary
GNU General Public License, which was designed for utility programs. This
license, the GNU Library General Public License, applies to certain
designated libraries. This license is quite different from the ordinary
one; be sure to read it in full, and don't assume that anything in it is
the same as in the ordinary license.
The reason we have a separate public license for some libraries is that
they blur the distinction we usually make between modifying or adding to a
program and simply using it. Linking a program with a library, without
changing the library, is in some sense simply using the library, and is
analogous to running a utility program or application program. However, in
a textual and legal sense, the linked executable is a combined work, a
derivative of the original library, and the ordinary General Public License
treats it as such.
Because of this blurred distinction, using the ordinary General
Public License for libraries did not effectively promote software
sharing, because most developers did not use the libraries. We
concluded that weaker conditions might promote sharing better.
However, unrestricted linking of non-free programs would deprive the
users of those programs of all benefit from the free status of the
libraries themselves. This Library General Public License is intended to
permit developers of non-free programs to use free libraries, while
preserving your freedom as a user of such programs to change the free
libraries that are incorporated in them. (We have not seen how to achieve
this as regards changes in header files, but we have achieved it as regards
changes in the actual functions of the Library.) The hope is that this
will lead to faster development of free libraries.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, while the latter only
works together with the library.
Note that it is possible for a library to be covered by the ordinary
General Public License rather than by this special one.
GNU LIBRARY GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library which
contains a notice placed by the copyright holder or other authorized
party saying it may be distributed under the terms of this Library
General Public License (also called "this License"). Each licensee is
addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also compile or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
c) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
d) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the source code distributed need not include anything that is normally
distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Library General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!

199
Doxyfile.temp
Unescape View File

@ -0,0 +1,199 @@
# Doxyfile 0.1
#---------------------------------------------------------------------------
# General configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = KOffice
PROJECT_NUMBER = "SVN trunk"
OUTPUT_DIRECTORY = "../apidocs"
OUTPUT_LANGUAGE = English
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ALWAYS_DETAILED_SEC = NO
FULL_PATH_NAMES = NO
STRIP_FROM_PATH =
INTERNAL_DOCS = NO
STRIP_CODE_COMMENTS = YES
CASE_SENSE_NAMES = YES
SHORT_NAMES = NO
HIDE_SCOPE_NAMES = NO
VERBATIM_HEADERS = YES
SHOW_INCLUDE_FILES = YES
JAVADOC_AUTOBRIEF = NO
INHERIT_DOCS = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
DISTRIBUTE_GROUP_DOC = NO
TAB_SIZE = 8
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
ALIASES =
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
OPTIMIZE_OUTPUT_FOR_C = NO
SHOW_USED_FILES = YES
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = NO
WARN_FORMAT =
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = example \
filters \
interfaces \
karbon \
kchart \
kdgantt \
kexi \
kformula \
kivio \
koshell \
kplato \
kpresenter \
krita \
kspread kugar kword lib
FILE_PATTERNS = *.h
RECURSIVE = YES
#EXCLUDE = \
#arts/tests kdeprint/tests khtml/java/tests kio/kfile/tests kioslave/http/kcookiejar/tests kwallet/backend/tests \
#kdecore/tests kdeui/tests kinit/tests kio/tests kparts/tests libkmid/tests
# */tests doesn't seem to work :(
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
EXCLUDE_PATTERNS = *.ui.h *.moc.* Makefile.* ChangeLog CHANGES CHANGES.* README \
README.* *.png AUTHORS DESIGN DESIGN.* *.desktop \
DESKTOP* COMMENTS HOWTO magic NOTES TODO THANKS
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
# the \include command).
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = NO
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT =
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT =
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT =
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .kde3
MAN_LINKS = YES
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::addtions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
PERL_PATH =
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
HAVE_DOT = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
TEMPLATE_RELATIONS = YES
HIDE_UNDOC_RELATIONS = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
GRAPHICAL_HIERARCHY = YES
DOT_PATH =
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 640
MAX_DOT_GRAPH_HEIGHT = 1024
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::addtions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
CGI_NAME =
CGI_URL =
DOC_URL =
DOC_ABSPATH =
BIN_ABSPATH =
EXT_DOC_PATHS =

186
INSTALL
Unescape View File

@ -0,0 +1,186 @@
Basic Installation
==================
These are generic installation instructions.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.
The file `configure.in' is used to create `configure' by a program
called `autoconf'. You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.
Running `configure' takes a while. While running, it prints some
messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that
the `configure' script does not know about. You can give `configure'
initial values for variables by setting them in the environment. Using
a Bourne-compatible shell, you can do that on the command line like
this:
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
Or on systems that have the `env' program, you can do it like this:
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
If you have to use a `make' that does not supports the `VPATH'
variable, you have to compile the package for one architecture at a time
in the source code directory. After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another
architecture.
Installation Names
==================
By default, `make install' will install the package's files in
`/usr/local/kde/bin', `/usr/local/kde/lib', etc. You can specify an
installation prefix other than `/usr/local/kde' by giving `configure'
the option `--prefix=PATH'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
KDE Specific
============
If you use ./configure --prefix to install KOffice in a different
location than the rest of KDE, you need to tell KDE about it.
For this, either set $KDEDIRS so that it contains both prefixes,
or add this to /etc/kderc :
[Directories]
prefixes=/the/prefix/I/used/to/install/koffice/
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on. Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
CPU-COMPANY-SYSTEM
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.
If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Operation Controls
==================
`configure' recognizes the following options to control how it
operates.
`--cache-file=FILE'
Use and save the results of the tests in FILE instead of
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
debugging `configure'.
`--help'
Print a summary of the options to `configure', and exit.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made.
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`--version'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`configure' also accepts some other, not widely useful, options.

12
Mainpage.dox
Unescape View File

@ -0,0 +1,12 @@
/**
* @mainpage KOffice API Reference
*
*
* KOffice consists of a number of applications.
* Very few actually have any API dox to speak of.
*
* - KDGantt
* - Kexi
* - KSpread
*
*/

20
Makefile.am
Unescape View File

@ -0,0 +1,20 @@
## koffice/Makefile.am.in
## (C) 1997 Stephan Kulow
AUTOMAKE_OPTIONS = foreign 1.4
COMPILE_FIRST = lib interfaces
# COMPILE_BEFORE_kexi = kword kugar
# COMPILE_BEFORE_kplato = kdgantt kugar
# For kword/mailmerge/kspread
# COMPILE_BEFORE_kword = kspread
# COMPILE_BEFORE_ascend = kword
COMPILE_LAST = filters
DISTCLEANFILES = inst-apps
MAINTAINERCLEANFILES = subdirs configure.in acinclude.m4 SUBDIRS
include admin/deps.am
include admin/Doxyfile.am
SUBDIRS=$(TOPSUBDIRS)

19
Makefile.am.in
Unescape View File

@ -0,0 +1,19 @@
## koffice/Makefile.am.in
## (C) 1997 Stephan Kulow
AUTOMAKE_OPTIONS = foreign 1.4
COMPILE_FIRST = lib interfaces
COMPILE_BEFORE_kexi = kword kugar
COMPILE_BEFORE_kplato = kdgantt kugar
# For kword/mailmerge/kspread
COMPILE_BEFORE_kword = kspread
COMPILE_BEFORE_ascend = kword
COMPILE_LAST = filters
DISTCLEANFILES = inst-apps
MAINTAINERCLEANFILES = subdirs configure.in acinclude.m4 SUBDIRS
include admin/deps.am
include admin/Doxyfile.am

14
Makefile.cvs
Unescape View File

@ -0,0 +1,14 @@
all:
@echo "This Makefile is only for the CVS repository"
@echo "This will be deleted before making the distribution"
@echo ""
@if test ! -d admin; then \
echo "Please recheckout this module!" ;\
echo "for cvs: use checkout once and after that update again" ;\
echo "for cvsup: checkout kde-common from cvsup and" ;\
echo " link kde-common/admin to ./admin" ;\
exit 1 ;\
fi
$(MAKE) -f admin/Makefile.common cvs
.SILENT:

92
README
Unescape View File

@ -0,0 +1,92 @@
KOffice is based on KDE ( http://www.kde.org ) which is needed to run KOffice.
You need kdelibs and kdebase installed if you want to compile and run
KOffice. Look in the kdelibs sourcedir for the file COMPILING for help. Also
look at the website as there are many helpfiles available.
KOffice is a collection of office applications linked together by a common
basis. This common basis assures that all office application can work
together. You can, for instance, insert a spreadsheet in your thesis without
leaving your document. Editing the spreadsheet happens _inside_ your thesis.
The applications currently included in KOffice are:
- KWord
Professional text editing
- KSpread
Professional number cruncher/spreadsheet
- KPresenter
Professional presentation program
- KChart
Graphing of your abstract data
- Karbon
Vector graphics tool
- Kugar
Database report creation
- Kivio
Flowcharting program
- Kexi
Integrated data management
- Krita
A pixel graphics tool
- KFormula
A mathematical formula editor
- KOffice Workspace
A combination of all of the above
Note: these applications are not necessarily part of the previous or next
official stable version of KOffice.
Developers:
===========
KOffice is created by Open Source programmers around the world. All developers
give their time/code to the community for everyone to benefit. The major reason
this is done is because those developers want to have a good office suite, and
they don't mind sharing it with you.
If you feel you found a bug or missing feature you can always contact the
developers of KOffice (via http://www.koffice.org ) or delve into the software
yourself.
The part that is shared between all KOffice applications can be found in the lib
directory. There classes like KoDocument can be found; these classes are
extended in the project directories.
Read the .h files in the respective directories for more info.
Document format:
================
Nearly all KOffice applications use XML formatted files in a ZIP file.
The main document in XML format can be read with a text editor (after having
unzip-ped it from the ZIP file.) XML itself is simply a set of tags,
where the application can define the meaning of these tags. The definition of
the document type is therefore different for each KOffice application (as you
will most likely not find a curved line in a KWord document). The Document Type
Definition can be found in every application's source directory in the
directory '(application)/dtd.'
If you would like more information about the makeup of the actual KOffice
document structure (not the XML DTD), see the lib/store/SPEC file.
If you want to see more/fix bugs in this file, feel free to ask or add it
yourself.
Contacts:
=========
User mailing list: mailto:koffice@kde.org
Developer mailing list: mailto:koffice-devel@kde.org
Subscribing and list information: http://www.kde.org/mailinglists
Archives: http://lists.kde.org
If you have questions about this README file or about KOffice in general,
please mail to the KOffice mailing list: mailto:koffice@kde.org
Thomas Zander
Chris Lee

31
README.APPS
Unescape View File

@ -0,0 +1,31 @@
This directory contains the source code for the upcoming KOffice 1.6.
The 1.6 release is a kind of "in-between" release, and not every program
will be actively developed here.
The maintainers of some programs have announced that they think that
the release cycle for 2.0 is too long and want a feature release in
between 1.5 and 2.0. For all the rest of the programs, bugfixes that
are committed in the 1.5 branch will be forward ported to 1.6 at the
time of the release.
The real development will happen in trunk, and will eventually lead to
KOffice version 2.0, which will be based on Qt4 and kdelibs4.
Here is the list of applications and libraries that will be developed
in the 1.6 cycle:
- lib/koproperty
- lib/kross
- kchart
- kexi
- krita
- kdgantt
- kplato
- doc
- kformula
- lib/kformula
It is up to the maintainer of those applications to merge their change
with trunk, and with 1.5 for fixed bugs. For all the rest of the
applications / subdirectories, all changes for 1.5 will be forward
ported as described above.

187
README.PACKAGERS
Unescape View File

@ -0,0 +1,187 @@
Packaging Information for KOffice.
----------------------------------
We recommend building several binary packages from the KOffice source.
Splitting KOffice into packages:
* gives users a better choice of which components they have
installed;
* allows users to install just the applications without unnecessary
dependencies;
* helps to reduce packaging conflicts for users with non-standard
package selections.
Table Of Contents
-----------------
1. Database drivers (MySQL, PostgreSQL)
2. Development files
2.1. KexiDB development files
2.2. Krita development files
3. Scripting support
4. Microsoft Access Import (optional, recommended)
5. Quick command-line tests of Kexi installation
1. Database drivers
-------------------
Kexi provides database drivers for MySQL and PostgreSQL. We suggest
putting each driver in a separate package, and that installation of
these packages be optional. Each driver package may then depend on
the corresponding 'native' libraries: libmysqlclient for MySQL; and
and libpqxx for PostgreSQL (libpqxx in turn depends on libpq).
Thus, the MySQL driver package could contain:
lib/kde3/kexidb_mysqldriver.so
lib/kde3/kexidb_mysqldriver.la
lib/kde3/keximigrate_mysql.so
lib/kde3/keximigrate_mysql.la
share/services/kexidb_mysqldriver.desktop
share/services/keximigrate_mysql.desktop
The PostgreSQL driver package consists of the following files:
lib/kde3/kexidb_pqxxsqldriver.so
lib/kde3/kexidb_pqxxsqldriver.la
lib/kde3/keximigrate_pqxx.so
lib/kde3/keximigrate_pqxx.la
share/services/kexidb_pqxxsqldriver.desktop
share/services/keximigrate_pqxx.desktop
Note that you SHOULD NOT care about SQLite database driver or adding
dependencies for SQLite, because SQLite support is built into Kexi
using a fork of SQLite source code.
2. Development files
--------------------
2.1. KexiDB development files
Location: koffice/kexi/kexiutils, koffice/kexi/kexidb, koffice/kexi/migration
KexiDB, the database abstraction library used in Kexi, installs some
development files which are required for building external plugins,
such as the MS Access import plugin described below.
We recommend providing KexiDB development files in a separate package.
The files are:
include/kexidb/*.h
include/kexiutils/*.h
lib/libkexidb.la
lib/libkexidb.so
lib/libkexidbparser.so
lib/libkexidbparser.la
The installation can be tested by building the MS Access import plugin
as described in the Microsoft Access import plugin section below.
2.2. Krita development files
Location: koffice/krita/core, koffice/krita/sdk,
koffice/krita/kritacolor, koffice/krita/ui
These directories contain header files that are installed and can be
used by plugin developers to extend Krita with new tools, colorspaces,
paint-ops and more. If your distribution packages development files
separately, it may be a good idea to make a package with these headers.
3. Scripting support
--------------------
Preliminary support for Ruby and Python scripting is available for
Krita and Kexi.
It can be disabled by passing the '--disable-scripting' option to
'configure'.
The 'Kross' scripting library (koffice/lib/kross) provides access to
the Python and Ruby scripting languages by the dynamically loaded
plugins.
Build time dependencies:
Python and Ruby development packages need to be installed in order
to build KOffice with full scripting support. In addition, the Ruby
interpreter is also required at build time.
Run time dependencies:
Kross detects which of these libraries is installed dynamically, at
run-time. Therefore, KOffice packages need not have any run-time
dependencies on any scripting interpreter.
The scripting language plugins can be found in:
koffice/lib/kross/python; and
koffice/lib/kross/ruby.
They install as:
lib/kde3/krosspython.{la,so}; and
lib/kde3/krossruby.{la,so}
It is recommended to put each interpreter plugin into a separate
package, and the user decide if they would like support for each
language individually.
For example, the Python scripting package may contain:
lib/kde3/krosspython.so
lib/kde3/krosspython.la
share/apps/kexi/scripts/exportxhtml/ExportXHTML.py
share/apps/kexi/scripts/exportxhtml/ExportXHTML.rc
share/apps/kexi/scripts/importxhtml/ImportXHTML.py
share/apps/kexi/scripts/importxhtml/ImportXHTML.rc
share/apps/kexi/scripts/projectdocumentor/ProjectDocumentor.py
share/apps/kexi/scripts/projectdocumentor/ProjectDocumentor.rc
share/apps/krita/scripts/invert.py
share/apps/krita/scripts/reshapehisto.py
and the Ruby scripting package may contain:
lib/kde3/krossruby.so
lib/kde3/krossruby.la
share/apps/krita/scripts/ruby/invert.rb
share/apps/krita/scripts/ruby/changecs.rb
share/apps/krita/scripts/ruby/randompaint.rb
4. Microsoft Access Import (optional, recommended)
-------------------------------------
A plugin to allow the import of MS Access (.mdb) files is available
for packaging separately. It is called KexiMDB.
This package is based on a stripped-down and modified version of
mdbtools: http://mdbtools.sf.net/
The package should be built after KOffice. It requires GLib, and the
Kexi development files as described above.
The version of the plugin for use with KOffice 1.5 should be available
from:
ftp://ftp.kde.org/pub/kde/stable/apps/KDE3.x/database/keximdb-1.0.tar.gz
Alternatively, it can be found in the KDE Subversion repository. It
can be built as follows:
svn export svn://anonsvn.kde.org/home/kde/branches/work/keximdb/koffice-1.5 keximdb-1.0
cd keximdb-1.0
make -f Makefile.cvs
./configure --enable-debug=full
make
make install
Configure may need to be informed of the location of the KexiDB
headers using the --with-kexidb-includes=... and the
--with-kexidb-libraries=... options.
5. Quick command-line tests of Kexi installation
------------------------------------------------
If you don't want to click through Kexi interface but still want
to make (almost) sure the application is properly packaged, please
install it and type the following from the command line:
kexi --create-opendb --drv sqlite3 --new form testdb
(ignore possible warning message)
This will:
- create a new empty database file "testdb",
- open it,
- create a new empty form

12406
acinclude.m4
View File

File diff suppressed because it is too large Load Diff

892
aclocal.m4 vendored
Unescape View File

@ -0,0 +1,892 @@
# generated automatically by aclocal 1.9.6 -*- Autoconf -*-
# Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
# 2005 Free Software Foundation, Inc.
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.
# Copyright (C) 2002, 2003, 2005 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# AM_AUTOMAKE_VERSION(VERSION)
# ----------------------------
# Automake X.Y traces this macro to ensure aclocal.m4 has been
# generated from the m4 files accompanying Automake X.Y.
AC_DEFUN([AM_AUTOMAKE_VERSION], [am__api_version="1.9"])
# AM_SET_CURRENT_AUTOMAKE_VERSION
# -------------------------------
# Call AM_AUTOMAKE_VERSION so it can be traced.
# This function is AC_REQUIREd by AC_INIT_AUTOMAKE.
AC_DEFUN([AM_SET_CURRENT_AUTOMAKE_VERSION],
[AM_AUTOMAKE_VERSION([1.9.6])])
# AM_AUX_DIR_EXPAND -*- Autoconf -*-
# Copyright (C) 2001, 2003, 2005 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# For projects using AC_CONFIG_AUX_DIR([foo]), Autoconf sets
# $ac_aux_dir to `$srcdir/foo'. In other projects, it is set to
# `$srcdir', `$srcdir/..', or `$srcdir/../..'.
#
# Of course, Automake must honor this variable whenever it calls a
# tool from the auxiliary directory. The problem is that $srcdir (and
# therefore $ac_aux_dir as well) can be either absolute or relative,
# depending on how configure is run. This is pretty annoying, since
# it makes $ac_aux_dir quite unusable in subdirectories: in the top
# source directory, any form will work fine, but in subdirectories a
# relative path needs to be adjusted first.
#
# $ac_aux_dir/missing
# fails when called from a subdirectory if $ac_aux_dir is relative
# $top_srcdir/$ac_aux_dir/missing
# fails if $ac_aux_dir is absolute,
# fails when called from a subdirectory in a VPATH build with
# a relative $ac_aux_dir
#
# The reason of the latter failure is that $top_srcdir and $ac_aux_dir
# are both prefixed by $srcdir. In an in-source build this is usually
# harmless because $srcdir is `.', but things will broke when you
# start a VPATH build or use an absolute $srcdir.
#
# So we could use something similar to $top_srcdir/$ac_aux_dir/missing,
# iff we strip the leading $srcdir from $ac_aux_dir. That would be:
# am_aux_dir='\$(top_srcdir)/'`expr "$ac_aux_dir" : "$srcdir//*\(.*\)"`
# and then we would define $MISSING as
# MISSING="\${SHELL} $am_aux_dir/missing"
# This will work as long as MISSING is not called from configure, because
# unfortunately $(top_srcdir) has no meaning in configure.
# However there are other variables, like CC, which are often used in
# configure, and could therefore not use this "fixed" $ac_aux_dir.
#
# Another solution, used here, is to always expand $ac_aux_dir to an
# absolute PATH. The drawback is that using absolute paths prevent a
# configured tree to be moved without reconfiguration.
AC_DEFUN([AM_AUX_DIR_EXPAND],
[dnl Rely on autoconf to set up CDPATH properly.
AC_PREREQ([2.50])dnl
# expand $ac_aux_dir to an absolute path
am_aux_dir=`cd $ac_aux_dir && pwd`
])
# AM_CONDITIONAL -*- Autoconf -*-
# Copyright (C) 1997, 2000, 2001, 2003, 2004, 2005
# Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 7
# AM_CONDITIONAL(NAME, SHELL-CONDITION)
# -------------------------------------
# Define a conditional.
AC_DEFUN([AM_CONDITIONAL],
[AC_PREREQ(2.52)dnl
ifelse([$1], [TRUE], [AC_FATAL([$0: invalid condition: $1])],
[$1], [FALSE], [AC_FATAL([$0: invalid condition: $1])])dnl
AC_SUBST([$1_TRUE])
AC_SUBST([$1_FALSE])
if $2; then
$1_TRUE=
$1_FALSE='#'
else
$1_TRUE='#'
$1_FALSE=
fi
AC_CONFIG_COMMANDS_PRE(
[if test -z "${$1_TRUE}" && test -z "${$1_FALSE}"; then
AC_MSG_ERROR([[conditional "$1" was never defined.
Usually this means the macro was only invoked conditionally.]])
fi])])
# Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005
# Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 8
# There are a few dirty hacks below to avoid letting `AC_PROG_CC' be
# written in clear, in which case automake, when reading aclocal.m4,
# will think it sees a *use*, and therefore will trigger all it's
# C support machinery. Also note that it means that autoscan, seeing
# CC etc. in the Makefile, will ask for an AC_PROG_CC use...
# _AM_DEPENDENCIES(NAME)
# ----------------------
# See how the compiler implements dependency checking.
# NAME is "CC", "CXX", "GCJ", or "OBJC".
# We try a few techniques and use that to set a single cache variable.
#
# We don't AC_REQUIRE the corresponding AC_PROG_CC since the latter was
# modified to invoke _AM_DEPENDENCIES(CC); we would have a circular
# dependency, and given that the user is not expected to run this macro,
# just rely on AC_PROG_CC.
AC_DEFUN([_AM_DEPENDENCIES],
[AC_REQUIRE([AM_SET_DEPDIR])dnl
AC_REQUIRE([AM_OUTPUT_DEPENDENCY_COMMANDS])dnl
AC_REQUIRE([AM_MAKE_INCLUDE])dnl
AC_REQUIRE([AM_DEP_TRACK])dnl
ifelse([$1], CC, [depcc="$CC" am_compiler_list=],
[$1], CXX, [depcc="$CXX" am_compiler_list=],
[$1], OBJC, [depcc="$OBJC" am_compiler_list='gcc3 gcc'],
[$1], GCJ, [depcc="$GCJ" am_compiler_list='gcc3 gcc'],
[depcc="$$1" am_compiler_list=])
AC_CACHE_CHECK([dependency style of $depcc],
[am_cv_$1_dependencies_compiler_type],
[if test -z "$AMDEP_TRUE" && test -f "$am_depcomp"; then
# We make a subdir and do the tests there. Otherwise we can end up
# making bogus files that we don't know about and never remove. For
# instance it was reported that on HP-UX the gcc test will end up
# making a dummy file named `D' -- because `-MD' means `put the output
# in D'.
mkdir conftest.dir
# Copy depcomp to subdir because otherwise we won't find it if we're
# using a relative directory.
cp "$am_depcomp" conftest.dir
cd conftest.dir
# We will build objects and dependencies in a subdirectory because
# it helps to detect inapplicable dependency modes. For instance
# both Tru64's cc and ICC support -MD to output dependencies as a
# side effect of compilation, but ICC will put the dependencies in
# the current directory while Tru64 will put them in the object
# directory.
mkdir sub
am_cv_$1_dependencies_compiler_type=none
if test "$am_compiler_list" = ""; then
am_compiler_list=`sed -n ['s/^#*\([a-zA-Z0-9]*\))$/\1/p'] < ./depcomp`
fi
for depmode in $am_compiler_list; do
# Setup a source with many dependencies, because some compilers
# like to wrap large dependency lists on column 80 (with \), and
# we should not choose a depcomp mode which is confused by this.
#
# We need to recreate these files for each test, as the compiler may
# overwrite some of them when testing with obscure command lines.
# This happens at least with the AIX C compiler.
: > sub/conftest.c
for i in 1 2 3 4 5 6; do
echo '#include "conftst'$i'.h"' >> sub/conftest.c
# Using `: > sub/conftst$i.h' creates only sub/conftst1.h with
# Solaris 8's {/usr,}/bin/sh.
touch sub/conftst$i.h
done
echo "${am__include} ${am__quote}sub/conftest.Po${am__quote}" > confmf
case $depmode in
nosideeffect)
# after this tag, mechanisms are not by side-effect, so they'll
# only be used when explicitly requested
if test "x$enable_dependency_tracking" = xyes; then
continue
else
break
fi
;;
none) break ;;
esac
# We check with `-c' and `-o' for the sake of the "dashmstdout"
# mode. It turns out that the SunPro C++ compiler does not properly
# handle `-M -o', and we need to detect this.
if depmode=$depmode \
source=sub/conftest.c object=sub/conftest.${OBJEXT-o} \
depfile=sub/conftest.Po tmpdepfile=sub/conftest.TPo \
$SHELL ./depcomp $depcc -c -o sub/conftest.${OBJEXT-o} sub/conftest.c \
>/dev/null 2>conftest.err &&
grep sub/conftst6.h sub/conftest.Po > /dev/null 2>&1 &&
grep sub/conftest.${OBJEXT-o} sub/conftest.Po > /dev/null 2>&1 &&
${MAKE-make} -s -f confmf > /dev/null 2>&1; then
# icc doesn't choke on unknown options, it will just issue warnings
# or remarks (even with -Werror). So we grep stderr for any message
# that says an option was ignored or not supported.
# When given -MP, icc 7.0 and 7.1 complain thusly:
# icc: Command line warning: ignoring option '-M'; no argument required
# The diagnosis changed in icc 8.0:
# icc: Command line remark: option '-MP' not supported
if (grep 'ignoring option' conftest.err ||
grep 'not supported' conftest.err) >/dev/null 2>&1; then :; else
am_cv_$1_dependencies_compiler_type=$depmode
break
fi
fi
done
cd ..
rm -rf conftest.dir
else
am_cv_$1_dependencies_compiler_type=none
fi
])
AC_SUBST([$1DEPMODE], [depmode=$am_cv_$1_dependencies_compiler_type])
AM_CONDITIONAL([am__fastdep$1], [
test "x$enable_dependency_tracking" != xno \
&& test "$am_cv_$1_dependencies_compiler_type" = gcc3])
])
# AM_SET_DEPDIR
# -------------
# Choose a directory name for dependency files.
# This macro is AC_REQUIREd in _AM_DEPENDENCIES
AC_DEFUN([AM_SET_DEPDIR],
[AC_REQUIRE([AM_SET_LEADING_DOT])dnl
AC_SUBST([DEPDIR], ["${am__leading_dot}deps"])dnl
])
# AM_DEP_TRACK
# ------------
AC_DEFUN([AM_DEP_TRACK],
[AC_ARG_ENABLE(dependency-tracking,
[ --disable-dependency-tracking speeds up one-time build
--enable-dependency-tracking do not reject slow dependency extractors])
if test "x$enable_dependency_tracking" != xno; then
am_depcomp="$ac_aux_dir/depcomp"
AMDEPBACKSLASH='\'
fi
AM_CONDITIONAL([AMDEP], [test "x$enable_dependency_tracking" != xno])
AC_SUBST([AMDEPBACKSLASH])
])
# Generate code to set up dependency tracking. -*- Autoconf -*-
# Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005
# Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
#serial 3
# _AM_OUTPUT_DEPENDENCY_COMMANDS
# ------------------------------
AC_DEFUN([_AM_OUTPUT_DEPENDENCY_COMMANDS],
[for mf in $CONFIG_FILES; do
# Strip MF so we end up with the name of the file.
mf=`echo "$mf" | sed -e 's/:.*$//'`
# Check whether this is an Automake generated Makefile or not.
# We used to match only the files named `Makefile.in', but
# some people rename them; so instead we look at the file content.
# Grep'ing the first line is not enough: some people post-process
# each Makefile.in and add a new line on top of each file to say so.
# So let's grep whole file.
if grep '^#.*generated by automake' $mf > /dev/null 2>&1; then
dirpart=`AS_DIRNAME("$mf")`
else
continue
fi
# Extract the definition of DEPDIR, am__include, and am__quote
# from the Makefile without running `make'.
DEPDIR=`sed -n 's/^DEPDIR = //p' < "$mf"`
test -z "$DEPDIR" && continue
am__include=`sed -n 's/^am__include = //p' < "$mf"`
test -z "am__include" && continue
am__quote=`sed -n 's/^am__quote = //p' < "$mf"`
# When using ansi2knr, U may be empty or an underscore; expand it
U=`sed -n 's/^U = //p' < "$mf"`
# Find all dependency output files, they are included files with
# $(DEPDIR) in their names. We invoke sed twice because it is the
# simplest approach to changing $(DEPDIR) to its actual value in the
# expansion.
for file in `sed -n "
s/^$am__include $am__quote\(.*(DEPDIR).*\)$am__quote"'$/\1/p' <"$mf" | \
sed -e 's/\$(DEPDIR)/'"$DEPDIR"'/g' -e 's/\$U/'"$U"'/g'`; do
# Make sure the directory exists.
test -f "$dirpart/$file" && continue
fdir=`AS_DIRNAME(["$file"])`
AS_MKDIR_P([$dirpart/$fdir])
# echo "creating $dirpart/$file"
echo '# dummy' > "$dirpart/$file"
done
done
])# _AM_OUTPUT_DEPENDENCY_COMMANDS
# AM_OUTPUT_DEPENDENCY_COMMANDS
# -----------------------------
# This macro should only be invoked once -- use via AC_REQUIRE.
#
# This code is only required when automatic dependency tracking
# is enabled. FIXME. This creates each `.P' file that we will
# need in order to bootstrap the dependency handling code.
AC_DEFUN([AM_OUTPUT_DEPENDENCY_COMMANDS],
[AC_CONFIG_COMMANDS([depfiles],
[test x"$AMDEP_TRUE" != x"" || _AM_OUTPUT_DEPENDENCY_COMMANDS],
[AMDEP_TRUE="$AMDEP_TRUE" ac_aux_dir="$ac_aux_dir"])
])
# Copyright (C) 1996, 1997, 2000, 2001, 2003, 2005
# Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 8
# AM_CONFIG_HEADER is obsolete. It has been replaced by AC_CONFIG_HEADERS.
AU_DEFUN([AM_CONFIG_HEADER], [AC_CONFIG_HEADERS($@)])
# Do all the work for Automake. -*- Autoconf -*-
# Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
# Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 12
# This macro actually does too much. Some checks are only needed if
# your package does certain things. But this isn't really a big deal.
# AM_INIT_AUTOMAKE(PACKAGE, VERSION, [NO-DEFINE])
# AM_INIT_AUTOMAKE([OPTIONS])
# -----------------------------------------------
# The call with PACKAGE and VERSION arguments is the old style
# call (pre autoconf-2.50), which is being phased out. PACKAGE
# and VERSION should now be passed to AC_INIT and removed from
# the call to AM_INIT_AUTOMAKE.
# We support both call styles for the transition. After
# the next Automake release, Autoconf can make the AC_INIT
# arguments mandatory, and then we can depend on a new Autoconf
# release and drop the old call support.
AC_DEFUN([AM_INIT_AUTOMAKE],
[AC_PREREQ([2.58])dnl
dnl Autoconf wants to disallow AM_ names. We explicitly allow
dnl the ones we care about.
m4_pattern_allow([^AM_[A-Z]+FLAGS$])dnl
AC_REQUIRE([AM_SET_CURRENT_AUTOMAKE_VERSION])dnl
AC_REQUIRE([AC_PROG_INSTALL])dnl
# test to see if srcdir already configured
if test "`cd $srcdir && pwd`" != "`pwd`" &&
test -f $srcdir/config.status; then
AC_MSG_ERROR([source directory already configured; run "make distclean" there first])
fi
# test whether we have cygpath
if test -z "$CYGPATH_W"; then
if (cygpath --version) >/dev/null 2>/dev/null; then
CYGPATH_W='cygpath -w'
else
CYGPATH_W=echo
fi
fi
AC_SUBST([CYGPATH_W])
# Define the identity of the package.
dnl Distinguish between old-style and new-style calls.
m4_ifval([$2],
[m4_ifval([$3], [_AM_SET_OPTION([no-define])])dnl
AC_SUBST([PACKAGE], [$1])dnl
AC_SUBST([VERSION], [$2])],
[_AM_SET_OPTIONS([$1])dnl
AC_SUBST([PACKAGE], ['AC_PACKAGE_TARNAME'])dnl
AC_SUBST([VERSION], ['AC_PACKAGE_VERSION'])])dnl
_AM_IF_OPTION([no-define],,
[AC_DEFINE_UNQUOTED(PACKAGE, "$PACKAGE", [Name of package])
AC_DEFINE_UNQUOTED(VERSION, "$VERSION", [Version number of package])])dnl
# Some tools Automake needs.
AC_REQUIRE([AM_SANITY_CHECK])dnl
AC_REQUIRE([AC_ARG_PROGRAM])dnl
AM_MISSING_PROG(ACLOCAL, aclocal-${am__api_version})
AM_MISSING_PROG(AUTOCONF, autoconf)
AM_MISSING_PROG(AUTOMAKE, automake-${am__api_version})
AM_MISSING_PROG(AUTOHEADER, autoheader)
AM_MISSING_PROG(MAKEINFO, makeinfo)
AM_PROG_INSTALL_SH
AM_PROG_INSTALL_STRIP
AC_REQUIRE([AM_PROG_MKDIR_P])dnl
# We need awk for the "check" target. The system "awk" is bad on
# some platforms.
AC_REQUIRE([AC_PROG_AWK])dnl
AC_REQUIRE([AC_PROG_MAKE_SET])dnl
AC_REQUIRE([AM_SET_LEADING_DOT])dnl
_AM_IF_OPTION([tar-ustar], [_AM_PROG_TAR([ustar])],
[_AM_IF_OPTION([tar-pax], [_AM_PROG_TAR([pax])],
[_AM_PROG_TAR([v7])])])
_AM_IF_OPTION([no-dependencies],,
[AC_PROVIDE_IFELSE([AC_PROG_CC],
[_AM_DEPENDENCIES(CC)],
[define([AC_PROG_CC],
defn([AC_PROG_CC])[_AM_DEPENDENCIES(CC)])])dnl
AC_PROVIDE_IFELSE([AC_PROG_CXX],
[_AM_DEPENDENCIES(CXX)],
[define([AC_PROG_CXX],
defn([AC_PROG_CXX])[_AM_DEPENDENCIES(CXX)])])dnl
])
])
# When config.status generates a header, we must update the stamp-h file.
# This file resides in the same directory as the config header
# that is generated. The stamp files are numbered to have different names.
# Autoconf calls _AC_AM_CONFIG_HEADER_HOOK (when defined) in the
# loop where config.status creates the headers, so we can generate
# our stamp files there.
AC_DEFUN([_AC_AM_CONFIG_HEADER_HOOK],
[# Compute $1's index in $config_headers.
_am_stamp_count=1
for _am_header in $config_headers :; do
case $_am_header in
$1 | $1:* )
break ;;
* )
_am_stamp_count=`expr $_am_stamp_count + 1` ;;
esac
done
echo "timestamp for $1" >`AS_DIRNAME([$1])`/stamp-h[]$_am_stamp_count])
# Copyright (C) 2001, 2003, 2005 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# AM_PROG_INSTALL_SH
# ------------------
# Define $install_sh.
AC_DEFUN([AM_PROG_INSTALL_SH],
[AC_REQUIRE([AM_AUX_DIR_EXPAND])dnl
install_sh=${install_sh-"$am_aux_dir/install-sh"}
AC_SUBST(install_sh)])
# Copyright (C) 2003, 2005 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 2
# Check whether the underlying file-system supports filenames
# with a leading dot. For instance MS-DOS doesn't.
AC_DEFUN([AM_SET_LEADING_DOT],
[rm -rf .tst 2>/dev/null
mkdir .tst 2>/dev/null
if test -d .tst; then
am__leading_dot=.
else
am__leading_dot=_
fi
rmdir .tst 2>/dev/null
AC_SUBST([am__leading_dot])])
# Add --enable-maintainer-mode option to configure. -*- Autoconf -*-
# From Jim Meyering
# Copyright (C) 1996, 1998, 2000, 2001, 2002, 2003, 2004, 2005
# Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 4
AC_DEFUN([AM_MAINTAINER_MODE],
[AC_MSG_CHECKING([whether to enable maintainer-specific portions of Makefiles])
dnl maintainer-mode is disabled by default
AC_ARG_ENABLE(maintainer-mode,
[ --enable-maintainer-mode enable make rules and dependencies not useful
(and sometimes confusing) to the casual installer],
USE_MAINTAINER_MODE=$enableval,
USE_MAINTAINER_MODE=no)
AC_MSG_RESULT([$USE_MAINTAINER_MODE])
AM_CONDITIONAL(MAINTAINER_MODE, [test $USE_MAINTAINER_MODE = yes])
MAINT=$MAINTAINER_MODE_TRUE
AC_SUBST(MAINT)dnl
]
)
AU_DEFUN([jm_MAINTAINER_MODE], [AM_MAINTAINER_MODE])
# Check to see how 'make' treats includes. -*- Autoconf -*-
# Copyright (C) 2001, 2002, 2003, 2005 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 3
# AM_MAKE_INCLUDE()
# -----------------
# Check to see how make treats includes.
AC_DEFUN([AM_MAKE_INCLUDE],
[am_make=${MAKE-make}
cat > confinc << 'END'
am__doit:
@echo done
.PHONY: am__doit
END
# If we don't find an include directive, just comment out the code.
AC_MSG_CHECKING([for style of include used by $am_make])
am__include="#"
am__quote=
_am_result=none
# First try GNU make style include.
echo "include confinc" > confmf
# We grep out `Entering directory' and `Leaving directory'
# messages which can occur if `w' ends up in MAKEFLAGS.
# In particular we don't look at `^make:' because GNU make might
# be invoked under some other name (usually "gmake"), in which
# case it prints its new name instead of `make'.
if test "`$am_make -s -f confmf 2> /dev/null | grep -v 'ing directory'`" = "done"; then
am__include=include
am__quote=
_am_result=GNU
fi
# Now try BSD make style include.
if test "$am__include" = "#"; then
echo '.include "confinc"' > confmf
if test "`$am_make -s -f confmf 2> /dev/null`" = "done"; then
am__include=.include
am__quote="\""
_am_result=BSD
fi
fi
AC_SUBST([am__include])
AC_SUBST([am__quote])
AC_MSG_RESULT([$_am_result])
rm -f confinc confmf
])
# Fake the existence of programs that GNU maintainers use. -*- Autoconf -*-
# Copyright (C) 1997, 1999, 2000, 2001, 2003, 2005
# Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 4
# AM_MISSING_PROG(NAME, PROGRAM)
# ------------------------------
AC_DEFUN([AM_MISSING_PROG],
[AC_REQUIRE([AM_MISSING_HAS_RUN])
$1=${$1-"${am_missing_run}$2"}
AC_SUBST($1)])
# AM_MISSING_HAS_RUN
# ------------------
# Define MISSING if not defined so far and test if it supports --run.
# If it does, set am_missing_run to use it, otherwise, to nothing.
AC_DEFUN([AM_MISSING_HAS_RUN],
[AC_REQUIRE([AM_AUX_DIR_EXPAND])dnl
test x"${MISSING+set}" = xset || MISSING="\${SHELL} $am_aux_dir/missing"
# Use eval to expand $SHELL
if eval "$MISSING --run true"; then
am_missing_run="$MISSING --run "
else
am_missing_run=
AC_MSG_WARN([`missing' script is too old or missing])
fi
])
# Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# AM_PROG_MKDIR_P
# ---------------
# Check whether `mkdir -p' is supported, fallback to mkinstalldirs otherwise.
#
# Automake 1.8 used `mkdir -m 0755 -p --' to ensure that directories
# created by `make install' are always world readable, even if the
# installer happens to have an overly restrictive umask (e.g. 077).
# This was a mistake. There are at least two reasons why we must not
# use `-m 0755':
# - it causes special bits like SGID to be ignored,
# - it may be too restrictive (some setups expect 775 directories).
#
# Do not use -m 0755 and let people choose whatever they expect by
# setting umask.
#
# We cannot accept any implementation of `mkdir' that recognizes `-p'.
# Some implementations (such as Solaris 8's) are not thread-safe: if a
# parallel make tries to run `mkdir -p a/b' and `mkdir -p a/c'
# concurrently, both version can detect that a/ is missing, but only
# one can create it and the other will error out. Consequently we
# restrict ourselves to GNU make (using the --version option ensures
# this.)
AC_DEFUN([AM_PROG_MKDIR_P],
[if mkdir -p --version . >/dev/null 2>&1 && test ! -d ./--version; then
# We used to keeping the `.' as first argument, in order to
# allow $(mkdir_p) to be used without argument. As in
# $(mkdir_p) $(somedir)
# where $(somedir) is conditionally defined. However this is wrong
# for two reasons:
# 1. if the package is installed by a user who cannot write `.'
# make install will fail,
# 2. the above comment should most certainly read
# $(mkdir_p) $(DESTDIR)$(somedir)
# so it does not work when $(somedir) is undefined and
# $(DESTDIR) is not.
# To support the latter case, we have to write
# test -z "$(somedir)" || $(mkdir_p) $(DESTDIR)$(somedir),
# so the `.' trick is pointless.
mkdir_p='mkdir -p --'
else
# On NextStep and OpenStep, the `mkdir' command does not
# recognize any option. It will interpret all options as
# directories to create, and then abort because `.' already
# exists.
for d in ./-p ./--version;
do
test -d $d && rmdir $d
done
# $(mkinstalldirs) is defined by Automake if mkinstalldirs exists.
if test -f "$ac_aux_dir/mkinstalldirs"; then
mkdir_p='$(mkinstalldirs)'
else
mkdir_p='$(install_sh) -d'
fi
fi
AC_SUBST([mkdir_p])])
# Helper functions for option handling. -*- Autoconf -*-
# Copyright (C) 2001, 2002, 2003, 2005 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 3
# _AM_MANGLE_OPTION(NAME)
# -----------------------
AC_DEFUN([_AM_MANGLE_OPTION],
[[_AM_OPTION_]m4_bpatsubst($1, [[^a-zA-Z0-9_]], [_])])
# _AM_SET_OPTION(NAME)
# ------------------------------
# Set option NAME. Presently that only means defining a flag for this option.
AC_DEFUN([_AM_SET_OPTION],
[m4_define(_AM_MANGLE_OPTION([$1]), 1)])
# _AM_SET_OPTIONS(OPTIONS)
# ----------------------------------
# OPTIONS is a space-separated list of Automake options.
AC_DEFUN([_AM_SET_OPTIONS],
[AC_FOREACH([_AM_Option], [$1], [_AM_SET_OPTION(_AM_Option)])])
# _AM_IF_OPTION(OPTION, IF-SET, [IF-NOT-SET])
# -------------------------------------------
# Execute IF-SET if OPTION is set, IF-NOT-SET otherwise.
AC_DEFUN([_AM_IF_OPTION],
[m4_ifset(_AM_MANGLE_OPTION([$1]), [$2], [$3])])
# Check to make sure that the build environment is sane. -*- Autoconf -*-
# Copyright (C) 1996, 1997, 2000, 2001, 2003, 2005
# Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 4
# AM_SANITY_CHECK
# ---------------
AC_DEFUN([AM_SANITY_CHECK],
[AC_MSG_CHECKING([whether build environment is sane])
# Just in case
sleep 1
echo timestamp > conftest.file
# Do `set' in a subshell so we don't clobber the current shell's
# arguments. Must try -L first in case configure is actually a
# symlink; some systems play weird games with the mod time of symlinks
# (eg FreeBSD returns the mod time of the symlink's containing
# directory).
if (
set X `ls -Lt $srcdir/configure conftest.file 2> /dev/null`
if test "$[*]" = "X"; then
# -L didn't work.
set X `ls -t $srcdir/configure conftest.file`
fi
rm -f conftest.file
if test "$[*]" != "X $srcdir/configure conftest.file" \
&& test "$[*]" != "X conftest.file $srcdir/configure"; then
# If neither matched, then we have a broken ls. This can happen
# if, for instance, CONFIG_SHELL is bash and it inherits a
# broken ls alias from the environment. This has actually
# happened. Such a system could not be considered "sane".
AC_MSG_ERROR([ls -t appears to fail. Make sure there is not a broken
alias in your environment])
fi
test "$[2]" = conftest.file
)
then
# Ok.
:
else
AC_MSG_ERROR([newly created file is older than distributed files!
Check your system clock])
fi
AC_MSG_RESULT(yes)])
# Copyright (C) 2001, 2003, 2005 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# AM_PROG_INSTALL_STRIP
# ---------------------
# One issue with vendor `install' (even GNU) is that you can't
# specify the program used to strip binaries. This is especially
# annoying in cross-compiling environments, where the build's strip
# is unlikely to handle the host's binaries.
# Fortunately install-sh will honor a STRIPPROG variable, so we
# always use install-sh in `make install-strip', and initialize
# STRIPPROG with the value of the STRIP variable (set by the user).
AC_DEFUN([AM_PROG_INSTALL_STRIP],
[AC_REQUIRE([AM_PROG_INSTALL_SH])dnl
# Installed binaries are usually stripped using `strip' when the user
# run `make install-strip'. However `strip' might not be the right
# tool to use in cross-compilation environments, therefore Automake
# will honor the `STRIP' environment variable to overrule this program.
dnl Don't test for $cross_compiling = yes, because it might be `maybe'.
if test "$cross_compiling" != no; then
AC_CHECK_TOOL([STRIP], [strip], :)
fi
INSTALL_STRIP_PROGRAM="\${SHELL} \$(install_sh) -c -s"
AC_SUBST([INSTALL_STRIP_PROGRAM])])
# Check how to create a tarball. -*- Autoconf -*-
# Copyright (C) 2004, 2005 Free Software Foundation, Inc.
#
# This file is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
# serial 2
# _AM_PROG_TAR(FORMAT)
# --------------------
# Check how to create a tarball in format FORMAT.
# FORMAT should be one of `v7', `ustar', or `pax'.
#
# Substitute a variable $(am__tar) that is a command
# writing to stdout a FORMAT-tarball containing the directory
# $tardir.
# tardir=directory && $(am__tar) > result.tar
#
# Substitute a variable $(am__untar) that extract such
# a tarball read from stdin.
# $(am__untar) < result.tar
AC_DEFUN([_AM_PROG_TAR],
[# Always define AMTAR for backward compatibility.
AM_MISSING_PROG([AMTAR], [tar])
m4_if([$1], [v7],
[am__tar='${AMTAR} chof - "$$tardir"'; am__untar='${AMTAR} xf -'],
[m4_case([$1], [ustar],, [pax],,
[m4_fatal([Unknown tar format])])
AC_MSG_CHECKING([how to create a $1 tar archive])
# Loop over all known methods to create a tar archive until one works.
_am_tools='gnutar m4_if([$1], [ustar], [plaintar]) pax cpio none'
_am_tools=${am_cv_prog_tar_$1-$_am_tools}
# Do not fold the above two line into one, because Tru64 sh and
# Solaris sh will not grok spaces in the rhs of `-'.
for _am_tool in $_am_tools
do
case $_am_tool in
gnutar)
for _am_tar in tar gnutar gtar;
do
AM_RUN_LOG([$_am_tar --version]) && break
done
am__tar="$_am_tar --format=m4_if([$1], [pax], [posix], [$1]) -chf - "'"$$tardir"'
am__tar_="$_am_tar --format=m4_if([$1], [pax], [posix], [$1]) -chf - "'"$tardir"'
am__untar="$_am_tar -xf -"
;;
plaintar)
# Must skip GNU tar: if it does not support --format= it doesn't create
# ustar tarball either.
(tar --version) >/dev/null 2>&1 && continue
am__tar='tar chf - "$$tardir"'
am__tar_='tar chf - "$tardir"'
am__untar='tar xf -'
;;
pax)
am__tar='pax -L -x $1 -w "$$tardir"'
am__tar_='pax -L -x $1 -w "$tardir"'
am__untar='pax -r'
;;
cpio)
am__tar='find "$$tardir" -print | cpio -o -H $1 -L'
am__tar_='find "$tardir" -print | cpio -o -H $1 -L'
am__untar='cpio -i -H $1 -d'
;;
none)
am__tar=false
am__tar_=false
am__untar=false
;;
esac
# If the value was cached, stop now. We just wanted to have am__tar
# and am__untar set.
test -n "${am_cv_prog_tar_$1}" && break
# tar/untar a dummy directory, and stop if the command works
rm -rf conftest.dir
mkdir conftest.dir
echo GrepMe > conftest.dir/file
AM_RUN_LOG([tardir=conftest.dir && eval $am__tar_ >conftest.tar])
rm -rf conftest.dir
if test -s conftest.tar; then
AM_RUN_LOG([$am__untar <conftest.tar])
grep GrepMe conftest.dir/file >/dev/null 2>&1 && break
fi
done
rm -rf conftest.dir
AC_CACHE_VAL([am_cv_prog_tar_$1], [am_cv_prog_tar_$1=$_am_tool])
AC_MSG_RESULT([$am_cv_prog_tar_$1])])
AC_SUBST([am__tar])
AC_SUBST([am__untar])
]) # _AM_PROG_TAR
m4_include([acinclude.m4])

6
autocorrect/Makefile.am
Unescape View File

@ -0,0 +1,6 @@
# (Is autocorrect.xml still used?)
# WARNING: Do not add any other language here - use kde-i18n/*/data/koffice/autocorrect for that.
scripts_DATA = autocorrect.xml en_US.xml
scriptsdir = $(kde_datadir)/koffice/autocorrect

22
autocorrect/autocorrect.xml
Unescape View File

@ -0,0 +1,22 @@
<!DOCTYPE autocorrection>
<Word>
<items>
<item find="(C)" replace="©" />
<item find="(R)" replace="®" />
<item find="(c)" replace="©" />
<item find="(r)" replace="®" />
<item find="--" replace="—" />
</items>
<SuperScript>
<superscript find="1st" super="st" />
<superscript find="2nd" super="nd" />
<superscript find="3rd" super="rd" />
<superscript find="othernb" super="th" />
</SuperScript>
<DoubleQuote>
<doublequote begin="«" end="»" />
</DoubleQuote>
<SimpleQuote>
<simplequote begin="'" end="'" />
</SimpleQuote>
</Word>

4141
autocorrect/en_US.xml
View File

File diff suppressed because it is too large Load Diff

210
changes-1.4
Unescape View File

@ -0,0 +1,210 @@
New applications: krita, kexi
Krita
=====
Krita is an image editor and paint application with a wide range of
applications, from photo editing to the creation of original artwork.
Sporting a clear and uncluttered interface (for a paint app...) it makes the
features it delivers accessible and intuitive to use.
This is the first public release of Krita and while it provides a coherent set
of features, it is only the first stepping stone towards a flexible paint
application for artists and image editors.
Krita offers:
* Layers (without fixed boundaries).
* A familiar set of tools -- brushes, selection tools and shape tools.
* Painting with filters.
* An extensible system for the addition of new color and paint models.
* Support for pressure sensitive tablets.
* The ability to read most graphics file formats, including gimp and photoshop files.
* Exporting to many graphics file formats (but not gimp or photoshop)
* A complete colour management system based on lcms.
* A useful set of filters (implemented as plugins, so the set of filters
is extensible) including a CImg based image restoration plugin.
* The ability to use Gimp palettes, brushes, patterns and gradients
Caveats:
* In this beta version exif data embedded in jpeg images is not preserved.
* Some tools and menu options do not yet function completely correctly.
===============
Kexi [ this is from http://www.kexi-project.org/wiki/wikiview/index.php?AnnouncementForKOffice1.4 ]
====
KOffice 1.4 is the first official release to include Kexi - the KOffice database management application.
Kexi is an integrated environment for managing data. It can be used for creating database schemas; inserting data; performing queries, and processing data. Forms can be created to provide a custom interface to your data. All database objects - tables, queries and forms - are stored in the database, making it easy to share databases.
Kexi is considered as a long awaited Open Source competitor for MS Access, Filemaker and Oracle Forms. Its development is motivated by the lack of Rapid Application Development (RAD) tools for database systems that are sufficiently powerful, inexpensive, open standards driven and portable across many OSes and hardware platforms.
Overview
Supports database storage in files and on database servers.
Graphical interface for creating and altering table structures.
Form entry, with visual form designer.
Advanced tabular data view.
Intuitive query designer - no knowledge of SQL required!
Integrated SQL Editor available for advanced users.
Data Processing and Access
Data migration from MySQL, PostgreSQL and MS Access databases (MS Access available as an external plugin).
KexiDB API available for developers for integration with other applications.
Scripting support with Python language - hidden for 0.1 version.
(JavaScript/ECMA-Script support is planned)
Easy data report generation (planned).
Database Storage
Kexi can store databases in files and on database servers, while providing a common user interface. Database drivers for the following database engines are available:
- SQLite (Native file format: version 2 and 3)
- PostgreSQL
- MySQL
Support for other database systems is planned for future versions, including the ODBC interface, for simpler and more flexible integration in corporate environments.
===================
KOffice Workspace (koshell):
* New sidebar
* Tab support
KOffice-wide changes:
* Document information dialog: Added keywords and subject for the document, as well as
position, company, and telephone (home/work) for the author
* Make the default unit be inch or cm depending on the KDE-wide measure system (imperial or metric)
* Improvements to the DCOP interface for loading and saving.
* -dpi command line option to override the DPI detected by X. You can set one value for x and y, or use -dpi x,y
* Improve filter chains to avoid absurd chains (e.g. kword -> plain text -> kspread)
* Startup dialog: themeable icons, correct initial tab, hide non-existent recent local files
* Page layout dialog: better preview, new GUI for margins
* Rulers: made more readable at all resolutions, added tooltips
kotext (shared by KWord and KPresenter):
* Word completion with tooltip
* Open links by clicking on them, use hand pointer, show link target in statusbar.
* Tab/Shift+Tab for changing indentation in lists
* Rewritten spell-checking support (based on kspell2, the main reason for the kdelibs >= 3.3 requirement)
which is much faster and solves many problems (e.g. KOffice-1.3's hanging right-click-menu)
* Improved autocorrection (better URL detection among other things)
KWord:
* OASIS file format support (almost complete)
* Copy/Paste and Drag-n-drop use the OASIS format.
* Make it possible to select entire paragraphs from the left margin again.
* Inline text frames can be navigated into using Left and Right keys.
* New "statistic" variables (number of words, number of lines etc.)
* "Select All Frames" features
* Non-breaking hyphen, which can be inserted with Ctrl+Shift+Minus
* Alt+Right and Alt+Left shortcuts for increasing/decreasing the numbering level
* Removed non-working feature "Type anywhere cursor"
* When dropping a link to an image, let the user choose between inserting a URL and the image
* Rewritten "convert to text box" and "convert table to text" features so that they
don't use the clipboard anymore.
* PageUp/PageDown now moves the caret by default (it's still configurable).
* When saving a new document, suggest a file name based on the beginning of the document
* Reorganized and simplified GUI of the configuration dialog
* Support for "protect content" in all types of framesets
* Support for different run-around-gaps on every side of the frame
KPresenter:
* Master page feature
* Reworked property editor
* Reworked object/page effects
* Footer and headers can be shown/hidden in each page
* Custom Slide Show
* OASIS file format support (incomplete)
* Flip now works as in Gimp. Horizontal flip flips on y-axis, vertical flip on x-axis
* Group objects: The grouped object is now in the z-order of the upperst
object grouped and no longer on the top.
* Ungroup object: The objects are now in the z-order where the group object
was and no longer on top.
* If a page is shown more than once during a presentation add the time for
the duration instead of showing only the last duration.
* Per-page presentation speed and per-object effect (animation) speed
* PageUp/PageDown during presentation now goes to beginning of the next/previous slide
* New "statistic" variables (number of words, number of lines etc.)
KSpread:
* OASIS file format support (incomplete)
* Support for right-to-left spreadsheets
* Calendar plugin
* dependencies are handled correctly
* much improved value parsing and formatting
* Generic format support (the cell format remains 'generic' until explicitely set)
* Cell validity
+ new type added: list
+ new data added: differentto
+ Add Input help (allow to display help)
+ Allow blanks cell
* Conditional cell attribute:
+ Add new data "differentto"
* New functions:
+ ACOT
+ RANDNORM (gaussian random numbers)
+ REGEXP
+ REGEXPRE (regexp replace)
+ SUMIF (conditional sum)
* Multiple steps undo and redo
* Improved handling of hyperlinks
* Better icons for toolbar and templates
KChart:
* New maintainer. Many, *many* bugfixes.
* Removed a lot of old non-working stuff. It will reappear, working, in future versions.
* New, much improved, data editor
* Same startup dialog as the rest of KOffice
* Templates (only one so far)
* Data as rows or columns
* Linear or logarithmic scale
* Export to PNG format
* Export to SVG format
* Import data from text files (not finished in the beta)
* Much improved manual
* Print support
KFormula:
* OASIS file format support (incomplete)
Kivio:
* Non blocking stencilset loading
* Added Nassi Schneiderman stencils
* Moving selected stencils with the keyboard
* Added a docker for adding stencils to the document
* Added a tool for adding connector targets to stencils
* Added a polyline connector
Karbon:
* OASIS file format support (incomplete)
* New color dialog
* Small preview widget
* ZoomIn/ZoomOut actions
* Build system fixes
Filters:
* WordPerfect import filter for KWord: brand new, now based on libwpd
* new Microsoft Excel import filter for KSpread
* KWord HTML filter
+ Ability to link an external stylesheet to a HTML page
* Gnumeric import/export: now supports
+ Text rotation
+ Cell validation
+ Print repeated columns
+ Document information
+ Area name
* KSpread HTML export
+ Sheets can be exported to separate HTML pages
+ Sheets are browsable by a table of contents
+ User can define which sheets to export
+ Ability to link an external stylesheet to a HTML page
+ The encoding of the HTML page is configurable
+ Borders are optional
+ The cell spacing is configurable
* OoImpress:
+ Custom slide show

195
changes-1.5
Unescape View File

@ -0,0 +1,195 @@
* General:
- Paragraph background color can now be set (in addition to text background color)
- Palettes now remember their position between sessions (Krita, Kivio, Karbon)
- Palettes now have a smart mode where they start floating on small screens and
docked on larger screens
- ToolBox is no longer duplicated for every view
- Accessibility: Allow speaking texts using the kdeaccessibility tools (KTTS).
- Accessibility: Alt-F8 to set focus to any focusable widget.
- Accessibility: F8 and Shift-F8 for mouseless splitter and dock widget sizing.
* Bug fixes:
** KWord:
- Statistic variables are not saved in KWord format (#111478)
- Fix bug where inserting a large image would not make it a size that fits the page
- Fix bug where images in headers were only shown in the first page.
- Fix RMB in table-cell should not unselect text
** Krita:
- Krita now compiles on NetBSD
- Fix rotation bugs
- When "Select Similar Colors" a transparant area, add only transparant areas instead
of the entire image to the selection.
- Fix loading and saving of grayscale images
- Fix ImageMagick 16/8 bit image confusion when loading and saving.
- BUG: 110296 Display is now restored on cancel
- many crash fixes
- Warn when applying a filter that will convert the layer data
- create and save new brushes
- show image in center of window
- group layers in folders
- cmyk8, cmyk16, rgb16, gray16, rgb-half, rgb-float16 and lab16 colorspaces
** KSpread:
- Fixed spreadsheets containing formulae being marked as modified immediately after being opened.
- 115948 format changes of an automerged cell affects all cells in the set.
** Karbon:
- 114421 Transform palette has a strange layout when it is tall
- 114424 Stroke properties palette has a strange layout when it is...
- 114425 Color palette has title "Fill color" even when it shows s...
- 114428 The last created object should stay selected
- 114577 The Document/Layers/History palette is not shown on start
- 114579 Deleting polyline segment moves the mouse pointer to (0, 0)
- 114580 JJ: The line thickness SpinBox has no tooltip
- 112765 Selecting a polyline and running the "round corners" plug...
- 60438 undo confusion between point and shape action
- 92974 svg export creates useless svg file (from text tool)
- 115752 Make paste operation undo:able
- 116612 svg import/rendering bugs
- 111372 karbon: KLibrary: Undefined symbol "init_libkarbonpart"
- 114578 A polyline spline has a too big surrounding box
- 89596 Switching between Karbon14 and KSVGPlugin view in Konquer...
- 38555 segv when opening a file svg or kontour native
- 116422 un-usable selecting behaviour multple moving
- 116972 Transform palette is not updated when moving or scaling an object
- 115213 The color and opacity bars in the color chooser palette are backwards.
(thanks Marijn Kruisselbrink for the initial patch)
- 96944 Wanted: good right-click actions for polyline tool, zoom ...
- 111619 Page layout: size alias and margins doesn't get saved
- 111717 How to bring back the overview window if you close it?
- 111618 Rename plugins menu to "Effects"
- 109520 Change Align Center (Vertical) to Align Middle and add some extra separators
- 108789 Keybindings like krita, and other tweaks
- 108755 Always use this document at startup, Karbon has no way to stop doing this. Add a basic karbon template.
- 91376, 111207, 60844 Dockers now use the KoPalette library. This means a huge improvement when it comes to docker management
- 112691 Usability: The tools should be grouped
- 114429 The color picker is bad: Karbon now uses the Krita color choosers.
- 99927 karbon prints empty page the same in preview
- 119452 Printing scales the entire drawing down
- 116494 [usability] polyline interaction suggestions
- 119024 Color chooser doesn't move crosshair/sliders when switching from foreground to background color
- 112680 JJ: All the dockers lack tooltips
- 39138 selecting inside groups
- 124691 crash when adding pattern
- 126006 Duplicated "Snap to grid" in "View" menu
- 126095 deleted objects saved in in odg
- 125957 l10n for Russian: different "width" for stroke and other ...
- 102860 karbon crashes when pasting text
- 126341 Can't undo after using whirl/pinch effect
- 129039 Reordering layer elements reorders layers themselves
- 126094 polyline tool does not work as expected
** Kivio:
- Fix grid painting
- Fix loading of remote documents
* Features:
** Krita:
- Add histograms
- Histograms for images with more than 8-bit to the channel can be zoomed
- Add histogram docker
- Many filters are now colorspace independent
- Add CMYK (8 and 16 bit)
- Add 16-bit grayscale
- Image separation feature
- Add openEXR support
- Separate painting styles from tools; now every tool, from freehand to star can use any
painting style (eraser, brush, pen, airbrush...)
- Create better and more modern selection visualisation
- Put brush, gradient, pattern and paint style in popups in a toolbar, reducing the amount
of space Krita needs for its dockers
- Make hardness of tablet pressure curve configurable
- Many performance improvements to the backend (allocation cache, transform cache)
- Use color profiles everywhere
- New curves widget for color adjustments
- Add feather selection feature
- Pasted clipboard contents are placed in the middle of the image initially
- Brush shape is shown as an outline cursor when painting freehand
- Krita now adds itself to the Open With menu in Konqueror
- support more modes from GImp image hose brushes
- Much work on documentation
- Allow the user to choose between contiguous fill behaviour in combination with selections.
Either fill the entire selection, or floodfill the image, but taking the selection into
account (default behaviour).
- Add a 16-bit float half format RGB colourspace and change the OpenEXR filters to use it.
Will probably add the option to load into 32-bit float as that should be faster.
- 16-bit LAB is now the fallback colormodel when a particular colormodel doesn't implement
a certain function
- Filter gallery feature
- Add an option to the colorpicker to pick colors not just from the active or
from all visible layers, but from any layer, while still working on this layer.
- Tools and most menu items now are disabled when a layer is invisible or locked.
- Add noise reduction filter
- Made scrolling with a scrollwheel work better
- Add round corners filter
- Add sobel filter
- Made crop tool much more usable
- Add small tiles filter
- Add pixellize filter
- Remove the text brush
** KWord:
- Undo and redo for resizing of tables and columns
- Grid for objects
- allow documents to start at any page number (no gui yet)
- Accessiblity: keyboard navigation across frames, create frame using the keyboard
- cleanups and usability improvements for the document structure widget
- make the Fit to Width zoommode work properly, even when you resize the window later.
- make Fit to Width zoommode the default for new users
- KWord makes selecting/moving/resizing frames easier by implementing all features from http://www.koffice.org/developer/keyboardmodifiers.php
- paint the cursor in a color that is always readable, even if you set the background color to black
- make positioning the caret at frame edge easier.
- make frame handling much easier
- Center page on screen
- Create new set of templates, based on usability and user feedback.
- make deleting a page (in dtp mode) actually work when there was still content on the page.
- frame selections are now per view.
- Remember picture insert directory
- Accessibility: Enhanced mouseless navigation using document structure area.
- KWord now uses OASIS OpenDocument
- Accessibility: Improvement: "Menu" key shows RMB popup in document structure area.
- Add a dot as the suffix of numbered lists (1, a, A, III)
** KSpread:
- Added cell reference highlighting when editing formulae. Also added click-and-drag resizing
of ranges referenced in formulae.
- Greatly improved OpenDocument support
- Sort dialog displays column & row names instead of "Column A","Column B" for selecting sort criteria
- new formula engine implemented - parsing and evaluation much faster and
more robust and flexible
** Karbon
- Duplicate object.
- Minor new feature: make it able to change docker font sizes.
- Enabled right mouse click to zoom out of canvas, partially fixing bug 96944
- Load SVG and Gimp gradients
- Support for changing gradient or pattern fills on the canvas (wish 119344)
** KPresenter:
- Display or not background
- Display or not slide master object
- QWhatsThis help added in COnfigure KPresenter... dialog
- User manual is up-to-date
** KChart:
- Correctly set a background color/image
** Kivio:
- Port to the new KoGuides which adds auto guide lines
- Port to KoPalette and cleaned up the palettes (toolwindows)
- Make it possible to rearrange the pages with d'n'd in the tab bar
- Add undo support for Add Connector Target
- New stencil text editor
- Added an object list palette
- Made the old stencil set toolwindow a dialog and cleaned it up a bit
- Made text properties editable for each textbox and not only each stencil
** Filters:
- Kpresenter can export page as image file (png/bmp/svg/mng/jpeg/xbm)
- Kivio can export page as image file

396
config.h.in
Unescape View File

@ -0,0 +1,396 @@
/* config.h.in. Generated from configure.in by autoheader. */
/* Define to 1 if you have the <Carbon/Carbon.h> header file. */
#undef HAVE_CARBON_CARBON_H
/* Define if you have the CoreAudio API */
#undef HAVE_COREAUDIO
/* Define to 1 if you have the <crt_externs.h> header file. */
#undef HAVE_CRT_EXTERNS_H
/* Defines if your system has the crypt function */
#undef HAVE_CRYPT
/* Define to 1 if you have the declaration of `round', and to 0 if you don't.
*/
#undef HAVE_DECL_ROUND
/* Define to 1 if you have the <dirent.h> header file, and it defines `DIR'.
*/
#undef HAVE_DIRENT_H
/* Define to 1 if you have the <dlfcn.h> header file. */
#undef HAVE_DLFCN_H
/* Define if you have DPMS support */
#undef HAVE_DPMS
/* Define if you have the DPMSCapable prototype in <X11/extensions/dpms.h> */
#undef HAVE_DPMSCAPABLE_PROTO
/* Define if you have the DPMSInfo prototype in <X11/extensions/dpms.h> */
#undef HAVE_DPMSINFO_PROTO
/* Define to 1 if you have the `fabsl' function. */
#undef HAVE_FABSL
/* Define to 1 if you have the <floatingpoint.h> header file. */
#undef HAVE_FLOATINGPOINT_H
/* Defines if your system has the libfontconfig library */
#undef HAVE_FONTCONFIG
/* Define to 1 if you have the `fseek64' function. */
#undef HAVE_FSEEK64
/* Define to 1 if fseeko (and presumably ftello) exists and is declared. */
#undef HAVE_FSEEKO
/* Define to 1 if you have the `ftell64' function. */
#undef HAVE_FTELL64
/* Define if you have isinf */
#undef HAVE_FUNC_ISINF
/* Defines if you have GL (Mesa, OpenGL, ...) */
#undef HAVE_GL
/* GraphicsMagick is available */
#undef HAVE_GMAGICK
/* Define to 1 if you have the <ieeefp.h> header file. */
#undef HAVE_IEEEFP_H
/* Define to 1 if you have the <inttypes.h> header file. */
#undef HAVE_INTTYPES_H
/* Defines if your system has the fontconfig and freetype libraries */
#undef HAVE_KARBONTEXT
/* Define to 1 if you have the <kspell2/broker.h> header file. */
#undef HAVE_KSPELL2_BROKER_H
/* Defines if your system has the libart library */
#undef HAVE_LIBART
/* Define if you have libjpeg */
#undef HAVE_LIBJPEG
/* If we are going to use libkspell2 for spell-checking */
#undef HAVE_LIBKSPELL2
/* Define if you have libpng */
#undef HAVE_LIBPNG
/* Define if you have a working libpthread (will enable threaded code) */
#undef HAVE_LIBPTHREAD
/* Define if you have libtiff */
#undef HAVE_LIBTIFF
/* Define if you have libz */
#undef HAVE_LIBZ
/* Define if you have support for long double in printf */
#undef HAVE_LONG_DOUBLE
/* ImageMagick is available */
#undef HAVE_MAGICK
/* ImageMagick Version 6 */
#undef HAVE_MAGICK6
/* ImageMagick Version 6.1 */
#undef HAVE_MAGICK61
/* Define to 1 if you have the <memory.h> header file. */
#undef HAVE_MEMORY_H
/* Define to 1 if you have the `mkstemp' function. */
#undef HAVE_MKSTEMP
/* Define to 1 if you have the <ndir.h> header file, and it defines `DIR'. */
#undef HAVE_NDIR_H
/* Define if your system needs _NSGetEnviron to set up the environment */
#undef HAVE_NSGETENVIRON
/* GetMagickInfoList has different number of arguments with versions >= 6.1.3
*/
#undef HAVE_OLD_GETMAGICKINFOLIST
/* Defines if your system has the OpenEXR library */
#undef HAVE_OPENEXR
/* Define to 1 if you have the <paper.h> header file. */
#undef HAVE_PAPER_H
/* Define to 1 if you have the <paths.h> header file. */
#undef HAVE_PATHS_H
/* Define to 1 if you have the `popen' function. */
#undef HAVE_POPEN
/* Define to 1 if your system has powf in <maths.h> */
#undef HAVE_POWF
/* Define if you have the development files for python */
#undef HAVE_PYTHON
/* define if you have libreadline available */
#undef HAVE_READLINE
/* Define if you have res_init */
#undef HAVE_RES_INIT
/* Define if you have the res_init prototype */
#undef HAVE_RES_INIT_PROTO
/* Define to 1 if you have the `rewinddir' function. */
#undef HAVE_REWINDDIR
/* Define if you have a STL implementation by SGI */
#undef HAVE_SGI_STL
/* Define to 1 if you have the `snprintf' function. */
#undef HAVE_SNPRINTF
/* Define to 1 if you have the <stdint.h> header file. */
#undef HAVE_STDINT_H
/* Define to 1 if you have the <stdlib.h> header file. */
#undef HAVE_STDLIB_H
/* Define to 1 if you have the <strings.h> header file. */
#undef HAVE_STRINGS_H
/* Define to 1 if you have the <string.h> header file. */
#undef HAVE_STRING_H
/* Define if you have strlcat */
#undef HAVE_STRLCAT
/* Define if you have the strlcat prototype */
#undef HAVE_STRLCAT_PROTO
/* Define if you have strlcpy */
#undef HAVE_STRLCPY
/* Define if you have the strlcpy prototype */
#undef HAVE_STRLCPY_PROTO
/* Define to 1 if you have the <sys/bitypes.h> header file. */
#undef HAVE_SYS_BITYPES_H
/* Define to 1 if you have the <sys/dir.h> header file, and it defines `DIR'.
*/
#undef HAVE_SYS_DIR_H
/* Define to 1 if you have the <sys/ndir.h> header file, and it defines `DIR'.
*/
#undef HAVE_SYS_NDIR_H
/* Define to 1 if you have the <sys/param.h> header file. */
#undef HAVE_SYS_PARAM_H
/* Define to 1 if you have the <sys/stat.h> header file. */
#undef HAVE_SYS_STAT_H
/* Define to 1 if you have the <sys/types.h> header file. */
#undef HAVE_SYS_TYPES_H
/* Define to 1 if you have the <unistd.h> header file. */
#undef HAVE_UNISTD_H
/* Define to 1 if you have the `vsnprintf' function. */
#undef HAVE_VSNPRINTF
/* Defines if your system has the libwpd library */
#undef HAVE_WPD
/* Defines if your system has the wv2 library */
#undef HAVE_WV2
/* Define if you have the X11 Input Extension */
#undef HAVE_XINPUTEXT
/* Suffix for lib directories */
#undef KDELIBSUFF
/* Define a safe value for MAXPATHLEN */
#undef KDEMAXPATHLEN
/* build Kexi macros plugin */
#undef KEXI_MACROS_SUPPORT
/* The correct header */
#undef LCMS_HEADER
/* Name of package */
#undef PACKAGE
/* Define to the address where bug reports for this package should be sent. */
#undef PACKAGE_BUGREPORT
/* Define to the full name of this package. */
#undef PACKAGE_NAME
/* Define to the full name and version of this package. */
#undef PACKAGE_STRING
/* Define to the one symbol short name of this package. */
#undef PACKAGE_TARNAME
/* Define to the version of this package. */
#undef PACKAGE_VERSION
/* Define the PREFIX where to install this package */
#undef PREFIX
/* The size of `char *', as computed by sizeof. */
#undef SIZEOF_CHAR_P
/* The size of `int', as computed by sizeof. */
#undef SIZEOF_INT
/* The size of `long', as computed by sizeof. */
#undef SIZEOF_LONG
/* The size of `short', as computed by sizeof. */
#undef SIZEOF_SHORT
/* The size of `size_t', as computed by sizeof. */
#undef SIZEOF_SIZE_T
/* The size of `unsigned long', as computed by sizeof. */
#undef SIZEOF_UNSIGNED_LONG
/* Define to 1 if you have the ANSI C header files. */
#undef STDC_HEADERS
/* Version number of package */
#undef VERSION
/* Defined if compiling without arts */
#undef WITHOUT_ARTS
/* Define to 1 if your processor stores words with the most significant byte
first (like Motorola and SPARC, unlike Intel and VAX). */
#undef WORDS_BIGENDIAN
/* Defines the executable of xmllint */
#undef XMLLINT
/*
* jpeg.h needs HAVE_BOOLEAN, when the system uses boolean in system
* headers and I'm too lazy to write a configure test as long as only
* unixware is related
*/
#ifdef _UNIXWARE
#define HAVE_BOOLEAN
#endif
/*
* AIX defines FD_SET in terms of bzero, but fails to include <strings.h>
* that defines bzero.
*/
#if defined(_AIX)
#include <strings.h>
#endif
#if defined(HAVE_NSGETENVIRON) && defined(HAVE_CRT_EXTERNS_H)
# include <sys/time.h>
# include <crt_externs.h>
# define environ (*_NSGetEnviron())
#endif
/* Number of bits in a file offset, on hosts where this is settable. */
#undef _FILE_OFFSET_BITS
#if !defined(HAVE_RES_INIT_PROTO)
#ifdef __cplusplus
extern "C" {
#endif
int res_init(void);
#ifdef __cplusplus
}
#endif
#endif
#if !defined(HAVE_STRLCAT_PROTO)
#ifdef __cplusplus
extern "C" {
#endif
unsigned long strlcat(char*, const char*, unsigned long);
#ifdef __cplusplus
}
#endif
#endif
#if !defined(HAVE_STRLCPY_PROTO)
#ifdef __cplusplus
extern "C" {
#endif
unsigned long strlcpy(char*, const char*, unsigned long);
#ifdef __cplusplus
}
#endif
#endif
/* Define to 1 to make fseeko visible on some hosts (e.g. glibc 2.2). */
#undef _LARGEFILE_SOURCE
/* Define for large files, on AIX-style hosts. */
#undef _LARGE_FILES
/*
* On HP-UX, the declaration of vsnprintf() is needed every time !
*/
#if !defined(HAVE_VSNPRINTF) || defined(hpux)
#if __STDC__
#include <stdarg.h>
#include <stdlib.h>
#else
#include <varargs.h>
#endif
#ifdef __cplusplus
extern "C"
#endif
int vsnprintf(char *str, size_t n, char const *fmt, va_list ap);
#ifdef __cplusplus
extern "C"
#endif
int snprintf(char *str, size_t n, char const *fmt, ...);
#endif
#if defined(__SVR4) && !defined(__svr4__)
#define __svr4__ 1
#endif
/* don't use magick filter */
#undef include_imagemagick_filter
/* type to use in place of socklen_t if not defined */
#undef kde_socklen_t
/* type to use in place of socklen_t if not defined (deprecated, use
kde_socklen_t) */
#undef ksize_t

45
configure.files
Unescape View File

@ -0,0 +1,45 @@
./admin/configure.in.min
configure.in.in
./example/configure.in.in
./filters/configure.in.mid
./filters/krita/configure.in.in
./filters/krita/gmagick/configure.in.bot
./filters/krita/jpeg/configure.in.bot
./filters/krita/magick/configure.in.bot
./filters/krita/openexr/configure.in.bot
./filters/krita/pdf/configure.in.bot
./filters/krita/pdf/configure.in.in
./filters/krita/png/configure.in.bot
./filters/krita/tiff/configure.in.bot
./filters/kword/msword/configure.in.bot
./filters/kword/msword/configure.in.in
./filters/kword/pdf/xpdf/configure.in.in
./filters/kword/wordperfect/configure.in.bot
./filters/kword/wordperfect/configure.in.in
./filters/xsltfilter/configure.in.bot
./filters/xsltfilter/configure.in.in
./karbon/configure.in.bot
./karbon/configure.in.in
./kexi/3rdparty/configure.in.in
./kexi/configure.in.in
./kexi/kexidb/drivers/configure.in.bot
./kexi/kexidb/drivers/configure.in.in
./kexi/main/configure.in.in
./kexi/migration/configure.in.in
./kexi/plugins/configure.in.in
./kexi/plugins/configure.in.mid
./kexi/plugins/macros/configure.in.in
./kivio/configure.in.in
./kpresenter/configure.in.in
./krita/configure.in.bot
./krita/configure.in.in
./krita/plugins/configure.in.in
./krita/plugins/viewplugins/imagesize/configure.in.in
./kspread/plugins/calculator/configure.in.in
./kword/mailmerge/configure.in.in
./lib/configure.in.in
./lib/configure.in.mid
./lib/kotext/configure.in.bot
./lib/kotext/configure.in.in
./lib/kross/configure.in.bot
./lib/kross/configure.in.in

2666
configure.in
View File

File diff suppressed because it is too large Load Diff

299
configure.in.in
Unescape View File

@ -0,0 +1,299 @@
#MIN_CONFIG(3.3)
# Remember to synchronize the version number with the file koffice/lib/kofficecore/kofficeversion.h
AM_INIT_AUTOMAKE(koffice, "1.6.3")
CXXFLAGS="$CXXFLAGS $KDE_DEFAULT_CXXFLAGS"
AC_CHECK_HEADERS(unistd.h sys/param.h floatingpoint.h paths.h)
AC_C_BIGENDIAN
AC_CHECK_KDEMAXPATHLEN
KDE_INIT_DOXYGEN([The KOffice API Reference], [Version $VERSION])
# Check for GraphicsMagick...
have_graphicsmagick=no
KDE_FIND_PATH(GraphicsMagick-config, GRAPHICS_MAGICK_CONFIG, [${prefix}/bin ${exec_prefix}/bin /usr/local/bin /opt/local/bin], [
AC_MSG_WARN([Could not find GraphicsMagick anywhere, check http://www.graphicsmagick.org/ for GraphicsMagick >= 1.1.7.])
])
if test -n "$GRAPHICS_MAGICK_CONFIG"; then
vers=`$GRAPHICS_MAGICK_CONFIG --version 2>/dev/null | $AWK 'BEGIN { FS = "."; } { printf "%d", ($1 * 1000 + $2) * 1000 + $3;}'`
if test -n "$vers" && test "$vers" -ge 1001007; then
LIBGMAGICK_LIBS="`$GRAPHICS_MAGICK_CONFIG --libs`"
LIBGMAGICK_LDFLAGS="`$GRAPHICS_MAGICK_CONFIG --ldflags`"
LIBGMAGICK_RPATH=
for args in $LIBGMAGICK_LIBS; do
case $args in
-L*)
LIBGMAGICK_RPATH="$LIBMAGICK_RPATH $args"
;;
esac
done
LIBGMAGICK_RPATH=`echo $LIBGMAGICK_RPATH | $SED -e "s/-L/-R/g"`
LIBGMAGICK_CPPFLAGS="`$GRAPHICS_MAGICK_CONFIG --cppflags`"
AC_DEFINE(HAVE_GMAGICK,1, [GraphicsMagick is available])
have_graphicsmagick=yes
else
AC_MSG_WARN([You need at least GraphicsMagick 1.1.7])
fi
fi
if test ! "$USE_RPATH" = "yes"; then
LIBGMAGICK_RPATH=
fi
AC_SUBST(LIBGMAGICK_LIBS)
AC_SUBST(LIBGMAGICK_LDFLAGS)
AC_SUBST(LIBGMAGICK_CPPFLAGS)
AC_SUBST(LIBGMAGICK_RPATH)
AM_CONDITIONAL(include_graphicsmagick_filter, test "$have_graphicsmagick" = "yes" -a HAVE_GMAGICK)
# End of GraphicsMagick check
# Check for ImageMagick...
have_imagemagick=no
KDE_FIND_PATH(Magick-config, MAGICK_CONFIG, [${prefix}/bin ${exec_prefix}/bin /usr/local/bin /opt/local/bin], [
AC_MSG_WARN([Could not find ImageMagick anywhere, check http://www.imagemagick.org/ for ImageMagick >= 5.5.2.])
])
if test -n "$MAGICK_CONFIG"; then
vers=`$MAGICK_CONFIG --version 2>/dev/null | $AWK 'BEGIN { FS = "."; } { printf "%d", ($1 * 1000 + $2) * 1000 + $3;}'`
if test -n "$vers" && test "$vers" -ge 5005002
then
if test "$vers" -ge 6000003
then
AC_DEFINE(HAVE_MAGICK6, 1, [ImageMagick Version 6])
fi
if test "$vers" -ge 6001000
then
AC_DEFINE(HAVE_MAGICK61, 1, [ImageMagick Version 6.1])
fi
LIBMAGICK_LIBS="`$MAGICK_CONFIG --libs`"
LIBMAGICK_LDFLAGS="`$MAGICK_CONFIG --ldflags`"
LIBMAGICK_RPATH=
for args in $LIBMAGICK_LIBS; do
case $args in
-L*)
LIBMAGICK_RPATH="$LIBMAGICK_RPATH $args"
;;
esac
done
LIBMAGICK_RPATH=`echo $LIBMAGICK_RPATH | $SED -e "s/-L/-R/g"`
LIBMAGICK_CPPFLAGS="`$MAGICK_CONFIG --cppflags`"
AC_DEFINE(HAVE_MAGICK,1, [ImageMagick is available])
have_imagemagick=yes
else
AC_MSG_WARN([You need at least ImageMagick 5.5.2])
fi
fi
if test ! "$USE_RPATH" = "yes"; then
LIBMAGICK_RPATH=
fi
AC_SUBST(LIBMAGICK_LIBS)
AC_SUBST(LIBMAGICK_LDFLAGS)
AC_SUBST(LIBMAGICK_CPPFLAGS)
AC_SUBST(LIBMAGICK_RPATH)
AM_CONDITIONAL(include_imagemagick_filter, test "$have_imagemagick" = "yes" -a HAVE_MAGICK61 -a ! "$have_graphicsmagick" = "yes" -a ! HAVE_GMAGICK)
# End of ImageMagick check
##########################################################################
# This last check is copied from kdenonbeta/gsf/configure.in.in
##########################################################################
# KOFFICE_PKG_CHECK_MODULES(GSTUFF, gtk+-2.0 >= 1.3 glib = 1.3.4, action-if, action-not)
# defines GSTUFF_LIBS, GSTUFF_CFLAGS, see pkg-config man page
# also defines GSTUFF_PKG_ERRORS on error
# Note: This is specially tweaked for karbon's fontconfig check. Please fix
# it before using it for other tests :-)
AC_DEFUN([KOFFICE_PKG_CHECK_MODULES], [
succeeded=no
if test -z "$PKG_CONFIG"; then
AC_PATH_PROG(PKG_CONFIG, pkg-config, no)
fi
if test "$PKG_CONFIG" = "no" ; then
echo "*** The pkg-config script could not be found. Make sure it is"
echo "*** in your path, or set the PKG_CONFIG environment variable"
echo "*** to the full path to pkg-config."
echo "*** Or see http://www.freedesktop.org/software/pkgconfig to get pkg-config."
echo "***"
echo "*** Due to that we can't perform the check for fontconfig..." # added for karbon (Werner)
else
PKG_CONFIG_MIN_VERSION=0.9.0
if $PKG_CONFIG --atleast-pkgconfig-version $PKG_CONFIG_MIN_VERSION; then
AC_MSG_CHECKING(for $2)
if $PKG_CONFIG --exists "$2" ; then
AC_MSG_RESULT(yes)
succeeded=yes
AC_MSG_CHECKING($1_CFLAGS)
$1_CFLAGS=`$PKG_CONFIG --cflags "$2"`
AC_MSG_RESULT($$1_CFLAGS)
AC_MSG_CHECKING($1_LIBS)
$1_LIBS=`$PKG_CONFIG --libs "$2"`
AC_MSG_RESULT($$1_LIBS)
else
$1_CFLAGS=""
$1_LIBS=""
## If we have a custom action on failure, don't print errors, but
## do set a variable so people can do so.
$1_PKG_ERRORS=`$PKG_CONFIG --errors-to-stdout --print-errors "$2"`
ifelse([$4], ,echo $$1_PKG_ERRORS,)
fi
AC_SUBST($1_CFLAGS)
AC_SUBST($1_LIBS)
else
echo "*** Your version of pkg-config is too old. You need version $PKG_CONFIG_MIN_VERSION or newer."
echo "*** See http://www.freedesktop.org/software/pkgconfig"
fi
fi
if test $succeeded = yes; then
ifelse([$3], , :, [$3])
# else # removed for karbon (Werner)
# ifelse([$4], , AC_MSG_ERROR([Library requirements ($2) not met; consider adjusting the PKG_CONFIG_PATH environment variable if your libraries are in a nonstandard prefix so pkg-config can find them.]), [$4])
fi
])
# --- Check for KDE 3.2 or 3.3 ---
AC_MSG_CHECKING([for KDE version])
AC_LANG_SAVE
AC_LANG_CPLUSPLUS
kdeversion_save_CXXFLAGS="$CXXFLAGS"
kdeversion_safe_LIBS="$LIBS"
LIBS="$LIBS $X_EXTRA_LIBS"
CXXFLAGS="$CXXFLAGS $all_includes"
AC_COMPILE_IFELSE([
#include <kdeversion.h>
#if ! ( KDE_IS_VERSION( 3, 2, 90 ) )
#error KDE 3.2
#endif
],
need_kde32_compat="no"
,
need_kde32_compat="yes"
)
AC_COMPILE_IFELSE([
#include <kdeversion.h>
#if ! ( KDE_IS_VERSION( 3, 3, 90 ) )
#error KDE 3.3
#endif
],
need_kde33_compat="no"
,
need_kde33_compat="yes"
)
AC_COMPILE_IFELSE([
#include <kdeversion.h>
#if ! ( KDE_IS_VERSION( 3, 4, 90 ) )
#error KDE 3.4
#endif
],
need_kde34_compat="no"
,
need_kde34_compat="yes"
)
AC_COMPILE_IFELSE([
#include <kdeversion.h>
#if ! ( KDE_IS_VERSION( 3, 5, 2 ) )
#error KDE 3.5.x (x < 2)
#endif
],
need_kde351_compat="no"
,
need_kde351_compat="yes"
)
CXXFLAGS="$kdeversion_save_CXXFLAGS"
LIBS="$kdeversion_safe_LIBS"
AC_LANG_RESTORE
if test "$need_kde32_compat" = "yes"; then
AC_MSG_RESULT([KDE 3.2.x])
else
if test "$need_kde33_compat" = "yes"; then
AC_MSG_RESULT([KDE 3.3.x])
else
if test "$need_kde34_compat" = "yes"; then
AC_MSG_RESULT([KDE 3.4.x])
else
if test "$need_kde351_compat" = "yes"; then
AC_MSG_RESULT([KDE 3.5.x (x < 2)])
else
AC_MSG_RESULT([KDE 3.5.x (x >=2) or SVN trunk])
fi
fi
fi
fi
AM_CONDITIONAL(need_kde32_compatibility, test "$need_kde32_compat" = "yes")
AM_CONDITIONAL(need_kde33_compatibility, test "$need_kde33_compat" = "yes")
AM_CONDITIONAL(need_kde34_compatibility, test "$need_kde34_compat" = "yes")
AM_CONDITIONAL(need_kde351_compatibility, test "$need_kde351_compat" = "yes")
# Keep the old KDE 3.1 test, as long as it is still used
AM_CONDITIONAL(need_kde31_compatibility, test "supported" = "no")
# --- End KDE 3.2 check ---
# --- OpenEXR check ---
KDE_FIND_PATH(pkg-config, PKGCONFIG, [${prefix}/bin ${exec_prefix}/bin /usr/bin /usr/local/bin /opt/local/bin], [
AC_MSG_WARN([Could not find pkg-config])
])
AC_MSG_CHECKING([for OpenEXR])
if test -n "$PKGCONFIG"; then
vers=`$PKGCONFIG OpenEXR --modversion 2>/dev/null`
if test -n "$vers"
then
OPENEXR_LIBS="`$PKGCONFIG OpenEXR --libs`"
OPENEXR_RPATH=
for args in $OPENEXR_LIBS; do
case $args in
-L*)
OPENEXR_RPATH="$OPENEXR_RPATH $args"
;;
esac
done
OPENEXR_RPATH=`echo $OPENEXR_RPATH | $SED -e "s/-L/-R/g"`
OPENEXR_CFLAGS="`$PKGCONFIG OpenEXR --cflags`"
AC_DEFINE_UNQUOTED(HAVE_OPENEXR, 1, [Defines if your system has the OpenEXR library])
fi
fi
if test ! "$USE_RPATH" = "yes"; then
OPENEXR_RPATH=
fi
if test -n "$OPENEXR_LIBS"
then
AC_MSG_RESULT([yes])
else
AC_MSG_RESULT([not found])
fi
AC_SUBST(OPENEXR_LIBS)
AC_SUBST(OPENEXR_CFLAGS)
AC_SUBST(OPENEXR_RPATH)
AM_CONDITIONAL(have_openexr, test -n "$OPENEXR_LIBS")
# --- End of OpenEXR check ---

4
doc/.directory
Unescape View File

@ -0,0 +1,4 @@
# KDE Config File
[KDE Desktop Entry]
BgImage=
Icon=

BIN
doc/CookBook.odt
View File

Binary file not shown.

7
doc/Makefile.am
Unescape View File

@ -0,0 +1,7 @@
KDE_LANG = en
KDE_DOCS = koffice
SUBDIRS = $(AUTODIRS)
xdg_apps_DATA = koffice.desktop

2
doc/TODO
Unescape View File

@ -0,0 +1,2 @@
You can find status information and TODO items for KOffice
documentation in the CookBook.odt

153
doc/api/Doxyfile.am
Unescape View File

@ -0,0 +1,153 @@
## generate API documentation with doxygen
apidox-am-yes:
@if test "$(subdir)" != "."; then \
$(mkinstalldirs) $(top_builddir)/apidocs/$(subdir) ;\
cp $(top_srcdir)/doc/api/Doxyfile.pim Doxyfile; \
echo "PROJECT_NAME = \"$(subdir)\"" >> Doxyfile; \
echo "PROJECT_NUMBER = \"Version $(VERSION)\"" >> Doxyfile; \
echo "INPUT = $(srcdir)" >> Doxyfile; \
echo "IMAGE_PATH = $(top_srcdir)/doc/api" >> Doxyfile ;\
echo "OUTPUT_DIRECTORY = $(top_builddir)/apidocs" >> Doxyfile; \
echo "HTML_OUTPUT = $(subdir)/html" >> Doxyfile; \
echo "HTML_HEADER = $(top_srcdir)/doc/api/header.html" >> Doxyfile; \
echo "HTML_FOOTER = $(top_srcdir)/doc/api/footer.html" >> Doxyfile; \
echo "HTML_STYLESHEET = $(top_builddir)/apidocs/doxygen.css" >> Doxyfile; \
echo "LATEX_OUTPUT = $(subdir)/latex" >> Doxyfile; \
echo "RTF_OUTPUT = $(subdir)/rtf" >> Doxyfile; \
echo "MAN_OUTPUT = $(subdir)/man" >> Doxyfile; \
$(DOXYGEN) Doxyfile ;\
sh $(top_srcdir)/doc/api/doxyndex.sh $(top_builddir)/apidocs $(subdir)/html ; \
fi
apidox-am-no:
install-data-local: install-apidox
## install API documentation
install-apidox:
@if test "$(subdir)" != "."; then \
$(mkinstalldirs) $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/$(subdir)/html ; \
if test -f $(top_builddir)/apidocs/$(subdir)/$(subdir).tag; then \
echo $(INSTALL_DATA) $(top_builddir)/apidocs/$(subdir)/$(subdir).tag $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/$(subdir); \
$(INSTALL_DATA) $(top_builddir)/apidocs/$(subdir)/$(subdir).tag $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/$(subdir); \
fi; \
if test -d $(top_builddir)/apidocs/$(subdir)/html; then \
list=`ls $(top_builddir)/apidocs/$(subdir)/html`; \
echo "installing $(top_builddir)/apidocs/$(subdir)/html" ;\
for file in $$list; do \
$(INSTALL_DATA) $(top_builddir)/apidocs/$(subdir)/html/$$file $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/$(subdir)/html; \
done; \
fi; \
rm -f $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/common; \
$(LN_S) $(kde_libs_htmldir)/en/common $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/common; \
else\
if test -d $(top_builddir)/apidocs; then \
$(mkinstalldirs) $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs ;\
list=`cd $(top_builddir)/apidocs && ls -1`; \
echo "installing $(top_builddir)/apidocs/$$file" ;\
for file in $$list; do \
if test -f $(top_builddir)/apidocs/$$file; then \
$(INSTALL_DATA) $(top_builddir)/apidocs/$$file $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs; \
fi; \
done ; fi; \
fi
uninstall-local: uninstall-apidox
## uninstall API documentation
uninstall-apidox:
@if test "$(subdir)" != "."; then \
if test -d $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/$(subdir); then \
rm -rfv $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs/$(subdir); \
fi\
else\
if test -d $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs; then \
rm -rfv $(DESTDIR)$(kde_htmldir)/en/$(PACKAGE)-apidocs; \
fi\
fi
apidox:
@if test "$(subdir)" != "."; then \
$(MAKE) apidox-am-@KDE_HAS_DOXYGEN@ ;\
else \
$(MAKE) apidox-am-toplevel-@KDE_HAS_DOXYGEN@ ;\
fi
@set fnord $(MAKEFLAGS); amf=$$2; if test -n '$(SUBDIRS)'; then \
list='$(SUBDIRS)'; \
for subdir in $$list; do \
if grep '^include .*Doxyfile.am' $(srcdir)/$$subdir/Makefile.am > /dev/null ; then \
echo "Making apidox in $$subdir"; \
if test "$$subdir" != "."; then \
(cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) GENERATE_FLAG=no apidox) || exit 1; \
fi ; fi ;\
done; \
for subdir in $$list; do \
if grep '^include .*Doxyfile.am' $(srcdir)/$$subdir/Makefile.am > /dev/null ; then \
echo "Making apidox in $$subdir"; \
if test "$$subdir" != "."; then \
(cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) GENERATE_FLAG=yes apidox) || exit 1; \
fi ; fi ;\
done; \
fi
apidox-am-toplevel-no:
apidox-am-toplevel-yes:
@echo "*** Creating API documentation main page"; \
cp $(top_srcdir)/admin/Doxyfile.global Doxyfile; \
echo "PROJECT_NAME = \"$(DOXYGEN_PROJECT_NAME)\"" >> Doxyfile ; \
echo "PROJECT_NUMBER = \"$(DOXYGEN_PROJECT_NUMBER)\"" >> Doxyfile ; \
echo "INPUT = $(top_srcdir)" >> Doxyfile ; \
echo "OUTPUT_DIRECTORY = $(top_builddir)/apidocs" >> Doxyfile ; \
echo "FILE_PATTERNS = *.dox" >> Doxyfile ; \
echo "RECURSIVE = NO" >> Doxyfile ; \
echo "SOURCE_BROWSER = NO" >> Doxyfile ; \
echo "ALPHABETICAL_INDEX = NO" >> Doxyfile ; \
echo "HTML_OUTPUT = ." >> Doxyfile ; \
echo "HTML_HEADER = $(top_srcdir)/doc/api/mainheader.html" >> Doxyfile ; \
echo "HTML_FOOTER = $(top_srcdir)/doc/api/mainfooter.html" >> Doxyfile ; \
echo "HTML_STYLESHEET = $(top_builddir)/apidocs/common/doxygen.css" >> Doxyfile ; \
echo "GENERATE_LATEX = NO" >> Doxyfile ; \
echo "GENERATE_RTF = NO" >> Doxyfile ; \
echo "GENERATE_MAN = NO" >> Doxyfile ; \
echo "GENERATE_XML = NO" >> Doxyfile ; \
echo "GENERATE_AUTOGEN_DEF = NO" >> Doxyfile ; \
echo "ENABLE_PREPROCESSING = NO" >> Doxyfile ; \
echo "CLASS_DIAGRAMS = NO" >> Doxyfile ; \
echo "HAVE_DOT = NO" >> Doxyfile ; \
echo "GENERATE_HTML = YES" >> Doxyfile ;\
$(mkinstalldirs) $(top_builddir)/apidocs ; \
rm -f $(top_builddir)/apidocs/common ; \
if test -d $(top_srcdir)/doc/common; then \
common_dir=`cd $(top_srcdir)/doc/common && pwd` ;\
else \
common_dir=$(kde_libs_htmldir)/en/common ;\
fi ;\
$(LN_S) $$common_dir $(top_builddir)/apidocs/common ;\
doxygen Doxyfile; \
rm -f Doxyfile
@true > $(top_builddir)/apidocs/subdirs
@$(MAKE) apidox-am-tree PARENT="" PARENTINDENT=""
@sort $(top_builddir)/apidocs/subdirs | sed -e 's+<!--.*-->++' > $(top_builddir)/apidocs/subdirs_ && mv $(top_builddir)/apidocs/subdirs_ $(top_builddir)/apidocs/subdirs
@sh $(top_srcdir)/doc/api/doxyndex.sh $(top_builddir)/apidocs .
apidox-am-tree:
@if test -n '$(SUBDIRS)' ; then \
list='$(SUBDIRS)' ; \
for subdir in $$list ; do \
if test "x$$subdir" != "x."; then \
if grep '^include .*Doxyfile.am' $(srcdir)/$$subdir/Makefile.am > /dev/null ; then \
echo "Making apidox index in $$subdir"; \
echo "<li><!-- $(PARENT)/$$subdir -->$(PARENTINDENT)<a href=\"@topdir@$(PARENT)/$$subdir/html/index.html\">$$subdir</a></li>" >> $(top_builddir)/apidocs/subdirs ; \
(cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) apidox-am-tree PARENT="$(PARENT)/$$subdir" PARENTINDENT='\&nbsp;\&nbsp;$(PARENTINDENT)' ) || exit 1; \
fi ; \
fi ; \
done ; \
fi
.PHONY: apidox-am-yes apidox-am-no install-data-local install-apidox install-apidox uninstall-local uninstall-apidox uninstall-apidox apidox apidox-am-toplevel-no apidox-am-toplevel-yes apidox-am-tree
# Local Variables:
# mode: makefile
# End:

191
doc/api/Doxyfile.koffice
Unescape View File

@ -0,0 +1,191 @@
PROJECT_NAME =
PROJECT_NUMBER =
OUTPUT_DIRECTORY = ../apidocs/
OUTPUT_LANGUAGE = English
USE_WINDOWS_ENCODING = NO
BRIEF_MEMBER_DESC = NO
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = NO
STRIP_FROM_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
DISTRIBUTE_GROUP_DOC = NO
TAB_SIZE = 4
ALIASES = obsolete=@deprecated
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
SUBGROUPING = YES
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = NO
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = NO
SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = NO
GENERATE_TESTLIST = NO
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
QUIET = YES
WARNINGS = NO
WARN_IF_UNDOCUMENTED = NO
WARN_IF_DOC_ERROR = YES
WARN_FORMAT =
WARN_LOGFILE =
INPUT =
FILE_PATTERNS = *.h \
*.cpp \
*.cc \
*.hpp \
*.dox \
*.c++ \
*.cxx \
*.h++ \
*.hh
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = *.moc.* \
moc* \
*.all_cpp.* \
*unload.* \
*/test/* \
*/tests/* \
*_p.h
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_SOURCE_FILES = NO
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
VERBATIM_HEADERS = YES
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 3
IGNORE_PREFIX = K
GENERATE_HTML = NO
HTML_OUTPUT =
HTML_FILE_EXTENSION = .html
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = YES
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
GENERATE_LATEX = NO
LATEX_OUTPUT =
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
GENERATE_RTF = NO
RTF_OUTPUT =
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
GENERATE_MAN = NO
MAN_OUTPUT =
MAN_EXTENSION = .kde3
MAN_LINKS = YES
GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = NO
GENERATE_AUTOGEN_DEF = NO
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED = QT_VERSION=320 \
__cplusplus \
Q_WS_X11
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = NO
PERL_PATH =
CLASS_DIAGRAMS = YES
HIDE_UNDOC_RELATIONS = NO
HAVE_DOT = NO
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 800
MAX_DOT_GRAPH_HEIGHT = 1024
MAX_DOT_GRAPH_DEPTH = 0
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
SEARCHENGINE = NO
#-----------------------------------------------------------------------
# KOffice Settings
#-----------------------------------------------------------------------
HTML_ALIGN_MEMBERS = NO
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
VERBATIM_HEADERS = NO
GENERATE_LATEX = NO
GENERATE_RTF = NO
GENERATE_MAN = NO
GENERATE_XML = NO
GENERATE_HTML = YES
SOURCE_BROWSER = NO
GENERATE_AUTOGEN_DEF = NO
ENABLE_PREPROCESSING = NO
CLASS_DIAGRAMS = NO
HAVE_DOT = NO
IGNORE_PREFIX = K
EXTRACT_ALL = NO

60
doc/api/doxyndex.sh
Unescape View File

@ -0,0 +1,60 @@
#! /bin/sh
#
# A shell script to post-process doxy-generated files; the purpose
# is to make the menu on the left in the file match the actually
# generated files (ie. leave out namespaces if there are none).
#
# Usage: doxyndex.sh <toplevel-apidocs-dir> <relative-html-output-directory>
#
# Typically, this means $(top_builddir)/apidocs and something like
# libfoo/html for the output. For the top-level dig, set relative-html
# to "." . In non-top directories, both <!-- menu --> and <!-- gmenu -->
# are calculated and replaced. Top directories get an empty <!-- menu -->
# if any.
WRKDIR="$1/$2"
TOPDIR=`echo "$2" | sed -e 's+[^/][^/]*/+../+g' -e 's+html$+..+'`
echo "Postprocessing files in $WRKDIR ($TOPDIR)"
# Special case top-level to have an empty MENU.
if test "x$2" = "x." ; then
MENU=""
else
MENU="<ul>"
# This is a list of pairs, with / separators so we can use basename
# and dirname (a crude shell hack) to split them into parts. For
# each, if the file part exists (as a html file) tack it onto the
# MENU variable as a <li> with link.
for i in "Main Page/index" \
"Modules/modules" \
"Namespace List/namespaces" \
"Class Hierarchy/hierarchy" \
"Alphabetical List/classes" \
"Class List/annotated" \
"File List/files" \
"Namespace Members/namespacemembers" \
"Class Members/functions" \
"Related Pages/pages"
do
NAME=`dirname "$i"`
FILE=`basename "$i"`
test -f "$WRKDIR/$FILE.html" && MENU="$MENU<li><a href=\"$FILE.html\">$NAME</a></li>"
done
MENU="$MENU</ul>"
fi
# Get the list of global Menu entries.
GMENU=`cat "$1"/subdirs | tr -d '\n'`
PMENU=`grep '<!-- pmenu' "$WRKDIR/index.html" | sed -e 's+.*pmenu *++' -e 's+ *-->++' | awk '{ c=split($0,a,"/"); for (j=1; j<=c; j++) { printf " / <a href=\""; if (j==c) { printf("."); } for (k=j; k<c; k++) { printf "../"; } if (j<c) { printf("../html/index.html"); } printf "\">%s</a>\n" , a[j]; } }' | tr -d '\n'`
# Now substitute in the MENU in every file. This depends
# on HTML_HEADER (ie. header.html) containing the <!-- menu --> comment.
for i in "$WRKDIR"/*.html
do
sed -e "s+<!-- menu -->+$MENU+" -e "s+<!-- gmenu -->+$GMENU+" -e "s+<!-- pmenu.*-->+$PMENU+" < "$i" | sed -e "s+@topdir@+$TOPDIR+g" > "$i.new" && mv "$i.new" "$i"
done

70
doc/api/header.html
Unescape View File

@ -0,0 +1,70 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>$title ($projectname)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="@topdir@/favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="@topdir@"><img id="nav_header_logo" alt="Home" align="left" src="@topdir@/kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KOffice API Docs</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<span id="nav_header_bottom_left">
/ <a href="http://www.koffice.org">KOffice</a>
/ <a href="@topdir@">API Docs</a>
<!-- pmenu $projectname -->
</span>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<h2><a name="content"></a>$projectname</h2>

BIN
doc/api/kfontdialog.png
View File

Binary file not shown.

71
doc/api/mainheader.html
Unescape View File

@ -0,0 +1,71 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>$title ($projectname)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="@topdir@/favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
.copyrights { width: 100%; margin: 1ex 10%; color:#BCBCBC; }
.copyrights a { color: #9A9A9A; }
-->
</style>
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="@topdir@"><img id="nav_header_logo" alt="Home" align="left" src="@topdir@/kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KOffice API Docs</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<span id="nav_header_bottom_left">
/ <a href="http://www.koffice.org">KOffice</a>
/ <a href="@topdir@">API Docs</a>
</span>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content"><div style="width:100%;">
<a name="content"></a><h2>$projectname</h2>

4
doc/karbon/Makefile.am
Unescape View File

@ -0,0 +1,4 @@
KDE_LANG = en
KDE_DOCS = AUTO

67
doc/karbon/index.docbook
Unescape View File

@ -0,0 +1,67 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&karbon14;">
<!ENTITY package "koffice">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
<book lang="&language;">
<bookinfo>
<title>The &karbon14; Handbook</title>
<authorgroup>
<author>
<firstname></firstname>
<othername></othername>
<surname></surname>
<affiliation>
<address><email></email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<legalnotice>&FDLNotice;</legalnotice>
<!-- Date and version information of the documentation
Don't forget to include this last date and this last revision number, we
need them for translation coordination !
Please respect the format of the date (DD/MM/YYYY) and of the version
(Major.minor.lesser), it could be used by automation scripts -->
<date>2005-09-04</date>
<releaseinfo>0.1.0</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>
&karbon14; is a Scalable Graphics editer for &kde;.
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>Karbon14</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction"> <title>Introduction</title> <para>
The documentation for &kappname; was not finished when &kde; was installed on
this computer.</para> <para>If you need help, please check <ulink
url="http://www.kde.org">The &kde; Website</ulink> for updates, or by
submitting your question to <ulink url="mailto:kde@kde.org">The
&kde; User Mailing list</ulink>.</para> <para><emphasis>The &kde;
Team</emphasis></para>
&underFDL;
</chapter>
&documentation.index;
</book>

4
doc/kchart/Makefile.am
Unescape View File

@ -0,0 +1,4 @@
KDE_LANG = en
KDE_DOCS = AUTO

BIN
doc/kchart/cr22-action-chart_line.png
View File

Binary file not shown.

BIN
doc/kchart/cr22-action-data.png
View File

Binary file not shown.

BIN
doc/kchart/cr22-action-options.png
View File

Binary file not shown.

BIN
doc/kchart/cr22-action-wizard.png
View File

Binary file not shown.

BIN
doc/kchart/file-toolbar.png
View File

Binary file not shown.

BIN
doc/kchart/file-toolbar2.png
View File

Binary file not shown.

BIN
doc/kchart/frame_chart.png
View File

Binary file not shown.

1375
doc/kchart/index.docbook
View File

File diff suppressed because it is too large Load Diff

BIN
doc/kchart/kchart-config1.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-config2.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-config3.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-config4.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-config5.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-config6.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-config7.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-config8.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-dataeditor.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-default.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-example1-1.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-example1-2.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-example1-3.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-example1-4.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-example1-5.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-example1-6.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-example1-7.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-example1-8.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-example1-9.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-kspread-bar.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-kspread.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-startupdialog.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-wizard0.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-wizard1.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-wizard2.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-wizard3.png
View File

Binary file not shown.

BIN
doc/kchart/kchart-wizard4.png
View File

Binary file not shown.

BIN
doc/kchart/shortcut.png
View File

Binary file not shown.

BIN
doc/kchart/toolbars.png
View File

Binary file not shown.

4
doc/kexi/Makefile.am
Unescape View File

@ -0,0 +1,4 @@
KDE_LANG = en
KDE_DOCS = AUTO

504
doc/kexi/basics.docbook
Unescape View File

@ -0,0 +1,504 @@
<!--
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" >
-->
<chapter id="basics">
<title>
&kexi; Basics
</title>
<sect1 id="doc-vs-project">
<title>
&kexi; Databases
</title>
<para>
Many applications such as OpenOffice.org or Microsoft Excel create
files which are called <firstterm>documents</firstterm>. &kexi;
creates files too, but we refer to them as <firstterm>&kexi;
database files</firstterm>, or simple <firstterm>database
files</firstterm> here. &kexi; database files usually have the
extension <filename>.kexi</filename>.
</para>
<!-- TODO: Picture of Kexi database icon? -->
<para>
In addition to storing your databases in database files, &kexi;
can also use databases on <firstterm>database
servers</firstterm>, which is why we refer to them as
<emphasis>database files</emphasis>, and not simply as
<emphasis>databases</emphasis>.
</para>
<para>
The term <firstterm>&kexi; project</firstterm>, or simply
<firstterm>project</firstterm> is also used to refer to a &kexi;
database, regardless of whether it is stored in a file or on a
database server.
</para>
</sect1>
<sect1 id="new-database">
<title>
Creating a New Database File
</title>
<procedure>
<step>
<para>
Run &kexi;, or if it is already running, use
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu><guimenuitem>New</guimenuitem>
</menuchoice>.
</para>
</step>
<step>
<para>
Click the <guibutton>OK</guibutton> to confirm the
creation of the project.
</para>
</step>
<step>
<para>
Enter a name for your project, and click <guibutton>Next</guibutton>.
</para>
</step>
<step>
<para>
Use the file browser to choose a folder where you would
like to save your database file. You may change the file
name in the <guilabel>Location:</guilabel> box if you dislike
the one that is suggested.
</para>
</step>
<step>
<para>
Click <guibutton>Create</guibutton>.
</para>
</step>
</procedure>
</sect1>
<sect1 id="main-window">
<title>
The &kexi; Main Window
</title>
<para>
The <guilabel>Project Navigator</guilabel> and
<guilabel>Properties Editor</guilabel> are shown in panes on
each side of the child window. These can be resized or hidden
as required. A pane can be hidden by clicking the small cross
at the top of the pane (just below the toolbar).
</para>
<para>
Database objects (tables, queries, etc.) listed in the <guilabel>Project
Navigator</guilabel> can opened by clicking (or
double-clicking, depending upon your global &kde; settings) on their names.
</para>
<sect2 id="main-application-elements">
<title>
Main application elements
</title>
<!--
<br><img src="img/04_06_00_main_window.png">
<br>Kexi's main window<br><br>
-->
<itemizedlist>
<title>
Main elements of &kexi; application's window are:
</title>
<listitem>
<para><emphasis>Menubar</emphasis></para>
<para>
contains available commands for the application.
You will find detailed description of any of the commands in the appendix.
<!-- @todo: point to the appendix (link) -->
</para>
</listitem>
<listitem>
<para><emphasis>Toolbar</emphasis></para>
<para>
contains most frequently used commands.
</para>
</listitem>
<listitem>
<!-- @todo: link to the various chapters from the listitems -->
<para><emphasis><guilabel>Project Navigator</guilabel>'s pane</emphasis></para>
<para>
contains a list of any object (tables, queries, forms, ...) created
within the currently opened database project. The navigator also contains
small toolbar with most usable commands related to the database objects.
</para>
</listitem>
<listitem>
<para><emphasis><guilabel>Opened database objects</guilabel> area</emphasis></para>
<para>
a central area of the application taking most of the screen space.
For IDEAl user interface mode it contains switchable tabs with
windows that are always maximized. For Childframe user interface
mode it contains floating windows.
</para>
</listitem>
<listitem>
<para><emphasis><guilabel>Properties</guilabel> pane</emphasis></para>
<para>
contains a list of properties of currently activated database object.
For certain objects (&eg; form's widgets) it can have several tabs.
</para>
</listitem>
<listitem>
<para><emphasis>Taskbar</emphasis></para>
<para>
contains a list of currently opened windows with database objects.
For IDEAl user interface mode, it is available as a number of tabs.
For Childframe user interface mode, it is available as a number of
buttons, behaving just like your operating system's taskbar.
</para>
</listitem>
</itemizedlist>
<sect3 id="project-navigator-pane">
<title><guilabel>Project Navigator</guilabel> pane</title>
<para>
The <guilabel>Project Navigator</guilabel> 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 split into groups: tables, queries, forms.
</para>
<para id="project-navigator-pane-toolbar">
The <guilabel>Project Navigator</guilabel> pane also contains a <emphasis>small toolbar for most
frequently used commands</emphasis> (from left to right): <guilabel>Open
selected object</guilabel>, <guilabel>Design selected object</guilabel>,
<guilabel>Create a new object</guilabel>, and <guilabel>Delete selected
object</guilabel>.
<!--
<img src="img/04_06_01_nav_mini_toolbar.png">
<br>A toolbar in the Project Navigator pane<br><br>
-->
</para>
<para>
For each object on the list a context menu is available using the &RMB;.
For example, this is context menu for the <emphasis>persons</emphasis> table.
<!--
<br><img src="img/04_06_01_context_menu.png">
<br>Project Navigator pane's context menu<br><br>
-->
<!-- TODO Commands of this menu is documented in <appendix>
See also a list of available shortcuts in <a href=
"ab_00_00_shortcuts.html#nav_panel">Appendix B.2. Project Navigator
pane <! - - TODO (js) APPENDIX number - - ></a> .
-->
</para>
<para>
Double clicking with the &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.
</para>
<para>
Note that your operating system or window manager 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 its window.
<!-- TODO (js) but then how to select an object without opening it? -->
</para>
</sect3>
<sect3 id="database-object-windows">
<title>Database object windows</title>
<orderedlist>
<title>Opening an object's window</title>
<listitem>
<para>
Select the object in the <link linkend="project-navigator-pane">Project Navigator
pane</link>.
</para>
</listitem>
<listitem>
<para>
<!-- <img src="icons/edit.png" class="icon"> -->
Click the <guibutton>Open</guibutton> button on the <link
linkend="project-navigator-pane-toolbar">Project Navigator pane's toolbar</link>.
</para>
</listitem>
</orderedlist>
<itemizedlist>
<title>Commands related to object windows</title>
<listitem><para><emphasis>Closing an object window</emphasis></para>
<para>
When the IDEAl user interface mode (the default) is used, each window has
its own tab. Place the mouse pointer on the icon on the tab. A
<!-- <img src="fileclose.png" class="icon"> --> <guibutton>Close</guibutton> button will become
visible. Click it to close the tab.
</para>
<para>
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.
</para>
<para>
Alternatively, regardless of the user interface mode you are using,
you can select <menuchoice><guimenu>Window</guimenu>
<guimenuitem>Close</guimenuitem></menuchoice> from the Menubar.
</para>
</listitem>
<listitem><para><emphasis>Window buttons for Childframe user interface
mode</emphasis></para>
<!--
<para>
<br><img src="img/04_06_02_window_buttons.png">
<br>Window's buttons<br><br>
</para>
-->
<para>
The other buttons (from right to left) can be used to: maximize, minimize
and undock the window.
</para>
<para>
There's a small icon on the left side of the title bar which can be clicked
to show a context menu with commands related to the window.
</para>
<!--
<para>See also Docking and undocking of the windows.</para>
-->
</listitem>
</itemizedlist>
</sect3>
<sect3 id="property-editor-pane">
<title><guilabel>Property Editor</guilabel> pane</title>
<para>
In the <guilabel>Property Editor</guilabel> pane you can change properties of the object
displayed in the active window. Depending on the context, the pane is
consisted of one or more tabs. The first, always visible tab, Properties,
contains the list of available properties.
</para>
<!--
<para>
<img src="img/04_06_03_prop_panel.png">
<br>Property Editor<br><br>
</para>
-->
<itemizedlist>
<title>Rules for using the Property Editor:</title>
<listitem>
<para>Each row contains a single property.</para>
</listitem>
<listitem>
<para>You can use the mouse or the keyboard to change values of particular
properties.</para>
</listitem>
<listitem>
<itemizedlist>
<title>Most frequently used types of property values are:</title>
<listitem>
<para><emphasis>a number;</emphasis> you can enter the value directly
or increase or decrease its value by clicking with the &LMB; on the arrows.
<!-- <img src="img/04_06_03_prop_arrows.png" class="icon"> -->
</para>
</listitem>
<listitem><para>text</para></listitem>
<listitem><para>drop down list of values</para></listitem>
<listitem><para><emphasis>Yes/No;</emphasis>
you can toggle the value by clicking on the button;
<guibutton>Yes</guibutton> (<emphasis>true</emphasis>) means that the button is
toggled on, <guibutton>>No</guibutton> (<emphasis>false</emphasis>) means that
the button is toggled off.
<!-- see the above figure -->
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem><para>
There is no need to confirm a changed value: changes are visible immediately
after moving to a different row of the Property Editor's list or by pressing
the <keycombo><keycap>Enter</keycap></keycombo> key.
</para></listitem>
<listitem>
<para>
Names of the recently changed properties that not yet were stored in the
database are marked with bold text.
</para>
</listitem>
<listitem>
<para>
After changing the value of a property, a special <guibutton>Undo changes</guibutton>
button appears on the right side of the Property Editor's list.
<!-- <img src="img/04_06_03_prop_undo.png" class="icon"> -->
By clicking it you can revert the value of the property to the original value
that was loaded from the database upon opening the database object. The button
is only visible when the property is actually highlighted.
</para>
</listitem>
</itemizedlist>
<itemizedlist>
<title>The Property Editor pane is empty if:</title>
<listitem><para>no single database object's window is opened, or</para>
</listitem>
<listitem><para>
the active database object's window does not offer properties; it is usually
the case when it is opened in Data View instead of Design View
</para>
</listitem>
</itemizedlist>
<!--
<para>
See also the list of keyboard shortcuts available for the Property Editor
pane in appendix Property Editor pane.
</para>
-->
</sect3>
</sect2>
</sect1>
<sect1 id="project-opening">
<title>
Opening an existing &kexi; database file
</title>
<itemizedlist>
<title>
To open an existing &kexi; database file:
</title>
<listitem><para>
select it in the <guilabel>Open Existing Project</guilabel>
dialog; or
</para></listitem>
<listitem><para>
open it by clicking on the .kexi file icon.
</para></listitem>
</itemizedlist>
<sect2 id="window-open-existing">
<title>
Opening a database file in the <guilabel>Open Existing
Project</guilabel> dialog
</title>
<itemizedlist>
<listitem><para>
Run &kexi;. <!--(see <a href="04_02_00_running_kexi.html">Running Kexi</a>).-->
You should see <guilabel>Choose Project</guilabel> startup dialog.
Choose <guilabel>Open Existing Project</guilabel> tab.
You will see the following dialog:
<!-- image: <img src="img/04_04_01_startup_open_existing.png"> -->
</para></listitem>
<listitem><para>
From <guilabel>Current location</guilabel> drop down box, pick a folder
containing a file you are looking for.
</para></listitem>
<listitem><para>
You can either pick a file or enter its name in the
<guilabel>Location:</guilabel> box.
</para></listitem>
<listitem><para>
Click <guibutton>OK</guibutton>.
</para></listitem>
</itemizedlist>
<sect3 id="open-existing-notes">
<title>
Notes
</title>
<itemizedlist>
<listitem><para>
By default the <guilabel>Filter:</guilabel> drop down list has
<guilabel>Kexi Database File-Based Project</guilabel> selected.
In case the file you are looking for has an other extension,
you can change the selection of the <guilabel>Filter:</guilabel>
drop down list to <guilabel>All Files</guilabel> to display
all available files (regardless of an extension).
</para></listitem>
<listitem><para>
If you have selected a file of an external type, like a MS Access .mdb
file, &kexi; will provide you with the option to import the file.
<!-- todo an advice to read "importing" chapter will be placed here -->
</para></listitem>
<listitem><para>
If you have selected a <emphasis>connection data</emphasis> file
(with .kexic extension) or a <emphasis>shortcut to a project on
database server</emphasis> file (with .kexis extension), &kexi;
will display appropriate dialogs.
</para></listitem>
</itemizedlist>
</sect3>
</sect2>
<sect2 id="open-icon">
<title>
Opening an existing &kexi; database file by clicking on .kexi file's icon
</title>
<para>
Click file's icon using your file manager or desktop.
&kexi; will open this database project automatically.
</para>
<!-- <img src="icons/mime-kexiproject_sqlite.png" class="icon"/> -->
<sect3 id="open-icon-notes">
<title>
Notes
</title>
<para>
<emphasis>Note about database files accessed remotely.</emphasis>
You may want to open a database file that is located on a remote
source (&eg; a web or FTP server or a MS Windows network share).
K Desktop Environment allows you to open files from remote sources
directly in applications and to save changes back to the source, but
this is not the case with database files. By clicking on a database
file located on a remote source, a copy of the file will be
downloaded to a temporary directory on your computer and all your
changes will be made to this local file. The remote original of
the file will remain unchanged, so it's recommended to copy
(download) the file to your computer first, then open the file and
copy it back to the remote source if you want to make it up to date.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="using-help">
<title>
Using built-in help
</title>
<itemizedlist>
<title>
The following ways to get built-in help in &kexi; are available:
</title>
<listitem>
<para><emphasis>The Handbook in form of electronic document.</emphasis></para>
<para>
The Handbook is available by pressing <keycombo><keycap>F1</keycap></keycombo>
key or selecting <menuchoice><guimenu>Help</guimenu><guimenuitem>&kexi;
Handbook</guimenuitem></menuchoice> from the menubar.
</para>
</listitem>
<listitem>
<para><emphasis>What's This? hints.</emphasis></para>
<para>
Select <menuchoice><guimenu>Help</guimenu><guimenuitem>What's
This?</guimenuitem></menuchoice>from the menu bar and click on
an area of the application to get hints about it.
</para>
</listitem>
</itemizedlist>
</sect1>
</chapter>

248
doc/kexi/building.docbook
Unescape View File

@ -0,0 +1,248 @@
<!--
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" >
-->
<chapter id="building-databases">
<title>Building Simple Databases</title>
<sect1 id="building-intro">
<title>Introduction</title>
<para>
To learn the basics of &kexi;, 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.
</para>
<para>
Start by creating a new empty <emphasis>Phone Book</emphasis>.
<!--
See chapter <a href="04_03_00_creating_database.html">4.3.
Creating a new database project</a> for information how to do this.
-->
</para>
<para>Having a new empty database project, perform the following steps:</para>
<procedure>
<step><para>Design database tables. Read <xref linkend="designing-tables"/>.</para></step>
<step><para>Enter data into tables. Read <xref linkend="entering-data-into-tables"/>.</para></step>
<step><para>Design database queries. Read <xref linkend="designing-queries"/>.</para></step>
<step><para>Design forms. Read <xref linkend="designing-forms"/>.</para></step>
<step><para>Use forms to enter data. Read <xref linkend="entering-data-using-forms"/>.</para></step>
</procedure>
</sect1>
<sect1 id="designing-tables">
<title>Designing Database Tables</title>
<para>
First, there will be two tables added to your database:
<emphasis>persons</emphasis> and <emphasis>phone_numbers</emphasis>.
These are exactly the same tables as described in chapter <link
linkend="database-and-spreadsheet">Database and spreadsheet</link>.
A layout for <emphasis>Persons</emphasis> can be found in section
<link linkend="data-integrity-and-validity">Data integrity and validity</link>
in that chapter.
</para>
<procedure>
<step>
<para>
Select <menuchoice><guimenu>Insert</guimenu><guimenuitem>Table</guimenuitem>
</menuchoice> from the Menubar. You can also use the button <guilabel>Create
object: table</guilabel> on the <link linkend="project-navigator-pane">Project
Navigator's toolbar</link>.
</para>
</step>
<step>
<para>
The 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
<emphasis>template</emphasis> 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
<link linkend="project-navigator-pane">Project Navigator</link>.
</para>
</step>
</procedure>
<sect2 id="design-window">
<title>The Table Designer window</title>
<itemizedlist>
<title>Table Designer window consists of following columns:</title>
<listitem><para>
<guilabel>PK</guilabel> - Primary Key. <!-- It will be discussed this topic in
<link linkend="building-advanced-database">in a later chapter</link>. -->
</para></listitem>
<listitem><para>
<guilabel>Field Caption</guilabel> - caption of the field
which will be displayed during data entering.
</para></listitem>
<listitem><para>
<guilabel>Data Type</guilabel> - a combo box containing a list of data types,
allowing to set a main rule for entered data for a given field. For example,
when an integer number data type is set for a field, a database user will not
able to enter letter characters into this field.
</para></listitem>
<listitem><para>
<guilabel>Comments</guilabel> - you can enter here any information useful for
understanding what the given field is provided for. This additional text will
be saved within the table design and only visible in design mode.
</para></listitem>
</itemizedlist>
<para>
In the <guilabel>Table designer</guilabel> window, every row corresponds to
a single table field. You can recognize you are in <emphasis>design
mode</emphasis> because the <!-- <img src="icons/state_edit.png" class="icon"> -->
<guibutton>Switch to Design View mode</guibutton> button is toggled on within
the main &kexi; toolbar.
</para>
<procedure>
<title>Designing the <emphasis>Persons</emphasis> table</title>
<step><para>
In the first row click on the cell in the <guilabel>Field Caption</guilabel>
column and enter <emphasis>Name</emphasis> as field caption.
</para>
<itemizedlist>
<title>Notes about field names and captions</title>
<listitem><para>
Every table field must have a name and a caption, these cannot be empty.
</para></listitem>
<listitem><para>
Field name is a word used by the database, usually not visible for users of the database application. The name may not contain special (national) characters (like ±, ¶, Ü)
or space characters. The name must only contain roman letters,
<!-- JSTANIEK: TODO: what about for example japanese letters? Are they allowed in japanese versions?-->
numbers and underscore sign &quot;_&quot;. Use the latter instead of
spaces or dashes.
</para></listitem>
<listitem><para>
Field names must be started with a letter or underscore sign
&quot;_&quot;, never with a number.
</para></listitem>
<listitem><para>
It does not matter whether you are using small or capital letters.
For &kexi; the database name &quot;Persons&quot; is the same as
&quot;persons&quot;.
</para></listitem>
<listitem><para>
Field caption, on the other hand, allows you to enter any letters and special characters. It will be displayed for users of the database application.
</para></listitem>
</itemizedlist>
</step>
<step>
<itemizedlist>
<title>In a similar way, enter the following fields into the table design:</title>
<listitem><para><guilabel>surname</guilabel></para></listitem>
<listitem><para>street</para></listitem>
<listitem><para>house_number</para></listitem>
<listitem><para>city</para></listitem>
</itemizedlist>
</step>
<step><para>
All the above fields, except <emphasis>house_number</emphasis>, are of type
<emphasis>text</emphasis>.
Change <emphasis>house_number</emphasis> field's type to <emphasis>integer
number</emphasis>. To do this, click on a cell in the <guilabel>Data
Type</guilabel> column, <emphasis>house_number</emphasis> row and then
click on drop down list's button <!--<img src="icons/dropdown_button.png" class="icon">-->
(you can also press <keycombo><keycap>F4</keycap></keycombo> or
<keycombo action="simul">&Alt;<keycap>Down</keycap></keycombo>. The list
of data types will appear. Select the <emphasis>Integer number</emphasis> type.
<!--
<br><img src="img/05_01_01_changing_datatype.png">
<br>Changing data type of a filed to integer number<br><br>
-->
</para><para>
From now on, the <emphasis>house_number</emphasis> field only accepts numbers.
</para></step>
<!-- TODO setting additional properties: e.g. caption -->
<step><para>
<emphasis>Persons</emphasis> table design is ready. Click <!-- <img src="icons/state_data.png" class="icon">-->
<guibutton>Switch to Data View</guibutton> button on the toolbar to finish
designing and switch to Data View for the table. This allows you entering
data into the table.
</para></step>
<step><para>
As the design is not yet saved in the database, the <guibutton>Save Object As</guibutton>
dialog window appears. You need to specify the name for the new table.
<!--
<br><img src="img/05_01_01_entering_table_name.png">
<br>Entering table name before saving its design<br><br>
-->
</para>
<para>
&kexi; offers a generic name like <emphasis>Table1</emphasis>.
To change the name, enter <emphasis>Persons</emphasis> into the
<emphasis>Caption</emphasis> field and press the <keycombo>
<keycap>Enter</keycap></keycombo> key or click the <guibutton>OK</guibutton>
button. The <guilabel>Caption</guilabel> field will be used to display the
table to database end-users, &eg; as a form. Unlike the name, the caption can
contain any characters including spaces and special characters.
</para>
<para>
Note that filling the <guilabel>Caption</guilabel> field automatically fills
the <guilabel>Name</guilabel> field. For your convenience the rule for using
only letters, numbers and the &quot;_&quot; character is kept. You
can alter the contents of the <guilabel>Name</guilabel> field if you want to.
<!--
<br><img src="img/05_01_01_automatic_names.png">
<br>Example of automatically filled Name field<br><br>
-->
</para></step>
<step><para>
You are asked about an agreement for automatic adding of primary key to the table.
<!--The idea of primary keys is described in <a href=""> -->
<!-- TODO chapter # chapter 6</a>.--> Click <guibutton>Add primary key</guibutton>
button to continue.
<!--
<br><img src="img/05_01_01_pkey_recommended.png">
<br>A question about automatic adding a primary key<br><br>
-->
</para></step>
<step><para>
The <emphasis>Persons</emphasis> table has been created and opened in Data View.
Its name appears in the <guilabel>Project Navigator</guilabel> pane.
<!-- <br><img src="img/05_01_01_table_created.png">
<br><em>Persons</em> table in the Project Navigator pane<br><br>
-->
</para></step>
<step><para>
Create the <emphasis>phone_numbers</emphasis> table, in a similar
way as <emphasis>persons</emphasis> table.
</para></step>
<step><para>
Create a <emphasis>person</emphasis> field of type <emphasis>Integer
number</emphasis> and <emphasis>phone</emphasis> of type <emphasis>Text</emphasis>.
Do not use a number type here because phone numbers can have many different
forms and prefixes.
</para></step>
<step><para>
Click <!--<img src="icons/state_data.png" class="icon"> --> <guibutton>Switch to
Data View</guibutton> button on the toolbar and enter <emphasis>Phones</emphasis>
caption for the table. As for your previous table, allow &kexi; to automatically
create a primary key.
</para></step>
</procedure>
</sect2>
</sect1>
&enteringdataintotables;
&querydesigning;
&designingforms;
&enteringdatausingforms;
</chapter>

98
doc/kexi/comparing.docbook
Unescape View File

@ -0,0 +1,98 @@
<!--
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" >
-->
<appendix id="comparing">
<title>
Comparing &kexi; to other database applications
</title>
<para>
Although different database applications tend to provide similar
functionality, they often use different terminology. For your
convenience, this appendix shows how the terminology used in
&kexi; corresponds to that used by other database applications.
Thus, this chapter may be useful when migrating databases from
one application to another.
</para>
<sect1 id="comparing-data-types">
<title>
Data types
</title>
<para>
The table below shows how the data types in &kexi; correspond
to data types in other database applications.
</para>
<para>
Some of the data types listed here are
<firstterm>sub-types</firstterm> of other types. For example,
the <emphasis>Long text</emphasis> type is a sub-type of the
<emphasis>Text</emphasis> type. To use a sub-type in
&kexi;, you should select the corresponding basic type (in
this case, Text) in the table designer, and then select the
sub-type using the <guilabel>Subtype</guilabel> setting in the
<guilabel>Properties Editor</guilabel>.
</para>
<table>
<title>
Comparison of data types used in &kexi; and other database
applications
</title>
<tgroup cols="4">
<thead>
<row>
<entry>&kexi;</entry>
<entry>MS Access</entry>
<entry>dBase/FoxPro</entry>
<entry>Paradox</entry>
</row>
</thead>
<tbody>
<row>
<entry>Text (Text)</entry>
<entry>Text</entry>
<entry>Character</entry>
<entry>Alphanumeric</entry>
</row>
<row>
<entry>Long text (Long text)</entry>
<entry>Memo</entry>
<entry>Memo</entry>
<entry>Memo</entry>
</row>
<row>
<entry>Date/Time (Date/Time)</entry>
<entry>Date, Time</entry>
<entry>Date</entry>
<entry>DateTime</entry>
</row>
<!-- Not visible in Kexi GUI yet.
<row>
<entry>Object (Object)</entry>
<entry>OLE Object</entry>
<entry>General</entry>
<entry>OLE, Graphical Binary</entry>
</row>
-->
<row>
<entry>Integer Number (Integer Number)</entry>
<entry>Number (Integer)</entry>
<entry>Numeric</entry>
<entry>Integer</entry>
</row>
<row>
<entry>Big Integer Number (Big Integer Number)</entry>
<entry>Long Integer</entry>
<entry>Numeric</entry>
<entry>Long Integer</entry>
</row>
<row>
<entry>Floating Point Number (Floating Point Number)</entry>
<entry>Single/Double precision number</entry>
<entry>Float</entry>
<entry>Number</entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>
</appendix>

230
doc/kexi/configuration.docbook
Unescape View File

@ -0,0 +1,230 @@
<!--
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" >
-->
<chapter id="configuration">
<title>
Configuring &kexi;
</title>
<para>
This chapter describes how you can configure &kexi; to suit your
own needs and preferences.
</para>
<sect1 id="configuring-window-layout">
<title>
Window Layout
</title>
<para>
&kexi; provides a <firstterm>Mutiple Document
Interface</firstterm> (MDI). This means that you can have
several database objects (such as tables, queries, forms and
scripts) open at the same time and in the same &kexi; main
window. Each database object is shown in a <firstterm>child
window</firstterm> within the main window.
</para>
<para>
There is a choice of two MDI modes available, allowing a choice
of how child windows are managed and displayed. The two modes
are:
<itemizedlist>
<listitem><para><guisubmenu>IDEAl Mode</guisubmenu>; and</para></listitem>
<listitem><para><guisubmenu>Childframe Mode</guisubmenu>.</para></listitem>
</itemizedlist>
These modes are described in the following two sections. You
can change the MDI mode from the <guisubmenu>MDI
Mode</guisubmenu> sub-menu under the <guimenu>Window</guimenu>
menu. Note that changing the MDI mode requires &kexi; to be
restarted before the new mode takes effect.
</para>
<sect2 id="window-layout-ideal">
<title>
IDEAl mode
</title>
<!-- TODO: Screenshot of IDEAl mode -->
<para>
IDEAl mode is the default MDI mode, and may be familiar from
other &kde; applications. In this mode, a single child window
is shown maximized within the &kexi; main window at once.
A tab bar, containing one tab for each child window, allows
other child windows to be viewed by simply clicking on the
relevant tab.
</para>
</sect2>
<sect2 id="window-layout-childframe">
<title>
Childframe mode
</title>
<!-- TODO: Screenshot of Childframe mode -->
<para>
In Childframe mode, child windows are displayed in the
main &kexi; window, but need not be maximized within it.
In order to use Childframe mode, you need to select
<action>
<guimenu>Window</guimenu>,
<guisubmenu>MDI Mode</guisubmenu>,
<guimenuitem>Childframe Mode</guimenuitem>
</action> from the menu.
</para>
<para>
Each child window has a titlebar with buttons for maximizing,
minimizing and closing it. They can also be moved and resized
within the main window in the normal way (for example, they
can be moved by clicking and dragging the title bar).
</para>
<para>
The buttons behave as follows: the right-most button closes
the child window. The button on its left maximizes the child
window - note this causes the buttons to move to the top right
of the main window, above the <guilabel>Properties
editor</guilabel> if it is open. The next button to the left
toggles the child window between minimized and restored.
</para>
<para>
The left-most button detaches, or
<firstterm>undocks</firstterm>, the child window, allowing it
to be moved out of the main window. For more information on
docking and undocking windows, see the next section.
</para>
</sect2>
</sect1>
<sect1 id="docking-windows">
<title>
Docking and Undocking Windows
</title>
<para>
By default, the <guilabel>Project Navigator</guilabel> and
<guilabel>Properties Editor</guilabel> panels are displayed as
part of the main &kexi; window. It is possible to
<firstterm>undock</firstterm> each panel, so that it is
displayed in a separate window. Once undocked, it is possible
to <firstterm>dock</firstterm> the panel so it appears back in
the main window again.
</para>
<para>
In <link linkend="window-layout-childframe">Childframe
mode</link>, it is also possible to undock child windows. For
example, a child window showing a database table could be
undocked, allowing the child window showing the table to be
maximized on the screen.
</para>
<para>
It can be useful to undock a window when using:
<itemizedlist>
<listitem>
<para>
a small screen;
</para>
</listitem>
<listitem>
<para>
large tables, queries or forms; and/or
</para>
</listitem>
<listitem>
<para>
more than one montitor.
</para>
</listitem>
</itemizedlist>
</para>
<sect2>
<title>
Docking and undocking side panels
</title>
<para>
The <guilabel>Project Navigator</guilabel> and
<guilabel>Properties Editor</guilabel> side panels may be
undocked by either:
<itemizedlist>
<listitem>
<para>
double-clicking on the 'grip' bar at the top of the
panel; or
</para>
</listitem>
<listitem>
<para>
clicking once on the arrow at the top of the panel, next
to the cross.
</para>
</listitem>
</itemizedlist>
<!-- TODO: Screenshot -->
</para>
<para>
Once undocked, panel windows may be docked into the main
window again similarly to undocking:
<itemizedlist>
<listitem>
<para>
double-clicking on the 'grip' bar at the top of the window; or
</para>
</listitem>
<listitem>
<para>
clicking once on the arrow at the top of the panel, next
to the cross.
</para>
</listitem>
<!-- TODO: Screenshot -->
</itemizedlist>
</para>
</sect2>
<sect2>
<title>
Docking and undocking child windows
</title>
<para>
Child windows may be docked and undocked in <link
linkend="window-layout-childframe">Childframe mode</link>
only.
</para>
<para>
In Childframe mode, child windows may be undocked by:
<itemizedlist>
<listitem>
<para>
right-clicking in the tab bar, on the tab corresponding
to the window to be undocked, and selecting
<guilabel>Undock</guilabel>; or
</para>
<!-- TODO: Screenshot -->
</listitem>
<listitem>
<para>
right-clicking on the title bar of the child window, and
selecting <guilabel>Undock</guilabel>; or
</para>
<!-- TODO: Screenshot -->
</listitem>
<listitem>
<para>
if the child window is <emphasis>not</emphasis>
maximized, clicking the arrow in the top right corner of
the child window (next to the minimize, maximize and
close buttons for that child window);
</para>
<!-- TODO: Screenshot -->
</listitem>
<listitem>
<para>
if the child window is maximized, clicking the arrow to
the right of the menu bar (next to the minimize, restore
and close buttons for that child window).
</para>
<!-- TODO: Screenshot -->
</listitem>
</itemizedlist>
</para>
<para>
To dock a child window, right-clicking in the tab bar, on the
tab corresponding to the window to be docked, and select
<guilabel>Dock</guilabel>.
</para>
<!-- TODO: Screenshot -->
</sect2>
</sect1>
</chapter>

BIN
doc/kexi/contact-example.png
View File

Binary file not shown.

63
doc/kexi/credits.docbook
Unescape View File

@ -0,0 +1,63 @@
<chapter id="credits">
<!-- Include credits for the programmers, documentation writers, and
contributors here. The license for your software should then be
included below the credits with a reference to the appropriate
license file included in the KDE distribution. -->
<title>Credits and License</title>
<para>
&kexi; Copyright 2002-2006 The &kexi; Team
<itemizedlist>
<title>&kexi; Developers:</title>
<listitem>
<para>Jaroslaw Staniek / OpenOffice Polska <email>js@iidea.pl</email></para>
</listitem>
<listitem>
<para>Lucijan Busch <email>lucijan@kde.org</email></para>
</listitem>
<listitem>
<para>Cedric Pasteur <email>cedric.pasteur@free.fr</email></para>
</listitem>
<listitem>
<para>Adam Pigg <email>adam@piggz.fsnet.co.uk</email></para>
</listitem>
<listitem>
<para>Martin Ellis <email>martin.ellis@kdemail.net</email></para>
</listitem>
<listitem>
<para>Sebastian Sauer <email>mail@dipe.org</email></para>
</listitem>
<listitem>
<para>Christian Nitschkowski <email>segfault_ii@web.de</email></para>
</listitem>
<listitem>
<para>Peter Simonsson <email>psn@linux.se</email></para>
</listitem>
<listitem>
<para>&Joseph.Wenninger; <email>jowenn@kde.org</email></para>
</listitem>
<listitem>
<para>Seth Kurzenberg <email>seth@cql.com</email></para>
</listitem>
<listitem>
<para>Laurent Montel <email>montel@kde.org</email></para>
</listitem>
<listitem>
<para>Till Busch <email>till@bux.at</email></para>
</listitem>
</itemizedlist>
</para>
<para>
Documentation by Martin A. Ellis <email>martin.ellis@kdemail.net</email>,
Jaroslaw Staniek <email>js@iidea.pl</email>
with contributions from Anne-Marie Mahfouf, Raphael Langerhorst, Michal Kubicki and Aron Stansvik.
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL; <!-- FDL: do not remove -->
&underLGPL; <!-- LGPL License -->
</chapter>

649
doc/kexi/database.docbook
Unescape View File

@ -0,0 +1,649 @@
<!--
<!DOCTYPE appendix PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" >
-->
<appendix id="database">
<title>Introduction to Databases</title>
<sect1 id="what-is-a-database">
<title>What Is a Database?</title>
<para>
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.
</para>
<para>
Look at this diagram for one of the above examples: a simple phone book.
</para>
<screenshot>
<screeninfo>A diagram of a phone number database</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="contact-example.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>A diagram of a phone number database</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
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 row in a table:
</para>
<para><emphasis><guilabel>Contacts</guilabel> table</emphasis></para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><guilabel>Name</guilabel></entry>
<entry><guilabel>Tel No.</guilabel></entry>
</row>
<row>
<entry>Joan</entry>
<entry>699 23 43 12</entry>
</row>
<row>
<entry>Adam</entry>
<entry>711 19 77 21</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
<emphasis>Terms and definitions</emphasis>:
A single data which constitutes a part of a greater collection can be called a
<firstterm>row</firstterm> or more professionally a
<firstterm>record</firstterm>.
The collection is normally called a <firstterm>table</firstterm>.
Moreover, the most natural name for the table is one describing the data it
offers/stores which is <guilabel>Contacts</guilabel>.
Furthermore, each row in the table consists of <firstterm>columns</firstterm>
often also called <firstterm>fields</firstterm>. In the table
<guilabel>Contacts</guilabel> there are two columns (fields):
<guilabel>Name</guilabel> and <guilabel>Tel No.</guilabel>.
</para>
<para>
For simple uses a single table can make up a <firstterm>database</firstterm>.
Many people consider these two equivalent.
As you will see, for real databases we usually need more than one table.
</para>
<para>
To sum up, you have already got a simple database with one table
<guilabel>Contacts</guilabel>.
</para>
</sect1>
<sect1 id="database-and-spreadsheet">
<title>Database and Spreadsheet</title>
<para>
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?
</para>
<para>
While comparing spreadsheets and databases you may encounter the following issues which you will later see in greater detail:
</para>
<itemizedlist>
<listitem><para><link linkend="referential-data-integrity">Referential
data integrity</link></para></listitem>
<listitem><para><link linkend="data-redundyncy">Data redundancy</link>
</para></listitem>
<listitem><para><link linkend="data-integrity-and-validity">Data integrity
and validity</link></para></listitem>
<listitem><para><link linkend="data-limiting">Limiting data view</link></para></listitem>
<listitem><para><link linkend="performance-and-capacity">Performance and
capacity</link></para></listitem>
<listitem><para><link linkend="convenient-data-entry">Convenient data entry</link></para></listitem>
<listitem><para><link linkend="reports">Reports</link></para></listitem>
<listitem><para><link linkend="programming">Programming</link></para></listitem>
<listitem><para><link linkend="multiuse">Multiuse</link></para></listitem>
<listitem><para><link linkend="security">Security</link></para></listitem>
</itemizedlist>
<sect2 id="difference-database-and-spreadsheet">
<title>How Is a Database Different From a Spreadsheet?</title>
<para>
Gradually exceeding the capacity of a mobile phone, expand your table
<guilabel>Contacts</guilabel> adding a column (field)
<guilabel>Address</guilabel>. Add more telephone numbers
(office, home) for each person and add surnames to names.
To make it simpler we assume the following:
</para>
<itemizedlist>
<listitem><para>the table is limited to two people (obviously,
there could be hundreds and thousands of them in a real
database)</para></listitem>
<listitem><para>there are no two persons with the same name and surname</para>
</listitem>
</itemizedlist>
<para><emphasis>Contacts table</emphasis></para>
<informaltable>
<tgroup cols="3">
<tbody>
<row>
<entry><emphasis>Name and surname</emphasis></entry>
<entry><emphasis>Tel</emphasis></entry>
<entry><emphasis>Address</emphasis></entry>
</row>
<row>
<entry>Joan Smith</entry>
<entry>699 23 43 12</entry>
<entry>Western Gate 1, Warsaw</entry>
</row>
<row>
<entry>Adam Willson</entry>
<entry>711 19 77 21</entry>
<entry>London, Frogs Drive 5</entry>
</row>
<row>
<entry>Joan Smith</entry>
<entry>110 98 98 00</entry>
<entry>Western Gate 1</entry>
</row>
<row>
<entry>Smith Joan</entry>
<entry>312 43 42 22</entry>
<entry>Warsaw, Western Gate 1</entry>
</row>
<row>
<entry>ADAM Willson</entry>
<entry>231 83 02 04</entry>
<entry>Frogs Drive 5, London</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
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?
</para>
<sect3 id="referential-data-integrity">
<title>Referential data integrity</title>
<para>
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 rows. For example, Joan takes three rows. A real problem
will arise if you forget to change one of the rows - the address asigned
to this person will be <emphasis>ambiguous</emphasis>, hence
<emphasis>your data loses integrity</emphasis>.
</para>
<para>
Moreover there is no simple way of deleting a chosen person from the table
since you have to remember about deleting all rows releted to him or her.
</para>
</sect3>
<sect3 id="data-redundyncy">
<title>Data redundancy</title>
<para>
This is directly connected to the previous problem. In fields
<guilabel>Name and surname</guilabel> and <guilabel>Address</guilabel>
the same data is entered many times. This is typical of a spreadsheets'
ineffective way of storing data because the database grows unnecessarily,
thus requiring more computer resources (larger size of data and slower access).
</para>
<para>
How can you solve these problems with a database? You can split information
into smaller chunks by creating an additional table <emphasis>Persons</emphasis>
with only two columns: <guilabel>Name and surname</guilabel>
and <guilabel>Address</guilabel>:
</para>
<para><emphasis><guilabel>Persons</guilabel> table</emphasis></para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><emphasis>Name and surname</emphasis></entry>
<entry><emphasis>Address</emphasis></entry>
</row>
<row>
<entry>Joan Smith</entry>
<entry>Western Gate 1, Warsaw</entry>
</row>
<row>
<entry>Adam Willson</entry>
<entry>Frogs Drive 5, London</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
Each row in the table <guilabel>Persons</guilabel> corresponds to a
<emphasis>single person</emphasis>. Table <guilabel>Contacts</guilabel>
is from now on a relation to the table <guilabel>Persons</guilabel>
<!--(see next paragraph)-->.
</para>
</sect3>
<sect3 id="data-integrity-and-validity">
<title>Data integrity and validity</title>
<para>
Note the way data is entered in the fields <guilabel>Name and surname</guilabel>
and <guilabel>Address</guilabel>. 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.
</para>
<para>
The above problem shows that &eg; 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 row instead of three. Moreover You will also
not find all the telephone numbers searching for the value "Joan Smith" in
the field <guilabel>Name and surname</guilabel>, because "Smith Joan" will
not fit to "Joan Smith".
</para>
<para>
How can you solve these problems using a database? You can do this by changing the design of the table <guilabel>Persons</guilabel> by:
</para>
<orderedlist>
<listitem><para>
<emphasis>Dividing data</emphasis> in the field <guilabel>Name and
surname</guilabel> into two separate fields: <guilabel>Name</guilabel>
and <guilabel>Surname</guilabel>.
</para></listitem>
<listitem><para>
<emphasis>Dividing data</emphasis> in the field <guilabel>Address</guilabel>
into three separate fields: <guilabel>Street</guilabel>, <guilabel>House
number</guilabel> and <guilabel>City</guilabel>.
</para></listitem>
<listitem><para>
<emphasis>Guaranteeing data correctness:</emphasis> by ensuring that no fields
are empty, &eg; you must always enter house number.
</para></listitem>
</orderedlist>
<para>
A modified table looks something like this:
</para>
<para><emphasis>Persons table</emphasis></para>
<informaltable>
<tgroup cols="5">
<colspec colnum="1" colname="c1"></colspec>
<colspec colnum="2" colname="c2"></colspec>
<colspec colnum="3" colname="c3"></colspec>
<colspec colnum="4" colname="c4"></colspec>
<colspec colnum="5" colname="c5"></colspec>
<tbody>
<row>
<entry><emphasis>Name</emphasis></entry>
<entry><emphasis>Surname</emphasis></entry>
<entry><emphasis>Street</emphasis></entry>
<entry><emphasis>House number</emphasis></entry>
<entry><emphasis>City</emphasis></entry>
</row>
<row>
<entry>Joan</entry>
<entry>Smith</entry>
<entry>Western Gate</entry>
<entry>1</entry>
<entry>Warsaw</entry>
</row>
<row>
<entry>Adam</entry>
<entry>Willson</entry>
<entry>Frogs Drive</entry>
<entry>5</entry>
<entry>London</entry>
</row>
<row>
<entry namest="c1" nameend="c5"><emphasis>Conditions</emphasis></entry>
</row>
<row>
<entry>required field</entry>
<entry>required field</entry>
<entry>required field</entry>
<entry>required field</entry>
<entry>required field</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
Thanks to introducing the condition <guilabel>required field</guilabel> 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.
</para>
</sect3>
<sect3 id="data-limiting">
<title>Limiting data view</title>
<para>
A spreadsheet displays all rows and columns of the table which is bothersome
in case of very large data sheets. You may of course filter and sort rows
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.
</para>
<para>
If you want to work on a small subset of data, &eg; 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.
</para>
<para>
To limit the <emphasis>data view</emphasis> database applications offer
<emphasis>queries</emphasis>, <emphasis>forms</emphasis>
and <emphasis>reports</emphasis>.
</para>
<para>
A very practical way of limitting is the following extended version of
the previously described table <guilabel>Persons</guilabel>:
</para>
<para><emphasis>Persons table</emphasis></para>
<informaltable>
<tgroup cols="6">
<tbody>
<row>
<entry><emphasis>Name</emphasis></entry>
<entry><emphasis>Surname</emphasis></entry>
<entry><emphasis>Street</emphasis></entry>
<entry><emphasis>House number</emphasis></entry>
<entry><emphasis>City</emphasis></entry>
<entry><emphasis>Income</emphasis></entry>
</row>
<row>
<entry>Joan</entry>
<entry>Smith</entry>
<entry>Western Gate</entry>
<entry>1</entry>
<entry>Warsaw</entry>
<entry>2300</entry>
</row>
<row>
<entry>Adam</entry>
<entry>Willson</entry>
<entry>Frogs Drive</entry>
<entry>5</entry>
<entry>London</entry>
<entry>1900</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
Let's assume that the newly introduced column <guilabel>Income</guilabel>
contains confidential data. How can you share &eg; contact details of the
persons with your coworkers but without <emphasis>revealing their
income</emphasis>? It is possible if <emphasis>you share only a query and
not the whole table</emphasis>. The query could select all columns except
for the column <guilabel>Income</guilabel>. In database world such a query
is often known as a <guilabel>view</guilabel>.
</para>
</sect3>
<sect3 id="performance-and-capacity">
<title>Performance and capacity</title>
<para>
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.
</para>
<para>
Spreadsheets containing large data sets may take ages to open. A 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.
</para>
<para>
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:
</para>
<itemizedlist>
<listitem><para>
The sequence of rows since you can order the rows according to your needs.
Moreover, you can view the same data in many views with different orders.
</para></listitem>
<listitem><para>
The same goes for columns (fields) of the table.
</para></listitem>
</itemizedlist>
<para>
Together with <link linkend="data-limiting">Limiting data view</link>
described in the previous paragraph these qualities constitute the
advantage of databases.
</para>
</sect3>
<sect3 id="convenient-data-entry">
<title>Data entry</title>
<para>
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, &eg; if the text occupies
too many rows or if all the columns do not fit on the screen.
</para>
<para>
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.
</para>
</sect3>
<sect3 id="reports">
<title>Reports</title>
<para>
Databases enable grouping, limiting and summing up data in a form of a
<emphasis>report</emphasis>. Spreadsheets are usually printed in a form
of small tables without fully automatic control over page divisions and
the layout of fields.
</para>
</sect3>
<sect3 id="programming">
<title>Programming</title>
<para>
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 and integrity rules mentioned in previous paragraphs.
</para>
<para>
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.
</para>
</sect3>
<sect3 id="multiuse">
<title>Multiuse</title>
<para>
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.
</para>
<para>
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.
</para>
<para>
On the other hand, databases have been designed mainly with multiuser
access in mind. Even for the simplest version locking at a particular table
row's level is possible, which enables easy sharing of table data.
</para>
</sect3>
<sect3 id="security">
<title>Security</title>
<para>
Securing a spreadsheet or its particular sections with a password is only
symbolic activity. After providing a spreadsheet file in a 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.
</para>
<para>
Features for edit locking or copy locking of a spreadsheet (or its part)
is equally easy to break.
</para>
<para>
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)
which were assigned to you by setting appropriate access rights.
</para>
<para>
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.
</para>
</sect3>
</sect2>
</sect1>
<sect1 id="database-design">
<title>Database Design</title>
<para>
Database design needs careful planning. Note that <guilabel>Contacts</guilabel>
table redesign proposed in section 1.2 can generate problems when the
table is filled with data. For example, renaming a field is a simple task,
but splitting the <guilabel>Address</guilabel> field into separate fields
requires careful and tedious work.
</para>
<para>
To avoid such situations, <emphasis>rethink your database project</emphasis>
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.
</para>
</sect1>
<sect1 id="who-needs-a-database">
<title>Who Needs a Database?</title>
<itemizedlist>
<title>Stick to spreadsheets if:</title>
<listitem><para>
Your needs are limited and your data will never grow to
large volumes (can you actually forecast that now?)
</para></listitem>
<listitem><para>
You are unable to acquire the methodology of database construction.
You may however consider either outsourcing this task to someone else
or using simpler tools.
</para></listitem>
<listitem><para>
You use complicated spreadsheets and you lack time or money to switch
to databases. Think or ask someone whether this does not lead down a
blind alley. Don't count on magical tools that would change your
spreadsheet (regardless how well made) into a database.
</para></listitem>
</itemizedlist>
<itemizedlist>
<title>Consider using databases if:</title>
<listitem><para>Your data collection expands every week.</para></listitem>
<listitem><para>
You often create new spreadsheets, copy within these and you feel
that this work is getting more and more tedious. In this case the
effort of switching to databases easily pays off.
</para></listitem>
<listitem><para>
You create reports and statements for which the table view of
a spreadsheet is not suitable. You can then consider switch
to using a database with form views.
</para></listitem>
</itemizedlist>
</sect1>
<sect1 id="database-software">
<title>Database Creation Software</title>
<para>
So far you have learnt the general characteristics of databases without
going into much detail about specific applications for designing them.
</para>
<para>
The first databases were built together with large mainframe computers
in the 60s, &eg; 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 a network.
</para>
<para>
In the 70s scientists formed the theory of relational databases
(terms like: <firstterm>table</firstterm>, <firstterm>record</firstterm>,
<firstterm>column (field)</firstterm> and <firstterm>relationality</firstterm>
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.
</para>
<para>When it comes to large databases in companies, the situation
hasn't changed:
they still require powerful computers or computer complexes called
<firstterm>clusters</firstterm>. This goes, however, beyond the topic
of this manual.
</para>
<para>
In the area of "accessible" databases with graphic user interface
for PCs you can choose from the following:
</para>
<itemizedlist>
<listitem><para>
<ulink url="http://www.dbase.com/">DBase</ulink>
- a tool for databases operation for DOS popular in the 80s. Files in DBase format
are still used in some specific cases due to their simplicity.
</para></listitem>
<listitem><para>
<ulink url="http://msdn.microsoft.com/vfoxpro/productinfo/overview/">FoxPro</ulink>
- an application similar to DBase (early 90s). After being taken over by
Microsoft, graphic user interfaces were introduced and therefore it is
used for creating databases on PCs. This product is still offered, though
seems a bit obsolete.
</para></listitem>
<listitem><para>
<ulink url="http://office.microsoft.com/access/">Microsoft Access</ulink>
- an application for databases (data and graphic interface design) with many
simplifications, therefore suitable for beginners, designed in the late 80s,
based on 16-Bit Architecture. This product is offered and widely used till today, especially
by small companies, where efficiency and multiuser requirements are not very demanding.
</para></listitem>
<listitem><para>
<ulink url="http://www.filemaker.com/">FileMaker</ulink>
- popular application similar to MS Access in simplicity, operating on Windows
and Macintosh platforms, offered since 1985.
</para></listitem>
<listitem><para>
<ulink url="http://www.kexi.pl/">&kexi;</ulink>
- a multiplatform application (Unix/Linux, Windows, Mac OS X) designed in 2003,
developed according to OpenSource principles, part of the global
<ulink url="http://www.kde.org/">K Desktop Environment</ulink> project,
&ie; graphic environment for Unix/Linux systems. A significant contributor
to &kexi;'s development is the OpenOffice Poland company.
</para></listitem>
</itemizedlist>
</sect1>
</appendix>

1480
doc/kexi/designingforms.docbook
View File

File diff suppressed because it is too large Load Diff

130
doc/kexi/enteringdataintotables.docbook
Unescape View File

@ -0,0 +1,130 @@
<!--
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" >
-->
<sect1 id="entering-data-into-tables">
<title>Entering Data Into Tables</title>
<para>
You have designed the two tables <literal>Persons</literal> and
<literal>phone_numbers</literal>. None of them contain any data yet. You can
enter some, and in this chapter you will learn how to do this fast and effectively.
</para>
<procedure>
<step>
<para>
Start with the <literal>persons</literal> table. Open it in <interface>Data View</interface> using the <!--<a href="04_06_01_project_navigator.html">--><interface>Project Navigtor</interface>'s context menu.
The current cell is marked with
(usually black) thicker border, a <firstterm>cell cursor</firstterm>. The contents
of the cell, if present, are highlighted with a different color. The current
row, i.e. the one you have placed your rectangular cursor in, is marked
on the left hand with an arrow symbol.
<!--<img src="icons/button_tableview_currentrow.png" class="icon">-->
</para>
<para>
You can navigate through table cells using the arrow keys, <keycap>Page Down</keycap>,
<keycap>Page Down</keycap>, <keycap>Home</keycap>, <keycap>End</keycap> keys; you can also
click with the mouse in a cell to select it. <!-- TODO chapter moved
To learn more
about available key bindings for the data table view, see the section
<a href="ab_00_00_shortcuts.html#data_table">
B.4. Data Table in the Appendix B. Key Bindings. -->
</para>
<para>
Initially, after opening the table <literal>Persons</literal>, the cursor is placed in
the <literal>id</literal> column. The column has autonumber property defined,
marked with blue <literal>(autonumber)</literal> text in the last row. It
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.
</para>
<!--<screenshot>
<screeninfo>Data entry</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="img/05_02_00_data_editing.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Data entry</phrase>
</textobject>
</mediaobject>
</screenshot>-->
</step>
<step>
<para>
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 a plus <!--<img src="icons/button_tableview_newrow.png" class="icon">-->
sign. Place your cursor in the (second) <literal>name</literal> column and enter a
person's name. Also enter surname, street, house number and city. When
done, move the cell cursor to the last empty row either by using the
<keycap>Arrow Down</keycap> key or by clicking in the last
row with the mouse to append a new row.
</para>
<note>
<title>Details About Actions Available While Entering Data Into Tables</title>
<itemizedlist>
<listitem>
<para>
As soon as you enter the first character, the current row is being edited. A pencil <!--<img src="icons/button_tableview_editrow.png" class="icon">--> symbol appears on the left side of the data table.
</para>
</listitem>
<listitem>
<para>
Double clicking a cell with the &LMB; or pressing <keycap>Enter</keycap> or the <keycap>F2</keycap> key also starts
editing of the current row.
</para>
</listitem>
<listitem>
<para>
Pressing the <keycap>Esc</keycap> key when the contents of a cell is edited
<emphasis>cancels changes made to this cell</emphasis>. However, the pencil
<!--<img src="icons/button_tableview_editrow.png" class="icon">-->
symbol will not disappear because you can still move to a different cell
of the edited row to change its contents. To
<emphasis>cancel changes made to the entire edited row</emphasis>, press the
<keycap>Esc</keycap> key again.
</para>
</listitem>
<listitem>
<para>
Instead of pressing the <keycap>Esc</keycap> key, you can click the
<!--<img src="icons/button_cancel.png" class="icon">--><guibutton>Cancel</guibutton>
toolbar button or select
<menuchoice><guimenu>Data</guimenu><guimenuitem>Cancel Row Changes</guimenuitem></menuchoice>
from the menubar.
</para>
</listitem>
<listitem>
<para>
Click the <keycombo action="simul"><keycap>Shift</keycap><keycap>Enter</keycap></keycombo>
keys to accept changes made to all cells in the currently edited row. You can also click
<!--<img src="icons/button_ok.png" class="icon">--><guibutton>OK</guibutton> toolbar
button or select <menuchoice><guimenu>Data</guimenu><guimenuitem>Save Row</guimenuitem></menuchoice>
from the menubar.
</para>
</listitem>
</itemizedlist>
</note>
</step>
<step>
<para>
Fill the <literal>phone_numbers</literal> table with data.<!--, e.g. similar to
provided in the figure below.--> In the <literal>persons</literal> column you
need to provide a number of the person existing in the <literal>persons</literal>
table.
</para>
<!--<screenshot>
<screeninfo>Example contents of the <literal>phone_numbers</literal> table</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="img/05_01_01_table2_contents.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Example contents of the <literal>phone_numbers</literal> table</phrase>
</textobject>
</mediaobject>
</screenshot>-->
</step>
</procedure>
</sect1>

33
doc/kexi/enteringdatausingforms.docbook
Unescape View File

@ -0,0 +1,33 @@
<!--
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" >
-->
<sect1 id="entering-data-using-forms">
<title>Entering Data Using Forms</title>
<para>
Data entering and editing is usually the task of the user of the database application. The designer of the database should check the form in terms of valid
data entry, and see whether the form works as expected.
</para>
<para>
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 the &LMB; or the <keycap>Tab</keycap> and
<keycombo action="simul"><keycap>Shift</keycap><keycap>Tab</keycap></keycombo>
keys. While editing, there will be a
<!--<img src="icons/button_tableview_editrow.png" class="icon">-->
pencil icon visible near the record navigator. After entering the row's (record)
data you can press the
<keycombo action="simul"><keycap>Shift</keycap><keycap>Enter</keycap></keycombo>
keys or click the
<!--<img src="icons/button_ok.png" class="icon">--><guibutton>OK</guibutton>
toolbar button to accept changes made to the current row. Clicking the
<!--<img src="icons/button_cancel.png" class="icon">--><guibutton>Cancel</guibutton>
toolbar button discards changes made to the current row and restores the contents of
the data fields. You can use the <!--<img src="icons/navigator_next.png" class="icon">-->
record navigator's button to move to a new row. All the navigator's functions are
also available in a similar way as in the data table view
<!-- TODO link -->.
<!-- TODO shortcuts! -->
</para>
</sect1>

122
doc/kexi/index.docbook
Unescape View File

@ -0,0 +1,122 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY package "koffice">
<!ENTITY kappname "&kexi;">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
<!-- Chapters -->
<!ENTITY intro SYSTEM "intro.docbook">
<!ENTITY basics SYSTEM "basics.docbook">
<!ENTITY building SYSTEM "building.docbook">
<!ENTITY querydesigning SYSTEM "querydesigning.docbook">
<!ENTITY enteringdataintotables SYSTEM "enteringdataintotables.docbook">
<!ENTITY designingforms SYSTEM "designingforms.docbook">
<!ENTITY enteringdatausingforms SYSTEM "enteringdatausingforms.docbook">
<!ENTITY configuration SYSTEM "configuration.docbook">
<!ENTITY menus SYSTEM "menus.docbook">
<!ENTITY credits SYSTEM "credits.docbook">
<!ENTITY database SYSTEM "database.docbook">
<!ENTITY comparing SYSTEM "comparing.docbook">
<!-- Do not define any other entities; instead, use the entities
from entities/general.entities and $LANG/user.entities. -->
]>
<book lang="&language;">
<bookinfo>
<title>
The &kexi; Handbook
</title>
<authorgroup>
<author>
<personname>
<firstname>Martin</firstname>
<othername>A.</othername>
<surname>Ellis</surname>
</personname>
<email>martin.ellis@kdemail.net</email>
</author>
<author>
<personname>
<firstname>Jaroslaw</firstname>
<surname>Staniek</surname>
</personname>
<email>js@iidea.pl</email>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2004</year>
<year>2005</year>
<year>2006</year>
<holder>Jaroslaw Staniek</holder>
<holder>Martin Ellis</holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation -->
<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook
and in the FDL itself on how to use it. -->
<legalnotice>&FDLNotice;</legalnotice>
<!-- Date and version information of the documentation
Don't forget to include this last date and this last revision number, we
need them for translation coordination !
Please respect the format of the date (YYYY-MM-DD) and of the version
(V.MM.LL), it could be used by automation scripts.
Do NOT change these in the translation. -->
<date>2006-09-07</date>
<releaseinfo>1.6</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>
&kexi; is the application for creating databases and for data management
in the &koffice; productivity suite.
</para>
</abstract>
<!-- Keywords -->
<keywordset>
<keyword>KDE</keyword>
<keyword>KOffice</keyword>
<keyword>Kexi</keyword>
<keyword>database</keyword>
</keywordset>
</bookinfo>
<!-- The contents of the documentation begin here. Label
each chapter so with the id attribute. This is necessary for two reasons: it
allows you to easily reference the chapter from other chapters of your
document, and if there is no ID, the name of the generated HTML files will vary
from time to time making it hard to manage for maintainers and for the CVS
system. Any chapter labelled (OPTIONAL) may be left out at the author's
discretion. Other chapters should not be left out in order to maintain a
consistent documentation style across all KDE apps. -->
&intro;
&basics;
&building;
&configuration;
&menus;
&credits;
&database;
&comparing;
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes: nil
sgml-general-insert-case: lower
End:
vim:tabstop=2:shiftwidth=2:expandtab
kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
-->

78
doc/kexi/intro.docbook
Unescape View File

@ -0,0 +1,78 @@
<!--
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" >
-->
<chapter id="introduction">
<title>Introduction</title>
<!-- The introduction chapter contains a brief introduction for the
application that explains what it does and where to report
problems. Basically a long version of the abstract. Don't include a
revision history. (see installation appendix comment) -->
<para>
&kexi; is a database management application. It can be used for
creating databases, inserting data, performing queries, and processing
data. Forms can be created to provide a custom interface to your
data. All database objects - tables, queries and forms - are stored in
the database, making it easy to share data and design.
</para>
<para>
&kexi; is part of the &koffice; productivity suite for the K Desktop
Environment.
</para>
<para>
In addition to storing your &kexi; databases in files, &kexi; can also
store your data on a <firstterm>database server</firstterm>. Using
a database server allows you to share your database with other
people, and also allows more than one person to use the database at
one time. The following database servers are supported by &kexi;:
<itemizedlist>
<listitem>
<para>
MySQL (See <ulink url="http://www.mysql.com/"
>http://www.mysql.com/</ulink>)
</para>
</listitem>
<listitem>
<para>
PostgreSQL (See <ulink url="http://www.postgresql.org/"
>http://www.postgresql.org/</ulink>)
</para>
</listitem>
</itemizedlist>
</para>
<para>
More information about &kexi; can be found at the &kexi; page on the
&koffice; website
at <ulink
url="http://www.koffice.org/kexi/">http://www.koffice.org/kexi/</ulink>,
and on the website for &kexi; itself
at <ulink url="http://www.kexi-project.org/about.html"
>http://www.kexi-project.org/about.html</ulink>.
</para>
<para>
If you have any questions about &kexi;, there are two mailing lists
you can use. The <ulink url="mailto:kexi@kde.org">Kexi user mailing
list</ulink> can be used to ask questions about using &kexi; or about
the &kexi; project. The <ulink url="mailto:kexi-devel@kde.org">Kexi
development mailing list</ulink> can be used to ask questions about
the development of &kexi;. Further information on how to subscribe
to these lists, together with a few other ways of making contact with
&kexi; developers, can be found at:
<itemizedlist>
<listitem>
<para>
<ulink
url="http://www.kexi-project.org/support.html"
>http://www.kexi-project.org/support.html</ulink>
</para>
</listitem>
</itemizedlist>
</para>
</chapter>

701
doc/kexi/menus.docbook
Unescape View File

@ -0,0 +1,701 @@
<!--
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" >
-->
<chapter id="menus">
<chapterinfo>
<authorgroup>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annemarie.mahfouf@free.fr</email></address>
</affiliation>
</author>
<author>
<personname>
<firstname>Jarosław</firstname>
<surname>Staniek</surname>
</personname>
<email>js@iidea.pl</email>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Command Reference</title>
<sect1 id="filemenu">
<title>The <guimenu>File</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>New...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Create a new project.</action> Currently opened project is not affected.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Open...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open an existing project.</action> Currently opened project is not affected.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Download Example Databases...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Open the KNewStuff dialog</action> which
allows you to download example databases via the
Internet. This is currently not available for MS Windows.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Saves object changes from the active window.</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Import</guisubmenu>
<guimenuitem>Data Table...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Imports table data from a file in Comma Separated Value (CSV) format.</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Export</guisubmenu>
<guimenuitem>Table or Query as Data Table...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Export data from the active table or query data to a file in Comma Separated Value (CSV) format.</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Print...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Print data from the active (opened) table or query.</action></para>
<important><para>Note for KDE: Make sure the proper print system is selected in the
<quote>Print system currently used:</quote> section. This option can
be seen after clicking on the <guimenu>Options&gt;&gt;</guimenu> button.</para></important></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Print Preview...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Show print preview for the active (opened) table or query.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Page Setup...</guimenuitem>
</menuchoice></term>
<listitem><para><guibutton>Set Font...</guibutton> for the <guilabel>Page title:</guilabel>,
<guibutton>Change...</guibutton> <guilabel>Page Size &amp; Margins</guilabel> and
<guilabel>Add table borders</guilabel>.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Close Project</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Close the currently opened project but leave &kexi; running.
</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Quit</action> &kexi;.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="editmenu">
<title>The <guimenu>Edit</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Undo</guimenuitem>
</menuchoice></term>
<listitem><para><action>Undoes an action.</action> You can revert to the state that existed
before your last change.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl; &Shift; <keycap>Z</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Redo</guimenuitem>
</menuchoice></term>
<listitem><para><action>Undoes an undo.</action> Reverse the action of Undo. This will restore the change
you originally made.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Cut</guimenuitem>
</menuchoice></term>
<listitem><para><action>Remove currently selected text and put it on the clipboard.</action>
This command is unavailable if there is no text currently selected. If this action is used
in the Form Designer, currently selected widget or group of widgets are removed and put on the clipboard.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Copy</guimenuitem>
</menuchoice></term>
<listitem><para><action>Copy currently selected text onto the clipboard. </action>
This command is unavailable if there is no text currently selected. If this action is used
in the Form Designer, currently selected widget or group of widgets are copied onto
the clipboard.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Paste</guimenuitem>
</menuchoice></term>
<listitem><para><action>Copy of the clipboard contents at the insertion point. </action>
This command is unavailable if the clipboard is empty. If this action is used
in the Form Designer and the clipboard contains copied widgets, they will be inserted
onto the form.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guisubmenu>Copy Special</guisubmenu>
<guimenuitem>Table or Query As Data Table...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Copy selected table or query data to clipboard.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guisubmenu>Paste Special</guisubmenu>
<guimenuitem>As Data Table...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Paste clipboard data to a new table within the current project.
</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Select All</guimenuitem>
</menuchoice></term>
<listitem><para><action>Select all characters in the edited text box or all widgets in the Form Designer.
</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Delete</guimenuitem>
</menuchoice></term>
<listitem><para><action>Delete the currently selected object.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Delete</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Delete Row</guimenuitem>
</menuchoice></term>
<listitem><para><action>Delete currently selected row from a table.</action></para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="viewmenu">
<title>The <guimenu>View</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut><keycap>F6</keycap></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Data View</guimenuitem>
</menuchoice></term>
<listitem><para><action>Switch to Data View.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut><keycap>F7</keycap></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Design View</guimenuitem>
</menuchoice></term>
<listitem><para><action>Switch to Design View.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut><keycap>F8</keycap></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Text View</guimenuitem>
</menuchoice></term>
<listitem><para><action>Switch to Text View.</action> Currently, only available for database queries
and means switching to the SQL View of the Query Designer.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>1</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Project Navigator</guimenuitem>
</menuchoice></term>
<listitem><para><action>Go to Project Navigator pane.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>2</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Main Area</guimenuitem>
</menuchoice></term>
<listitem><para><action>Go to the main area.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>3</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Property Editor</guimenuitem>
</menuchoice></term>
<listitem><para><action>Go to the Property Editor pane.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Show/Hide Properties</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display or hide the Property Editor pane.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Show/Hide Project Navigator</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display or hide the Project Navigator pane.</action></para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="insertmenu">
<title>The <guimenu>Insert</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Insert</guimenu>
<guimenuitem>Table...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Inserts a new, empty table design without saving it.</action>
The Table Designer window will appear.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Insert</guimenu>
<guimenuitem>Query...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Inserts a new, empty query design without saving it.</action>
The Query Designer window will appear.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Insert</guimenu>
<guimenuitem>Form...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Inserts a new, empty form design without saving it.</action>
The Form Designer window will appear.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Insert</guimenu>
<guimenuitem>Script...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Inserts a new, empty script design without saving it.</action>
The Script Editor window will appear. The command is available only if scripting
is enabled in &kexi;.</para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="formatmenu">
<title>The <guimenu>Format</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Format</guimenu>
<guimenuitem>Font...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Change font for selected object.</action>
Can be used in the Form Designer to set widget's font.</para></listitem>
</varlistentry>
<!-- Forms -->
<varlistentry>
<term><menuchoice>
<guimenu>Format</guimenu>
<guimenuitem>Snap to Grid</guimenuitem>
</menuchoice></term>
<listitem><para><action>If this is enabled, when moving widgets on the form surface
the top left corner of the widget will snap or move to the nearest grid point.</action>
This does reduce your freedom to freely position widgets on the form surface,
however it also helps to line up widgets precisely.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Format</guimenu>
<guimenuitem>Layout Widgets</guimenuitem>
</menuchoice></term>
<listitem><para>Creates a new layout for widgets. Widgets can be layed out Horizontally, Vertically, In Grid, Horizontally in Splitter, Vertically in Splitter.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Format</guimenu>
<guimenuitem>Break Layout</guimenuitem>
</menuchoice></term>
<listitem><para><action>Breaks the currently selected layout.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Format</guimenu>
<guimenuitem>Align Widgets Position</guimenuitem>
</menuchoice></term>
<listitem><para><action>Align the currently selected widgets' position:
To Left, To Right, To Top, To Bottom, To Grid.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Format</guimenu>
<guimenuitem>Align Widgets Size</guimenuitem>
</menuchoice></term>
<listitem><para><action>Align the currently selected widgets' size:
To Fit, To Grid, To Shortest, To Tallest, To Narrowest, To Widest.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Format</guimenu>
<guimenuitem>Bring Widget to Front</guimenuitem>
</menuchoice></term>
<listitem><para><action>Bring the currently selected widgets to front.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Format</guimenu>
<guimenuitem>Send Widget to Back</guimenuitem>
</menuchoice></term>
<listitem><para><action>Send the currently selected widgets to back.</action></para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="datamenu">
<title>The <guimenu>Data</guimenu> Menu</title>
<!--when do the first two items appear ???-->
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Shift;<keycap>Return</keycap></keycombo>
</shortcut>
<guimenu>Data</guimenu>
<guimenuitem>Save Row</guimenuitem>
</menuchoice></term>
<listitem><para><action>Save currently selected table row's data.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Data</guimenu>
<guimenuitem>Cancel Row Changes</guimenuitem>
</menuchoice></term>
<listitem><para><action>Cancel changes made to currently selected table row.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Data</guimenu>
<guisubmenu>Sort</guisubmenu>
<guimenuitem>Ascending</guimenuitem>
</menuchoice></term>
<listitem><para><action>Sorts data in ascending order (from A to Z and from 0 to 9).</action>
Data from selected column is used for sorting.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Data</guimenu>
<guisubmenu>Sort</guisubmenu>
<guimenuitem>Descending</guimenuitem>
</menuchoice></term>
<listitem><para><action>Sorts data in descending (from Z to A and from 9 to 0).</action>
Data from selected column is used for sorting.</para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="toolsmenu">
<title>The <guimenu>Tools</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Import Database...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Opens the Data Base Importing Wizard</action>
to import an existing database into a &kexi; database.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Execute Script File...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays the file dialog</action>
to open an existing script file.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Scripts Manager...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays &kexi;'s <guilabel>Scripts Manager</guilabel>
dialog</action> to execute, load, unload, install, unistall or download scripts.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Scripts</guimenuitem>
</menuchoice></term>
<listitem><para><action>Executes an already loaded script.</action></para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="windowmenu">
<title>The <guimenu>Window</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo>
</shortcut>
<guimenu>Window</guimenu>
<guimenuitem>Close</guimenuitem>
</menuchoice></term>
<listitem><para><action>Close the active window.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Window</guimenu>
<guimenuitem>Close All</guimenuitem>
</menuchoice></term>
<listitem><para><action>Close all opened windows.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Window</guimenu>
<guisubmenu>MDI Mode</guisubmenu>
<guimenuitem>Childframe Mode</guimenuitem>
</menuchoice></term>
<listitem><para><action>Switch to Childframe user interface mode.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Window</guimenu>
<guisubmenu>MDI Mode</guisubmenu>
<guimenuitem>IDEAl Mode</guimenuitem>
</menuchoice></term>
<listitem><para><action><action>Switch to IDEAl user interface mode.</action></action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>Right</keycap></keycombo>
</shortcut>
<guimenu>Window</guimenu>
<guimenuitem>Next Window</guimenuitem>
</menuchoice></term>
<listitem><para><action>Switch to the next window.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>Left</keycap></keycombo>
</shortcut>
<guimenu>Window</guimenu>
<guimenuitem>Previous Window</guimenuitem>
</menuchoice></term>
<listitem><para><action>Switch to the previous window.</action></para></listitem>
</varlistentry>
</variablelist>
<para>The last items in this menu show the currently opened window names.</para>
</sect1>
<sect1 id="settingsmenu">
<title>The <guimenu>Settings</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Toolbars</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Show or hide one of the toolbars.</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Configure the keyboard shortcuts used by &kexi;.
</action> See the section on configuring shortcuts for more
details.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="helpmenu">
<title>The <guimenu>Help</guimenu> Menu</title>
&help.menu.documentation;
</sect1>
</chapter>

109
doc/kexi/querydesigning.docbook
Unescape View File

@ -0,0 +1,109 @@
<!--
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" >
-->
<sect1 id="designing-queries">
<title>Designing Database Queries</title>
<para>
A database's primary purpose is to store and help extract information
you are looking for. Unlike databases written on a paper sheets, &kexi;
database allows you to specify more search criteria. Results
are returend faster even for large data sets. All this is a power of
databases, however to be able to perform efffective <emphasis>queries</emphasis>
in your database, you need to learn how to tell the database what you are
looking for.
</para>
<para>
With database queries you can limit data coming from a table to a predefined
set of rows and columns as well as dynamically <firstterm>join</firstterm>
data coming from multiple tables.
</para>
<para>
To see how queries work in practice you will create a <literal>contacts</literal>
query joining data from two tables: <literal>persons</literal> and
<literal>phone_numbers</literal> (designed in
<!--<a href="05_01_00_table_designing.html">-->chapter 3.1i
<!--</a>-->
and filled with data in
<!--<a href="05_02_00_entering_data_into_tables.html">-->chapter 3.2
<!--</a>-->).
</para>
<procedure>
<step>
<para>
Create a new empty query by selecting <!--<img src="icons/query_newobj.png" class="icon">-->
<menuchoice><guimenu>Insert</guimenu><guimenuitem>Query</guimenuitem></menuchoice> from
the menubar. The design window will appear. <!--similar to the one presented in the
figure below. -->The window is split into two areas: query
relationships at the top and query columns below.
<!-- TODO update screenshot with names of window's areas -->
</para>
</step>
<step>
<para>
Select the table <literal>persons</literal> in the drop down list <guilabel>Table:</guilabel>
located at the top of the window and click the <guibutton>Add</guibutton> button. A graphical
representation of the table will appear in the relations area. Do the same for the
<literal>phone_numbers</literal> table to insert it too, as in the figure below.
</para>
<!--<screenshot>
<screeninfo><literal>contacts</literal> query design</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="img/05_03_00_query_design.png" format="PNG"/>
</imageobject>
<textobject>
<phrase><literal>contacts</literal> query design</phrase>
</textobject>
</mediaobject>
</screenshot>-->
</step>
<step>
<para>
Add query relationship using mouse drag &amp; drop technique: click the field
<literal>id</literal> in the table <literal>persons</literal> table, drag it
and drop into the <literal>person</literal> field of the <literal>phone_numbers</literal>
table. This will <emphasis>join both fields by creating a new relationship</emphasis>.
</para>
</step>
<step>
<para>
Double-click the <literal>name</literal> field in the <literal>persons</literal>
table, to add the field as a <firstterm>query column</firstterm>. In a similar way,
add <literal>surname</literal>, <literal>street</literal>, <literal>house_number</literal>,
<literal>city</literal> fields from the <literal>persons</literal> table and
<literal>phone</literal> from the <literal>phone_numbers</literal> table.
</para>
</step>
<step>
<para>
Query design is now ready for testing. Click the <!--<img src="icons/state_data.png" class="icon">-->
<guibutton>Switch to data view</guibutton> button on the toolbar, to switch from
design to viewing the data provided as query results.
</para>
<!--<screenshot>
<screeninfo><literal>Contacts</literal> query results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="img/05_03_00_query_results.png" format="PNG"/>
</imageobject>
<textobject>
<phrase><literal>Contacts</literal> query results</phrase>
</textobject>
</mediaobject>
</screenshot>-->
</step>
<step>
<para>
Save the query design for later use by clicking the <!--<img src="icons/filesave.png" class="icon">-->
<guibutton>Save</guibutton> button on the toolbar. You can also use
<menuchoice><guimenu>File</guimenu><guimenuitem>Save</guimenuitem></menuchoice>
from the menubar or press the <keycombo action="simul"><keycap>Ctrl</keycap><keycap>S</keycap></keycombo>
keys. Because the query design has not been saved yet, you will be asked to
specify a name for it. Enter <literal>Contacts</literal> text in the
<guilabel>caption</guilabel> field and click the <guibutton>OK</guibutton> button.
</para>
</step>
</procedure>
</sect1>

4
doc/kformula/Makefile.am
Unescape View File

@ -0,0 +1,4 @@
KDE_LANG = en
KDE_DOCS = AUTO

BIN
doc/kformula/ambiguous-string.png
View File

Binary file not shown.

BIN
doc/kformula/correct_index_location.png
View File

Binary file not shown.

BIN
doc/kformula/definite_integral.png
View File

Binary file not shown.

BIN
doc/kformula/file-toolbar.png
View File

Binary file not shown.

BIN
doc/kformula/file-toolbar2.png
View File

Binary file not shown.

BIN
doc/kformula/green1.png
View File

Binary file not shown.

BIN
doc/kformula/green2.png
View File

Binary file not shown.

BIN
doc/kformula/greens.png
View File

Binary file not shown.

BIN
doc/kformula/incorrect_index_location.png
View File

Binary file not shown.

1246
doc/kformula/index.docbook
View File

File diff suppressed because it is too large Load Diff

BIN
doc/kformula/index_smear.png
View File

Binary file not shown.

BIN
doc/kformula/kfontinst1.png
View File

Binary file not shown.

BIN
doc/kformula/kfontinst2.png
View File

Binary file not shown.

BIN
doc/kformula/kfontinst3.png
View File

Binary file not shown.

BIN
doc/kformula/kfontinst4.png
View File

Binary file not shown.

BIN
doc/kformula/kfontinst5.png
View File

Binary file not shown.

BIN
doc/kformula/kfontinst6.png
View File

Binary file not shown.

BIN
doc/kformula/lower-index.png
View File

Binary file not shown.

BIN
doc/kformula/matrix-view.png
View File

Binary file not shown.

BIN
doc/kformula/matrix.png
View File

Binary file not shown.

BIN
doc/kformula/negative_thin_space.png
View File

Binary file not shown.

BIN
doc/kformula/path-integral.png
View File

Binary file not shown.

BIN
doc/kformula/rk-edit0.png
View File

Binary file not shown.

BIN
doc/kformula/rk-edit1.png
View File

Binary file not shown.

BIN
doc/kformula/rk-edit2.png
View File

Binary file not shown.

BIN
doc/kformula/scilab-edit.png
View File

Binary file not shown.

BIN
doc/kformula/scilab.png
View File

Binary file not shown.

BIN
doc/kformula/shortcut0.png
View File

Binary file not shown.

BIN
doc/kformula/shortcut1.png
View File

Binary file not shown.

BIN
doc/kformula/sin.png
View File

Binary file not shown.

BIN
doc/kformula/toolbars.png
View File

Binary file not shown.

BIN
doc/kformula/upper-index.png
View File

Binary file not shown.

4
doc/kivio/Makefile.am
Unescape View File

@ -0,0 +1,4 @@
KDE_LANG = en
KDE_DOCS = AUTO

64
doc/kivio/credits.docbook
Unescape View File

@ -0,0 +1,64 @@
<chapter id="credits">
<chapterinfo>
<authorgroup>
<author><firstname>Ben</firstname>
<surname>Lamb</surname>
<affiliation>
<address>
<email>kde@zurgy.org</email>
</address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Credits and License</title>
<para>
&kivio;
</para>
<para>
Program copyright 2000-2003 The &kivio; Team
</para>
<para>
Current maintainer is Peter Simonsonn <email>psn@linux.se</email>.
</para>
<itemizedlist>
<title>Contributors</title>
<listitem>
<para>Ian Reinhart Geiser <email>geiseri@kde.org</email></para>
</listitem>
<listitem>
<para>Laurent Montel <email>montel@kde.org</email></para>
</listitem>
<listitem>
<para>Frauke Oster <email>frauke@frsv.de</email></para>
</listitem>
<listitem>
<para>Dave Marotti <email>lndshark@verticaladdiction.net</email></para>
</listitem>
<listitem>
<para>The Kompany.com - "<trademark>Where Open Source is at Home</trademark>" <email>info@thekompany.com</email></para>
</listitem>
<listitem>
<para>Current documentation is maintained by Ben Lamb
<email>kde@zurgy.org</email></para>
</listitem>
</itemizedlist>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>

64
doc/kivio/index.docbook
Unescape View File

@ -0,0 +1,64 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY package "koffice">
<!ENTITY kappname "&kivio;">
<!ENTITY introduction SYSTEM "introduction.docbook">
<!ENTITY usage SYSTEM "usage.docbook">
<!ENTITY working SYSTEM "working.docbook">
<!ENTITY credits SYSTEM "credits.docbook">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
<book lang="&language;">
<bookinfo>
<title>The &kivio; Handbook</title>
<authorgroup>
<author>
<firstname>Ben</firstname>
<surname>Lamb</surname>
<affiliation>
<address>
<email>kde@zurgy.org</email>
</address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<date>2006-01-30</date>
<releaseinfo>1.5.0</releaseinfo>
<copyright>
<year>2003</year><year>2000</year>
<holder>Ben Lamb</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<abstract>
<para>
&kivio; is the &koffice; flowchart and diagram creation tool.
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>Kivio</keyword>
<keyword>KOffice</keyword>
<keyword>Flowchart</keyword>
<keyword>Diagram</keyword>
</keywordset>
</bookinfo>
&introduction;
&usage;
&working;
&credits;
</book>

33
doc/kivio/introduction.docbook
Unescape View File

@ -0,0 +1,33 @@
<chapter id="introduction">
<chapterinfo>
<authorgroup>
<author><firstname>Ben</firstname>
<surname>Lamb</surname>
<affiliation>
<address>
<email>kde@zurgy.org</email>
</address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Introduction</title>
<sect1 id="what-is">
<title>What is &kivio;?</title>
<para>&kivio; is the &koffice; flowchart and diagram creation tool. It allows you to create accurate scale diagrams by arranging pre-drawn shapes and 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 which are grouped into collections, known as stencil sets, by subject area.</para>
</sect1>
<sect1 id="this-document">
<title>About this Document</title>
<para>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.</para>
</sect1>
<sect1 id="contributing">
<title>Contributing to &kivio;</title>
<para>&kivio; is a volunteer project. Your contributions are welcome. If you find a bug whilst using the software please report it by selecting <menuchoice><guimenu>Help</guimenu><guimenuitem>Report Bug...</guimenuitem></menuchoice>.</para>
<para>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.</para>
</sect1>
</chapter>

203
doc/kivio/usage.docbook
Unescape View File

@ -0,0 +1,203 @@
<chapter id="usage">
<chapterinfo>
<authorgroup>
<author><firstname>Ben</firstname>
<surname>Lamb</surname>
<affiliation>
<address>
<email>kde@zurgy.org</email>
</address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Basic Usage</title>
<sect1 id="starting">
<title>Starting &kivio;</title>
<para>Like other &koffice; applications, on startup &kivio; presents a startup dialog. The dialog offers a choice of creating a new document, opening a saved document or choosing a document from a list of recently saved files.</para>
<para>If you're new to &kivio; begin by creating an empty document by double-clicking on the <guilabel>Empty Document</guilabel> template.</para>
<para>&kivio;'s main window contains a view of the current document. The page outline and margins are shown, as is a grid. Surrounding this view are horizontal and vertical rules. By default a tools toolbar is placed on the left-hand side and beneath the document view is a page selector. Beneath that is the status bar which shows the current position of the mouse pointer as a location on the page.</para>
<para>At the top of the window are the two main toolbars. These contain buttons for the most commonly used features of &kivio;.</para>
</sect1>
<sect1 id="stencils">
<title>Using Stencils</title>
<para>Diagrams are created by placing different pre-drawn shapes and stencils on the page. Stencils can represent many different things and &kivio; comes with a wide selection. For ease of reference they are grouped into collections known as stencil sets. To use a stencil set select <menuchoice><guimenu>Tools</guimenu><guisubmenu>Add Stencil Set</guisubmenu></menuchoice>. 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.</para>
<para>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.</para>
<para>To place a stencil onto the document simply drag it from the stencil area to the page.</para>
<sect2>
<title>Selecting Stencils</title>
<para>
&kivio; identifies the stencil currently being edited by displaying eight green squares on the corners and edges of a square around the stencil. Stencils shown in this manner are described as being selected. The green rectangles are known as handles.
To change the currently selected stencil move the mouse pointer over the stencil you wish to select and press the &LMB;.
To select all the stencils on the current page select <menuchoice><guimenu>Edit</guimenu><guimenuitem>Select All</guimenuitem></menuchoice>.
To deselect all stencils select <menuchoice><guimenu>Edit</guimenu><guimenuitem>Deselect</guimenuitem></menuchoice>.
</para>
</sect2>
<sect2>
<title>Moving Stencils</title>
<para>
To move a stencil to another position on the page, select the stencil. Note the pointer will change to a hand icon. Hold down the &LMB; and move the mouse to the new position. Release the mouse button to place the stencil at the new position.</para>
</sect2>
<sect2>
<title>Resizing a Stencil</title>
<para>Select the stencil, and then move the mouse pointer over one of the handles. Note the mouse pointer change. Hold down the &LMB; and move the mouse. The coordinates of the stencil will be adjusted continuously as the mouse is moved. When you are happy with the new size release the mouse button to give the stencil its new final size.</para>
</sect2>
<sect2>
<title>Undoing a Mistake</title>
<para>If at any time you are unhappy with a change you have made to the document you can select <menuchoice><guimenu>Edit</guimenu><guimenuitem>Undo</guimenuitem></menuchoice> to revert the change. There is also an icon on the toolbar.</para>
<para>If you undo an action and decide that was a mistake, select <menuchoice><guimenu>Edit</guimenu><guimenuitem>Redo</guimenuitem></menuchoice> to restore the change. &kivio; stores multiple actions to undo/redo several changes.</para>
</sect2>
<sect2>
<title>Limitations of the Stencils</title>
<para>Note that stencils cannot currently be rotated.</para>
</sect2>
<sect2>
<title>Labeling Stencils</title>
<para>A lot of stencils in the <guilabel>Flowcharting Collections</guilabel>, <guilabel>Geographic Collections</guilabel>, <guilabel>Hardware Collections</guilabel>, <guilabel>Miscellaneous Collections</guilabel> and <guilabel>UML Collections</guilabel> can contain text to describe their function. To add text to a stencil move the mouse pointer over the stencil and double-click it or open the context menu with the &RMB; and select <guimenuitem>Edit Text...</guimenuitem>. A dialog box will appear prompting for some text. Enter some text and click <guibutton>OK</guibutton>. The text should be shown inside the stencil.</para>
<para>The item <guimenuitem>Edit Text...</guimenuitem> in the menu is disabled, if a stencil cannot be labeled.</para>
<para>The font, size, alignment and style of the text can be adjusted by selecting <menuchoice><guimenu>Format</guimenu><guimenuitem>Text...</guimenuitem></menuchoice>. Alternatively use the buttons on the Format toolbar.
The adjustments will only affect the currently selected stencil.</para>
</sect2>
<sect2>
<title>Selecting Several Stencils</title>
<para>There are two ways to select multiple stencils in &kivio;.</para>
<orderedlist>
<listitem>
<para>Click once inside the first stencil you wish to select.
Hold down &Ctrl; as you click inside subsequent stencils.
All the stencils will be shown with handles around them.</para>
</listitem>
<listitem>
<para>Move the mouse pointer to a blank area of the document near the stencils you want to select.</para>
<para>Hold down the &LMB; and move the mouse to the other side of the stencils you want to select, drawing a rectangle around them.</para>
<para>The rectangle must completely encompass the stencils for them to be selected.
</para>
</listitem>
</orderedlist>
</sect2>
<sect2>
<title>Adjusting the Fill Color and Line Color</title>
<para>Stencils can be filled with a solid color and the color of the outline can be changed. Select a stencil then select <menuchoice><guimenu>Format</guimenu><guimenuitem>Stencils &amp; Connectors...</guimenuitem></menuchoice>.</para>
<!--para>There is also a <guibutton>Set Background Color</guibutton> button on the Format toolbar. Clicking on the arrow to the right-hand side of this button will display 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.</para-->
</sect2>
<sect2>
<title>Adjusting the Line Thickness</title>
<para>The width of a stencil's border can be adjusted by selecting <menuchoice><guimenu>Format</guimenu><guimenuitem>Stencils &amp; Connectors...</guimenuitem></menuchoice>. The line width can be entered in centimeters or increased/decreased using the arrows of the spin box. Or use the <guibutton>Line Width</guibutton> button on the <guilabel>Format</guilabel> toolbar. Select a width from the drop down box or select <guilabel>Custom...</guilabel> to open enter the width in the spin box.</para>
</sect2>
<sect2>
<title>Connecting Shapes Together</title>
<para>&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.</para>
<para>To draw a connector select <menuchoice><guimenu>Tools</guimenu><guimenuitem>Straight Connector</guimenuitem></menuchoice> or <menuchoice><guimenu>Tools</guimenu><guimenuitem>Polyline Connector</guimenuitem></menuchoice>.</para>
<para>The <guilabel>Polyline Connector</guilabel> tool is also available from the <guilabel>Tools</guilabel> toolbar; by default shown on the top side of the window. Click on this tool to begin using it; the mouse pointer will change shape.</para>
<para>Notice that all stencils have little blue crosses around their edges. These crosses mark points where connectors can be attached.</para>
<para>To connect two stencils move to one of the connection points on the first stencil, hold down the &LMB; and drag a line to one of the connection points on the second stencil. The green square at the end of the line will change to red when it is over a connection point indicating that the line is attached to a stencil. </para>
<para>When you have finished using the connector tool, click on the <guiicon>Arrow</guiicon> tool to regain normal selection functionality.</para>
<note><para>A stencil can have multiple connectors attached to it, even at the same connection point.</para></note>
<para>Various properties of the connector can be adjusted including line thickness and color, this is done in the same way as for stencils.</para>
<para><guilabel>Straight Connectors</guilabel> may also be labeled with text. To add text to a straight connector open the context menu with the &RMB; and select <guimenuitem>Edit Text...</guimenuitem>. 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.</para>
<para>Arrowheads can be added to either end of a connector. Select the connector and then select <menuchoice><guimenu>Format</guimenu><guimenuitem>Arrowheads...</guimenuitem></menuchoice>.</para>
<para>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. </para>
</sect2>
<sect2>
<title>Grouping Stencils</title>
<para>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.</para>
<para>To make a group select the stencils and select <menuchoice><guimenu>Format</guimenu><guimenuitem>Group Selection</guimenuitem></menuchoice>.</para>
<para>The procedure can be reversed by selecting a group of stencils and select <menuchoice><guimenu>Format</guimenu><guimenuitem>Ungroup</guimenuitem></menuchoice>.</para>
</sect2>
<sect2>
<title>Overlaying Stencils</title>
<para>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 <menuchoice><guimenu>Format</guimenu><guimenuitem>Bring to Front</guimenuitem></menuchoice> or <menuchoice><guimenu>Format</guimenu><guimenuitem>Send to Back</guimenuitem></menuchoice>.</para>
<para><guimenuitem>Send to Back</guimenuitem> will cause the stencil to be obscured by any stencil which overlaps it. <guimenuitem>Bring to Front</guimenuitem> will cause the stencil to obscure any stencil which it overlaps.</para>
</sect2>
<sect2>
<title>Locking Stencils</title>
<para>A stencil's properties may be <quote>locked</quote> to prevent accidental changes. To alter a stencil's protection use the protection palette. This can be displayed by selecting <menuchoice><guimenu>View</guimenu><guisubmenu>Palettes</guisubmenu><guimenuitem>Show Protection</guimenuitem></menuchoice>. Select the stencil or stencils you wish to protect and then tick the properties you want to protect on the protection palette.</para>
<para>The protections available are: <guilabel>Width</guilabel>, <guilabel>Height</guilabel>, <guilabel>Aspect ratio</guilabel>, <guilabel>X position</guilabel>, <guilabel>Y position</guilabel> and <guilabel>Deletion</guilabel>. Deletion prevents a stencil from being deleted from the document.</para>
</sect2>
<sect2>
<title>Stencil Geometry</title>
<para>For accurately specifying the dimensions of a stencil use the Geometry palette. To display the palette select <menuchoice><guimenu>View</guimenu><guisubmenu>Palettes</guisubmenu><guimenuitem>Show Geometry</guimenuitem></menuchoice>. The palette contains four spin boxes for specifying the horizontal (<guilabel>X:</guilabel>) and vertical (<guilabel>Y:</guilabel>) position of the stencil and the <guilabel>Width:</guilabel> and <guilabel>Height:</guilabel>.</para>
<tip><para>Although the measurements are displayed in centmeters it is possible to enter other units into the textbox. For example, entering 2.5 mm will be converted into centimeter. Points (pt) and inches (in) are also accepted.</para></tip>
</sect2>
</sect1>
<sect1 id="viewing">
<title>Viewing the Document</title>
<sect2>
<title>Zooming In and Out</title>
<para>To adjust the zoom level select <menuchoice><guimenu>View</guimenu><guisubmenu>Zoom Level</guisubmenu></menuchoice>. This submenu contains a list of percentages from 33% to 500%; selecting one of these magnify the document by that percentage.</para>
<para>There is also a list of zoom levels in a spin box on the <guilabel>Edit</guilabel> toolbar, by default shown at the top of the screen.</para>
<para>A second method of controlling the magnification is to use the zoom tool. This is available on the <guilabel>Tools</guilabel> toolbar. This tool can be used in two ways. Clicking on the document with the zoom tool active will increase the magnification. Holding down the &Shift; key whilst clicking will decrease the magnification, &ie; zoom out.</para>
<para>Alternatively, holding down the &LMB; and dragging out a box then releasing the mouse button will increase the magnification so that that portion of the document fills the available space.</para>
</sect2>
<sect2>
<title>Panning the Document</title>
<para>The <guiicon>Pan Document</guiicon> tool lets you move the document around, adjusting the portion that is visible. This is very useful when working at high magnifications where the entire document is not completely visible. To pan a document select <guiicon>Pan Document</guiicon> from the <guilabel>Tools</guilabel> toolbar or <menuchoice><guimenu>Tools</guimenu><guisubmenu>Pan Document</guisubmenu></menuchoice> in the menu. Once activated the mouse pointer turns into a hand. To move the document move the mouse over the currently visible portion, hold down the &LMB; and drag.</para>
</sect2>
<sect2>
<title>The Overview</title>
<para>The <guilabel>Overview</guilabel> palette provides a quick way of adjusting the zoom level and moving around the document. To enable it select <menuchoice><guimenu>View</guimenu><guisubmenu>Palettes</guisubmenu><guimenuitem>Overview</guimenuitem></menuchoice>.</para>
<para>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.</para>
<para>At the bottom of the palette there is a slider and two buttons to zoom 25% in or out.</para>
</sect2>
<sect2>
<title>Using Palettes</title>
<para>All palettes have a handle on the top side which enables them to be moved around and positioned on any edge of the main view. They can also float anywhere on the screen. To hide or show a palette select it from <menuchoice><guimenu>View</guimenu><guisubmenu>Palettes</guisubmenu></menuchoice>.</para>
</sect2>
<sect2>
<title>Multiple Views</title>
<para>It is possible to have multiple views of the same document displayed simultaneously.</para>
<para>Select <guimenuitem>New View</guimenuitem> from the <guimenu>View</guimenu> menu and a new &kivio; window showing the same document will appear. This is very useful for multiple monitor setups.</para>
<para>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 <menuchoice><guimenu>View</guimenu><guimenuitem>Close All Views</guimenuitem></menuchoice>.</para>
</sect2>
<sect2>
<title>Split Views</title>
<para>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 <menuchoice><guimenu>View</guimenu><guimenuitem>Split View</guimenuitem></menuchoice>. The orientation of the split can be changed from horizontal to vertical using <menuchoice><guimenu>View</guimenu><guisubmenu>Splitter Orientation</guisubmenu></menuchoice>. To restore the window to its original state select <menuchoice><guimenu>View</guimenu><guimenuitem>Remove View</guimenuitem></menuchoice>.</para>
</sect2>
<!--sect2>
<title>The View Manager</title>
<para>The View Manager allows you to store the current display settings, including zoom level and position. You can then adjust the view and still be able to revert back to the previous settings. A number of different settings can be stored and given names for ease of reference.</para>
<para>To display the View Manager choose <menuchoice><guimenu>View</guimenu><guisubmenu>Docker</guisubmenu><guimenuitem>View Manager</guimenuitem></menuchoice>. The docker contains five buttons and a list of stored views.</para>
<para>The first button, <guibutton>Add Current View</guibutton>, stores the current display settings. Once the settings have been stored you can modify the display settings. To revert to any one of the stored settings click on its name in the list.</para>
<para>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, <guibutton>Rename Item</guibutton>; this lets you enter your own text.</para>
<para>The second button, <guibutton>Remove Item</guibutton>, removes the currently selected set of stored settings.</para>
<para>The final two buttons, <guibutton>Move Item Up</guibutton> and <guibutton>Move Item Down</guibutton>, allow the order of the settings in the list to be adjusted.</para>
</sect2-->
<sect2>
<title>Customizing the Display</title>
<para>The <guimenu>View</guimenu> menu contains options for toggling the display of page margins, rulers, guides and the grid.</para>
</sect2>
</sect1>
</chapter>

212
doc/kivio/working.docbook
Unescape View File

@ -0,0 +1,212 @@
<chapter id="working">
<chapterinfo>
<authorgroup>
<author><firstname>Ben</firstname>
<surname>Lamb</surname>
<affiliation>
<address>
<email>kde@zurgy.org</email>
</address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Working with &kivio;</title>
<sect1 id="opening">
<title>Opening a Document</title>
<para>To open a previously saved document select <menuchoice><guimenu>File</guimenu><guimenuitem>Open...</guimenuitem></menuchoice>, a standard &kde; file dialog box will appear.</para>
<para>Recently used documents are listed under <menuchoice><guimenu>File</guimenu><guisubmenu>Open Recent</guisubmenu></menuchoice>.</para>
</sect1>
<sect1 id="saving">
<title>Saving a Document</title>
<para>To save the current document select <menuchoice><guimenu>File</guimenu><guimenuitem>Save</guimenuitem></menuchoice> or <menuchoice><guimenu>File</guimenu><guimenuitem>Save As...</guimenuitem></menuchoice> to give an existing file a different name.</para>
<note><para>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 <guilabel>Filter:</guilabel> combo box in the save file dialog.</para></note>
</sect1>
<sect1 id="printing">
<title>Printing</title>
<para>The document can be printed by selecting <menuchoice><guimenu>File</guimenu><guimenuitem>Print...</guimenuitem></menuchoice>. The standard &kde; printing dialog appears. A preview of the printed output can be obtained by selecting <menuchoice><guimenu>File</guimenu><guimenuitem>Print Preview...</guimenuitem></menuchoice>.</para>
</sect1>
<sect1 id="import-export">
<title>Importing/Exporting Documents</title>
<para>The <guimenuitem>Import...</guimenuitem> menu option on the <guimenu>File</guimenu> menu currently loads a &kivio; or &XML; document into a new &kivio; application.</para>
<para>The <guimenuitem>Export...</guimenuitem> menu option on the <guimenu>File</guimenu> menu currently perform the same functions as <menuchoice><guimenu>File</guimenu> <guimenuitem>Save As...</guimenuitem></menuchoice>. These options let you save a document under a different name or into an other format.</para>
</sect1>
<sect1 id="multiple-pages">
<title>Documents with Multiple Pages</title>
<para>A &kivio; document can contain several pages of diagrams.</para>
<sect2>
<title>Adding Pages</title>
<para>To <action>add additional pages</action> to a document select <menuchoice><guimenu>Page</guimenu><guimenuitem>Insert Page</guimenuitem></menuchoice> or click with the &RMB; on the page tab and select <guimenuitem>Insert Page</guimenuitem> from the context menu. The selector beneath the document view shows tabs for all the pages in the document that have not been hidden.</para>
</sect2>
<sect2>
<title>Removing Pages</title>
<para>Unwanted pages can be removed by selecting <menuchoice><guimenu>Page</guimenu><guimenuitem>Remove Page</guimenuitem></menuchoice> or click with the &RMB; on the page tab and select <guimenuitem>Remove Page</guimenuitem> from the context menu.</para>
</sect2>
<sect2>
<title>Renaming Pages</title>
<para>The names given to each page can be adjusted by double-clicking on the page name on the page selector or by clicking with the &RMB; on the page tab and select <guimenuitem>Rename Page...</guimenuitem> from the context menu. A dialog box will appear allowing the name to be edited.</para>
</sect2>
<sect2>
<title>Working with Pages</title>
<para>The order of the pages can be adjusted by dragging the tabs on the page selector bar.</para>
<note><para>The arrow buttons on the page selector bar are for scrolling through the page tabs, they do not cycle through the pages themselves.</para></note>
<para>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 <menuchoice><guimenu>Page</guimenu><guimenuitem>Hide Page</guimenuitem></menuchoice>. This will remove the currently selected page from the page selector bar.</para>
<para>To reveal a hidden page select <menuchoice><guimenu>Page</guimenu><guimenuitem>Show Page...</guimenuitem></menuchoice> and choose the page you want to see from the list box.</para>
</sect2>
</sect1>
<sect1 id="page-export">
<title>Exporting a Page</title>
<para>Individual pages can be exported as bitmap graphics files. To export the current page select <menuchoice><guimenu>File</guimenu> <guimenuitem>Export...</guimenuitem></menuchoice> or <menuchoice><guimenu>File</guimenu> <guimenuitem>Save As...</guimenuitem></menuchoice>. A standard &kde; file dialog box appears. The export format is determined by the name extension you give the file, it must end with one of the extensions listed below.</para>
<para>The following formats are supported:</para>
<itemizedlist>
<listitem><para>PNG Image (.png)</para></listitem>
<listitem><para>JPEG Image (.jpg)</para></listitem>
<listitem><para>BMP Image (.bmp)</para></listitem>
<listitem><para>Encapsulated Postscript Image (.eps)</para></listitem>
<listitem><para>Portable Bitmap (.pbm)</para></listitem>
<listitem><para>PCX Image (.pcx)</para></listitem>
<listitem><para>Portable Pixmap Image (.ppm)</para></listitem>
<listitem><para>SGI Image (RGB) (.rgb)</para></listitem>
<listitem><para>X PixMap Image (.xpm)</para></listitem>
<listitem><para>JPEG 2000 Image (.jp2)</para></listitem>
<listitem><para>Krita Document (.kra)</para></listitem>
<listitem><para>Adobe Illustrator Document (.ai)</para></listitem>
<listitem><para>TIFF Image (.tiff)</para></listitem>
<listitem><para>ILM EXR Image (.exr)</para></listitem>
<listitem><para>Karbon14 Document (.karbon)</para></listitem>
<listitem><para>GIMP Native Image Format (.xcf)</para></listitem>
<listitem><para>Scalable Vector Graphics (.svg)</para></listitem>
<listitem><para>&Windows; MetaFile (.wmf)</para></listitem>
</itemizedlist>
<para>You have to confirm the export, because this may result in some loss of formatting. Click the button <guibutton>Save</guibutton> and the <guilabel>Export to Image</guilabel> dialog is displayed. In this dialog you can set some export options: <guilabel>Page:</guilabel> range, the <guilabel>Area to export:</guilabel>, the <guilabel>Custom size (in pixels):</guilabel> and the <guilabel>Margin:</guilabel> of the page.</para>
</sect1>
<sect1 id="grid">
<title>The Grid</title>
<para>&kivio; displays a regularly spaced grid over the document to aid stencil positioning. The visibility of the grid can be toggled by selecting <menuchoice><guimenu>View</guimenu><guimenuitem>Show Grid</guimenuitem></menuchoice>.</para>
<para>Objects edges are snapped to the nearest point on the grid regardless of whether it is visible. To toggle this behavior select <menuchoice><guimenu>View</guimenu><guimenuitem>Snap Grid</guimenuitem></menuchoice>.</para>
<para>To customize the grid select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kivio;...</guimenuitem></menuchoice> and click on the <guiicon>Grid</guiicon> on the icon list.</para>
<para>This dialog box will let you adjust the color the grid is drawn in, the horizontal and vertical spacing and the snap distance.</para>
<para>Tip: It is possible to have a non-square grid by specifying different horizontal and vertical spacings.</para>
</sect1>
<sect1 id="text-tool">
<title>Freestanding Text</title>
<para>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.</para>
<para>To add freestanding text make sure no object is selected by selecting <menuchoice><guimenu>Edit</guimenu><guimenuitem>Deselect </guimenuitem></menuchoice>, then activate the text tool by selecting <menuchoice><guimenu>Tools</guimenu><guimenuitem>Text Tool</guimenuitem></menuchoice>. The mouse pointer will change to indicate the text tool is activated.</para>
<para>Drag a box to contain the text. A dialog box will appear prompting for the text, enter some text and click <guibutton>OK</guibutton>. The formatting of the text can be adjusted by selecting <menuchoice><guimenu>Format</guimenu><guimenuitem>Text...</guimenuitem></menuchoice> or by using the toolbars.</para>
</sect1>
<sect1 id="page-layout">
<title>Page Layout</title>
<para>The page size, margins and orientation, portrait or landscape, can be adjusted using the <guilabel>Page Size &amp; Margins</guilabel> dialog box. This is accessible by selecting <menuchoice><guimenu>Format</guimenu><guimenuitem>Page Layout...</guimenuitem></menuchoice>.</para>
</sect1>
<sect1 id="guides">
<title>Using Guides</title>
<para>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.</para>
<sect2>
<title>Adding Guides</title>
<para>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 &LMB; 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.
Or use <menuchoice><guimenu>View</guimenu><guimenuitem>Add Guide Line...</guimenuitem></menuchoice> to open a dialog to select the <guilabel>Orientation</guilabel> and the <guilabel>Position</guilabel> of the guide.</para>
</sect2>
<sect2>
<title>Repositioning Guides</title>
<para>Once a guide is in place you can reposition it by moving the mouse over it, holding down the &LMB; and dragging. Release the mouse button when the guide is in its new position.</para>
</sect2>
<sect2>
<title>Visibility and Snapping</title>
<para>To hide guides select <menuchoice><guimenu>View</guimenu><guimenuitem>Guide Lines</guimenuitem></menuchoice>, this toggles the visibility.</para>
<para>By default stencil edges are snapped to the nearest guide, to toggle this behavior select <menuchoice><guimenu>View</guimenu><guimenuitem>Snap Grid</guimenuitem></menuchoice>.</para>
</sect2>
</sect1>
<sect1 id="layers">
<title>Layers</title>
<para>&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.</para>
<sect2>
<title>The Layer Palette</title>
<para>To adjust the current page's layers select <menuchoice><guimenu>View</guimenu><guisubmenu>Palettes</guisubmenu><guimenuitem>Show Layers </guimenuitem></menuchoice>. The layer palette allows layers to be created, deleted and renamed. It can also be used to adjust layer visibility, drawing order and select the current layer.</para>
<para>&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.</para>
</sect2>
<sect2>
<title>Adding Layers</title>
<para>Using the <guilabel>Layers</guilabel> palette you can add new layers by clicking the <guibutton>New Layer</guibutton> button, the first from the left. Layers can be deleted by clicking the second button, <guibutton>Remove Layer</guibutton>. &kivio; numbers the layers consecutively, to rename a layer select it in the list and click <guibutton>Rename Layer</guibutton>.</para>
</sect2>
<sect2>
<title>Layer Settings</title>
<para>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 <guibutton>Move Layer Up</guibutton> and <guibutton>Move Layer Down</guibutton> buttons to change its position.</para>
<para>Each layer is listed with four small icons next to its name. From left
to right they represent:</para>
<variablelist>
<varlistentry>
<term>Visibility (shown as a small eye)</term>
<listitem><para>Clicking on the icon will toggle the layer's visibility.
</para></listitem>
</varlistentry>
<varlistentry>
<term>Printable (shown as a small printer)</term>
<listitem><para>Toggles if the layer should be printed with the document or
not. You might use a non-printing layer to keep notes to yourself, or as a
scrapbook to hold images you're not ready to use yet.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Editable (shown as a small pencil)</term>
<listitem><para>Toggles if you can edit a layer or not. You might want to
mark some layers non-editable while you work on others, to prevent
inadvertant changes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Connectable (shown as a small connector)</term>
<listitem><para>You can permit connecting of items that lie on different
layers with this icon.</para></listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<sect1 id="arranging">
<title>Arranging Stencils</title>
<sect2>
<title>The Align Tool</title>
<para>The <guilabel>Align</guilabel> 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 <menuchoice><guimenu>Format</guimenu><guimenuitem>Align &amp; Distribute...</guimenuitem></menuchoice>. 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.</para>
</sect2>
<sect2>
<title>The Distribute Tool</title>
<para>The <guilabel>Distribute</guilabel> tool arranges a group of stencils so that there is an even amount of spacing between each stencil.</para>
<para>First select the stencils you want to rearrange, then select <menuchoice><guimenu>Format</guimenu><guimenuitem>Align &amp; Distribute...</guimenuitem></menuchoice> and click on the <guilabel>Distribute</guilabel> tab in the tabbed window that appears.</para>
<para>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 <guilabel>Spacing</guilabel> option if you desire this.</para>
<para>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.</para>
<note><para>The option to use the extent of the page takes the page margins into consideration.</para></note>
</sect2>
</sect1>
</chapter>

8
doc/koffice.desktop
Unescape View File

@ -0,0 +1,8 @@
[Desktop Entry]
Type=Application
Name=KOffice
Name[sv]=Koffice
Name[tr]=Koffice
NoDisplay=true
DocPath=koffice/index.html
Categories=Qt;KDE;Office;

4
doc/koffice/Makefile.am
Unescape View File

@ -0,0 +1,4 @@
KDE_LANG = en
KDE_DOCS = AUTO

855
doc/koffice/index.docbook
Unescape View File

@ -0,0 +1,855 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&koffice;">
<!ENTITY package "koffice">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
<!-- maintained by raphael.langerhorst@kdemail.net -->
<book lang="&language;">
<bookinfo>
<title>&koffice;</title>
<subtitle>A General Introduction</subtitle>
<authorgroup>
<author>
<firstname>Raphael</firstname>
<surname>Langerhorst</surname>
<affiliation><address><email>raphael.langerhorst@kdemail.net</email></address></affiliation>
</author>
<author>
<firstname>Jost</firstname>
<surname>Schenck</surname>
<affiliation><address><email>jost@schenck.de</email></address></affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<date>2005-10-27</date>
<releaseinfo>1.5.0</releaseinfo>
<abstract>
<para>
&koffice; is an integrated office suite for the K Desktop Environment
(&kde;).
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KOffice</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<sect1>
<title>&koffice; components</title>
<para>
&koffice; is an integrated office suite for the K Desktop Environment
(&kde;). &koffice; currently consists of the following components:
</para>
<itemizedlist>
<listitem><para>&kword; (a frames-based wordprocessor)</para></listitem>
<listitem><para>&kspread; (a spreadsheet application)</para></listitem>
<listitem><para>&kpresenter; (screen and slide presentations)</para></listitem>
<listitem><para>&kivio; (a flowchart application)</para></listitem>
<listitem><para>Karbon14 (a vector drawing application)</para></listitem>
<listitem><para>&krita; (a pixel based drawing application)</para></listitem>
<listitem><para>&kugar; (a tool for generating business quality reports)</para></listitem>
<listitem><para>Kexi (an integrated environment for managing data)</para></listitem>
<listitem><para>&kchart; (a charts/graphs generation application)</para></listitem>
<listitem><para>&kformula; (an editor for mathematical formulae)</para></listitem>
</itemizedlist>
<para>
Because these components are based on the KParts component model, &koffice;
components are designed to work very well with each other. Any &koffice;
component can be embedded in another &koffice; document. For instance, you
can insert a spreadsheet which you created in &kspread; directly into a &kword;
document. In this way, complex, compound documents can be created using
&koffice;.
</para>
<para>
A plugin mechanism makes it easy to extend the functionality of
&koffice;. You will find many plugins in some of the components
and can learn how to write plugins yourself. There is also a section
of this manual dedicated to developing plugins that should get you
started.
</para>
<para>
This manual only covers the general features of &koffice;, those that
are common to most or all components in the suite. For detailed information
about the different components, have a look at the respective manual.
</para>
</sect1>
<sect1 id="features">
<title>Overview of &koffice; features</title>
<sect2 id="featureintegration">
<title>Integration</title>
<para>
&koffice; provides a framework that all components build on. Through
this framework high integration is achieved. It is possible to develop
your own component that integrates as well. The technology of this is
described in more depth in the <link linkend="kparts">chapter on
KParts</link>.
</para>
</sect2>
<sect2 id="featureleightweight">
<title>Lightweight</title>
<para>
Despite offering so many components, &koffice; is very lightweight, fast and
has a rather low memory footprint. This is also achieved because &koffice; builds
on &kde;, which is already a very powerful application development framework.
</para>
<para>
A goal of &koffice; is also to not overload the user interface with features
that are hardly needed. This results in a lean and mean user interface that
lets you do your work efficiently.
</para>
<para>
Being lightweight can at times also mean that that very particular special
functionality you need is not there. In this case you can always add the
functionality yourself by extending &koffice;. &koffice; really doesn't
want to get bloated by adding large chunks of features that only very
few users might need. Such features can always be made available through
additional plugins or scripts, thus keeping &koffice; itself lightweight.
</para>
</sect2>
<sect2 id="featurecompleteness">
<title>Completeness</title>
<para>
&koffice; offers a wide range of components, covering most of the home
and business office needs. Additional features can always be implemented
through scripts, plugins or even whole components based on the &koffice;
framework.
</para>
</sect2>
<sect2 id="featurefileformat">
<title>OASIS OpenDocument Format</title>
<para>
It is a major importance for any office suite to adhere to established
standards. Especially on the file format level to allow seamless document
exchange with other office suites. This also avoids vendor lock-in, which
is especially important for companies and also for individuals.
</para>
<para>
For this reason &koffice; has adapted the OASIS OpenDocument format
as native file format.
</para>
</sect2>
<sect2 id="featurekde">
<title>KDE Features</title>
<para>
Since &koffice; builds on &kde; all the features you would expect from a
&kde; application are also available in &koffice;. This includes DCOP, KParts,
Desktop Integration, Configurability and so on. All this makes the look and
feel of &koffice; very familiar and really integrates &koffice; into the
desktop environment, thus allowing seamless workflows.
</para>
</sect2>
</sect1>
</chapter>
<chapter>
<title>&koffice; Technology</title>
<sect1 id="kparts">
<title>KParts - the building blocks of &koffice;</title>
<!-- <sect2 id="kpartsintro"> -->
<!-- <title>KParts Introduction</title> -->
<para>
Each &koffice; application is designed to fulfill very specific needs.
For example, &kspread; is a program for manipulating spreadsheets, while
&kword; is a program for word processing. By focusing on a specific
area, each program aims for perfection in exactly this area. However,
depending on what you do with &koffice;, you'll often want to take
advantage of functionality provided by different applications, but in
the <emphasis>same</emphasis> document.
</para>
<para>
Suppose that you are preparing a document in &kword; and want to
illustrate some point using a table. While &kword; provides its own
functionality for the insertion of tables, this may not be enough for
your needs. For example, you may want to use certain currency data
formats or to do calculations using spreadsheet formulae. Now, some
&kword; programmer certainly <emphasis>could</emphasis> try to implement
this functionality. However, &kword; would never be as good as &kspread;
in this field; and if it tried to implement all the functionality you
might possibly need, it would end up becoming unreasonably complex and
the source code would become impossible to maintain.
</para>
<para>
The alternative to this is KParts. Its philosophy is simple: let every
application do what it does best.
</para>
<!-- </sect2> -->
<sect2 id="compound-docs">
<title>Compound documents with KParts</title>
<para>
With KParts, your documents can use <emphasis>all</emphasis>
functionality offered by <emphasis>all</emphasis> &koffice;
applications. You can take advantage of this by inserting so-called
<quote>parts</quote> into your document. Every one of those parts is
essentially another document, that is, <quote>a document within a
document</quote>.
</para>
<para>
In the example mentioned above, you would simply insert a &kspread; part
into your &kword; document. Then, whenever you edit your table,
&kspread; would take control in the background. Control would return to
&kword; when you stop working on the table and start working on text
again. The only change you would notice is that the toolbars and menus,
while editing the table, reflect the functionality of &kspread; instead
of that of &kword;. This ability to include the functionality of one
application in another is called <quote>embedding</quote>.
</para>
</sect2>
<sect2 id="kparts-try-it">
<title>Using KParts in your document</title>
<para>
If you have never worked with compound documents, you may find them
confusing at first. The following step-by-step instructions show you
that using KParts is just as easy as working with a single application.
</para>
<procedure>
<title>Inserting a &kspread; part into a &kword; application</title>
<step>
<para>Start &kword;. You can do that either from the panel or by typing
<userinput><command>kword</command></userinput> at the command line.
</para>
</step>
<step>
<para>
Start a new, blank document. You may want to type some sample text.
</para>
</step>
<step>
<para>
Select <menuchoice><guimenu>Insert</guimenu> <guisubmenu>Object Frame</guisubmenu>
<guimenuitem>Spreadsheets</guimenuitem></menuchoice>. You'll notice that the mouse cursor has
changed to a cross. This form of the cursor indicates that you are supposed
to select an area.
</para>
</step>
<step>
<para>
Press the &LMB; mouse button where you want the upper left corner of
your table to be, hold it and drag it to the lower right corner. Release
the button. Now a dialog appears that gives you the possibility to
insert an existing document or to create a new one. Create a blank worksheet.
That's it--you're done.
</para>
</step>
</procedure>
<para>
Easy, isn't it? You should now see a table frame in your &kword;
document. Now, doubleclick inside the table to see what happens. You'll
notice that:
</para>
<itemizedlist>
<listitem>
<para>
Your menubars and toolbars have changed. They now reflect those of
&kspread;.
</para>
</listitem>
<listitem>
<para>
Your table frame now contains the elements of a &kspread; view, with
scrollbars, a tab bar for the selection of tables, &etc;
</para>
</listitem>
</itemizedlist>
<para>
Try editing the table. You'll see that it's not different from using
&kspread;. In fact you <emphasis>are</emphasis> using &kspread;.
</para>
<para>
Now click somewhere into your &kword; document, outside of the table
area. The menubars and toolbars should change back to those of
&kword;, the elements of the &kspread; view should disappear. Your table
stays and still reflects all of the changes you've applied to it.
</para>
<para>
KParts are easy to use. Try inserting other parts or even parts in
parts.
</para>
</sect2>
</sect1>
</chapter>
<chapter id="configuration">
<title>Configuring &koffice; and Your System</title>
<para>
While &koffice; should work quite nice out of the box, there may well be
some things to optimize to get the best out of &koffice;. This chapter
shows you what you might want to do to achieve the best results with
your new office suite and make it suite your needs. &koffice; is
highly configurable, even down to detailed toolbar and menu layout.
</para>
<sect1 id="the-font-issue">
<title>Optimizing Font Output</title>
<para>
Fonts are a difficult topic on X Windows. In this section we'll cover
some problems that are frequently reported by people using
&koffice;. Some problems are not just &koffice;s fault, but depend on
your system configuration, which is why you may need to modify system
configuration files in order to solve them. If you don't have access to
the root account on your system, please ask your system operator about
this and point him or her to this manual. As the topic of fonts is too
complex to cover all of it here, you may want to consult the <ulink
url="http://www.pegasus.rutgers.edu/~elflord/font_howto/Font-HOWTO/">Font
HOWTO</ulink> from which I've taken the following information. You will
find more details there.
</para>
<sect2>
<title>How to Get Nicely Scaled Fonts on Screen</title>
<para>
STUFF
</para>
</sect2>
<sect2><title>How to Get Correct Printout</title>
<para> While &koffice; automatically can handle all X11 fonts
<emphasis>on screen</emphasis>, printout can pose a problem: on most
systems, printing is done via
<application>ghostscript</application>. Now, while &koffice; knows the
font names used by X Windows, it does normally
<emphasis>not</emphasis> know the font names used by
<application>ghostscript</application>. &koffice; tries to guess these
names, which unfortunately doesn't work all of the time. </para>
<para>
This problem can be solved, although this is not that easy. Actually,
maybe you are using a distribution which has done most work for you
already (so if you have no reason to complain about printout you can
skip this section). What you have to do is to tell
<application>ghostscript</application> how to translate the (guessed)
font names &koffice; uses to its own font names. This can be done by
adding lines to a file called <filename>Fontmap</filename>. An alias
line in <filename>Fontmap</filename> looks like the following
example:</para>
<example>
<title>An alias in the <application>ghostscript</application> Fontmap</title>
<screen>
/Algerian-Roman /Algerian ;
</screen>
</example>
<para>
Please note that a space before the ';' is mandatory. In this example,
Algerian-Roman is the name &koffice; uses for Algerian. You'll have to
add such lines for the fonts &koffice; doesn't display correctly. To
make this task easier, Donovan Rebbechi has written a perl script you
can find at <ulink
url="http://pegasus.rutgers.edu/~elflord/font_howto/kwdfont">http://pegasus.rutgers.edu/~elflord/font_howto/kwdfont</ulink>.
Assuming that you have a fontfile
<filename>/usr/share/ghostscript/fonts/fontfile.ttf</filename> you'll
enter <userinput><command>kwdfont</command>
<parameter>/usr/share/ghostscript/fonts/fontfile.ttf</parameter></userinput>
to get the appropriate aliases. The script should mork in most cases. As
mentioned, you should have a look at the <ulink
url="http://pegasus.rutgers.edu/~elflord/font_howto/html/">Font
HOWTO</ulink> for more accurate and in-depth information.
</para>
</sect2>
</sect1>
<sect1 id="custom-gui">
<title>Customizing the &koffice; &GUI;</title>
<para>
While &koffice; comes out of the box with a &GUI; (graphical user interface)
that should suit most people's needs, there are good reasons why you may
want to change the way the programs look.
</para>
<para>
My mother, for example, is a bit afraid of buttons and menu entries she
doesn't understand. To tailor &koffice; to her needs, I reduced the
&GUI; to a bare minimum of functionality. As she only needs to write
letters and use certain templates, there is no need for much more
functionality than saving, loading, printing, &etc;
</para>
<para> Thanks to the <quote>action</quote> concept of &Qt; and &kde;,
you can freely customize &koffice; menubars and tool
bars. Unfortunately, at the moment, there are no easy-to-use dialogs
to do this. &koffice; stores its &GUI; configuration in &XML; files
and you'll have to edit those. Hopefully, this situation will change
in the future; for now, you'll need some basic knowledge of how an
&XML; document works (or <acronym>HTML</acronym>, which is a subset of
&XML;). [The <quote>action</quote> concept needs to be discussed in
more detail -- kt.] </para>
<para>
Normally, each &koffice; application has at least two of those &XML;
files: one describing the &GUI; of the shell (basically, that's what you
see if there is no document open) and one describing the &GUI; of the
respective part (that's what you see normally). For example, for
&kword;, these two &XML; files are named
<filename>kword_shell.rc</filename> and <filename>kword.rc</filename>.
</para>
<para>
Here's a simple example of such an rc-file.
</para>
<example>
<title>An example of a simple rc-file</title>
<screen>
&lt;!DOCTYPE QConfig &gt;&lt;qconfig&gt;
&lt;menubar&gt;
&lt;menu name="Edit"&gt;&lt;text&gt;Edit&lt;/text&gt;
&lt;action name="edit_cut"/&gt;
&lt;action name="edit_copy"/&gt;
&lt;action name="edit_paste"/&gt;
&lt;separator/&gt;
&lt;action name="edit_find"/&gt;
&lt;/menu&gt;
&lt;menu name="Insert"&gt;&lt;text&gt;Insert&lt;/text&gt;
&lt;action name="insert_picture"/&gt;
&lt;action name="insert_clipart"/&gt;
&lt;menu name="Variable"&gt;&lt;text&gt;Variable&lt;/text&gt;
&lt;action name="insert_var_datefix"/&gt;
&lt;action name="insert_var_datevar"/&gt;
&lt;/menu&gt;
&lt;/menu&gt;
&lt;/menubar&gt;
&lt;toolbars&gt;
&lt;toolbar name="edit_toolbar" position="right"&gt;
&lt;action name="edit_cut"/&gt;
&lt;action name="edit_copy"/&gt;
&lt;action name="edit_paste"/&gt;
&lt;/toolbar&gt;
&lt;/toolbars&gt;
&lt;/qconfig&gt;
</screen>
</example>
</sect1>
</chapter>
<chapter id="more-info">
<title>How to get more information</title>
<sect1 id="other-manuals">
<title>Other &koffice; manuals</title>
<para>
For detailed information on the different &koffice; applications, please
consult their respective manuals. <!-- (use ulink to help:/appname/ -->
<!-- for the meantime - it's a hack, but it's the best we have -->
<!-- presently. [FIXME: how do I provide links to them? Do we -->
<!-- need set-tag?] -->
</para>
</sect1>
<sect1 id="links">
<title>Links</title>
<para>
The following links should be useful if you're looking for more information
about &kde; or &koffice;.
</para>
<itemizedlist>
<listitem>
<para><ulink url="http://koffice.kde.org">The &koffice;
homepage</ulink>. Here you can find information on how to get and
install &koffice;, news about &koffice; development, screenshots &etc;
</para></listitem>
<listitem>
<para>
<ulink url="http://www.kde.org">The KDE Homepage</ulink>. KDE is the most advanced and
absolutely free desktop environment for unix-like operating systems.
&koffice; makes use of the &kde; libraries.
</para></listitem>
<listitem>
<para><ulink url="http://www.trolltech.com">Trolltech</ulink>. The creators
of the C++-toolkit &Qt;. &kde; and &koffice; make use of &Qt;.
</para></listitem>
</itemizedlist>
</sect1>
</chapter>
<chapter id="programmersinfo">
<title>Programming &koffice;</title>
<sect1 id="programmingintro">
<title>Introduction</title>
<para>
If you want to do &koffice; development, the following resources might
be of interest:
</para>
<itemizedlist>
<listitem><para> At <ulink
url="http://developer.kde.org">http://developer.kde.org</ulink> you'll
find many documents about programming with &Qt; and &kde;. Here you can find
the online version of the complete &kde; library documentation.
</para></listitem>
<listitem><para>
In the &koffice; sources you'll find an example application in the
<filename class="directory">example</filename> folder.
</para></listitem>
</itemizedlist>
</sect1>
<!--
<sect1 id="programmingplugin">
<title>Developing &koffice; Plugins</title>
<para>
TO BE WRITTEN.
</para>
</sect1>
<sect1 id="scripting">
<title>Scripting &koffice;</title>
<para>
This section gives you information on how you can automate and
script &koffice;.
</para>
<sect2 id="dcop">
<title>DCOP</title>
<para>
TO BE WRITTEN.
</para>
</sect2>
</sect1>
<sect1 id="programmingreport">
<title>Creating Reports with Kugar</title>
<para>
TO BE WRITTEN.
Maybe this should go completely into the
Kugar manual? So we just keep a reference to the kugar manual
here.
</para>
</sect1>
<sect1 id="programmingdatabase">
<title>Integrating a Database with Kexi</title>
<para>
TO BE WRITTEN.
Again, should this just be a reference to kexi documentation?
</para>
</sect1>
<sect1 id="programmingcomponents">
<title>Developing &koffice; Components</title>
<para>
TO BE WRITTEN.
</para>
</sect1>
-->
</chapter>
<chapter id="legal">
<title>Copyright and Licensing</title>
<para>
&koffice; is the result of the joint effort of many developers. Each source file
of &koffice; is copyrighted by the people who wrote this particular file and
their names can be found at the start of each source file with the license that applies to
that source file. The names of the core developers can be found at
<ulink url="http://www.koffice.org/people.php">
http://www.koffice.org/people.php</ulink>.
</para>
<para>
This manual is copyright by Jost Schenck. It can be distributed
freely, as long as this copyright notice is included. You may change
it as long as you send me the changes or commit them to &kde;
<acronym>CVS</acronym>. I'll not be liable for anything resulting
from the use of this manual.
</para>
<para>
The other &koffice; manuals are copyrighted by their respective authors.
</para>
<!--TRANS:CREDIT_FOR_TRANSLATORS-->
&underFDL;
&underGPL;
</chapter>
<appendix id="installation">
<title>Installation</title>
<sect1 id="requirements">
<title>System Requirements</title>
<para>
In order to install and use &koffice; you must have:
</para>
<itemizedlist>
<listitem><para>
A functioning &UNIX; system (for example, &Linux; or BSD)
with a configured &X-Window; (for example, XFree86 or X.Org).
</para></listitem>
<listitem><para>
The &Qt; 3.3 libraries from Trolltech. See
<ulink url="http://www.trolltech.com/">www.trolltech.com</ulink>
for more information.
</para></listitem>
<listitem><para>
The K Desktop Environment 3.3 (&kde; 3.3) or newer. &koffice; cannot be compiled
with earlier versions of &kde;. Information on obtaining and installing
&kde; can be found at: &kde-http;
</para></listitem>
<listitem><para>
Permission to install software on your computer. If you are on a
stand-alone system, this should not be a problem. However, if you are
using a networked computer, check with your administrator first.
</para></listitem>
</itemizedlist>
<para>
Please note that, while you need the &kde; 3.3 (or newer) libraries
on your system, you can still use &koffice; in a different desktop
environment (for example, XFCE or GNOME).
</para>
<para>
If you plan on <link linkend="from-source">compiling &koffice; from
source code</link> you will also need:
</para>
<itemizedlist>
<listitem><para>
<command>automake</command> 1.6.1 or later. This can be downloaded from:
<ulink url="ftp://ftp.gnu.org/pub/gnu/automake/">ftp://ftp.gnu.org/pub/gnu/automake/</ulink>
</para></listitem>
<listitem><para>
<command>autoconf</command> 2.53 or later. This can be downloaded from:
<ulink url="ftp://ftp.gnu.org/pub/gnu/autoconf/">ftp://ftp.gnu.org/pub/gnu/autoconf/</ulink>
</para></listitem>
<listitem><para>
A C++ compiler which supports exceptions, preferably a recent version of GCC.
(See <ulink url="http://gcc.gnu.org">http://gcc.gnu.org</ulink>
for info about getting and installing it.)
</para></listitem>
<listitem><para>
Troll Tech's &Qt; 3.3 development packages. If these packages are not installed on
your system and they are not included in the distribution of your operating
system, you should probably have to compile &Qt; from source.
These sources can be obtained from
<ulink url="http://www.trolltech.com/download/index.html">
http://www.trolltech.com/download/index.html</ulink>.
</para></listitem>
</itemizedlist>
<para>
Once you have determined that your system meets these requirements,
you should decide whether you want to compile the source code
or install from pre-compiled binary packages.
</para>
<para>
If you want to obtain the most current binary version of &koffice;,
you can find more information by following this link:
<link linkend="getting-binaries">Getting Binary Packages</link>.
</para>
<para>
If pre-compiled binaries are not available for your system, you can download
the source code and compile it yourself. Instructions on where to obtain the
current source code (and what to do with the source code once you have it)
can be found by following this link:
<link linkend="getting-source">Getting the source code</link>.
</para>
<note><para> Please see the <ulink
url="http://koffice.kde.org">&koffice; homepage</ulink> for further
details. That is where you can always find the most up-to-date
information on both source and binary distributions! </para></note>
</sect1>
<sect1 id="getting-binaries">
<title>Getting Binary Packages</title>
<para>
You can download the most current binaries from:
</para>
<para>
<ulink url="http://koffice.kde.org/releases/1.4.0-release.php">
http://koffice.kde.org/releases/1.4.0-release.php</ulink>
</para>
<para>
or from one of many mirror sites. The current list of mirror sites
can be found at:
</para>
<para>
<ulink url="http://www.kde.org/mirrors.html">http://www.kde.org/mirrors.html</ulink>
</para>
<note><para> It is important that you use a binary package which is
compatible with your system. If you use the &Linux; operating system
and are unable to find a binary package at the &koffice; web site or
one of its mirrors, you may be able to obtain one from the website of
your distribution. </para></note>
</sect1>
<sect1 id="from-binaries">
<title>From Binary Packages</title>
<para>
To install &koffice; from precompiled binaries, you should:
</para>
<procedure>
<step>
<para>Ensure your computer has all of the required software installed
and in working condition (excluding &koffice; of course). You can find
the system requirements by following this link: <link
linkend="requirements">System Requirements</link>.</para></step>
<step><para>Download the &koffice; binary (or binaries) into a temporary
folder.</para></step>
<step><para>If the filename ends in <literal
role="extension">.rpm</literal> (&RedHat; Package Management file),
&koffice; can be installed with the following command:
<screen><prompt>$</prompt><userinput><command>rpm</command><option>-U </option><replaceable>filename</replaceable></userinput></screen>
</para>
<para>If the filename ends in <literal role="extension">.deb</literal> (Debian Package file), &koffice; can be installed with the following command:
<screen><prompt>$</prompt> <userinput><command>dpkg</command><option>-i </option><replaceable>filename</replaceable></userinput></screen>
</para>
<para>If the filename ends in <literal role="extension">.tar.gz</literal>
or <literal role="extension">.tgz</literal> (a tarball file),
&koffice; can be installed with the following commands:</para>
<screen>
<prompt>$</prompt> <userinput><command>cd</command> /</userinput>
<prompt>$</prompt> <userinput><command>tar</command> <option>-xzvf</option> <replaceable>filename</replaceable></userinput>
</screen>
<para>In these examples <emphasis>filename</emphasis> should be replaced by the
complete name of the package <emphasis>including the full path</emphasis> if
you are not in the directory in which you saved.</para>
</step>
<step><para>
That's all. &koffice; should now be installed on your system.
</para></step>
</procedure>
<note><para> If you have a graphical front-end for package management,
such as &kpackage; or <application>GnoRPM</application>, installed on
your system, you may find that more convenient to use than a command
line. Consult the program's documentation to find out how to install
with it. </para></note>
</sect1>
<sect1 id="getting-source">
<title>Getting Source Code</title>
<para>
You can download the current source code from:
<ulink url="http://koffice.kde.org/">http://koffice.kde.org/</ulink>
or from one of many mirror sites. The current list of mirror sites
can be found at:
</para>
<para>
<ulink url="http://www.kde.org/mirrors.html">http://www.kde.org/mirrors.html</ulink>
</para>
</sect1>
<sect1 id="from-source">
<title>From Source Code</title>
<para>
If you want to build &koffice; from source code, you should:
</para>
<procedure>
<step><para>
Ensure your computer has all the required software installed and
in working condition (excluding &koffice; of course). You can find
the system requirements by following this link:
<link linkend="requirements">System Requirements</link>.
</para></step>
<step><para>
Download the &koffice; source file into a temporary folder.
</para></step>
<step><para>
If the filename ends in <literal role="extension">.src.rpm</literal>
(&RedHat; Package Management file), the source code for &koffice; can
be installed with:
<screen><prompt>$</prompt> <userinput><command>rpm</command><option>-U</option> <replaceable>filename</replaceable></userinput></screen></para>
<para>If the filename ends in <literal role="extension">.src.tar.gz</literal> or <literal role="extension">.src.tgz</literal> (a tarball file),
the source code for &koffice; can be installed with:
<screen><prompt>$</prompt> <userinput><command>tar</command> <option>-xzvf</option> <replaceable>filename</replaceable></userinput></screen>
</para></step>
<step><para>The source code for &koffice; should now be installed on
your system.</para></step>
</procedure>
</sect1>
</appendix>
&documentation.index;
</book>

4
doc/koshell/Makefile.am
Unescape View File

@ -0,0 +1,4 @@
KDE_LANG = en
KDE_DOCS = AUTO

507
doc/koshell/index.docbook
Unescape View File

@ -0,0 +1,507 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&koshell;">
<!ENTITY package "koffice">
<!ENTITY % English "INCLUDE" >
<!ENTITY % addindex "IGNORE">
]>
<book lang="&language;">
<bookinfo>
<title>The &koshell; Handbook</title>
<authorgroup>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annma@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2005-2006</year>
<holder>Anne-Marie Mahfouf</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<!-- Date and version information of the documentation
Don't forget to include this last date and this last revision number, we
need them for translation coordination !
Please respect the format of the date (DD/MM/YYYY) and of the version
(Major.minor.lesser), it could be used by automation scripts -->
<date>2006-01-30</date>
<releaseinfo>1.5.0</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>
&koshell; is the &koffice; Workspace where you can work with each component of the &koffice; productivity suite at the same time. &koshell; helps you organize your work in a friendly environment.
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KOffice</keyword>
<keyword>workspace</keyword>
<keyword>KWord</keyword>
<keyword>KSpread</keyword>
<keyword>KPresenter</keyword>
<keyword>KChart</keyword>
<keyword>KPlato</keyword>
<keyword>Kexi</keyword>
<keyword>Krita</keyword>
<keyword>Kivio</keyword>
<keyword>Kugar</keyword>
<keyword>KFormula</keyword>
<keyword>Karbon14</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<para>&koshell; is a framework in which you can work with several &koffice; applications in the same window. Being based on a true component framework &koshell; provides exactly the
same functionality as the stand-alone applications, and adds more
features, by making available all components in the same window. </para>
<para>
&koshell; is part of the &koffice; productivity suite for the K Desktop
Environment. Other applications in &koffice; include:</para>
<itemizedlist>
<listitem><para>&kword; (A full featured <acronym>WYSIWYG</acronym> (What You See Is What You Get)
Word-processor/Desktop Publishing Program.)</para></listitem>
<listitem><para>&kspread; (A spreadsheet application.)</para></listitem>
<listitem><para>&kpresenter; (A presentation creator.)</para></listitem>
<listitem><para>Kexi (An integrated environment for databases.) </para></listitem>
<listitem><para>&kivio; (A flowchart creator.)</para></listitem>
<listitem><para><application>Karbon14</application> (A vector drawing program.)</para></listitem>
<listitem><para>&krita; (A pixel based drawing program.)</para></listitem>
<listitem><para>&kchart; (A chart and graph creator.)</para></listitem>
<listitem><para>&kformula; (A formula editor.)</para></listitem>
<listitem><para>&kugar; (A report generation tool.) </para></listitem>
</itemizedlist>
<para>See the individual application manuals for details on how to use them. These manuals apply to
running the applications as components inside &koshell; just as well as running them stand-alone.
</para>
</chapter>
<chapter id="main-window">
<title>The &koshell; Main Window</title>
<sect1 id="General">
<title>General</title>
<para>&koshell; consists in a friendly workspace to allow you to work on several &koffice; applications at the same time. In the &koshell; main window you can see a side pane on the left showing the icons of the available &koffice; components and the main view on the right which contains the main window of the active component and the usual menubar and toolbar. </para>
<screenshot>
<screeninfo>Here's a screenshot of &koshell; when you start it for the first time</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="koshell1.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&koshell; screenshot</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
Here you can see &koshell; as it is the first time you run it. &koshell; always starts empty. You can then choose different actions. You can use the side pane on the left to open the programs as if they are standalone applications. You can also open any supported document via the <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem>
</menuchoice> menu and the corresponding &koffice; application will open with the document loaded.
</para>
<para>
You can also import any supported document using the <menuchoice><guimenu>File</guimenu><guimenuitem>Import</guimenuitem>
</menuchoice> menu and as with the Open action, the adequate &koffice; application will be used to load your document.
</para>
</sect1>
<sect1 id="side-pane">
<title>Side Pane</title>
<screenshot>
<screeninfo>&koshell;'s Side Pane</screeninfo>
<mediaobject>
<imageobject><imagedata format="PNG" fileref="side-pane.png"/></imageobject>
<textobject>
<phrase>&koshell;'s Side Pane</phrase>
</textobject>
<caption>
<para>
&koshell;'s Side Pane
</para>
</caption>
</mediaobject>
</screenshot>
<para>The side pane allows you to open a new &koffice; component as if it was the stand-alone application. In most components, you are asked what document you want to open, a template, an empty document or an existing document. The main window of the component is then shown and the menubar, toolbars and statusbar in &koshell; are
adapted to reflect the functionality of the active component.</para>
<para>You can change the size of the icons in the side pane.
Right-clicking on the side pane will give you the option to use Large,
Normal, or Small icons, as well as the option to use text only
instead of icons.</para>
<para>If you dislike the sidebar, you can simply hide it by dragging the
splitter to the left. </para>
</sect1>
<sect1 id="main-view">
<title>Main View</title>
<para>The view on the right which takes up most of the area of the &koshell;
main window shows the active component. This exactly corresponds to the main
window the component uses when run as a stand-alone application. </para>
<screenshot>
<screeninfo>&koshell;'s Main View</screeninfo>
<mediaobject>
<imageobject><imagedata format="PNG" fileref="main-view.png"/></imageobject>
<textobject>
<phrase>&koshell;'s Main View</phrase>
</textobject>
<caption>
<para>
&koshell;'s Main View
</para>
</caption>
</mediaobject>
</screenshot>
<para>When a component is loaded, the component own menus are merged with the &koshell; menus and the component toolbars are added on the workspace.</para>
<para>Each new component is opened in a new tab. Using the &RMB; on each tab title, you can save the document in that tab or close that tab. The small button on the right bottom with a red cross also allows you to close the current tab.</para>
<para>A special action common to all components is the
<menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem> </menuchoice> action in &koshell; menubar. It opens the <guilabel>Insert Object</guilabel> dialog which starts the &koffice; component as if it was a stand-alone application.</para>
<screenshot>
<screeninfo>&koshell; Insert Object dialog</screeninfo>
<mediaobject>
<imageobject><imagedata format="PNG" fileref="new-dialog.png"/></imageobject>
<textobject>
<phrase>&koshell; Insert Object dialog</phrase>
</textobject>
<caption>
<para>
&koshell; Insert Object dialog
</para>
</caption>
</mediaobject>
</screenshot>
</sect1>
</chapter>
<chapter id="commands">
<title>Command Reference</title>
<sect1 id="koshell-mainwindow">
<title>Menus and shortcut keys</title>
<sect2>
<title>The <guimenu>File</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>New</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open</action> the <guilabel>Insert Object</guilabel> dialog which lists all possible new documents you can open.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Open...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open</action> a supported document by choosing the corresponding &koffice; application. </para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Open Recent</guisubmenu>
</menuchoice></term>
<listitem><para><action>Display</action> a selection of recently saved documents you can open. </para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save</guimenuitem>
</menuchoice></term>
<listitem><para><action>Save</action> the current document. </para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Save</action> the current document with a name you provide. </para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Reload</guimenuitem>
</menuchoice></term>
<listitem><para><action>Reload</action> the current document. </para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Import...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Import</action> a supported document. </para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Export...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Export</action> the current document. </para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Mail...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Invokes &kmail; so you can email the file.
The file is already attached to the email.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save All</guimenuitem>
</menuchoice></term>
<listitem><para>Saves all open documents in &koffice; Workspace.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Print...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Print the current document.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Print Preview...</guimenuitem>
</menuchoice></term>
<listitem><para><action>View the current document as it will be printed.</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Document Information</guimenuitem>
</menuchoice></term>
<listitem><para><action>View or enter information about the current document and
author.</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Close</guimenuitem>
</menuchoice></term>
<listitem><para><action>Close the current document but leave &koshell; running.
</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quits</action> &koshell;.</para></listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>The <guimenu>Settings</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Hide/Show Toolbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Toggle</action> the <guilabel>Main</guilabel> Toolbar.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Configure</action> the shortcuts.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Configure</action> the items you want to put in the toolbar.
</para></listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>The <guimenu>Help</guimenu> Menu</title>
&help.menu.documentation;
</sect2>
</sect1>
</chapter>
<chapter id="technology">
<title>Under The Hood</title>
<para>&koshell; makes extensive use of several &kde; key technologies, most
notably KParts and &DCOP;.</para>
<para>The &GUI; integration of the components is done by plugins
providing KParts versions of the applications. This only needs a thin
additional layer on top of the already existing code of the
stand-alone applications. Because they are based on the KParts component model, &koffice; programs
are designed to work very well with each other. Any &koffice; component
can be embedded in another &koffice; document.</para>
<para>For communication between the components &DCOP; is used. This
has the nice characteristic that it is completely transparent to
whether the application is run stand-alone or embedded as KPart into
&koshell;. </para>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<para>
&koshell;
</para>
<para>
Program copyright 2001-2005 The &koffice; Workspace Team
</para>
<para>
Original authors:
<itemizedlist>
<listitem><para>Sven Lüppken
<email>sven@kde.org</email></para> </listitem>
<listitem><para>Torben Weis
<email>weis@kde.org</email></para> </listitem>
<listitem><para>David Faure
<email>faure@kde.org</email></para> </listitem>
</itemizedlist>
</para>
<para>
Documentation copyright 2005 Anne-Marie Mahfouf annma@kde.org
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL; <!-- FDL: do not remove -->
&underGPL; <!-- GPL License -->
</chapter>
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-koshell">
<title>How to obtain &koshell;</title>
&install.intro.documentation;
</sect1>
<sect1 id="requirements">
<title>Requirements</title>
<para>
&koshell; is part of &koffice;
on <ulink url="http://www.koffice.org/koshell ">The &koshell; home
page</ulink>
You must have &koffice; installed. &koshell; will not work without the rest of
&koffice;
</para>
</sect1>
<sect1 id="compilation">
<title>Compilation and installation</title>
&install.compile.documentation;
</sect1>
</appendix>
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes: nil
sgml-general-insert-case: lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->

BIN
doc/koshell/koshell1.png
View File

Binary file not shown.

BIN
doc/koshell/main-view.png
View File

Binary file not shown.

BIN
doc/koshell/new-dialog.png
View File

Binary file not shown.

BIN
doc/koshell/side-pane.png
View File

Binary file not shown.

4
doc/kplato/Makefile.am
Unescape View File

@ -0,0 +1,4 @@
KDE_LANG = en
KDE_DOCS = AUTO

566
doc/kplato/commands.docbook
Unescape View File

@ -0,0 +1,566 @@
<chapter id="commands">
<chapterinfo>
<authorgroup>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annma@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Command Reference</title>
<sect1 id="filemenu">
<title>The <guimenu>File</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>New</guimenuitem>
</menuchoice></term>
<listitem><para><action>Create a new document.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Open...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open an existing document.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Open Recent</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open an existing document</action> by selecting it
from a combo box of recently used files.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save</guimenuitem>
</menuchoice></term>
<listitem><para><action>Save the document.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Save the document with a new name or format.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Reload</guimenuitem>
</menuchoice></term>
<listitem><para><action>Reloads the document.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Import...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Import other documents.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Export...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Save a document to any supported format.</action>
The document does not become the exported file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Mail...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Send the file as an email attachment.</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Print...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Print the document.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Print Preview...</guimenuitem>
</menuchoice></term>
<listitem><para><action>View the document as it will be printed.</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Document Information</guimenuitem>
</menuchoice></term>
<listitem><para><action>View or enter information about the document and
author.</action></para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Close</guimenuitem>
</menuchoice></term>
<listitem><para><action>Close the current document but leave &kplato; running.
</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quit</action> &kplato;.</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="editmenu">
<title>The <guimenu>Edit</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Undo</guimenuitem>
</menuchoice></term>
<listitem><para><action>Undo the last action.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Redo</guimenuitem>
</menuchoice></term>
<listitem><para><action>Redo the last undone action.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Delete Task</guimenuitem>
</menuchoice></term>
<listitem><para><action>Delete</action> the currently highlighted task.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Indent Task</guimenuitem>
</menuchoice></term>
<listitem><para><action>Indent</action> the currently highlighted task.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Unindent Task</guimenuitem>
</menuchoice></term>
<listitem><para><action>Unindent</action> the currently highlighted task.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Move Up</guimenuitem>
</menuchoice></term>
<listitem><para><action>Move up</action> the currently highlighted task.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Move Down</guimenuitem>
</menuchoice></term>
<listitem><para><action>Move down</action> the currently highlighted task.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="viewmenu">
<title>The <guimenu>View</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Expected</guimenuitem>
</menuchoice></term>
<listitem><para><action> - </action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Optimistic</guimenuitem>
</menuchoice></term>
<listitem><para><action> - </action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Pessimistic</guimenuitem>
</menuchoice></term>
<listitem><para><action> -</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Gantt</guimenuitem>
</menuchoice></term>
<listitem><para><action>View Gantt</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Resources</guimenuitem>
</menuchoice></term>
<listitem><para><action>Toggle</action> on and off the resources names in the
Gantt view.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Task Name</guimenuitem>
</menuchoice></term>
<listitem><para><action>Toggle</action> on and off the tasks names in the
Gantt view.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Task Links</guimenuitem>
</menuchoice></term>
<listitem><para><action>Toggle</action> on and off the task links in the
Gantt view.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Progress</guimenuitem>
</menuchoice></term>
<listitem><para><action>Toggle</action> on and off the progress in the
Gantt view.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Float</guimenuitem>
</menuchoice></term>
<listitem><para><action> - </action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Critical Path</guimenuitem>
</menuchoice></term>
<listitem><para><action>Highlight</action> the critical path in red.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Critical Tasks</guimenuitem>
</menuchoice></term>
<listitem><para><action>Highlight</action> the critical tasks in red.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Resources</guimenuitem>
</menuchoice></term>
<listitem><para><action>View</action> the resources instead of the Gantt or
the accounts.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Accounts</guimenuitem>
</menuchoice></term>
<listitem><para><action>View</action> the accounts instead of the Gantt or
the resources.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="insertmenu">
<title>The <guimenu>Insert</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Insert</guimenu>
<guimenuitem>Task...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the task settings dialog which allows
to define a new task after the current highlighted task.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Insert</guimenu>
<guimenuitem>Sub-Task...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the task settings dialog which allows
to define and insert a new sub-task of the current highlighted task.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Insert</guimenu>
<guimenuitem>Milestone...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the task settings dialog which allows
to define and insert a new sub-task of the current highlighted task.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="projectmenu">
<title>The <guimenu>Project</guimenu> Menu</title>
<para><variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Project</guimenu>
<guimenuitem>Edit Main Project...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the project settings dialog.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Project</guimenu>
<guimenuitem>Edit Standard Worktime...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the standard worktime dialog.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Project</guimenu>
<guimenuitem>Edit Calendar...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the calendar settings dialog.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Project</guimenu>
<guimenuitem>Edit Accounts...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the accounts settings dialog.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Project</guimenu>
<guimenuitem>Edit Resources...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the resources dialog where you can add
new resources groups and new resources names and properties.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Project</guimenu>
<guimenuitem>Calculate</guimenuitem>
</menuchoice></term>
<listitem><para><action>Calculate</action> Expected, Optimistic and Pessimistic.
</para></listitem>
</varlistentry>
</variablelist></para>
</sect1>
<sect1 id="toolsmenu">
<title>The <guimenu>Tools</guimenu> Menu</title>
<para><variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Generate WBS Code</guimenuitem>
</menuchoice></term>
<listitem><para><action> - </action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Define WBS Pattern...</guimenuitem>
</menuchoice></term>
<listitem><para><action> - </action>
</para></listitem>
</varlistentry>
</variablelist></para>
</sect1>
<sect1 id="settingsmenu">
<title>The <guimenu>Settings</guimenu> Menu</title>
<para><variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Toolbars</guimenuitem>
</menuchoice></term>
<listitem><para><action>Show or hide the toolbars: <guilabel>File</guilabel>, <guilabel>Report</guilabel>,
<guilabel>View</guilabel> and <guilabel>Project</guilabel>.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Configure the keyboard shortcuts used by &kplato;.
</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Configure</action> the items you want to put in
the toolbars.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure &kplato;...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the &kplato; settings dialog.
</para></listitem>
</varlistentry>
</variablelist></para>
</sect1>
<sect1 id="helpmenu">
<title>The <guimenu>Help</guimenu> Menu</title>
&help.menu.documentation;
</sect1>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-parent-document: ("index.docbook" "book" "chapter")
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->

BIN
doc/kplato/configure-wbs.png
View File

Binary file not shown.

BIN
doc/kplato/configure1.png
View File

Binary file not shown.

BIN
doc/kplato/configure2.1.png
View File

Binary file not shown.

BIN
doc/kplato/configure2.png
View File

Binary file not shown.

228
doc/kplato/definitions.docbook
Unescape View File

@ -0,0 +1,228 @@
<chapter id="definitions">
<chapterinfo>
<authorgroup>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annma@kde.org</email></address>
</affiliation>
</author>
<author>
<firstname>Raphael</firstname>
<surname>Langerhorst</surname>
<affiliation>
<address><email>raphael.langerhorst@kdemail.net</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Definitions</title>
<sect1 id="gantt">
<title>Gantt charts</title>
<para>A Gantt chart is a popular type of bar chart, that aims to show the timing
of tasks or activities as they occur over time. Although the Gantt chart did not
initially indicate the relationships between tasks this has become more
common in current usage as both timing and interdependencies between tasks can
be identified.
</para>
<para>
In project management, a Gantt chart can show when the project terminal elements
start and finish, summary elements (shown) or terminal element dependencies (not
shown). A terminal element is defined as the smallest task tracked as part of
the project effort. The tasks are displayed on a page as bars. The page is laid
out such that time increases as you move across the page. A task's start
time/date is indicated by the point on the page the bar starts, and it's
duration is indicated by the length of the bar.
</para>
<para>
Since the initial introduction of Gantt charts, they have become an industry
standard as a key project management tool for representing the phases, tasks and
activities that are scheduled as part of a project Work Breakdown Structure
(WBS) or timeline of tasks.
</para>
<para>
The initial format of the chart was developed by Henry L. Gantt (1861-1919) in
1910 (see <quote>Work, Wages and Profit</quote> by H. L. Gantt, published by The
Engineering Magazine, NY, 1910).
</para>
</sect1>
<sect1 id="wbs">
<title>Work Breakdown Structure (WBS)</title>
<para>
In project management, a work breakdown structure (WBS) is an exhaustive,
hierarchical (from general to specific) tree structure of deliverables and tasks
that need to be performed to complete a project.
</para>
<para>
The purpose of a WBS is to identify terminal elements (the actual items to be
done in a project). Therefore, WBS serves as the basis for much of project
planning.
</para>
<para>A useful rule of thumb is that any project can be broken down into
between 10 and 20 tasks.
</para>
<para>
Work breakdown structure is a very common project management tool. Many United
States government statements of work require work breakdown structures.
</para>
<para>See the <xref linkend="configure-wbs" /> section to learn how to
configure your WBS.
</para>
</sect1>
<sect1 id="float">
<title>Float</title>
<para>
Float in project management is the amount of time that a terminal element in a
project network can be delayed by, without causing a delay to:
<itemizedlist>
<listitem><para>subsequent terminal elements (free float)</para></listitem>
<listitem><para>project completion date (total float).</para></listitem>
</itemizedlist>
Float is sometimes also called slack.
</para>
</sect1>
<sect1 id="task">
<title>Task</title>
<para>
A task is a part of a project that needs to be accomplished within a defined
period of time. Tasks can be linked together to create Dependencies.
</para>
<para>
Tasks take place over a period of time and generally consume resources.
</para>
<para>
A task is termed critical when it has zero or negative float.
</para>
<para>
In &kplato;, each task has a task ID, a name and a responsible person.
The timing, the cost and the assigned resources can also be set
in the <guilabel>Task Settings</guilabel>dialog.
</para>
<para>A subtask is any node in the WBS tree that has a task as its
parent.</para>
</sect1>
<sect1 id="resource">
<title>Resource</title>
<para>
A resource is an item required to complete a task. Resources can be
people, equipment, facilities, funding or anything else needed to perform the
work of a project. Resources can have a limited time availability (&ie; an
employee that works 8 hours a day, 5 days a week).
</para>
<para>The availability is
defined by <link linkend="calendar">calendars</link>.
</para>
<para>
In &kplato; resources are either persons (work) or machines/devices (material).
</para>
</sect1>
<sect1 id="calendar">
<title>Calendars</title>
<para>
A calendar defines at what time a <link linkend="resource">resource</link>
is available.
</para>
<para>
Calendars can be either a regular working week or special working times
that can be individually defined for each day. This allows for very subtle
control over the availability of resources.
</para>
<para>
Every <link linkend="resource">resource</link> is usually connected to a
calendar.
</para>
<para>
In &kplato; you can even use hierarchical calendars.
</para>
</sect1>
<sect1 id="milestone">
<title>Milestone</title>
<para>
A milestone is a scheduled event signifying the completion of a major
deliverable or a set of related deliverables (usually marking the end of a
period). A milestone is an activity with zero duration and no effort &ie; there
is no work associated with a milestone. It is a flag in the workplan to signify
some other work has completed.
</para>
<para>
Usually a milestone is used as a project checkpoint to validate how the project
is progressing and revalidate work. Milestones are also used as high-level
snapshots for management to validate the progress of the project. In many cases
there is a decision to be made at a milestone.
</para>
</sect1>
<sect1 id="critical-path">
<title>Critical path</title>
<para>A path is a series of connected tasks. In project management, a
critical path is the sequence of project network terminal elements with the
longest overall duration, determining the shortest time to complete the project.
</para>
<para>
The duration of the critical path determines the duration of the entire project.
Any delay of a terminal element on the critical path directly impacts the
planned project completion date (i.e. there is no float on the critical path).
For example, if a task on the critical path is delayed by one day, then the
entire project will be delayed by one day (unless another task on the
critical path can be accelerated by one day).
</para>
<para>
A project can have several, parallel critical paths. An additional parallel path
through the network with the total duration just shorter than the critical path
is called a sub-critical path.
</para>
<para>
Originally, the critical path method considered only logical dependencies among
terminal elements. A related concept is the critical chain, which adds resource
dependencies.
</para>
<para>
The critical path method was invented by the DuPont corporation.
</para>
</sect1>
<sect1 id="scheduling">
<title>Scheduling</title>
<para>
Scheduling is the process of creating a project schedule based on the project
data like <link linkend="task">tasks</link>,
<link linkend="resource">resources</link> and
<link linkend="calendar">calendars</link>. The result can be viewed in a chart,
like a <link linkend="gantt">gantt chart</link>. &kplato; can also generate
reports for a project.
</para>
<para>
There are usually various scheduling modes, like optimistic, expected and
pessimistic scheduling. When creating a task the additional estimation
percentage
for optimistic and pessimistic scheduling can be set. These settings are then
used for the various scheduling modes.
</para>
<para>
When scheduling a project with &kplato;, you can choose between optimistic,
expected and pessimistic scheduling.
</para>
</sect1>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-parent-document: ("index.docbook" "book" "chapter")
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->

BIN
doc/kplato/edit-accounts.png
View File

Binary file not shown.

BIN
doc/kplato/edit-accounts1.png
View File

Binary file not shown.

BIN
doc/kplato/edit-calendar.png
View File

Binary file not shown.

BIN
doc/kplato/edit-calendar1.png
View File

Binary file not shown.

BIN
doc/kplato/edit-calendar2.png
View File

Binary file not shown.

BIN
doc/kplato/edit-resources.png
View File

Binary file not shown.

BIN
doc/kplato/edit-resources1.png
View File

Binary file not shown.

BIN
doc/kplato/edit-worktime.png
View File

Binary file not shown.

131
doc/kplato/index.docbook
Unescape View File

@ -0,0 +1,131 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kplato "KPlato">
<!ENTITY kappname "&kplato;">
<!ENTITY package "koffice">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
<!ENTITY definitions SYSTEM "definitions.docbook">
<!ENTITY mainwindow SYSTEM "mainwindow.docbook">
<!ENTITY wbs SYSTEM "wbs.docbook">
<!ENTITY options SYSTEM "options.docbook">
<!ENTITY commands SYSTEM "commands.docbook">
]>
<book lang="&language;">
<bookinfo>
<title>The &kplato; Handbook</title>
<authorgroup>
<author>
<firstname>Raphael</firstname>
<!-- <othername></othername> -->
<surname>Langerhorst</surname>
<affiliation>
<address><email>raphael.langerhorst@kdemail.net</email></address>
</affiliation>
</author>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annma@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<legalnotice>&FDLNotice;</legalnotice>
<!-- Date and version information of the documentation
Don't forget to include this last date and this last revision number, we
need them for translation coordination !
Please respect the format of the date (DD/MM/YYYY) and of the version
(Major.minor.lesser), it could be used by automation scripts -->
<date>2006-02-11</date>
<releaseinfo>0.5.0</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>
&kplato; is a project planning and management application for &kde;.
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KPlato</keyword>
<keyword>Project</keyword>
<keyword>Management</keyword>
<keyword>gantt</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction"> <title>Introduction</title>
<para><emphasis>
&kplato; as included in &koffice; 1.5 is a technology preview
release and it is not advised to use &kplato; in critical
production scenarios. Do so at your own risk. In this first public release we
focus on planning and scheduling of projects.
</emphasis></para>
<para>
&kplato; is a project management application and a planning tool.
As an integrated component of &koffice;, &kplato; can
be used within larger documents of other &koffice; components.
</para>
</chapter>
<chapter id="features"> <title>Features</title>
<itemizedlist>
<title>Features include:</title>
<listitem><para>Resource management,</para></listitem>
<listitem><para>Hierarchical calendars,</para></listitem>
<listitem><para>Tasks with dependencies and subtasks.</para></listitem>
<listitem>
<itemizedlist>
<title>Chart for visualization:</title>
<listitem><para>Gantt</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<itemizedlist><title>Project scheduling</title>
<listitem><para>Pessimistic,</para></listitem>
<listitem><para>Expected,</para></listitem>
<listitem><para>Optimistic.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Work breakdown structure (WBS).</para></listitem>
<listitem><para>Critical path and resources.</para></listitem>
<listitem><para>Embedding into other KOffice applications.</para></listitem>
</itemizedlist>
</chapter>
&definitions;
&mainwindow;
&wbs;
&options;
&commands;
<chapter id="license"><title>License</title>
&underFDL;
</chapter>
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->

53
doc/kplato/mainwindow.docbook
Unescape View File

@ -0,0 +1,53 @@
<chapter id="main-window">
<chapterinfo>
<authorgroup>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annma@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>&kplato; Main window</title>
<para>Here is the default &kplato; main window when you load an existing
project.</para>
<screenshot>
<screeninfo>Here's a screenshot of &kplato;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mainwindow1.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kplato; main window</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>At the top there is the menubar (1). All &kplato; functions are
available from the menus, which are described in detail in <xref
linkend="commands" />.</para>
<para>Below the menubar are located the toolbars (2) and (3). You can show or
hide them using the
<menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Toolbars</guimenuitem></menuchoice> menu. You can also configure
the toolbars (add or remove actions) using the
<menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem></menuchoice> dialog.
</para >
<para>(3) is the view toolbar. It allows you to quickly switch between
different views: Gantt, Resources or Accounts.</para>
<para>(4) is the main view. In the Gantt view currently shown on
the screenshot, you have 2 panes, one with the tasks names and one with
the Gantt chart.</para>
<para>(5) is the resource pane which you can see in the Gantt and Resources
views but not in the Account view. It is not shown per default and you
can drag the separation bar to display it.</para>
</chapter>

BIN
doc/kplato/mainwindow1.png
View File

Binary file not shown.

366
doc/kplato/options.docbook
Unescape View File

@ -0,0 +1,366 @@
<chapter id="options">
<chapterinfo>
<authorgroup>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annma@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Configuring &kplato;</title>
<sect1 id="project-settings">
<title>The <guilabel>Project Settings</guilabel> Dialog</title>
<para>This dialog allows you to set some properties for your current project.
You can access this dialog using the
<menuchoice><guimenu>Project</guimenu>
<guimenuitem>Edit Main Project...</guimenuitem></menuchoice> menu.</para>
<screenshot>
<screeninfo>The Project Settings dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="project-settings.png" format="PNG"/>
</imageobject>
<textobject><phrase>The Project Settings dialog</phrase></textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><guilabel>ID:</guilabel></term>
<listitem><para>Enter a number. It sets the project
identification and must be unique.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Name:</guilabel></term>
<listitem><para>Enter the name of your project.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Leader:</guilabel></term>
<listitem><para>Enter the name of the project leader. Clicking
the <guibutton>Choose...</guibutton> button will bring your
contact list from KAddressBook and you can choose a name here.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Scheduling</guilabel></term>
<listitem><para>Here you define when the project will start or
end. Choose either a start date or an end date.</para>
<variablelist>
<varlistentry>
<term><guilabel>Start Date:</guilabel></term>
<listitem><para>If a start date is set, the project is scheduled forward
from this time. When the project has been calculated, end time shows when the
project is planned to end.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>End Date:</guilabel></term>
<listitem><para>If a end date is set, the project is scheduled backwards
from this time. When the project has been calculated, start time shows when the
project must start in order to finish in time.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Project notes and summary:</guilabel></term>
<listitem><para>You can write here various notes associated
with the project or/and a project summary.</para></listitem>
</varlistentry>
</variablelist>
<para>Clicking the <guibutton>OK</guibutton> button will apply your changes and
close the dialog and clicking the <guibutton>Cancel</guibutton> button will
cancel any change you just made.</para>
</sect1>
<sect1 id="standard-worktime">
<title>The <guilabel>Standard Worktime</guilabel> Dialog</title>
<para>This dialog allows you to set the worktime in terms of hours.
You can access this dialog using the
<menuchoice><guimenu>Project</guimenu>
<guimenuitem>Edit Standard Worktime...</guimenuitem></menuchoice> menu.</para>
<screenshot>
<screeninfo>The Standard Worktime dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="edit-worktime.png" format="PNG"/>
</imageobject>
<textobject><phrase>The Standard Worktime dialog</phrase></textobject>
</mediaobject>
</screenshot>
<para>These values are used when you estimate the effort needed to
complete a task. Defaults are the numbers of hours worked in a normal
day/week/month and year.</para>
<variablelist>
<varlistentry>
<term><guilabel>Hours per year:</guilabel></term>
<listitem><para>Set the hours worked per year.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Hours per month:</guilabel></term>
<listitem><para>Set the hours worked per month.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Hours per week:</guilabel></term>
<listitem><para>Set the hours worked per week.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Hours per day:</guilabel></term>
<listitem><para>Set the hours worked per day.</para></listitem>
</varlistentry>
</variablelist>
<para>Clicking the <guibutton>OK</guibutton> button will apply your changes and
close the dialog and clicking the <guibutton>Cancel</guibutton> button will
cancel any change you just made.</para>
</sect1>
<sect1 id="edit-calendar">
<title>The <guilabel>Calendar's Settings</guilabel> Dialog</title>
<para>This dialog allows you to set a calendar for your current project.
You can access this dialog using the
<menuchoice><guimenu>Project</guimenu>
<guimenuitem>Edit Calendar...</guimenuitem></menuchoice> menu.</para>
<screenshot>
<screeninfo>The Calendar's Settings dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="edit-calendar.png" format="PNG"/>
</imageobject>
<textobject><phrase>The Calendar's Settings dialog</phrase></textobject>
</mediaobject>
</screenshot>
<para>You can have several calendars for your current project. First add a name
for your first calendar using the <guibutton>Add</guibutton> button. The
calendar view becomes active with the current day marked in a square
when you click on the calendar name.</para>
<screenshot>
<screeninfo>Working with a calendar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="edit-calendar1.png" format="PNG"/>
</imageobject>
<textobject><phrase>Working with a calendar</phrase></textobject>
</mediaobject>
</screenshot>
<para>You can set <guilabel>Working</guilabel> or <guilabel>Non-working</guilabel> days. Click on the days you want
as Working days for example for your project and choose <guilabel>Working</guilabel> instead
of <guilabel>Undefined</guilabel>. Set then the work interval by choosing the start and end
times and click the <guibutton>Add interval</guibutton> button to add the
working time. Click the <guibutton>Apply</guibutton> button to validate your
choice.</para>
<screenshot>
<screeninfo>Working and non-working days</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="edit-calendar2.png" format="PNG"/>
</imageobject>
<textobject><phrase>Working and non-working days</phrase></textobject>
</mediaobject>
</screenshot>
<para>Here you can see the working days in blue and the non-working day
in red.</para>
<para>Clicking the <guibutton>OK</guibutton> button will apply your changes and
close the dialog and clicking the <guibutton>Cancel</guibutton> button will
cancel any change you just made.</para>
</sect1>
<sect1 id="edit-accounts">
<title>The <guilabel>Edit Accounts</guilabel> Dialog</title>
<para>Accounts are used to evaluate the project cost. This dialog allows you to
set up the various accounts used in your current project.
You can access this dialog using the
<menuchoice><guimenu>Project</guimenu>
<guimenuitem>Edit Accounts...</guimenuitem></menuchoice> menu.</para>
<screenshot>
<screeninfo>The Edit Accounts dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="edit-accounts.png" format="PNG"/>
</imageobject>
<textobject><phrase>The Edit Accounts dialog</phrase></textobject>
</mediaobject>
</screenshot>
<para>To create an account, click the <guibutton>New</guibutton> button.
You can then enter the account name which you validate by using the Enter
key. You can add a short description of this account by double-clicking
in the description field.</para>
<para>You can create sub-accounts of your main account or a new account. Remove
any highlighted account using the <guibutton>Remove</guibutton> button.</para>
<para>You can also set a default account by choosing the account name in
the drop-down list.</para>
<screenshot>
<screeninfo>Creating accounts</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="edit-accounts1.png" format="PNG"/>
</imageobject>
<textobject><phrase>Creating accounts</phrase></textobject>
</mediaobject>
</screenshot>
<para>Clicking the <guibutton>OK</guibutton> button will apply your changes and
close the dialog and clicking the <guibutton>Cancel</guibutton> button will
cancel any change you just made.</para>
</sect1>
<sect1 id="edit-resources">
<title>The <guilabel>Resources</guilabel> Dialog</title>
<para>This dialog allows you to set the resources for your current project.
You can access this dialog using the
<menuchoice><guimenu>Project</guimenu>
<guimenuitem>Edit Resources...</guimenuitem></menuchoice> menu.</para>
<screenshot>
<screeninfo>The Resources dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="edit-resources.png" format="PNG"/>
</imageobject>
<textobject><phrase>The Resources dialog</phrase></textobject>
</mediaobject>
</screenshot>
<para>You need first to define a resource group by clicking the
<guibutton>New</guibutton> button in the resource group area. Click on
this group name and add a new resource by clicking the
<guibutton>New</guibutton> button in the resource area. This will display
the <guilabel>Resource Settings</guilabel> dialog.</para>
<screenshot>
<screeninfo>The Resources Settings dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="edit-resources1.png" format="PNG"/>
</imageobject>
<textobject><phrase>The Resources Settings dialog</phrase></textobject>
</mediaobject>
</screenshot>
<para>Clicking the <guibutton>OK</guibutton> button will apply your changes and
close the dialog and clicking the <guibutton>Cancel</guibutton> button will
cancel any change you just made.</para>
</sect1>
<sect1 id="configure-dialog">
<title>The <guilabel>Configure &kplato;...</guilabel> Dialog</title>
<para>This dialog allows you to set default options globally in &kplato;. You
can access this dialog using the
<menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure &kplato;...</guimenuitem></menuchoice> menu.</para>
<para>On any widget in this dialog you can get a <guilabel>What's This
</guilabel>help with <keycombo
action="simul">&Shift;<keycap>F1</keycap></keycombo> or using the
<guiicon>Help</guiicon> icon.
</para>
<sect2 id="configure-task-defaults">
<title><guilabel>Task Defaults</guilabel></title>
<para>This set the options that will be used per default each time you add a
new task.
</para>
<screenshot>
<screeninfo>Task Defaults</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="configure2.png" format="PNG"/>
</imageobject>
<textobject><phrase>Task Defaults</phrase></textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><guilabel>Responsible:</guilabel></term>
<listitem><para>Insert the name of the person responsible for this task.
This is not limited to persons available in a resource group but can be
anyone.</para>
<para>Clicking the <guibutton>Choose...</guibutton> button will allow you to
insert a person from your address book.</para>
<screenshot>
<screeninfo>Addresses</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="configure2.1.png" format="PNG"/>
</imageobject>
<textobject><phrase>Addresses</phrase></textobject>
</mediaobject>
</screenshot>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Timing</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Schedule:</guilabel></term>
<listitem><para>Choose the scheduling constraint you would
like as default. Depending on this constraint, the date fields
become available if they need to be filled. These
settings affect the actual scheduling of the task.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Estimate:</guilabel></term>
<listitem><para>Estimates the predictions of the quantitative
results. The estimation can be either effort based or duration based. If it is
effort based, the final duration will depend on the resources assigned to the
task. For duration based estimation, the assigned resources don't affect the
fixed duration of the task, but only the costs.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Note:</guilabel></term>
<listitem><para>Write here a note that you would like to be
displayed as default on each new task.</para></listitem>
</varlistentry>
</variablelist>
<para>Clicking the <guibutton>Defaults</guibutton> button will reset the
dialog to its defaults, while clicking <guibutton>Apply</guibutton> will apply
your changes but leave the dialog open. Clicking the <guibutton>OK</guibutton>
button will apply your changes and close the dialog and
<guibutton>Cancel</guibutton> will cancel any change you just made.</para>
</sect2>
</sect1>
</chapter>

BIN
doc/kplato/project-settings.png
View File

Binary file not shown.

139
doc/kplato/wbs.docbook
Unescape View File

@ -0,0 +1,139 @@
<chapter id="configure-wbs">
<chapterinfo>
<authorgroup>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annma@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Configuring the Work Breakdown Structure (WBS)</title>
<para>The <link linkend="wbs">Work Breakdown Structure</link> introduces
numbering for all tasks in the
project, according to the task structure. The tasks are numbered in a fashion
that reflects the structure of the project.
The WBS is defined as a tree structure.
</para>
<screenshot>
<screeninfo>The WBS</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="wbs.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>The WBS</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>You can configure the way you want the WBS to look in your project. To do
so, you can use the <menuchoice>
<guimenu>Tools</guimenu><guimenuitem>Define WBS Pattern...
</guimenuitem></menuchoice> menu. This displays the <guilabel>WBS Definition</guilabel> Dialog.
</para>
<sect1 id="define-wbs">
<title>The WBS Definition Dialog</title>
<screenshot>
<screeninfo>WBS Definition Dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="configure-wbs.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>WBS Definition Dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><guilabel>Code</guilabel></term>
<listitem><para>Default is <guilabel>Number</guilabel> but you can set the WBS
code to be Roman Numbers or Letters, either upper case or
lower case.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Separator</guilabel></term>
<listitem><para>The default separator is a dot and can be set
to anything else you want. The separator defines the way the
tree will look. On the screenshot above, the separator is the
dot.</para></listitem>
</varlistentry>
</variablelist>
<para>Instead of having the same code for all levels (for example 3.2.1)
you can define a different code for each level. For this you can check
<guilabel>Use Levels</guilabel> and then you define each level code and
separator.</para>
<para>For example if you want your tree to be 1:II-B you will set
level 0 to Number and separator :, level 1 will be Roman upper case and
separator - and level 2 will be Letter upper case.</para>
<para>This is illustrated on the next screenshot.</para>
<screenshot>
<screeninfo>WBS levels definition</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="wbs1.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>WBS levels definition</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>To set a new level, choose the level number in the box near the
<guibutton>Add Level</guibutton> button then click the <guibutton>Add
Level</guibutton> button. Then choose the Code for the level and the
separator.</para>
<screenshot>
<screeninfo>Add a level</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="wbs3.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Add a level</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>To remove a level, choose the level number in the first column of the
list and click on it. The level row is then highlighted and the level number
changes to bold. Then click the <guibutton>Remove</guibutton> button. This is
demonstrated on the screenshot with Level 2.</para>
<screenshot>
<screeninfo>Remove a level</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="wbs2.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Remove a level</phrase>
</textobject>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="generate-wbs-code">
<title><guilabel>Generate WBS Code</guilabel></title>
<para>The WBS code is auto-generated; simply choose <guimenuitem>Generate WBS
Code</guimenuitem> from the <guimenu>Tools</guimenu> menu to generate the
WBS code for the project.</para>
<para>After you changed the WBS definition you will want to generate the
new WBS.</para>
</sect1>
</chapter>

BIN
doc/kplato/wbs.png
View File

Binary file not shown.

BIN
doc/kplato/wbs1.png
View File

Binary file not shown.

BIN
doc/kplato/wbs2.png
View File

Binary file not shown.

BIN
doc/kplato/wbs3.png
View File

Binary file not shown.

4
doc/kpresenter/Makefile.am
Unescape View File

@ -0,0 +1,4 @@
KDE_LANG = en
KDE_DOCS = AUTO

321
doc/kpresenter/a11y.docbook
Unescape View File

@ -0,0 +1,321 @@
<chapter id="a11y">
<chapterinfo>
<authorgroup>
<author>
<firstname>Gary</firstname>
<surname>Cramblitt</surname>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>For Users with Disabilities</title>
<para>This section of the documentation discusses accessibility features in &kpresenter;
for users with disabilities. Some of these features apply to &kde; as a whole and are controlled from
<ulink url="help:kcontrol">&kcontrolcenter;</ulink>. Some apply to all &koffice; applications,
and some are specific to &kpresenter;.</para>
<sect1 id="a11y-install">
<title>Installing the <command>kdeaccessibility</command> Module</title>
<indexterm><primary>kdeaccessibility</primary></indexterm>
<para>
Most of the features described in this chapter are enabled by installing the
<command>kdeaccessibility</command> module.
The <command>kdeaccessibility</command> module is part of the &kde; project
<ulink url="http://www.kde.org">http://www.kde.org</ulink>. The <command>kdeaccessibility</command>
package can be obtained from &kde-ftp;, the
main ftp site of the &kde; project.
</para>
<para>Many distributions offer precompiled binaries on their ftp sites. Please check your distribution's web sites for more information.</para>
<para>More information about &kde; accessibility can be obtained by
visiting <ulink url="http://accessibility.kde.org/">http://accessibility.kde.org/</ulink>.
</para>
</sect1>
<sect1 id="a11y-sight">
<title>Visual Impairments</title>
<indexterm><primary>Visual Impairments</primary></indexterm>
<note><para>&kpresenter; is not usable by totally blind users. It is hoped that
a general screen reader for the blind will be available in future versions of &kde;.
</para></note>
<sect2 id="a11y-theming">
<title>Theming</title>
<indexterm><primary>Theming</primary></indexterm>
<para>For low-sighted or light alergic users, several features are available from
<menuchoice><guimenu>K-Button</guimenu><guimenuitem>&kcontrolcenter;</guimenuitem></menuchoice>.
Under <menuchoice><guimenu>Appearance &amp; Themes</guimenu><guimenuitem>Theme Manager</guimenuitem>
</menuchoice>, you may select from several themes. If you are light alergic, the
<guilabel>HighContrastDark</guilabel> or <guilabel>HighContrastLight</guilabel> themes
may be helpful. If you have difficulty reading small fonts or seeing small icons, the
<guilabel>HighContrastDark-Big</guilabel> or <guilabel>HighContrastLight-Big</guilabel>
themes will increase the size of text, buttons, and icons. You may also customize
background, colors, fonts, and icons from the same screen. A set of monochrome icons
is available.
</para>
<tip><para>If you choose one of the <guilabel>Big</guilabel> themes, you may discover that
some screens are too large to fit your monitor. Purchasing a larger monitor will be helpful.
You can drag the portions of the screen not visible into the visable area by
holding down the &Alt; key and dragging with the mouse anywhere
within the screen. If you have trouble operating a mouse, you can also move screens by pressing
<keycombo action="simul">&Alt;<keycap>F3</keycap></keycombo>. In
the dropdown Windows Operations Menu, choose
<menuchoice><guimenuitem>Move</guimenuitem></menuchoice>.
Move the screen with the arrow keys and press <keycap>&Esc;</keycap>.
</para></tip>
</sect2>
<sect2 id="a11y-kmagnifier">
<title>KMagnifier</title>
<indexterm><primary>magnifier</primary></indexterm>
<para>The <command>kdeaccessibility</command> module includes a screen magnifier
application called <ulink url="help:kmag">KMagnifier</ulink>.
If it is installed, you may run it from
<menuchoice><guimenu>K-Button</guimenu><guimenuitem>Utilities</guimenuitem>
<guimenuitem>Accessibility</guimenuitem><guimenuitem>Screen Magnifier</guimenuitem></menuchoice>.
</para>
</sect2>
<sect2 id="a11y-tts">
<title>Text-to-Speech</title>
<indexterm><primary>Text-to-Speech</primary></indexterm>
<indexterm><primary>TTS</primary></indexterm>
<para>The <command>kdeaccessibility</command> module includes a Text-to-Speech
component called KTTS. If KTTS is installed, you can configure &kpresenter; to
speak the text that is under the mouse pointer or speak the text of each
screen widget as it receives focus. Before using this feature, first configure
KTTS. See <ulink url="help:kttsd">The KTTS Handbook</ulink> for details.
To turn on the TTS feature in &kpresenter;,
select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
&kpresenter;...</guimenuitem></menuchoice> from the menubar.
This will display a dialog box.
Clicking <guibutton>TTS</guibutton> will allow you to change
the following.</para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="tts.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><guilabel>Speak widget under mouse pointer</guilabel></term>
<listitem><para>When checked, &kpresenter; will speak the text of each widget
as the mouse pointer moves over the widget.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Speak widget with focus</guilabel></term>
<listitem><para>When checked, &kpresenter; will speak the text of each widget
as it receives focus.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Speak tool tips</guilabel></term>
<listitem><para>When checked, &kpresenter; will speak the popup tool tip
for each widget in addition to the text of the widget.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Speak Whats This</guilabel></term>
<listitem><para>When checked, &kpresenter; will speak the Whats This help
for each widget in addition to the text of the widget.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Say whether disabled</guilabel></term>
<listitem><para>When checked, &kpresenter; will speak the word "disabled"
if the widget is currently disabled (grayed).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Speak accelerators</guilabel></term>
<listitem><para>When checked, &kpresenter; will speak the accelerator
of the widget in addition to the text of the widget.
Accelerators are the underlined letters you see in the text of the
widget. For example, in the main menu, the
<menuchoice><guimenuitem>Quit</guimenuitem></menuchoice> menu item
has the "Q" underlined. You can choose it by pressing <keycap>Q</keycap>.
To speak the accelerator, check this option and enter the
word you want to speak before the accelerator in the
<guilabel>Prefaced by the word</guilabel> box. In this
example shown above, &kpresenter; will speak "Accelerator Q".</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Polling interval</guilabel></term>
<listitem><para>This option determines how often &kpresenter; will
check for a change in the widget under the mouse pointer or
a new focused widget. You should leave this option on the
default setting.</para>
</listitem>
</varlistentry>
</variablelist>
<note><para>
If the <guibutton>TTS</guibutton> option does not appear
on this screen, you do not have the KTTS component installed
in your system.
</para></note>
<note><para>Not all widgets are spoken. For example,
the items on the main menubar are not spoken.
</para></note>
</sect2>
</sect1>
<sect1 id="a11y-motor">
<title>Motor Impairments and Mouseless Operation</title>
<indexterm><primary>Motor Impairments</primary></indexterm>
<indexterm><primary>Mouseless Operation</primary></indexterm>
<sect2 id="a11y-kmousetool">
<title>KMouseTool</title>
<para>If you can operate a mouse, but have trouble clicking, the
<ulink url="help:kmousetool">KMouseTool</ulink> application may help. Run it from
<menuchoice><guimenu>K-Button</guimenu><guimenuitem>Utilities</guimenuitem>
<guimenuitem>KMouseTool (Automatik Mouse Click)</guimenuitem></menuchoice>.
</para>
</sect2>
<sect2 id="a11y-kbd-xaccess">
<title>XAccess Features</title>
<indexterm><primary>XAccess</primary></indexterm>
<indexterm><primary>Sticky Keys</primary></indexterm>
<indexterm><primary>Slow Keys</primary></indexterm>
<indexterm><primary>Bounce Keys</primary></indexterm>
<para>The &kcontrolcenter; offers several keyboard features collectively called XAccess.
They include:</para>
<variablelist>
<varlistentry>
<term>Sticky Keys</term>
<listitem><para>This feature permits operation of meta keys, such as
&Alt;, &Ctrl;, and &Shift; without having to hold the keys down. It is useful
when you can only use one finger or one hand to operate the keyboard.
With Sticky Keys on, press and release a &Alt;, &Ctrl;, or &Shift; key, then
press another key. The result is as if you pressed both keys at once.
Press the &Alt;, &Ctrl;, or &Shift; key again to turn off the sticky key.
Activate this feature in
<menuchoice><guimenu>K-Button</guimenu><guimenuitem>&kcontrolcenter;</guimenuitem>
<guimenuitem>Regional &amp; Accessibility</guimenuitem><guimenuitem>Modifier Keys</guimenuitem></menuchoice>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Slow Keys</term>
<listitem><para>This feature is useful if you have hand tremors or difficulty
accurately pressing keys. It prevents
inadvertent key presses by requiring that a key be held down for a minimum
time before it is accepted. Activate this feature in
<menuchoice><guimenu>K-Button</guimenu><guimenuitem>&kcontrolcenter;</guimenuitem>
<guimenuitem>Regional &amp; Accessibility</guimenuitem><guimenuitem>Keyboard Filters </guimenuitem></menuchoice>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Bounce Keys</term>
<listitem><para>This feature is also useful if you have hand tremors. It prevents
inadvertent repeated key presses by preventing another keystroke for
a certain amount of time. Activate this feature in
<menuchoice><guimenu>K-Button</guimenu><guimenuitem>&kcontrolcenter;</guimenuitem>
<guimenuitem>Regional &amp; Accessibility</guimenuitem><guimenuitem>Keyboard Filters</guimenuitem></menuchoice>.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="a11y-mouse-emulation">
<title>Mouse Emulation</title>
<indexterm><primary>Mouse Emulation</primary></indexterm>
<para>Mouse Emulation permits you to move and click the mouse using the keyboard.
Press <keycombo>&Alt;<keycap>F12</keycap></keycombo> to activate it. Use the arrow keys
to move the mouse pointer to the desired location, and press <keycap>spacebar</keycap>
to "click" the mouse. Unfortunately, you cannot use Mouse Emulation to perform
&RMB; clicks or dragging.
</para>
</sect2>
<sect2 id="a11y-mouse-navigation">
<title>Mouse Navigation</title>
<indexterm><primary>Mouse Navigation</primary></indexterm>
<para>This feature permits you to emulate the mouse using the numeric keypad
of your keyboard. To activate it, go to
<menuchoice><guimenu>K-Button</guimenu><guimenuitem>&kcontrolcenter;</guimenuitem>
<guimenuitem>Peripherals</guimenuitem><guimenuitem>Mouse</guimenuitem>
<guimenuitem>Mouse Navigation</guimenuitem></menuchoice>.
Check the <guilabel>Move pointer with keyboard (using the num pad)</guilabel> box. When you do this, the other settings will become enabled, and you can customize the keyboard pointer behavior further, if required.
The various keys on the number pad move in the direction you would expect. Note that you can move diagonally as well as up, down, left and right. The <keycap>5</keycap> key emulates a click to a pointer button, typically &LMB;. You change which button is emulated by using the <keycap>/</keycap> key (which makes it &LMB;),
<keycap>*</keycap> key (which makes it middle mouse button) and <keycap>-</keycap> (which makes it &RMB;).
Using the <keycap>+</keycap> emulates a doubleclick to the selected pointer button. You can use the
<keycap>0</keycap> key to emulate holding down the selected pointer button (for easy dragging),
and then use the <keycap>.</keycap> to emulate releasing the selected pointer button.
</para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="mousenav.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
</sect2>
<sect2 id="a11y-motor-shortcuts">
<title>Keyboard shortcuts</title>
<para>Use the <keycap>Menu</keycap> key to pop up the context
menu. On most keyboards, the <keycap>Menu</keycap> key is on the righthand
side of the keyboard between the <keycap>&Windows;</keycap> and &Ctrl;
keys. It has a menu icon on it.
</para>
</sect2>
<sect2 id="a11y-motor-panel-sizing">
<title>Resizing panels</title>
<para>You can move the sizing bar between the outline panel and the
slide panel, and between the slide panel and the notes panel
by pressing <keycap>F8</keycap>. A sizing icon appears
overtop the sizing bar. Pressing <keycap>F8</keycap> again moves from one
sizing bar to the next. After the last sizing bar, pressing <keycap>F8</keycap>
hides the sizing icon. Use the arrow keys to move the bar up or down, or left or right.
Press &Esc; when finished sizing.
</para>
</sect2>
<sect2 id="a11y-motor-moving-focus">
<title>Setting focus to widgets</title>
<para>Normally, one can use the &Tab; and <keycombo action="simul">&Shift;&Tab;</keycombo>
to move focus from one widget to the next in any application. However, when focus is
in the slide panel of &kpresenter;, pressing &Tab; does not move the focus.
You can set focus to any widget that can receive focus by
pressing <keycombo action="simul">&Alt;<keycap>F8</keycap></keycombo>. A small lettered box appears
overtop each widget on the screen that can receive focus.
</para>
<screenshot>
<mediaobject>
<imageobject><imagedata fileref="kbd-focus-ext.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>Press the letter to move focus to the corresponding widget. Press
<keycombo action="simul">&Alt;<keycap>F8</keycap></keycombo> again or &Esc;
to abandon moving the focus.
</para>
</sect2>
</sect1>
</chapter>

BIN
doc/kpresenter/autocorrection1.png
View File

Binary file not shown.

BIN
doc/kpresenter/autocorrection2.png
View File

Binary file not shown.

BIN
doc/kpresenter/autocorrection3.png
View File

Binary file not shown.

BIN
doc/kpresenter/autocorrection4.png
View File

Binary file not shown.

BIN
doc/kpresenter/barstyle1.png
View File

Binary file not shown.

BIN
doc/kpresenter/barstyle3.png
View File

Binary file not shown.

BIN
doc/kpresenter/barstyle4.png
View File

Binary file not shown.

BIN
doc/kpresenter/barstyle5.png
View File

Binary file not shown.

BIN
doc/kpresenter/barstyle6.png
View File

Binary file not shown.

BIN
doc/kpresenter/barstyle7.png
View File

Binary file not shown.

BIN
doc/kpresenter/break.png
View File

Binary file not shown.

BIN
doc/kpresenter/changeformat.png
View File

Binary file not shown.

BIN
doc/kpresenter/completion.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure1.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure2.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure3.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure4.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure4a.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure4a1.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure4b.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure4c.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure5.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure6.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure6b.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure6c.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure6d.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure6e.png
View File

Binary file not shown.

BIN
doc/kpresenter/configure7.png
View File

Binary file not shown.

53
doc/kpresenter/faq.docbook
Unescape View File

@ -0,0 +1,53 @@
<chapter id="q-and-a">
<chapterinfo>
<authorgroup>
<author>
<firstname>Neil</firstname>
<surname>Lucock</surname>
<affiliation>
<address><email>neil@nlucock.freeserve.co.uk</email></address>
</affiliation>
</author>
<author>
<firstname>Krishna</firstname>
<surname>Tateneni</surname>
<affiliation>
<address><email>tateneni@pluto.njcc.com</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Questions and Answers</title>
<subtitle>&kpresenter; 1.6</subtitle>
<para>Things you might like but &kpresenter; does not yet do (and what
to do about it)</para>
<!--
FIXME: Does video embedding via kmplayer or kaboodle work?
<para>Movies or video. You cannot run video within &kpresenter;. If
you really need to show a movie, make a link to it on your desktop,
move &kpresenter; out of the way, click the link to the movie file and
use <application>mplayer</application> (or similar) to view it.</para>
-->
<para><application>Powerpoint</application> Files. &kpresenter; does
attempt to import &Microsoft; <application>Powerpoint</application>
files but it does not always work perfectly. It depends on the
<application>Powerpoint</application> file version and what is in the
file. You can always import pictures for the background image and
re-type any text. It's not the ideal solution, re-doing the entire
presentation. However, just bear in mind that
<application>Powerpoint</application> does not even attempt to read
&kpresenter; files.</para>
<para>Taking notes or minutes. One piece of software allows you to
make notes during the meeting and puts them into a word
processor. If you are speaking, someone else should be taking notes. If
you really must do this sort of thing, take a note pad and pencil.
</para>
</chapter>

145
doc/kpresenter/great-presentations.docbook
Unescape View File

@ -0,0 +1,145 @@
<!--
<?xml version="1.0" ?>
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd">
To edit or validate this document separately, uncomment this prolog
Be sure to comment it out again when you are done -->
<chapter id="hints-and-tips">
<chapterinfo>
<authorgroup>
<author>
<firstname>Neil</firstname>
<surname>Lucock</surname>
<affiliation>
<address><email>neil@nlucock.freeserve.co.uk</email></address>
</affiliation>
</author>
<author>
<firstname>Krishna</firstname>
<surname>Tateneni</surname>
<affiliation>
<address><email>tateneni@pluto.njcc.com</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>General Hints and Tips for Great Presentations</title>
<para>Okay, you've decided to use &kpresenter; for your
presentation. Before you start making transparencies or animated slide
shows, go and find a piece of paper and sit down at a desk away from
the computer. It doesn't matter whether you are doing a teaching
session or trying to convince the boss that your plan, policy or idea
should be adopted, you need to figure out what you are trying to
say. Write down all the subjects you need to cover, try to get them in
the order you think will make sense. Don't put any details in yet,
just decide on headings and the structure of your talk.</para>
<para>Under each heading make a note of what facts you need to
cover. You are trying to build a convincing argument. Consider
grouping your facts into things must be included, things that should
be included and things that it would be nice to cover if you had
plenty of time.</para>
<para>Once you have written down all the things you need to say,
consider the time available to do it in. Ten minutes seems ages when
you start, but it is very difficult to actually get much across in so
short a time. Get your sheet of paper and a clock with a second
hand. Practise your presentation over and over again. This has many
benefits. Firstly, you get the timing right. If someone says you have
ten minutes, never go over the allowed time. Secondly, when you
actually do it in front of a live audience, it will not be the first
time you have done that presentation. Third, you get the words right
in your own head. You will find ways of saying things about the
subject. If you've heard yourself do this presentation several times,
you will know what you are going to say next and how you are going to
say it. </para>
<para>&kpresenter; does not produce Speaker's Notes at the time of
writing, but I am happy to just use ordinary slides. Produce some
slides for yourself, printed on plain paper, and some for use with the
Overhead Projector. Make the text on your slides nice and big, you
need to be able to read it at a distance. I use 14 or 16 point text,
experiment to find a size that you can read easily. I never write out
a script.</para>
<para>If you are using an Overhead projector, learn how to use it
beforehand. Make sure that the bulb works, that the spare bulb is
still okay. Clean the lens and display plates. If you are not used to
working with projectors, practice. Ensure that the projection screen
itself is clean. It's probably best, when timing yourself, to allow
for five seconds (count <quote>one thousand and one, one thousand and
two....</quote>) to change each slide. That way you know you don't
have to rush. If you need to point at something on a slide, you can
use a pointer and point at the display screen, find a laser pointer or
put a pencil on the transparency itself. Be warned, these tend to roll
out of place when you nudge the table.</para>
<para>Consider where you are going to stand. You cannot stand in
front of your display, so off to one side is probably your best option
if you want your audience to be able to see. I often project a picture
onto a wipeboard and draw over the top of it. If you are using a PC
with a digital projector you can draw over the top of your slides with
&kpresenter;'s pen tool. Remember, drawing freehand with a mouse is a
skill that needs practice. If you are using an Overhead projector, you
can use transparent overlay slides and a pen over the top of your
computer generated ones.</para>
<para>When you are doing the presentation do not accidently look into
the light, it's easy to do. If you are not going to use the machine
for a few minutes, turn it off. Practise to get where you are going
to stand sorted out. Check the room you intend to use for electrical
sockets and learn how the blinds work and where the light switches
are. Good preparation not only makes you less likely to make mistakes
(inanimate things can be a nightmare in front of an audience) but also
gives you confidence. Always have a <quote>Plan B</quote> ready if
something refuses to work. Have a paper copy of your slides with
you. You can photocopy and distribute these to your audience if the
equipment fails.</para>
<para>I have not said much about the content yet. At present all you
have is a piece of paper with everything you want to say on it. Before
you make anything, ask youself if their understanding of what you are
saying is going to improved by showing them a picture. Bad
presentations consist of a series of slides full of text. The
presenter then reads the slide to the audience (who have already read
it as they can read faster than someone can say it aloud). Try to
avoid writing anything on the slide, except a title and a number. Draw
a picture of what you need to say, then explain the picture to
them. That way they do not get ahead of you (they can read faster than
you can speak, remember?) and you look like you know it. You do not
know it, you are using the picture as a series of prompts. A slide
should support what you are saying, not duplicate it. A slide should
be the focus of the audience's attention, not a distraction.</para>
<para>An example. I teach Railway staff how to respond to accidents. I
wanted to use a slide to discuss how you can move dangerous loads from
a derailed or damaged rail vehicle to a road vehicle after an
accident. The slide I made had a simple drawing of tank wagon, the
kind used for carrying gases or oils. On the side I wrote
<quote>Lethal Chemical Company</quote> so that I do not have to
explain it. I wanted to make several important points. First, you must
get any overhead electric wires turned off before you do anything if
they are within a certain distance. I drew one of the supporting
structures and drew an arrow with the safety distance on it. Then I
wanted to say that you must not transfer the wagon's contents in
darkness or thunderstorms. I drew a moon and a lightning bolt above
the vehicle. You must get specialist advice, so I drew a sheet of
paper and wrote the word <quote>Plan</quote> near the vehicle. You
also have to ensure that the vehicle does not move when the weight
inside is removed. I drew little red wedges by the wheels. Everything
I need to talk about is on this drawing. All I have to do is look at
the drawing and it tells me what I need to cover. When I have covered
all the things in the drawing, I have finished on that
subject. </para>
<para>In general, only use a slide or picture if it shows something
that adds to what you are saying. Finally, relax and try not to rush
through it all. Talk to them, not at them and remember that a
presentation is about whatever message you are trying to get
across. &kpresenter; is a useful tool. It can help you to get that
message over, but it cannot do the job for you.</para>
</chapter>

556
doc/kpresenter/guides.docbook
Unescape View File

@ -0,0 +1,556 @@
<chapter id="guides">
<chapterinfo>
<authorgroup>
<author>
<firstname>Neil</firstname>
<surname>Lucock</surname>
<affiliation>
<address><email>neil@nlucock.freeserve.co.uk</email></address>
</affiliation>
</author>
<author>
<firstname>Krishna</firstname>
<surname>Tateneni</surname>
<affiliation>
<address><email>tateneni@pluto.njcc.com</email></address>
</affiliation>
</author>
<author>
<firstname>Brad</firstname>
<surname>Hards</surname>
<affiliation>
<address><email>bradh@frogmouth.net</email></address>
</affiliation>
</author>
<author>
<firstname>Danny</firstname>
<surname>Allen</surname>
<affiliation>
<address><email>danny@dannyallen.co.uk</email></address>
</affiliation>
</author>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annemarie.mahfouf@free.fr</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Detailed Guides</title>
<para>This chapter describes how to perform some common tasks in
&kpresenter;.</para>
<sect1 id="html-wizard">
<title>Create a <acronym>HTML</acronym> Slideshow</title>
<para>Turn an existing presentation into standard <acronym>HTML</acronym>
pages with accompanying navigation aids.</para>
<procedure>
<step>
<para>First, either make a new presentation, or open an existing one. Then,
click on <guimenu>File</guimenu><guimenuitem>Create HTML
Slideshow...</guimenuitem></para>
<screenshot>
<screeninfo>File menu option to <guimenuitem>Create HTML
Slideshow...</guimenuitem></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="htmlshow1.png" format="PNG"/>
</imageobject>
<textobject><phrase>File menu option to <guimenuitem>Create HTML
Slideshow...</guimenuitem></phrase></textobject>
</mediaobject>
</screenshot>
</step>
<step>
<para>A dialog box asks if you want to use a previously saved
configuration:</para>
<screenshot>
<screeninfo>Previous configuration dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="htmlshow2.png" format="PNG"/>
</imageobject>
<textobject><phrase>Previous configuration dialog</phrase></textobject>
</mediaobject>
</screenshot>
<para>Click <guibutton>No</guibutton> if this is the first time that you have
used this feature, or if you want to alter specific options. The
<guibutton>Yes</guibutton> option allows you to use details that you have
previously entered for your <acronym>HTML</acronym> slideshow, so that you can
quickly create the slideshow without needing to adjust the options.</para>
</step>
<step>
<para>You will then get a dialog box asking for a few details:</para>
<screenshot>
<screeninfo>Fill in the details for your <acronym>HTML</acronym>
slideshow</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="htmlshow3.png" format="PNG"/>
</imageobject>
<textobject><phrase>Fill in the details for your <acronym>HTML</acronym>
slideshow</phrase></textobject>
</mediaobject>
</screenshot>
<para>Fill in each field (the dialog takes the informations from &kcontrol; if they exist) and ensure that the path details are correct, as this
is where &kpresenter; will save your new <acronym>HTML</acronym> files
and pictures. Click on the <guibutton>Next</guibutton> when you are
done.</para>
<para>If the path you select at this stage does not exist, &kpresenter; will
ask if you would like to create it.</para></step>
<step>
<para>Now you can configure the specific <acronym>HTML</acronym> options:</para>
<screenshot>
<screeninfo>Fill in additional details for your <acronym>HTML</acronym>
slideshow</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="htmlshow4.png" format="PNG"/>
</imageobject>
<textobject><phrase>Fill in additional details for your <acronym>HTML</acronym>
slideshow</phrase></textobject>
</mediaobject>
</screenshot>
<para>Here, the encoding and format details can be changed, along with
the zoom level of the slides. For example, if you originally designed your
slides to display full screen on a 1280 x 1024 resolution screen, you could
scale the slides to 50% to enable them to be easily viewed in a much smaller web
browser window.</para>
<para>In most cases, the defaults will be fine, and you can safely press the
<guibutton>Next</guibutton> to continue to the next page.</para>
</step>
<step>
<para>Now you can customize the colors of the web pages:</para>
<screenshot>
<screeninfo>Setting up the display style for your <acronym>HTML</acronym>
slideshow</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="htmlshow5.png" format="PNG"/>
</imageobject>
<textobject><phrase>Setting up the display style for your
<acronym>HTML</acronym>
slideshow</phrase></textobject>
</mediaobject>
</screenshot>
<para>When &kpresenter; creates the web pages for you, the text colors
for the navigation aids will follow whatever you set here. To change any of
these colors, click the colored bar next to the corresponding text label. The
colors used in your actual slides will be unchanged.</para>
<tip><para>Choose colors that are complementary to the contents of your
presentation.</para></tip>
</step>
<step><para>The <guibutton>Next</guibutton> button presents a dialog box
that allows you to change the name used on the <acronym>HTML</acronym> page for
each slide:</para>
<screenshot>
<screeninfo>Setting the slide names</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="htmlshow6.png" format="PNG"/>
</imageobject>
<textobject><phrase>Setting the slide names</phrase>
</textobject>
</mediaobject>
</screenshot>
</step>
<step>
<para>If your presentation was intended to be displayed in an unattended manner
(&ie; automatic advance to next slide, &etc;), you can also make your
<acronym>HTML</acronym>
presentation counterpart exhibit the same behavior:</para>
<screenshot>
<screeninfo>Unattended presentations</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="htmlshow7.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Unattended presentations</phrase></textobject>
</mediaobject>
</screenshot>
<para>Here, you can force the slide to advance to the next after a specified
amount of time, and also make the presentation return to the start once it
reaches the end.</para>
</step>
<step>
<para>Now it is time to actually produce your <acronym>HTML</acronym>
presentation, the progress of
which is shown in this dialog box:</para>
<screenshot>
<screeninfo>Saving your configuration</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="htmlshow8.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Saving your configuration</phrase></textobject>
</mediaobject>
</screenshot>
<para>Finally, you can save the configuration you have just used before you
close the dialog box by pressing the <guibutton>Save
Configuration...</guibutton> button.
</para>
</step>
<step><para>What we now have are the newly-produced <filename>html/</filename>
and <filename>pics/</filename> folders,
created where we earlier set the path:</para>
<screenshot>
<screeninfo>The newly created <acronym>HTML</acronym> slideshow
folders</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="htmlshow9.png" format="PNG"/>
</imageobject>
<textobject><phrase>The newly created <acronym>HTML</acronym> slideshow
folders</phrase></textobject>
</mediaobject>
</screenshot>
</step>
</procedure>
<para>There is also an <filename>index.html</filename> file to launch
your web slideshow.</para>
<para>You can see how it works by using your file manager or web
browser to open the <filename>index.html</filename> file. Click where prompted,
and the first slide of your presentation is displayed. It will now behave as a
&kpresenter; slideshow.</para>
<para>Each click on the arrow icons take you to the next or previous slide.
To get back to the start of the slideshow click on the slide icon.</para>
<tip><para>To share your presentation with the world, transfer the
newly-produced files to a network-accessible location (&ie; webspace),
remembering to keep the directory structure intact.</para></tip>
</sect1>
<sect1 id="ms-export">
<title>Exporting &kpresenter; presentations to a <trademark>Memory
Stick</trademark></title>
<para>
Some Sony projectors have the ability to run a presentation directly
from a <trademark>Memory Stick</trademark>, without needing to connect a
computer up to the projector. &kpresenter; can export presentations to the
format required by these projectors, and this tutorial will show you how to
export your presentation.
</para>
<para>
Each exported slideshow consists of a series of image files (one for
each slide in the original presentation, plus two title slides) and an
index file. They are created in a fairly complex directory structure
that allows more than one presentation to be stored on a single memory
stick. A simple example is shown below, consisting of two
presentations.
</para>
<mediaobject id="ms-export-directory-structure">
<imageobject>
<imagedata format="PNG" fileref="msexport4.png"/>
</imageobject>
<textobject><phrase><trademark>Memory Stick</trademark> directory
structure</phrase></textobject>
</mediaobject>
<procedure>
<step>
<para>
If the presentation that you want to export is not already open, go to
<guimenu>File</guimenu><guimenuitem>Open...</guimenuitem> and select the
presentation that you want to export.
</para>
</step>
<step>
<para>
Now, select the <guimenu>File</guimenu> menu and choose <guimenuitem>Create
Memory Stick Slideshow...</guimenuitem>.
</para>
<screenshot>
<screeninfo>The &kpresenter; <guimenuitem>Create Memory Stick
Slideshow...</guimenuitem> menu selection.</screeninfo>
<mediaobject>
<imageobject>
<imagedata format="PNG" fileref="msexport1.png"/>
</imageobject>
<textobject><phrase>The &kpresenter; <guimenuitem>Create Memory Stick
Slideshow...</guimenuitem> menu selection.</phrase></textobject>
</mediaobject>
</screenshot>
</step>
<step>
<para>
This will bring up the <guilabel>Create Memory Stick
Slideshow</guilabel> dialog.</para>
<screenshot>
<screeninfo>The &kpresenter; <guilabel>Create Memory Stick
Slideshow</guilabel> dialog.</screeninfo>
<mediaobject>
<imageobject>
<imagedata format="PNG" fileref="msexport2.png"/>
</imageobject>
<textobject><phrase>The &kpresenter; <guilabel>Create Memory Stick
Slideshow</guilabel> dialog.</phrase></textobject>
</mediaobject>
</screenshot>
<para>
The <guilabel>Path</guilabel> is the directory in which your presentation will
be exported to as directories (<filename>DCIM</filename> and
<filename>MSSONY</filename>, see the <link
linkend="ms-export-directory-structure">directory structure
diagram</link> above) will be created. If you are able to, you may wish to export
directly
to the <trademark>Memory Stick</trademark>, in which case you would enter the
location of the medium here.
</para>
<para>
The <guilabel>Title</guilabel> is used for both the name of the index
file, and as a text label on the title slide. Note that this title
does not affect the titles on any of the normal presentation slides -
the title slide is visible using the Sony projector setup prior to
starting the actual presentation display.
</para>
<para>Select the <guibutton>Set Colors</guibutton> option to expand the
dialog:</para>
<screenshot>
<screeninfo>The &kpresenter; <guilabel>Create Memory Stick
Slideshow</guilabel> dialog (extended).</screeninfo>
<mediaobject>
<imageobject>
<imagedata format="PNG" fileref="msexport2b.png"/>
</imageobject>
<textobject><phrase>The &kpresenter; <guilabel>Create Memory Stick
Slideshow</guilabel> dialog (extended).</phrase></textobject>
</mediaobject>
</screenshot>
<para>
These two color selectors are only used for the title slide. It
can be useful to change the title slides to make the presentations
easier to identify when working on the projector, though it is perfectly safe to
leave them as default.
</para>
<para>
You can then press the <guibutton>OK</guibutton> button to proceed with the
actual export process.
</para>
</step>
<step>
<para>
Your presentation will now be exported into the correct format, with the
following dialog informing you of the progress of this process:
</para>
<screenshot>
<screeninfo>The &kpresenter; <guilabel>Create Memory Stick
Slideshow</guilabel> progress dialog.</screeninfo>
<mediaobject>
<imageobject>
<imagedata format="PNG" fileref="msexport3.png"/>
</imageobject>
<textobject><phrase>The &kpresenter; <guilabel>Create Memory Stick
Slideshow</guilabel> progress dialog.</phrase></textobject>
</mediaobject>
</screenshot>
<para>
When the export is complete, you can select the
<guibutton>Done</guibutton> button, and the dialog will close.
</para>
</step>
<step>
<para>
If you did not export the slideshow directly onto a <trademark>Memory
Stick</trademark>, you will need to copy the correct files onto the
<trademark>Memory
Stick</trademark> before you can utilise the projector. As noted above,
you need to copy over the correct directories and files starting at
<filename>DCIM</filename> and <filename>MSSONY</filename> into the
"root", or <filename>/</filename> of the <trademark>Memory Stick</trademark>. It
is
critical that the directory structure is maintained, and you may
find it easier to copy the whole of <filename>DCIM</filename> and
<filename>MSSONY</filename> directories.
</para>
<para>
If necessary, you can safely rename the index file (which is
<filename>Slideshow.SPP</filename> by default), however you cannot
rename the slide images, nor can you change the name of these directories,
as these are encoded into the index file.
</para>
</step>
</procedure>
</sect1>
<sect1 id="creating-templates">
<title>Creating &kpresenter; Templates</title>
<para>It is very easy to add new templates to &kpresenter;'s library.</para>
<para>If you have made a presentation in a style that you would like to use
again, you can save it as a template.</para>
<para>This tutorial will show how we can make a new template and save
it.</para>
<procedure>
<step>
<para>Open &kpresenter; and create a new document.</para>
</step>
<step>
<para>To add a little sparkle to the blank slide, we can change the slide
background - do this by either going to <guimenu>Format</guimenu> >
<guimenuitem>Slide Background...</guimenuitem>, or by selecting the same item
from the &RMB; menu:</para>
<screenshot>
<screeninfo>The &kpresenter; <guilabel>Slide Background</guilabel>
dialog.</screeninfo>
<mediaobject>
<imageobject>
<imagedata format="PNG" fileref="template02.png"/>
</imageobject>
<textobject><phrase>The &kpresenter; <guilabel>Slide Background</guilabel>
dialog.</phrase></textobject>
</mediaobject>
</screenshot>
<para>We want the background to look attractive, so let's add a background
gradient by using the drop-down menu, and then selecting the gradient colors by
clicking the colored boxes. Of course, you may choose to use an image as a
background by clicking the <guilabel>Picture</guilabel> tab: feel free to
experiment, but keep it beautiful!</para>
<screenshot>
<screeninfo>Choosing a slide background</screeninfo>
<mediaobject>
<imageobject>
<imagedata format="PNG" fileref="template03.png"/>
</imageobject>
<textobject><phrase>Choosing a slide background</phrase></textobject>
</mediaobject>
</screenshot>
</step>
<step>
<para>The page should now have the background you desire. Create a text box, and
type a heading for your slide:</para>
<screenshot>
<screeninfo>Adding a Heading to the new template</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="template04.png" format="PNG"/>
</imageobject>
<textobject><phrase>Adding a Heading to the new template</phrase></textobject>
</mediaobject>
</screenshot>
<para>When you are happy with your template, go to <menuchoice><guimenu>File</guimenu>
<guimenuitem>Template Manager</guimenuitem></menuchoice>:</para>
<screenshot>
<screeninfo><guimenu>File</guimenu><guimenuitem>Template
Manager</guimenuitem></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="template05.png" format="PNG"/>
</imageobject>
<textobject><phrase><guimenu>File</guimenu><guimenuitem>Template
Manager</guimenuitem></phrase></textobject>
</mediaobject>
</screenshot>
<para>This dialog box allows you to select where you would like your template to
be saved:</para>
<screenshot>
<screeninfo>Saving the new template</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="template06.png" format="PNG"/>
</imageobject>
<textobject><phrase>Saving the new template</phrase></textobject>
</mediaobject>
</screenshot>
<para>I highly recommend that you save the template in the <guilabel>Screen
Presentations</guilabel> group. You may call it whatever you wish, in this case,
my template is named <userinput>Tutorial_Template</userinput>. Once you are
happy with the settings, press <guibutton>OK</guibutton> to add your custom
template to the template collection.</para>
</step>
<step>
<para>You can now close the document you have been working on (there is no need
to save it). The next time you are presented with the startup
dialog, your very own template will be available to select!</para>
<screenshot>
<screeninfo>Your new template in the &kpresenter; startup
dialog.</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="template07.png" format="PNG"/>
</imageobject>
<textobject><phrase>Your new template in the &kpresenter;
startup dialog.</phrase></textobject>
</mediaobject>
</screenshot>
</step>
</procedure>
</sect1>
</chapter>

BIN
doc/kpresenter/htmlshow1.png
View File

Binary file not shown.

BIN
doc/kpresenter/htmlshow2.png
View File

Binary file not shown.

BIN
doc/kpresenter/htmlshow3.png
View File

Binary file not shown.

BIN
doc/kpresenter/htmlshow4.png
View File

Binary file not shown.

BIN
doc/kpresenter/htmlshow5.png
View File

Binary file not shown.

BIN
doc/kpresenter/htmlshow6.png
View File

Binary file not shown.

BIN
doc/kpresenter/htmlshow7.png
View File

Binary file not shown.

BIN
doc/kpresenter/htmlshow8.png
View File

Binary file not shown.

BIN
doc/kpresenter/htmlshow9.png
View File

Binary file not shown.

267
doc/kpresenter/index.docbook
Unescape View File

@ -0,0 +1,267 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY package "koffice">
<!ENTITY kappname "&kpresenter;">
<!ENTITY % addindex "IGNORE">
<!ENTITY tutorial SYSTEM "tutorial.docbook">
<!ENTITY screen SYSTEM "screen.docbook">
<!ENTITY guides SYSTEM "guides.docbook">
<!ENTITY great SYSTEM "great-presentations.docbook">
<!ENTITY menus SYSTEM "menus.docbook">
<!ENTITY options SYSTEM "options.docbook">
<!ENTITY a11y SYSTEM "a11y.docbook">
<!ENTITY faq SYSTEM "faq.docbook">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
<book lang="&language;">
<bookinfo>
<title>The &kpresenter; Handbook</title>
<authorgroup>
<author>
<firstname>Neil</firstname>
<surname>Lucock</surname>
<affiliation>
<address><email>neil@nlucock.freeserve.co.uk</email></address>
</affiliation>
</author>
<author>
<firstname>Krishna</firstname>
<surname>Tateneni</surname>
<affiliation>
<address><email>tateneni@pluto.njcc.com</email></address>
</affiliation>
</author>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annemarie.mahfouf@free.fr</email></address>
</affiliation>
</author>
<author>
<firstname>Gary</firstname>
<surname>Cramblitt</surname>
<affiliation>
<address><email>garycramblitt@comcast.net</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<date>2006-11-22</date>
<releaseinfo>1.6</releaseinfo>
<copyright>
<year>1999</year><year>2000</year>
<holder>Krishna Tateneni</holder>
</copyright>
<copyright>
<year>2001</year><year>2002</year>
<holder>Neil Lucock</holder>
</copyright>
<copyright>
<year>2005</year>
<holder>Anne-Marie Mahfouf</holder>
</copyright>
<copyright>
<year>2006</year>
<holder>Gary Cramblitt</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<abstract>
<para>
&kpresenter; is the presentations program in the &koffice; suite of
productivity applications.
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KPresenter</keyword>
<keyword>KOffice</keyword>
<keyword>Graphics</keyword>
<keyword>Presentations</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<important> <para>Please check <ulink
url="http://docs.kde.org/en/HEAD/koffice/kpresenter/">http://docs.kde.org</ulink>
for updated versions of this document.</para></important>
<para>
&kpresenter; is the presentations program in the &koffice; productivity
suite. Using &kpresenter;, you can prepare a set of slides for use in an
on-screen slideshow or for printing. Your slides can include text and
graphics in a variety of formats, and of course, you can embed all sorts
of objects using KParts.
</para>
<para>
The &koffice; productivity suite consists of a number of applications
which are designed to work together. Overview documentation for
&koffice; is available, as well as manuals for each component of the
suite. The components of &koffice; are:
</para>
<itemizedlist>
<listitem>
<para>
&kword; - a frames based wordprocessor.
</para>
</listitem>
<listitem><para>
&kspread; - a spreadsheet application.
</para>
</listitem>
<listitem>
<para>
&kpresenter; - a presentations application.
</para>
</listitem>
<listitem>
<para>
&kformula; - an editor for mathematical formulae.
</para>
</listitem>
<listitem>
<para>
&kchart; - an application to draw charts and diagrams.
</para>
</listitem>
</itemizedlist>
<para>
&koffice; is a free (or open-source) software project which is
released under the terms of the &GNU; General Public
License.
</para>
</chapter>
&tutorial;
&screen;
&guides;
&great;
&menus;
&options;
&a11y;
&faq;
<chapter id="credits">
<title>Credits and License</title>
<para>
&kpresenter;
</para>
<para>
Program copyright 1998-2000 by Reginald Stadlbauer
<email>reggie@kde.org</email>
</para>
<para>
Current maintainer is Laurent Montel <email>montel@kde.org</email>.
</para>
<itemizedlist>
<title>Contributors</title>
<listitem>
<para>
Werner Trobin <email>trobin@kde.org</email>.
</para>
</listitem>
<listitem>
<para>
David Faure <email>dfaure@kde.org</email>
</para>
</listitem>
<listitem>
<para>
Toshitaka Fujioka <email>fujioka@kde.org</email>
</para>
</listitem>
<listitem>
<para>
Luk&aacute;&scaron; Tinkl <email>lukas@kde.org</email>
</para>
</listitem>
<listitem>
<para>
Thorsten Zachmann <email>t.zachmann@zagge.de</email>
</para>
</listitem>
<listitem>
<para>
Ariya Hidayat <email>ariya@kde.org</email>
</para>
</listitem>
<listitem>
<para>
Percy Leonhardt <email>percy@eris23.de</email>
</para>
</listitem>
</itemizedlist>
<para>
Documentation based on the work copyright 1999-2000 by Krishna
Tateneni. Portions are copyright 2000-2002 Neil Lucock
<email>neil@nlucock.freeserve.co.uk</email>
and 2005 Anne-Marie Mahfouf <email>annemarie.mahfouf@free.fr</email>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>
<appendix id="installation">
<title>Installation</title>
&install.intro.documentation;
&install.compile.documentation;
</appendix>
&documentation.index;
</book>

BIN
doc/kpresenter/kbd-focus-ext.png
View File

Binary file not shown.

BIN
doc/kpresenter/link.png
View File

Binary file not shown.

2066
doc/kpresenter/menus.docbook
View File

File diff suppressed because it is too large Load Diff

BIN
doc/kpresenter/mousenav.png
View File

Binary file not shown.

BIN
doc/kpresenter/msexport1.png
View File

Binary file not shown.

BIN
doc/kpresenter/msexport2.png
View File

Binary file not shown.

BIN
doc/kpresenter/msexport2b.png
View File

Binary file not shown.

BIN
doc/kpresenter/msexport3.png
View File

Binary file not shown.

BIN
doc/kpresenter/msexport4.png
View File

Binary file not shown.

1032
doc/kpresenter/options.docbook
View File

File diff suppressed because it is too large Load Diff

BIN
doc/kpresenter/properties.png
View File

Binary file not shown.

44
doc/kpresenter/screen.docbook
Unescape View File

@ -0,0 +1,44 @@
<chapter id="screen-description">
<chapterinfo>
<authorgroup>
<author>
<firstname>Neil</firstname>
<surname>Lucock</surname>
<affiliation>
<address><email>neil@nlucock.freeserve.co.uk</email></address>
</affiliation>
</author>
<author>
<firstname>Krishna</firstname>
<surname>Tateneni</surname>
<affiliation>
<address><email>tateneni@pluto.njcc.com</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>The &kpresenter; Screen</title>
<para>Here is the default &kpresenter; Screen Layout.</para>
<para>At the top there is the menubar. All &kpresenter; functions are
available from the menus, which are described in detail in <xref
linkend="menu-items" />.</para>
<para>Below the menubar are the toolbars. There are several
toolbars. You may hide and show toolbars as you prefer. The toolbars
are described in detail in <xref linkend="toolbars" />.
</para>
<para>The <guilabel>Outline</guilabel> and
<guilabel>Preview</guilabel> panes give an overview of your entire
presentation. The <guilabel>Preview</guilabel> pane provides
thumbnails of each slide, and allows you to drag and drop to change
the order. The <guilabel>Outline</guilabel> pane provides a
hierarchal tree of each slide, and also the objects inside the slides.
As well as overview, this allows you to easily select objects which
may be covered by others, or are otherwise difficult to grab directly on
the slide.</para>
</chapter>

BIN
doc/kpresenter/settings01.png
View File

Binary file not shown.

BIN
doc/kpresenter/settings03.png
View File

Binary file not shown.

BIN
doc/kpresenter/settings04.png
View File

Binary file not shown.

BIN
doc/kpresenter/template02.png
View File

Binary file not shown.

BIN
doc/kpresenter/template03.png
View File

Binary file not shown.

BIN
doc/kpresenter/template04.png
View File

Binary file not shown.

BIN
doc/kpresenter/template05.png
View File

Binary file not shown.

BIN
doc/kpresenter/template06.png
View File

Binary file not shown.

BIN
doc/kpresenter/template07.png
View File

Binary file not shown.

BIN
doc/kpresenter/textmenu1.png
View File

Binary file not shown.

BIN
doc/kpresenter/textmenu2.png
View File

Binary file not shown.

BIN
doc/kpresenter/toolsmenu01.png
View File

Binary file not shown.

BIN
doc/kpresenter/tts.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut01.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut02.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut03.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut04.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut05.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut06.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut07.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut08.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut09.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut10.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut11.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut12.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut13.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut14.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut15.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut16.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut17.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut18.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut19.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut20.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut21.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut22.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut23.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut24.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut25.png
View File

Binary file not shown.

BIN
doc/kpresenter/tut26.png
View File

Binary file not shown.

510
doc/kpresenter/tutorial.docbook
Unescape View File

@ -0,0 +1,510 @@
<!-- <?xml version="1.0" ?>
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd">
To edit or validate this document separately, uncomment this prolog
Be sure to comment it out again when you are done -->
<chapter id="tutorial">
<chapterinfo>
<authorgroup>
<author>
<firstname>Neil</firstname>
<surname>Lucock</surname>
<affiliation>
<address><email>neil@nlucock.freeserve.co.uk</email></address>
</affiliation>
</author>
<author>
<firstname>Krishna</firstname>
<surname>Tateneni</surname>
<affiliation>
<address><email>tateneni@pluto.njcc.com</email></address>
</affiliation>
</author>
<author>
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>annemarie.mahfouf@free.fr</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>A Step-By-Step Tutorial</title>
<para>
In this chapter, &kpresenter; is introduced using a simple tutorial. We
shall walk through the most basic steps that are involved in creating a
presentation, and adding some basic effects.
</para>
<sect1 id="start-new">
<title>Start a new document</title>
<para>
When you start &kpresenter;, the usual &koffice; startup dialog appears.
</para>
<screenshot>
<screeninfo>The <guilabel>&koffice;</guilabel>
startup dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tut01.png" format="PNG"/></imageobject>
<textobject><phrase>The &koffice; startup dialog</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Select <guilabel>Screen</guilabel> on the left then select the template labeled
<guilabel>Title</guilabel> (highlighted in blue in the screenshot above) by
clicking on it. You can check <guilabel>Always use this template</guilabel> to
make it the default template.
</para>
<para>
Now click <guibutton>Use This Template</guibutton>. This brings up the slide
editor window, where you can view and edit the slides (and objects contained in
them) in your document. At the moment, we just have one slide, with one
object on it, which is a text box.
</para>
<screenshot>
<screeninfo>The slide editor</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut02.png" format="PNG"/></imageobject>
<textobject><phrase>The slide editor</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Double-click the text box. The cursor changes to a vertical bar to show
that you can now type some text and the background of the edited area
becomes grey.
</para>
<screenshot>
<screeninfo>The text insertion cursor</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut03.png" format="PNG"/>
</imageobject>
<textobject><phrase>The text insertion cursor</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Go ahead, type some text!
</para>
<screenshot>
<screeninfo>Adding text</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tut04.png" format="PNG"/></imageobject>
<textobject><phrase>Adding text</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Click away from the text to de-select the text box when you are done
typing.
</para>
</sect1>
<sect1 id="insert-page">
<title>Add a new page</title>
<para>
Let's now add a new slide to our document. To do so, click the
<guimenu>Insert</guimenu> menu, and then click on
<guimenuitem>Slide...</guimenuitem>.
</para>
<screenshot>
<screeninfo>Inserting a slide from the menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tut05.png" format="PNG"/></imageobject>
<textobject><phrase>Inserting a slide from the menu</phrase></textobject>
</mediaobject>
</screenshot>
<para>
This brings up the <guilabel>Insert Slide</guilabel> dialog.
</para>
<screenshot>
<screeninfo>The <guilabel>Insert Slide</guilabel> dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tut06.png" format="PNG"/></imageobject>
<textobject><phrase>The <guilabel>Insert Slide</guilabel>
dialog</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Select <guilabel>Use different template</guilabel> and click <guibutton>OK</guibutton> to add a
new page after page 1.
</para>
<para>
The <guilabel>Create Document</guilabel> dialog comes up so that we can decide
what the new slide should look like. This time, select <guilabel>Screen</guilabel> on the left and double click on the
<guilabel>One Column</guilabel> template (highlighted in blue.)
</para>
<screenshot>
<screeninfo>Choosing a template for the new page</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut07.png" format="PNG"/></imageobject>
<textobject><phrase>Choosing a template for the new
page</phrase></textobject>
</mediaobject>
</screenshot>
<para>
The new slide now appears in the editing window. To change between pages
of your presentation, you can select slides in the pane to the left
(highlighted in blue for this screenshot).
</para>
<screenshot>
<screeninfo>The slides list</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut08.png" format="PNG"/></imageobject>
<textobject><phrase>The slides list</phrase></textobject>
</mediaobject>
</screenshot>
<para>
The newly inserted slide has two text boxes. There is one for a title,
and another to contain a bulleted list of items.
</para>
<screenshot>
<screeninfo>The new slide</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut09.png" format="PNG"/></imageobject>
<textobject><phrase>The new slide</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Double-click and type a title. Then double-click on the second text
box with the bullet. Type some text and end the paragraph by pressing the
<keycap>Enter</keycap> or <keycap>Return</keycap> key. As you type new
paragraphs, bullets automatically appear in front of them.
</para>
<screenshot>
<screeninfo>Adding text to the second slide</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut10.png" format="PNG"/></imageobject>
<textobject><phrase>Adding text to the second slide</phrase></textobject>
</mediaobject>
</screenshot>
<para>
You can de-select the text box by clicking away from it.
</para>
</sect1>
<sect1 id="insert-pic">
<title>Insert a picture</title>
<para>
Let's go back to the first slide now. Use the list of slides on the left
of your screen.
</para>
<para>
In this section, we'll liven our presentation up a bit by adding a nice
logo to the title page. To do so, the first step is to click on the
<guimenu>Insert</guimenu> menu item, and then on
<guimenuitem>Picture...</guimenuitem>.
</para>
<screenshot>
<screeninfo>Using the menu to add an image</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut11.png" format="PNG"/></imageobject>
<textobject><phrase>Using the menu to add an image</phrase></textobject>
</mediaobject>
</screenshot>
<para>
This brings up a file selection dialog. To learn about this or other
standard &kde; dialog boxes in detail, please consult the &kde;
documentation. You can browse by clicking on <guiicon>folder</guiicon>
icons or by using the <guiicon>browser</guiicon> style buttons on the
toolbar (highlighted in red.) Clicking the <guiicon>up arrow</guiicon>
takes you up one folder level.
</para>
<para>
Find the file named <filename>koffice-logo.png</filename>, which may be
in a different folder than the one shown in the screenshot below. You
can also choose any other graphic file if you like! Select the file, and
click <guibutton>OK</guibutton>.
</para>
<screenshot>
<screeninfo>Choosing a picture to add</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut12.png" format="PNG"/></imageobject>
<textobject><phrase>Choosing a picture to add</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Click with the &LMB; where you want to place the loge in it's original size or
draw a rectangle with the left mouse cursor to specify the position and size for the logo.
There are selection handles (little squares) visible around the border of the graphic.
</para>
<screenshot>
<screeninfo>The newly added image</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut13.png" format="PNG"/></imageobject>
<textobject><phrase>The newly added image</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Place the mouse cursor anywhere in the middle of the logo, and drag it
to the middle of the title page. Then use the selection handles to resize
it correctly.
</para>
<screenshot>
<screeninfo>Dragging and resizing the image</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut14.png" format="PNG"/></imageobject>
<textobject><phrase>Dragging and resizing the image</phrase></textobject>
</mediaobject>
</screenshot>
<para>
That's it. Now you have a picture on the title page!
</para>
</sect1>
<sect1 id="insert-object">
<title>Insert a &koffice; object</title>
<para>Let's insert another &koffice; object under the picture, for example
a chart.</para>
<para>
Every &koffice; supported document can be embedded in a &kpresenter; slide.
Let's choose a chart from &kchart;. To do so, the first step is to click on the
<guimenu>Insert</guimenu> menu item, and then
on <guisubmenu>Object</guisubmenu>.
</para>
<screenshot>
<screeninfo>The Insert Object menu</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut24.png" format="PNG"/></imageobject>
<textobject><phrase>The Insert Object menu</phrase></textobject>
</mediaobject>
</screenshot>
<para>
A list of the &koffice; available components appears as submenu.
Select <guilabel>Chart</guilabel> and then outline with your mouse the area you
want to put your chart in on the &kpresenter; slide.
</para>
<screenshot>
<screeninfo>Select the area where to put the chart</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut25.png" format="PNG"/></imageobject>
<textobject><phrase>Select the area where to put the chart</phrase></textobject>
</mediaobject>
</screenshot>
<!--TODO check if the Open Document dialog should appear when the chart is
created and not a blank chart-->
<para>
Once you release the mouse button, a blank chart is added on the slide. Whenever
you work in the chart, the toolbars and menubar in &kpresenter; main window are
replaced by those from &kchart;.
</para>
<screenshot>
<screeninfo>&kchart; menus and toolbars embedded</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut26.png" format="PNG"/></imageobject>
<textobject><phrase>&kchart; menus and toolbars embedded</phrase></textobject>
</mediaobject>
</screenshot>
<para>While you are in the chart, clicking with the &RMB; will bring the
&kchart; settings menu which allows you to modify the parameters of the chart.
Please see the &kchart; user manual to get more information on how to use
&kchart;.</para>
<para>Click anywhere with the &LMB; outside the chart to go back to
&kpresenter; slide.</para>
<para>A single click on the chart will allow you to drag it to change its
location and also to drag the borders to make it bigger as with any other
&kpresenter; object. Double click on the chart to get into &kchart; mode and
modify any of the chart property.</para>
</sect1>
<sect1 id="addshadow">
<title>Add a shadow to the title text</title>
<para>
Let's continue enhancing our title page by adding a shadow
behind the title. <mousebutton>Right</mousebutton> click anywhere on the
title text. This achieves two things: the text box containing the title
is selected, and a menu pops up.
</para>
<para>
Select the <guimenuitem>Shadow Objects...</guimenuitem> option in the popup menu.
</para>
<screenshot>
<screeninfo>The context menu</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut15.png" format="PNG"/></imageobject>
<textobject><phrase>The context menu</phrase></textobject>
</mediaobject>
</screenshot>
<para>
The <guilabel>Shadow</guilabel> dialog pops up. The distance between the
shadow and the text is currently 0 so the shadow cannot be seen (this
part of the dialog box is highlighted in red.)
</para>
<screenshot>
<screeninfo>The <guilabel>Shadow</guilabel> dialog</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut16.png" format="PNG"/></imageobject>
<textobject><phrase>The <guilabel>Shadow</guilabel>
dialog</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Increase the distance value to 3. The effect of changing the distance
can be seen in the preview window. Now click <guibutton>OK</guibutton>.
</para>
<screenshot>
<screeninfo>Adding a shadow to the title</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut17.png" format="PNG"/></imageobject>
<textobject><phrase>Adding a shadow to the title</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Now the title has a shadow!
</para>
<screenshot>
<screeninfo>The new shadowed title</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut18.png" format="PNG"/></imageobject>
<textobject><phrase>The new shadowed title</phrase></textobject>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="textcolor">
<title>Change the color of the title text</title>
<para>
Let's finish by changing the color of the title text from black to
blue. To do so, select the title text by double-clicking the text box and select the text.
</para>
<para>
Open the <guilabel>Select Color</guilabel> dialog by clicking on the <guiicon>dark blue A</guiicon>
icon on the right side of the <guilabel>Text</guilabel> toolbar (this icon has
a Color... tooltip) or choose the <guimenu>Text</guimenu> menu and then click on
<guimenuitem>Color...</guimenuitem> and change the color to blue.</para>
<screenshot>
<screeninfo>The color palette</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut19.png" format="PNG"/></imageobject>
<textobject><phrase>The color palette</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Click <guilabel>OK</guilabel> in the <guilabel>Select Color</guilabel> dialog. Changing the color of
the selected text to blue changes its appearance. The exact color that
highlighted text turns depends on your system color scheme.
</para>
<screenshot>
<screeninfo>Highlighted text</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut20.png" format="PNG"/></imageobject>
<textobject><phrase>Highlighted text</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Now click away from the text to de-select it.
</para>
<screenshot>
<screeninfo>The finished title</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut21.png" format="PNG"/></imageobject>
<textobject><phrase>The finished title</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Now that there are two slides, why not try a slide show! To start the
slide show, press the <guiicon>play</guiicon> button (the blue double arrow) on
the <guilabel>Slide Show</guilabel> toolbar. The first slide should appear on your screen.
</para>
<screenshot>
<screeninfo>The first slide</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut22.png" format="PNG"/></imageobject>
<textobject><phrase>The first slide</phrase></textobject>
</mediaobject>
</screenshot>
<para>
To advance from the first slide to the next, just click anywhere on the
screen, or use the <keycap>Page Down</keycap> key.
</para>
<screenshot>
<screeninfo>The second slide</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="tut23.png" format="PNG"/></imageobject>
<textobject><phrase>The second slide</phrase></textobject>
</mediaobject>
</screenshot>
<para>
To exit the slide show, <mousebutton>right</mousebutton> click, and then
select the <guimenuitem>End</guimenuitem> option from the
popup menu.
</para>
</sect1>
</chapter>

BIN
doc/kpresenter/zoomfactor.png
View File

Binary file not shown.

4
doc/krita/Makefile.am
Unescape View File

@ -0,0 +1,4 @@
KDE_LANG = en
KDE_DOCS = AUTO

7
doc/krita/README.SCREENSHOTS
Unescape View File

@ -0,0 +1,7 @@
Note for translators:
The file "mountains.png" is the original photo used for creating the screenshots
in the Dialogs section.
- ASK

1411
doc/krita/commands-dialogs.docbook
View File

File diff suppressed because it is too large Load Diff

2158
doc/krita/commands-menus.docbook
View File

File diff suppressed because it is too large Load Diff

769
doc/krita/commands-palettes.docbook
Unescape View File

@ -0,0 +1,769 @@
<sect1 id="commands-palettes">
<title>Palettes</title>
<para>
This section describes &krita;'s palettes. The palettes are usually found at
the right hand side of &krita;'s main window. There are three palettes which
help you in customizing your images:
</para>
<sect2 id="commands-palettes-controlbox">
<title>The <guilabel>Control box</guilabel> palette</title>
<para>The <guilabel>Control box</guilabel> contains three tabs. You can get an
overview of the image, view a color histogram, and modify options for the
current tool.</para>
<sect3 id="commands-palettes-controlbox-overview">
<title><guilabel>Overview</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Overview</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-overview.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Overview</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>Overview</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>This tab offers you two settings. With the spinbox, slider, and
<guibutton>1:1</guibutton> button at the bottom, you can set the zoom level
for the document. The <guilabel>Exposure</guilabel> slider and textbox can be
used to choose the exposure level for OpenEXR images. Furthermore, the
<guilabel>X</guilabel> and <guilabel>Y</guilabel> labels indicate the current
pointer position, with (0,0) being the top left corner of the canvas.</para>
</sect3>
<sect3 id="commands-palettes-controlbox-histogram">
<title><guilabel>Histogram</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Histogram</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-histogram.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Histogram</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>Histogram</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>This tab displays a color histogram showing the distribution of
colors over the image. The histogram is split up in red, green and blue
levels.</para>
</sect3>
<sect3 id="commands-palettes-controlbox-tool">
<title><guilabel>Tool</guilabel></title>
<para>Actually, there is no tab named like this, since the tab name changes to
reflect the name of the currently selected tool. This tab shows the
customization options available for the tools that have them.</para>
<sect4 id="commands-palettes-controlbox-tool-brush">
<title><guilabel>Brush</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Brush</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-brush.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Brush</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Brush</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>There are three options available on this tab.
</para><para>
The <guilabel>Opacity</guilabel> slider and spin box are used to set the
opacity when drawing (opacity is the opposite of transparency, i.e. 100%
opaque is 0% transparent, and vice versa).
</para><para>
In the <guilabel>Mode</guilabel> drop down box, you can choose a drawing
mode. This changes the actual effect that results from drawing on the image
(for example, only changing the saturation or lightness).
</para><para>
With the <guilabel>Paint direct</guilabel> option, you can determine whether
you want to paint directly on the current layer, or on a temporary layer which
is then composited onto the actual layer. This makes a difference especially
when using relative low opacity values.</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-line">
<title><guilabel>Line</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Line</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-line.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Line</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Line</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>See <link
linkend="commands-palettes-controlbox-tool-brush">Brush</link>
for the description of <guilabel>Opacity</guilabel> and
<guilabel>Mode</guilabel>. The <guilabel>?</guilabel> button shows a tip about
the usage of modifier keys.</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-rectangle">
<title><guilabel>Rectangle</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Rectangle</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-rectangle.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The Tool tab for <guilabel>Rectangle</guilabel></phrase>
</textobject>
<caption><para>The Tool tab for <guilabel>Rectangle</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>See <link
linkend="commands-palettes-controlbox-tool-brush">Brush</link> for a description of <guilabel>Opacity</guilabel> and
<guilabel>Mode</guilabel>.
</para><para>
The <guilabel>Fill</guilabel> drop down box is used to specify whether the
inside of the rectangle should be filled. You can choose between three fill
options: the current foreground color, background color or pattern is
used.</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-bezier">
<title><guilabel>Bezier</guilabel></title>
<para>See <link
linkend="commands-palettes-controlbox-tool-brush">Brush</link> for the
description of <guilabel>Mode</guilabel> and <guilabel>Opacity</guilabel>.</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-ellipse">
<title><guilabel>Ellipse</guilabel></title>
<para>The same options as for <link
linkend="commands-palettes-controlbox-tool-rectangle">Rectangle</link> are
available here.</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-polygon">
<title><guilabel>Polygon</guilabel></title>
<para>The same options as for <link
linkend="commands-palettes-controlbox-tool-rectangle">Rectangle</link> are
available here.</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-polyline">
<title><guilabel>Polyline</guilabel></title>
<para>The same options as for <link
linkend="commands-palettes-controlbox-tool-line">Line</link>
are available here.</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-star">
<title><guilabel>Star</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Star</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-star.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Star</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Star</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>The options for <link
linkend="commands-palettes-controlbox-tool-rectangle">Rectangle</link> are
available here, as well as two options specific to this tool.
</para><para>
The <guilabel>Vertices</guilabel> drop down box is used to set the amount
of vertices (points) in the star.
</para><para>
The <guilabel>Ratio</guilabel> setting defines the shape of the
star. A ratio of 0% will create a star with no inner area (when drawing the
star, the two lines that make up a star point, overlap). Increasing the ratio
will slowly make the star more outlined (the two lines are <quote>pulled
apart</quote>). A star with a ratio of 100% is a regular polygon.
</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-duplicate">
<title><guilabel>Duplicate</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Duplicate</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-duplicate.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Duplicate</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Duplicate</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>The same options as for <link
linkend="commands-palettes-controlbox-tool-line">Line</link>
are available here. In addition, there are three other options.
</para><para>
With the <guilabel>Healing</guilabel> and
<guilabel>Healing radius</guilabel> options, you can specify that the
duplication should not copy the colors, but only the <quote>structure</quote>
of the source area.
</para><para>
If you enable the <guilabel>Correct the perspective</guilabel> option, the
duplicate tool will follow your perspective grid.
</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-paintwithfilters">
<title><guilabel>Paint with Filters</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Paint with Filters</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-paintwithfilters.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Paint with Filters</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Paint with Filters</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>Depending on the filter, you can set different options here. The
options you can set are the same as those available in the
<quote>normal</quote> settings dialog for the chosen filter. See the
<link linkend="commands-dialogs-filters">Filters section in the Dialogs
chapter</link> for more information.</para> </sect4>
<sect4 id="commands-palettes-controlbox-tool-transform">
<title><guilabel>Transform</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Transform</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-transform.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Transform</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Transform</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<!-- >The <guilabel>Move X</guilabel> and <guilabel>Move Y</guilabel>
spin boxes show, and can be used to set, the displacement of the layer or
selection. The same applies to <guilabel>Scale X</guilabel> and <guilabel>Scale
Y</guilabel> for the scaling of the current layer or selection. Finally, -->
<para>You can choose which transformation algorithm to use in the
<guilabel>Filter</guilabel> drop down box.</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-crop">
<title><guilabel>Crop</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Crop</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-crop.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Crop</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Crop</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>Set the corner coordinates of the area that should remain with the
four spin boxes <guilabel>X</guilabel>, <guilabel>Y</guilabel>,
<guilabel>Width</guilabel> and <guilabel>Height</guilabel>. You can also
fill in <guilabel>Ratio</guilabel> to determine the Y/X ratio. Check one of
the checkboxes to have the respective value remain constant while changing the
size of the area. The drop down box can be used to select whether the entire
image or only the current layer should be cropped. Clicking the
<guibutton>Crop</guibutton> button has the same effect as double-clicking
outside the area in the image.</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-contiguousfill">
<title><guilabel>Contiguous Fill</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Contiguous Fill</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-contiguousfill.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Contiguous Fill</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Contiguous Fill</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>The same options as for <link
linkend="commands-palettes-controlbox-tool-brush">Brush</link>
are available here, as are a couple of other options.
</para><para>
The setting in the <guilabel>Threshold</guilabel> slider and spin box
determines how near the color of a point should be to the color of the
starting point of the fill, in order for the fill to spread out over the
former point. A higher threshold will therefore fill areas that have less
similar colors, a lower threshold limits the spread.
</para><para>
If you check the <guilabel>Fill entire selection</guilabel> checkbox, the
entire selection will be filled instead of only the neighboring area.
</para><para>
Checking the <guilabel>Limit to current layer</guilabel> checkbox changes the
behavior of the fill: the extent to which the fill is done, is determined from
the current layer only instead of the entire image.
</para><para>
By checking the <guilabel>Use pattern</guilabel> checkbox you can choose to
fill with the currently selected pattern instead of with the foreground color.
</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-gradient">
<title><guilabel>Gradient</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Gradient</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-gradient.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Gradient</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Gradient</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>The same options as for <link
linkend="commands-palettes-controlbox-tool-brush">Brush</link>
are available here, as are a couple of other options.
</para><para>
The <guilabel>Shape</guilabel> drop down box can be used to select the gradient
type: <guilabel>Linear</guilabel>, <guilabel>Bi-Linear</guilabel>, <guilabel>Radial</guilabel>,
<guilabel>Square</guilabel>, <guilabel>Conical</guilabel> and <guilabel>Conical Symmetric</guilabel>.
</para><para>
The <guilabel>Repeat</guilabel> option determines whether the gradient is
repeated if it does not fill the entire image. With <guilabel>None</guilabel>, the colors on the
ends of the gradient are used to fill the remaining space. With <guilabel>Forwards</guilabel>, the
gradient is normally repeated (connecting the back end of one occurrence with
the front end of the next). With <guilabel>Alternating</guilabel>, the gradient is repeated with
every second occurrence being drawn from back to front (linking front to front
and back to back).
</para><para>
Check the <guilabel>Reverse</guilabel> checkbox to have the gradient drawn
reversed (from back to front).
</para><para>
The final setting is <guilabel>Anti-alias threshold</guilabel>, which
determines how smooth the gradient will become.
</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-text">
<title><guilabel>Text</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Text</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-text.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Text</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Text</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>The same options as for <link
linkend="commands-palettes-controlbox-tool-brush">Brush</link>
are available here. Furthermore there is an option <guilabel>Font</guilabel>,
which shows the font that will be used for the text. Click the
<guibutton>...</guibutton> button to change the font.
</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-colorpicker">
<title><guilabel>Color Picker</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Color Picker</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-colorpicker.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Color Picker</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Color Picker</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>The first option is a dropdown box in which you can choose which
layer to pick the color from. If you choose a specific layer,
the color of the point in that layer will be retrieved. With <guilabel>Sample
All Visible Layers</guilabel>, the topmost visible layer which is not
transparent at that point is used.
</para><para>
If the <guilabel>Update current color</guilabel> checkbox is checked, then the
current foreground color (when clicking with the &LMB;) or background color
(when clicking with the &RMB;) is set to the picked color.
</para><para>
The checkbox <guilabel>Add to palette</guilabel> and the accompanying
dropdown box determine whether the picked color should be added to an existing
palette. Check the checkbox, and choose the desired palette from the list, if
you want to do so.
</para><para>
The checkbox <guilabel>Show colors as percentages</guilabel> switches the
range of color values displayed from the <quote>normal</quote> range (e.g. 0 to
255) to a scaled value between 0% and 100%.
</para><para>
With the <guilabel>Sample radius</guilabel> option, you can choose the area
size to use when picking the color. A radius of one just picks one pixel,
larger radii will make the picker average over the colors of the circle-shaped
area with the chosen radius that is centered around the chosen pixel.
</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-select">
<title><guilabel>Select</guilabel> tools</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Select</guilabel> tools</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-select.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Select</guilabel> tools</phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Select</guilabel> tools</para></caption>
</mediaobject>
</screenshot>
</para>
<para>The <guilabel>Paint Selection</guilabel>, <guilabel>Erase Selection</guilabel>,
<guilabel>Select Rectangular</guilabel>, <guilabel>Select Elliptical</guilabel>, <guilabel>Select Polygonal</guilabel> and <guilabel>Select Outline</guilabel> tools have one option:
the <guilabel>Action</guilabel> to perform. You can choose between <guilabel>Add</guilabel> to, or
<guilabel>Subtract</guilabel> from the selection.</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-selectcontiguous">
<title><guilabel>Select Contiguous Area</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Select Contiguous</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-selectcontiguous.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Select Contiguous</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Select Contiguous</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>The <guilabel>Action</guilabel> is the same as discussed with the
<link linkend="commands-palettes-controlbox-tool-select">Select
operations</link>.
</para><para>
The slider and spin box at <guilabel>Fuzziness</guilabel> determine how near
colors must be to the color at the clicked point to be added to the selection.
</para><para>
When the <guilabel>Sample merged</guilabel> checkbox is checked, the
bounds of the selection are determined by looking at the entire image instead
of at the current layer.
</para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-selectsimilar">
<title><guilabel>Similar Select</guilabel></title>
<para>The <guilabel>Action</guilabel> and <guilabel>Fuzziness</guilabel>
options are the same as with <link
linkend="commands-palettes-controlbox-tool-selectcontiguous">Select
contiguous</link>. </para>
</sect4>
<sect4 id="commands-palettes-controlbox-tool-selectmagnetic">
<title><guilabel>Select Magnetic</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tool</guilabel> tab for <guilabel>Select Magnetic</guilabel></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-controlbox-selectmagnetic.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tool</guilabel> tab for <guilabel>Select Magnetic</guilabel></phrase>
</textobject>
<caption><para>The <guilabel>Tool</guilabel> tab for <guilabel>Select Magnetic</guilabel></para></caption>
</mediaobject>
</screenshot>
</para>
<para>The <guilabel>Action</guilabel> option is the same as with the other
<link linkend="commands-palettes-controlbox-tool-select">Select tools</link>.
</para>
<para>
The <guilabel>Distance</guilabel> option determines the maximal distance at
which boundaries to attach to, are searched for. The <guibutton>To
Selection</guibutton> button has the same effect as double-clicking the &LMB;:
the selection is finished.
</para>
</sect4>
</sect3>
</sect2>
<sect2 id="commands-palettes-colors">
<title>The <guilabel>Colors</guilabel> palette</title>
<para>In this palette you can choose the foreground and background colors
that should be used for painting. You can choose these in five different
ways. Each of these has its own tab on this palette.
</para><para>
You can choose which color to set by clicking the corresponding
buttons at the top left. The topmost color is the foreground color, the
bottom one is the background color. You can click the double-headed arrow
to swap the colors: foreground color becomes background color and vice
versa. You can reset the colors to the default (foreground black, background
white) by clicking the small black/white icon.
</para>
<sect3 id="commands-palettes-colors-hsv">
<title><guilabel>HSV</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>HSV</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-colors-hsv.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>HSV</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>HSV</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>On this tab, you can select a color via the Hue / Saturation / Value
system.
</para><para>
The hue determines the major color and starts at red with 0, then increases
along the color spectrum (that is, along the <quote>line</quote> yellow, green,
blue, violet) to a maximum of 359. This is represented in the circle on the tab
as the angle component (starting at the top, rotate along the circle
in clockwise direction to increase the hue).
</para><para>
The saturation determines the pureness of the color. A saturation of 255
yields the pure color, while a saturation of 0 yields a gray. This is the
radius component of the color circle on the tab: the center corresponds to
no saturation, the circle boundary corresponds to fully saturated.
</para><para>
The value determines the lightness of the color. This darkens or lightens the
color, as can be set using the vertical slider on the tab. A value of 0 gives
black, a value of 255 gives the pure color.
</para>
</sect3>
<sect3 id="commands-palettes-colors-rgb">
<title><guilabel>RGB</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>RGB</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-colors-rgb.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>RGB</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>RGB</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>On this tab, colors can be selected using their Red / Green / Blue
components.
</para><para>
You can set red, green and blue components on a scale of 0 to 255. At 0 that
color component is absent, at 255 it is used at maximum intensity. The sliders
will change color to give you a hint about which color you will produce by
altering the corresponding value.
</para>
</sect3>
<sect3 id="commands-palettes-colors-gray">
<title><guilabel>Gray</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Gray</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-colors-gray.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Gray</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>Gray</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>On this tab, you can choose a gray value (indicated with a K for Key,
the usual designation for black).</para>
<para>The gray value can be chosen on a scale from 0 (pure white) to 255
(pure black).</para>
</sect3>
<sect3 id="commands-palettes-colors-palettes">
<title><guilabel>Palettes</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Palettes</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-colors-palettes.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Palettes</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>Palettes</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>On this tab, you can select a color from one of several predefined
color palettes.</para>
<para>You can choose which color palette to pick from in the drop down
box at the top.</para>
</sect3>
<sect3 id="commands-palettes-colors-watercolors">
<title><guilabel>Watercolors</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Watercolors</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-colors-watercolors.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Watercolors</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>Watercolors</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>This tab offers you a selection of watercolors for painting with <quote>wet
paint</quote>.
</para><para>
You can set two options to modify the painting behaviour: <guilabel>Paint
strength</guilabel> influences how much paint you will apply to the canvas,
and <guilabel>Wetness</guilabel> determines how wet the paint is when it is
applied. You can dry the paint later.
</para>
</sect3>
</sect2>
<sect2 id="commands-palettes-layers">
<title>The <guilabel>Layers</guilabel> palette</title>
<para>This palette offers two tabs.</para>
<sect3 id="commands-palettes-layers-layers">
<title><guilabel>Layers</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Layers</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-layers-layers.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Layers</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>Layers</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>This tab offers you access to various operations on layers.
</para><para>
On the top left, you can select what blending mode should be used for the
selected layer. These are the same possibilities as you can choose from for
drawing modes.
</para><para>
The slider/textbox at the top right determines the opacity of the selected
layer. 0% opacity corresponds to 100% transparency, and vice versa.
</para><para>
The list shows all layers and their names, and offers various controls for each
layer. The eye icon toggles whether the layer is visible or not. The link icon
is used to link layers together. The lock icon determines if the layer is
locked or not. Locked layers cannot be edited.
</para><para>
Below the layer list, there are some other controls. You can create a new
layer, move the current layer up or down, show the layer's properties and
delete it.
</para>
<para>
There are some more handy tricks you can do with the mouse within the list.
Right-click on the layer list and select <guilabel>New Folder</guilabel> to
create a new layer folder, which you can use to group layers in. You can also
drag and drop layers to change their order. To do so, click on the bottom part
of the list item representing the layer, drag the mouse, and release the mouse
button at the desired position. If you click at the top part of the list item
instead, you will get a text field so that you can rename the layer.
</para>
</sect3>
<sect3 id="commands-palettes-layers-scriptsmanager">
<title><guilabel>Scripts Manager</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Script Manager</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="palettes-layers-scriptsmanager.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Script Manager</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>Script Manager</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>This tab is a smaller version of the <guilabel>Script
Manager</guilabel> dialog. See the description over there for more
information.
</para>
</sect3>
</sect2>
</sect1>

752
doc/krita/commands-toolbars.docbook
Unescape View File

@ -0,0 +1,752 @@
<sect1 id="commands-toolbars">
<title>Toolbars</title>
<para>This section describes &krita;'s toolbars. By default, the
<guilabel>Krita</guilabel> toolbar is located to the left of the drawing area,
while the others can be found at the top, below the menu bar.</para>
<para>You can customize your toolbars by choosing
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
Toolbars...</guimenuitem></menuchoice> or by clicking with the &RMB; on a
toolbar and choosing <guimenuitem>Configure Toolbars...</guimenuitem>.</para>
<sect2 id="commands-toolbars-file">
<title>The <guilabel>File</guilabel> Toolbar</title>
<para>
<screenshot>
<screeninfo>The <guilabel>File</guilabel> toolbar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-file.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>File</guilabel> toolbar</phrase>
</textobject>
<caption><para>The <guilabel>File</guilabel> toolbar</para></caption>
</mediaobject>
</screenshot>
</para>
<para>This toolbar contains actions for working with files. In &krita;'s
default, there are five buttons on this toolbar: <guilabel>New</guilabel>,
<guilabel>Open</guilabel>, <guilabel>Save</guilabel>, <guilabel>Print
Preview</guilabel>, and <guilabel>Print</guilabel>.</para>
<para>These actions all correspond to entries in the <link
linkend="commands-menus-file"><guimenu>File</guimenu> menu</link>.</para>
</sect2>
<sect2 id="commands-toolbars-edit">
<title>The <guilabel>Edit</guilabel> Toolbar</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Edit</guilabel> toolbar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-edit.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Edit</guilabel> toolbar</phrase>
</textobject>
<caption><para>The <guilabel>Edit</guilabel> toolbar</para></caption>
</mediaobject>
</screenshot>
</para>
<para>This toolbar contains editing actions. With default settings this
toolbar offers four buttons: <guilabel>Undo</guilabel>,
<guilabel>Redo</guilabel>, <guilabel>Cut</guilabel>, and
<guilabel>Copy</guilabel>.</para>
<para>These actions all correspond to entries in the <link
linkend="commands-menus-edit"><guimenu>Edit</guimenu> menu</link>.</para>
</sect2>
<sect2 id="commands-toolbars-navigation">
<title>The <guilabel>Navigation</guilabel> Toolbar</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Navigation</guilabel> toolbar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-navigation.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Navigation</guilabel> toolbar</phrase>
</textobject>
<caption><para>The <guilabel>Navigation</guilabel> toolbar</para></caption>
</mediaobject>
</screenshot>
</para>
<para>This toolbar offers easy access to navigation actions. The two
default actions available are <guilabel>Zoom In</guilabel> and
<guilabel>Zoom Out</guilabel>. With <guilabel>Zoom In</guilabel>, the zoom
level is increased. You will see less, but in higher detail. With
<guilabel>Zoom Out</guilabel>, the zoom level is decreased, so that you see
more at less detail. </para>
</sect2>
<sect2 id="commands-toolbars-krita">
<title>The <guilabel>Krita</guilabel> Toolbar</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Krita</guilabel> toolbar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-krita.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Krita</guilabel> toolbar</phrase>
</textobject>
<caption><para>The <guilabel>Krita</guilabel> toolbar</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
This toolbar contains painting operations and tools, as well as editing and
selecting tools. The available actions and some controls are listed below. You
can change the behaviour of most tools (and with that, usually the resulting
effect) by setting their <link
linkend="commands-palettes-controlbox-tool">options</link>.
</para>
<variablelist>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-brush.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Brush</guilabel></term>
<listitem><para>
With this tool you can paint freely. Click the &LMB; to paint a
single instance of the currently selected brush, or hold the &LMB; and drag
your mouse around to paint. The mouse movements you make are directly used for
painting.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-line.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Line</guilabel></term>
<listitem><para>
This tool is used to draw lines. Click the &LMB; to indicate the first
endpoint, keep the button pressed, drag to the second endpoint and release the
button.
</para><para>
Use &Shift; while holding the mouse button to restrict drawing to only
horizontal or vertical lines. You can press &Alt; while still keeping the &LMB;
down to move the line to a different location.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-rectangle.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Rectangle</guilabel></term>
<listitem><para>
This tool can be used to paint rectangles. Click and hold the &LMB; to indicate
one corner of the rectangle, drag to the opposite corner, and release the
button.
</para><para>
If you hold &Shift; while drawing, a square will be drawn instead of a
rectangle. Holding &Ctrl; will change the way the rectangle is constructed.
Normally, the first mouse click indicates one corner and the second click the
opposite. With &Ctrl;, the initial mouse position indicates the center of the
rectangle, and the final mouse position indicates a corner.
You can press &Alt; while still keeping the &LMB; down to move the rectangle to
a different location.
</para><para>
You can change between the corner/corner and center/corner drawing
methods as often as you want by pressing or releasing &Ctrl;, provided that you
keep the &LMB; pressed. With &Ctrl; pressed, mouse movements will affect all
four corners of the rectangle (relative to the center), without &Ctrl;, one
of the corners is unaffected.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-ellipse.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Ellipse</guilabel></term>
<listitem><para>
Use this tool to paint an ellipse. The currently selected brush is used for
drawing the ellipse outline. Click and hold the &LMB; to indicate one corner of
the <quote>bounding rectangle</quote> of the ellipse, then move your mouse to
the opposite corner. &krita; will show a preview of the ellipse using a thin
line. Release the button to draw the ellipse.
</para><para>
If you hold &Shift; while drawing, a circle will be drawn instead of an
ellipse. Holding &Ctrl; will change the way the ellipse is constructed: instead
of two corners, the initial mouse position indicates the ellipse center, and the
final mouse position indicates one of the corners of the bounding rectangle.
You can press &Alt; while still keeping the &LMB; down to move the ellipse to a
different location.
</para><para>
You can change between the corner/corner and center/corner drawing
methods as often as you want by pressing or releasing &Ctrl;, provided that you
keep the &LMB; pressed. With &Ctrl; pressed, mouse movements will
affect all four corners of the bounding rectangle (relative to the center),
without &Ctrl;, the corner opposite to the one you are moving remains still.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-polygon.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Polygon</guilabel></term>
<listitem><para>
With this tool you can draw polygons. Click the &LMB; to indicate the
starting point and successive vertices, then double-click or press &Enter; to
connect the last vertex to the starting point.
</para></listitem></varlistentry>
<varlistentry> <term><inlinemediaobject><imageobject><imagedata
fileref="tool-polyline.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Polyline</guilabel></term>
<listitem><para>
Polylines are drawn like polygons, with the difference that the double-click
indicating the end of the polyline does not connect the last vertex to the
first one.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-star.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Star</guilabel></term>
<listitem><para>
This tool creates star-shaped objects. Press the &LMB; to indicate the center,
and drag the mouse to change the size and rotation of the star.
</para><para>
You can press &Alt; while still keeping the &LMB; down to move the star to a
different location.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-bezier.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Bezier</guilabel></term>
<listitem><para>
You can draw Bezier curves by using this tool. Click the &LMB; to indicate the
starting point of the curve, then click again for consecutive control points
of the curve.
</para>
<para>
<screenshot>
<screeninfo>Drawing a Bezier curve</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tool-bezier-example.png" format="PNG" />
</imageobject>
<textobject>
<phrase>Drawing a Bezier curve</phrase>
</textobject>
<caption><para>Drawing a Bezier curve</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
&krita; will show a blue line with two handles when you add a control point.
You can drag these handles to change the direction of the curve in that point.
</para>
<para>
<screenshot>
<screeninfo>Modifying a Bezier curve</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tool-bezier-example2.png" format="PNG" />
</imageobject>
<textobject>
<phrase>Modifying a Bezier curve</phrase>
</textobject>
<caption><para>Modifying a Bezier curve</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
You can click on a previously inserted control point to modify it. With an intermediate
control point (&ie; a point that is not the starting point and not the ending
point), you can move the direction handles seperately to have the curve enter
and leave the point in different directions. After editing a point, you can
just click on the canvas to continue adding points to the curve.
</para>
<para>
Pressing <keycap>Delete</keycap> will remove the currently selected control
point from the curve. Double-click the &LMB; on any point of the curve or
press &Enter; to finish drawing, or press &Esc; to cancel the entire curve.
You can use &Ctrl; while keeping the &LMB; pressed to move the entire curve to
a different position.
</para>
<para>
<screenshot>
<screeninfo>A finished Bezier curve</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tool-bezier-example3.png" format="PNG" />
</imageobject>
<textobject>
<phrase>A finished Bezier curve</phrase>
</textobject>
<caption><para>A finished Bezier curve</para></caption>
</mediaobject>
</screenshot>
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-duplicate.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Duplicate</guilabel></term>
<listitem><para>
You can use this tool to duplicate parts of an image. Press &Shift; and click
with the &LMB; on the location you want to duplicate from. &krita; will
indicate this location by an outline of your current brush. Then click with
the &LMB; to designate the location where you want to duplicate to, and drag
with the mouse. You will then duplicate whatever is at the source location to
the current (destination) location.
</para><para>
While you are painting the duplicate, both your cursor in the destination
location and the brush outline in the source location will move, in order to
give you visual feedback.
</para><para>
You can also use this tool to correct colors in a part of the image: use the
<guilabel>Healing</guilabel> option for that.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-paintwithfilters.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Paint with
filters</guilabel></term>
<listitem><para>
This tool allows you to pick a filter and draw with it. The image below shows
the effect of using a large circular brush and painting with, from left to
right, the Maximize Channel, Minimize Channel, Invert, and Desaturate filters.
</para>
<para>
<screenshot>
<screeninfo>Painting with filters</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tool-paintwithfilters-example.png" format="PNG" />
</imageobject>
<textobject>
<phrase>Painting with filters</phrase>
</textobject>
<caption><para>Painting with filters</para></caption>
</mediaobject>
</screenshot>
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-crop.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Crop</guilabel></term>
<listitem><para>
With this tool you can crop a layer or an image to a certain rectangular area.
Click and drag with the &LMB; to define an area. This area is designated by an
outline with 8 handles. You can then use the handles to change the size of the
area which the image or layer is to be cropped to. You can also click and drag
inside the area to move the outline in its entirety.
</para><para>
Double-click outside the area (i.e. on a part of the image that is to be removed)
to confirm the cropping operation.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-move.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Move</guilabel></term>
<listitem><para>
With this tool, you can move the current layer or selection by dragging the
mouse.
</para></listitem></varlistentry>
<varlistentry>
<term><inlinemediaobject><imageobject><imagedata fileref="tool-transform.png"
format="PNG"></imagedata> </imageobject></inlinemediaobject> Transform</term>
<listitem><para>
With this tool you can quickly transform the current selection or layer.
Handles will appear at the corners and sides, with which you can resize the
selection or layer. You can perform rotations by moving the mouse above or to
the left of the handles and dragging it. You can also click anywhere inside
the selection or layer and move it by dragging the mouse.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-perspectivetransform.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Perspective Transform</guilabel></term>
<listitem><para>
This tool allows you to change the perspective of an image. Designate the area
which should become the new image by clicking at its top-left, top-right,
bottom-right and bottom-left corners. The area given by these four corners
will then be transformed so that the given corners become the corners of the
actual image.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-contiguousfill.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Contiguous Fill</guilabel></term>
<listitem><para>
Use this tool to fill a contiguous area of one color with the current
foreground color or a pattern. Simply click to fill up the area.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-gradient.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Gradient</guilabel></term>
<listitem><para>
This tool fills the current layer or selection with the currently selected
gradient. Click the &LMB;, hold it, and drag the mouse to define two endpoints.
The gradient will be drawn along this line. If the line does not extend to the
border of the selection or layer, the color at the corresponding endpoint of
the gradient will be used to fill up the rest of the area at that side.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-text.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Text</guilabel></term>
<listitem><para>
With this tool you can add simple text to your image. Click the &LMB; on the
location at which you want have the text. Then enter the desired text in the
dialog window that appears. The text will be horizontally centered on, and
the top of the text will be at the same height as, the chosen location.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-colorpicker.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Color Picker</guilabel></term>
<listitem><para>
With this tool you can find the color values of a point. Click the &LMB;
somewhere in the image to see color information about that point in the
<guilabel>Control box</guilabel>.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-pan.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Pan</guilabel></term>
<listitem><para>
This tool can be used to navigate through your image. Click and hold the &LMB;
and move the mouse to scroll in a certain direction.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-zoom.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Zoom</guilabel></term>
<listitem><para>
Use this tool to zoom in and out. Click the &LMB; to increase the zoom by
a factor 2 (e.g. 1:1 to 2:1), click the &RMB; to decrease the zoom by a factor
2 (e.g. 1:1 to 1:2).
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-perspectivegrid.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Perspective Grid</guilabel></term>
<listitem><para>
You can create and edit a perspective grid with this tool. Click the &LMB; and
drag the mouse to indicate the first two corners of the grid, then click for
the third and fourth corners. The outline of the grid is now shown and you can
edit it if you are not completely happy. When you switch to a different tool,
the perspective grid will be subdivided and shown as thin gray lines.
</para>
<note><para>If you only see three corners instead of four, you probably
clicked instead of dragging initially. In this case you can still click the
handle of your now combined first and second corners and drag it to get four
separate corners.</para></note>
<para>
Clicking the <guilabel>Perspective Grid</guilabel> tool again later will allow
you to modify the grid. You can hide or remove the grid by choosing the
<guimenuitem>Hide Perspective Grid</guimenuitem> or <guimenuitem>Clear
Perspective Grid</guimenuitem> options from the <guimenu>View</guimenu> menu.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-paintselection.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Paint Selection</guilabel></term>
<listitem><para>
This tool can be used to select custom areas. The currently selected brush is
used to select areas: instead of painting on the image, the area is selected.
For more information on selections, see <link
linkend="selections">the Selections chapter</link>.
</para></listitem></varlistentry>
<varlistentry>
<term><inlinemediaobject><imageobject><imagedata
fileref="tool-eraseselection.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Erase Selection</guilabel></term>
<listitem><para>
This tool works almost the same as the <guilabel>Paint Selection</guilabel>
tool, but a selection, if it exists at the mouse location, is removed instead
of created.
</para></listitem></varlistentry>
<varlistentry>
<term><inlinemediaobject><imageobject><imagedata
fileref="tool-selectrectangular.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Select Rectangular</guilabel></term>
<listitem><para>
You can use this tool to select rectangular areas. Operation is similar to the
<guilabel>Rectangle</guilabel> tool, and &Shift;, &Ctrl; and &Alt; can be used
like when painting rectangles.
</para></listitem></varlistentry>
<varlistentry>
<term><inlinemediaobject><imageobject><imagedata
fileref="tool-selectelliptical.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Select Elliptical</guilabel></term>
<listitem><para>
You can use this tool to select elliptical areas. Operation is similar to the
<guilabel>Ellipse</guilabel> tool, and &Shift;, &Ctrl; and &Alt; can be used
like when painting ellipses.
</para></listitem></varlistentry>
<varlistentry>
<term><inlinemediaobject><imageobject><imagedata
fileref="tool-selectpolygonal.png"
format="PNG"></imagedata> </imageobject></inlinemediaobject> <guilabel>Select
Polygonal</guilabel></term>
<listitem><para>
You can use this tool to select polygonal areas. Operation is similar to the
<guilabel>Polygon</guilabel> tool, and &Shift;, &Ctrl; and &Alt; can be used
like when painting polygons.
</para></listitem></varlistentry>
<varlistentry>
<term><inlinemediaobject><imageobject><imagedata
fileref="tool-selectoutline.png"
format="PNG"></imagedata> </imageobject></inlinemediaobject> <guilabel>Select
Outline</guilabel></term>
<listitem><para>
You can use this tool to select custom outlined areas. Click the &LMB; and drag
with your mouse, like when painting with the <guilabel>Brush</guilabel> tool,
to define the outline. When you release the mouse button, the outline will be
finished with a straight line between the current position and the start
position.
</para></listitem></varlistentry>
<varlistentry>
<term><inlinemediaobject><imageobject><imagedata
fileref="tool-selectcontiguous.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Select Contiguous</guilabel></term>
<listitem><para>
With this tool you can select contiguous areas of a color. Click with the
&LMB; to select an area.
</para></listitem></varlistentry>
<varlistentry>
<term><inlinemediaobject><imageobject><imagedata
fileref="tool-selectsimilar.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Select Similar</guilabel></term>
<listitem><para>
With this tool you can select multiple areas with the same color. Detection is
done the same as with the contiguous fill, but the areas do not need to be
adjacent.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-selectmagnetic.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Magnetic Selection</guilabel></term>
<listitem><para>
With this tool you can easily select a visually distinct area. Click with the
&LMB; and move the mouse around the area that you want to select. If the area
has a well enough defined boundary, the selection will be drawn nicely around
it. You will see a number of control points appear, which connect the various
parts of the selection boundary.
</para><para>
If you want more control over the area that is selected, press &Ctrl; to
switch to manual mode. You will now have to click for each control point.
In manual mode, you can also move control points by clicking on them with the
&LMB; and dragging with the mouse.
</para><para>
When you want to return to automatic mode, simply press &Ctrl; again. You can
switch between these two modes as often as you like.
</para></listitem></varlistentry>
<varlistentry><term><inlinemediaobject><imageobject><imagedata
fileref="tool-selectbezier.png" format="PNG"></imagedata>
</imageobject></inlinemediaobject> <guilabel>Select Bezier</guilabel></term>
<listitem><para>
With this tool you can select an area by drawing a Bezier outline. See the
description of the Bezier tool for details.
</para></listitem></varlistentry>
</variablelist>
</sect2>
<sect2 id="commands-toolbars-brushesandstuff">
<title>The <guilabel>Brushes and Stuff</guilabel> Toolbar</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Brushes and Stuff</guilabel> toolbar</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-brushesandstuff.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Brushes and Stuff</guilabel> toolbar</phrase>
</textobject>
<caption><para>The <guilabel>Brushes and Stuff</guilabel> toolbar</para></caption>
</mediaobject>
</screenshot>
</para>
<para>This toolbar contains dropdown <quote>palettes</quote> in which you
can choose brush shapes, gradients, and fill patterns. It also contains a
dropdown box for painter's tools, and a tablet pressure setting.</para>
<sect3 id="commands-toolbars-brushesandstuff-brushshapes">
<title><guilabel>Brush Shapes</guilabel></title>
<para>
<screenshot>
<screeninfo>The <guilabel>Brush Shapes</guilabel> palette</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-brushes-brushshapes-predefined.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Brush Shapes</guilabel> palette</phrase>
</textobject>
<caption><para>The <guilabel>Brush Shapes</guilabel> palette</para></caption>
</mediaobject>
</screenshot>
</para>
<para>In the <guilabel>Brush Shapes</guilabel> palette, you can choose
which brush to paint with. This brush is used for painting operations
like <guilabel>Freehand</guilabel>, <guilabel>Rectangle</guilabel>,
<guilabel>Ellipse</guilabel>, etcetera. You can choose a predefined
brush (in the <guilabel>Predefined Brushes</guilabel> tab, shown above), or
customize or create one.</para>
<para>
<screenshot>
<screeninfo>The <guilabel>Brush Shapes</guilabel> palette with the <guilabel>Autobrush</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-brushes-brushshapes-autobrush.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Brush Shapes</guilabel> palette with the <guilabel>Autobrush</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>Brush Shapes</guilabel> palette with the <guilabel>Autobrush</guilabel>
tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>The <guilabel>Autobrush</guilabel> tab allows you to create a customized
rectangular or ellipsoid brush. You can set its height and width using
the <guilabel>Size</guilabel> spin boxes. The link icon controls whether
the height and width are forced to be the same or not. If a connected link
picture is shown, changing one value will automatically change the other one
as well. A disconnected link indicates that both values can be set
independently. The fuzziness of the brush can be set with the
<guilabel>Fade</guilabel> spin boxes. Again, horizontal and vertical values can
be allowed to differ or not, depending on the state of the link button.</para>
<para>
<screenshot>
<screeninfo>The <guilabel>Brush Shapes</guilabel> palette with the <guilabel>Custom Brush</guilabel> tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-brushes-brushshapes-custombrush.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Brush Shapes</guilabel> palette with the <guilabel>Custom Brush</guilabel> tab</phrase>
</textobject>
<caption><para>The <guilabel>Brush Shapes</guilabel> palette with the <guilabel>Custom Brush</guilabel>
tab</para></caption>
</mediaobject>
</screenshot>
</para>
<para>The <guilabel>Custom Brush</guilabel> tab of this palette lets you
use the current image as a brush. With the <guibutton>Add to
Predefined Brushes</guibutton> button, you can save it for later use.</para>
</sect3>
<sect3 id="commands-toolbars-brushesandstuff-gradients">
<title>Gradients</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Gradients</guilabel> palette</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-brushes-gradients.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Gradients</guilabel> palette</phrase>
</textobject>
<caption><para>The <guilabel>Gradients</guilabel> palette</para></caption>
</mediaobject>
</screenshot>
</para>
<para>In the <guilabel>Gradients</guilabel> palette, you can choose a gradient
to paint with using the <guilabel>Gradient</guilabel> tool. Clicking once on a gradient in the
palette will show a larger preview. Click it again to make it the current
gradient.</para>
<para>You can create your own gradients with the <guibutton>Custom
Gradient</guibutton> button.</para>
</sect3>
<sect3 id="commands-toolbars-brushesandstuff-patterns">
<title>Patterns</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Patterns</guilabel> palette</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-brushes-patterns.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Patterns</guilabel> palette</phrase>
</textobject>
<caption><para>The <guilabel>Patterns</guilabel> palette</para></caption>
</mediaobject>
</screenshot>
</para>
<para>The <guilabel>Patterns</guilabel> palette allows you to choose a pattern
for operations like Pattern fill. Click a pattern to see a preview at
actual size, then click it again to select it.</para>
<para>
<screenshot>
<screeninfo>The <guilabel>Patterns</guilabel> palette with the <guilabel>Custom Pattern</guilabel> tab selected</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="toolbar-brushes-patterns-custompattern.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Patterns</guilabel> palette with the <guilabel>Custom Pattern</guilabel> tab selected</phrase>
</textobject>
<caption><para>The <guilabel>Patterns</guilabel> palette with the <guilabel>Custom Pattern</guilabel> tab selected</para></caption>
</mediaobject>
</screenshot>
</para>
<para>You can also create a custom pattern, as is shown above.</para>
</sect3>
<sect3 id="commands-toolbars-brushesandstuff-painterstools">
<title>Painter's tools</title>
<para>With the <guilabel>Painter's tools</guilabel> dropdown box, you can
select the tool your painting operation should simulate. For example, you can
paint with a normal brush, an airbrush, or a filter.</para>
</sect3>
<sect3 id="commands-toolbars-brushesandstuff-pressurevariation">
<title>Pressure variation</title>
<para>This setting allows you to change &krita;'s behaviour when you use a
tablet to paint with. When you change the pressure on the tablet, you can
choose between changing the line width (<guilabel>size</guilabel>), the
opacity, and the darkness.</para>
</sect3>
</sect2>
</sect1>

14
doc/krita/commands.docbook
Unescape View File

@ -0,0 +1,14 @@
<chapter id="commands">
<title>Command Reference</title>
<para>
This chapter explains &krita;'s user interface in detail. Each of the menus,
toolbars, palettes, and dialogs will be discussed.
</para>
&commands-menus;
&commands-toolbars;
&commands-palettes;
&commands-dialogs;
</chapter>

BIN
doc/krita/createdocument.png
View File

Binary file not shown.

63
doc/krita/credits.docbook
Unescape View File

@ -0,0 +1,63 @@
<chapter id="credits">
<title>Credits and License</title>
<para>
&krita;
</para>
<para>
Program copyright &copy; 1999-2006 The &krita; Team
</para>
<para>
Contributors:
<itemizedlist>
<listitem><para>Adrian Page
<email>Adrian.Page@tesco.net</email></para></listitem>
<listitem><para>Andrew Richards
<email>physajr@phys.canterbury.ac.nz</email></para></listitem>
<listitem><para>Bart Coppens <email>kde@bartcoppens.be</email></para></listitem>
<listitem><para>Boudewijn Rempt
<email>boud@valdyas.org</email> (current maintainer)</para></listitem>
<listitem><para>Carsten Pfeiffer
<email>pfeiffer@kde.org</email></para></listitem>
<listitem><para>Casper Boemann <email>cbr@boemann.dk</email></para></listitem>
<listitem><para>Cyrille Berger <email>cyb@lepi.org</email></para></listitem>
<listitem><para>Danny Allen
<email>dannya40uk@yahoo.co.uk</email></para></listitem>
<listitem><para>Dirk Schoenberger
<email>dirk.schoenberger@sz-online.de</email></para></listitem>
<listitem><para>G&aacute;bor Lehel
<email>illissius@gmail.com</email></para></listitem>
<listitem><para>John Califf
<email>jcaliff@compuzone.net</email></para></listitem>
<listitem><para>Matthias Elter <email>elter@kde.org</email></para></listitem>
<listitem><para>Melchior Franz <email>melchior@kde.org</email></para></listitem>
<listitem><para>Michael Koch <email>koch@kde.org</email></para></listitem>
<listitem><para>Michael Thaler
<email>michael.thaler@ph.tum.de</email></para></listitem>
<listitem><para>Patrick Julien
<email>freak@codepimps.org</email></para></listitem>
<listitem><para>Roger Larsson
<email>roger.larsson@norran.net</email></para></listitem>
<listitem><para>Sven Langkamp
<email>longamp@reallygood.de</email></para></listitem>
</itemizedlist>
</para>
<para>
Documentation copyright &copy; 2005-2006 Boudewijn Rempt
<email>boud@valdyas.org</email>, Sander Koning
<email>sanderkoning@kde.nl</email>
with contributions from Casper Boemann, Bart Coppens, Cyrille Berger, Burkhard
Lueck, and Anne-Marie Mahfouf.
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL; <!-- FDL: do not remove -->
&underGPL; <!-- GPL License -->
</chapter>

BIN
doc/krita/crocusses-autocontrast.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-blur.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-brightnesscontrast.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-bumpmap.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-coloradjustment.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-colortoalpha.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-colortransfer.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-customconvolution.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-desaturate.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-edgebottom.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-edgeleft.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-edgeright.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-embossall.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-embosshorvert.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-embossvariable.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-gaussianblur.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-gaussiannoise.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-invert.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-lenscorrection.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-maximizechannel.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-meanremoval.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-minimizechannel.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-oilpaint.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-pixelize.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-raindrops.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-randomnoise.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-randompick.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-roundcorners.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-sharpen.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-smalltiles.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-sobel.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-topedge.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-unsharpmask.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-wave.png
View File

Binary file not shown.

BIN
doc/krita/crocusses-waveletnoise.png
View File

Binary file not shown.

BIN
doc/krita/crocusses.png
View File

Binary file not shown.

1553
doc/krita/developers-plugins.docbook
View File

File diff suppressed because it is too large Load Diff

534
doc/krita/developers-scripting.docbook
Unescape View File

@ -0,0 +1,534 @@
<sect1 id="developers-scripting">
<title>Scripting</title>
<para>
In &krita;, you can write scripts in Ruby or Python (the availability of the
interpreters might depend on what your distributions or the administrator of
your machine did install). Here you will find a description of the scripting
API.
</para><para>
Some examples are distributed with &krita;, and you might find them in
<filename>/usr/share/apps/krita/scripts</filename> (or
<filename>/opt/kde/share/apps/krita/scripts</filename>).
</para>
<sect2 id="developers-scripting-variables">
<title>Variables in the <classname>Krosskritacore</classname> module</title>
<itemizedlist>
<listitem><para><varname>KritaDocument</varname> returns a
<classname>Document</classname> object</para></listitem>
<listitem><para><varname>KritaScript</varname> returns a
<classname>ScriptProgress</classname> object</para></listitem>
</itemizedlist>
<para>
You can retrieve an object using the <function>get</function> function of the
<classname>Krosskritacore</classname> module, in Ruby you will have to write something like that:
<programlisting>
doc = Krosskritacore::get("KritaDocument")
script = Krosskritacore::get("KritaScript")
</programlisting>
</para>
</sect2>
<sect2 id="developers-scripting-functions">
<title>Functions in the <classname>Krosskritacore</classname> module</title>
<itemizedlist>
<listitem><para>Function: <function>getBrush</function></para><para>
This function returns a <classname>Brush</classname> taken from the list of
&krita; resources. It takes one argument: the name of the brush.
For example (in Ruby):
<programlisting>
Krosskritacore::getBrush("Circle (05)")
</programlisting></para></listitem>
<listitem><para>Function: <function>getFilter</function></para><para>
This function returns a <classname>Filter</classname> taken from the list of
&krita; resources. It takes one argument: the name of the filter.
For example (in Ruby):
<programlisting>
Krosskritacore::getFilter("invert")
</programlisting></para></listitem>
<listitem><para>Function: <function>getPattern</function></para><para>
This function returns a <classname>Pattern</classname> taken from the list of
&krita; resources. It takes one argument: the name of the pattern.
For example (in Ruby):
<programlisting>
Krosskritacore::getPattern("Bricks")
</programlisting></para></listitem>
<listitem><para>Function: <function>loadBrush</function></para><para>
This function loads a <classname>Brush</classname> and then returns it.
It takes one argument: the filename of the brush.</para></listitem>
<listitem><para>Function: <function>loadPattern</function></para><para>
This function loads a <classname>Pattern</classname> and then returns it.
It takes one argument: the filename of the pattern.</para></listitem>
<listitem><para>Function: <function>newCircleBrush</function></para><para>
This function returns a <classname>Brush</classname> with a circular shape. It
takes at least two arguments: width and height. It can take two other
arguments: width of the shading, and height of the shading. If the shading
is not specified, no shading will be used.
For example (in Ruby):
<programlisting>
Krosskritacore::newCircleBrush(10,20) # create a plain circle
Krosskritacore::newCircleBrush(10,20,5,10) # create a gradient
</programlisting></para></listitem>
<listitem><para>Function: <function>newHSVColor</function></para><para>
This function returns a new <classname>Color</classname> with the given HSV
triplet. It takes three arguments: hue component (0 to 255), saturation
component (0 to 255), value component (0 to 255).
For example (in Ruby):
<programlisting>
Krosskritacore::newHSVColor(255,125,0)
</programlisting></para></listitem>
<listitem><para>Function: <function>newImage</function></para><para>
This function returns a new <classname>Image</classname>. It takes four arguments:
width, height, colorspace id, name of the image. And in return you get an
<classname>Image</classname> object.
For example (in Ruby):
<programlisting>
Krosskritacore::newImage(10,20, "RGBA", "kikoo")
</programlisting></para></listitem>
<listitem><para>Function: <function>newRectBrush</function></para><para>
This function returns a <classname>Brush</classname> with a rectangular shape.
It takes at least two arguments: width and height. It can take two other
arguments: width of the shading and height of the shading. If the shading is
not specified, no shading will be used.
For example (in Ruby):
<programlisting>
Krosskritacore::newRectBrush(10,20) # create a plain rectangle
Krosskritacore::newRectBrush(10,20,5,10) # create a gradient
</programlisting></para></listitem>
<listitem><para>Function: <function>newRGBColor</function></para><para>
This function returns a new <classname>Color</classname> with the given RGB
triplet. It takes three arguments: red component (0 to 255), blue component (0 to
255), green component (0 to 255).
For example (in Ruby):
<programlisting>
Krosskritacore::newRGBColor(255,0,0) # create a red color
Krosskritacore::newRGBColor(255,255,255) # create a white color
</programlisting></para></listitem>
</itemizedlist>
</sect2>
<sect2 id="developers-scripting-objects">
<title>Descriptions and function lists for various objects in
<classname>Krosskritacore</classname></title>
<itemizedlist>
<listitem><para>Object: PaintLayer</para>
<itemizedlist>
<listitem><para>Function: <function>beginPainting</function></para></listitem>
<listitem><para>Function: <function>convertToColorspace</function></para><para>
Convert the image to a colorspace. This function takes one argument: the name
of the destination colorspace.
For example (in Ruby):
<programlisting>
image.convertToColorspace("CMYK")
</programlisting></para></listitem>
<listitem><para>Function: <function>createHistogram</function></para><para>
This function creates a Histogram for this layer. It takes two arguments:
the type of the histogram ("RGB8HISTO"), and 0 if the histogram is linear, or
1 if it is logarithmic.</para></listitem>
<listitem><para>Function: <function>createHLineIterator</function></para><para>
Create an iterator over a layer, it will iterate on a row. This function takes three arguments:
<varname>x</varname> (start in the row), <varname>y</varname> (vertical
position of the row), width of the row.</para></listitem>
<listitem><para>Function: <function>createPainter</function></para><para>
This function creates a <classname>Painter</classname> which will allow you to
paint on the layer. </para></listitem>
<listitem><para>Function: <function>createRectIterator</function></para><para>
Create an iterator over a layer, it will iterate on a rectangular area. This
function takes four arguments: <varname>x</varname>, <varname>y</varname>,
width of the rectangle, height of the rectangle.</para></listitem>
<listitem><para>Function: <function>createVLineIterator</function></para><para>
Create an iterator over a layer, it will iterate on a column. This function
takes three arguments: <varname>x</varname> (horizontal position of the
column), <varname>y</varname> (start in the column), height of the column.</para></listitem>
<listitem><para>Function: <function>endPainting</function></para><para>
This function closes the current undo entry and adds it to the history.</para></listitem>
<listitem><para>Function: <function>fastWaveletTransformation</function></para><para>
Returns the fast wavelet transformation of the layer.</para></listitem>
<listitem><para>Function: <function>fastWaveletUntransformation</function></para><para>
Untransforms a fast wavelet into this layer. It takes one argument: a wavelet
object.
For example (in Ruby):
<programlisting>
wavelet = layer.fastWaveletTransformation()
layer.fastWaveletUntransformation(wavelet)
</programlisting></para></listitem>
<listitem><para>Function: <function>getHeight</function></para><para>
Return the height of the layer.</para></listitem>
<listitem><para>Function: <function>getWidth</function></para><para>
Return the width of the layer.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Object: <classname>Filter</classname></para>
<itemizedlist>
<listitem><para>Function: <function>getFilterConfiguration</function></para><para>
This function returns the <classname>FilterConfiguration</classname>
associated with this filter.</para></listitem>
<listitem><para>Function: <function>process</function></para><para>
This function will apply the filter. It takes at least one argument: the
source layer. You can also use these four aguments: <varname>x</varname>,
<varname>y</varname>, <varname>width</varname>, <varname>height</varname>.
(<varname>x</varname>,<varname>y</varname>,<varname>width</varname>,<varname>height</varname>)
defines the rectangular area on which the filter
will be computed. If the rectangle is not defined, then the filter will be
applied on the entire source layer.
For example (in Ruby)
<programlisting>
doc = Krosskritacore::get("KritaDocument")
image = doc.getImage()
layer = image.getActivePaintLayer()
width = layer.getWidth()
height = layer.getHeight()
filter = Krosskritacore::getFilter("invert")
filter.process(layer, layer)
filter.process(layer, layer, 10, 10, 20, 20 )
</programlisting></para></listitem>
</itemizedlist></listitem>
<listitem><para>Object: <classname>FilterConfiguration</classname></para>
<itemizedlist>
<listitem><para>Function: <function>getProperty</function></para><para>
This function returns the value of a parameter of the associated
<classname>Filter</classname>. It takes one argument: the name of the
parameter.</para></listitem>
<listitem><para>Function: <function>setProperty</function></para><para>
This function defines a parameter of the associated
<classname>Filter</classname>. It takes two arguments: the name of the
parameter and the value, whose type depends on the
<classname>Filter</classname>.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Object: <classname>Histogram</classname></para>
<para>This class allows you to access the histogram of a
<classname>PaintLayer</classname>.
Example (in Ruby):
<programlisting>
doc = krosskritacore::get("KritaDocument")
image = doc.getImage()
layer = image.getActiveLayer()
histo = layer.createHistogram("RGB8HISTO",0)
min = layer.getMin() * 255
max = layer.getMax() * 255
for i in min..max
print layer.getValue(i)
print "\n"
end
</programlisting>
</para>
<itemizedlist>
<listitem><para>Function: <function>getChannel</function></para><para>
Return the selected channel.</para></listitem>
<listitem><para>Function: <function>getCount</function></para><para>
This function returns the number of pixels used by the histogram.</para></listitem>
<listitem><para>Function: <function>getHighest</function></para><para>
This function returns the highest value of the histogram.</para></listitem>
<listitem><para>Function: <function>getLowest</function></para><para>
This function returns the lowest value of the histogram.</para></listitem>
<listitem><para>Function: <function>getMax</function></para><para>
This function returns the maximum bound of the histogram (values at greater
position than the maximum are null). The value is in the range 0.0 &ndash; 1.0.</para></listitem>
<listitem><para>Function: <function>getMean</function></para><para>
This function returns the mean of the histogram.</para></listitem>
<listitem><para>Function: <function>getMin</function></para><para>
This function returns the minimum bound of the histogram (values at smaller
position than the minimum are null). The value is in the range 0.0 &ndash; 1.0.</para></listitem>
<listitem><para>Function: <function>getNumberOfBins</function></para><para>
Return the number of bins of this histogram. </para></listitem>
<listitem><para>Function: <function>getTotal</function></para><para>
This function returns the sum of all values of the histogram.</para></listitem>
<listitem><para>Function: <function>getValue</function></para><para>
Return the value of a bin of the histogram. This function takes one argument:
index, in the range [0..255].</para></listitem>
<listitem><para>Function: <function>setChannel</function></para><para>
Select the channel of the layer on which to get the result of the histogram.
This function takes one argument: the channel number.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Object: <classname>ScriptProgress</classname></para>
<para><classname>ScriptProgress</classname> is used to manage the progress bar
of the status bar in &krita;.
For example (in Ruby):
<programlisting>
script = Krosskritacore::get("KritaScript")
script.setProgressTotalSteps(1000)
script.setProgressStage("progressive", 0)
for i in 1..900
script.incProgress()
end
script.setProgressStage("brutal", 1000)
</programlisting></para>
<itemizedlist>
<listitem><para>Function: <function>incProgress</function></para><para>
This function increments the progress by one step.</para></listitem>
<listitem><para>Function: <function>setProgress</function></para><para>
This function sets the value of the progress. It takes one argument:
the value of the progress.</para></listitem>
<listitem><para>Function: <function>setProgressStage</function></para><para>
This function sets the value of the progress and displays the text.</para></listitem>
<listitem><para>Function: <function>setProgressTotalSteps</function></para><para>
This function set the number of steps that the script will require. It takes
one argument: the maximum value of the progress</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Object: <classname>Wavelet</classname></para><para>
This object holds the coefficients of a wavelet transformation of a
<classname>PaintLayer</classname>.</para>
<itemizedlist>
<listitem><para>Function: <function>getDepth</function></para><para>
Returns the depth of the layer.</para></listitem>
<listitem><para>Function: <function>getNCoeff</function></para><para>
Returns the value of the Nth coefficient. The function takes one argument: the
index of the coefficient.</para></listitem>
<listitem><para>Function: <function>getNumCoeffs</function></para><para>
Returns the number of coefficients in this wavelet (= size * size * depth).</para></listitem>
<listitem><para>Function: <function>getSize</function></para><para>
Returns the size of the wavelet (size = width = height).</para></listitem>
<listitem><para>Function: <function>getXYCoeff</function></para><para>
Returns the value of a coefficient. The function takes two arguments:
<varname>x</varname> and <varname>y</varname>.</para></listitem>
<listitem><para>Function: <function>setNCoeff</function></para><para>
Set the value of the Nth coefficient. The function takes two arguments: the
index of the coefficient and the new value of the coefficient.</para></listitem>
<listitem><para>Function: <function>setXYCoeff</function></para><para>
Set the value of a coefficient. The function takes three arguments:
<varname>x</varname>, <varname>y</varname>, and the new value of the
coefficient.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Object: <classname>Painter</classname></para>
<itemizedlist>
<listitem><para>Function: <function>convolve</function></para><para>
This function applies a convolution kernel to an image. It takes at least three arguments:
a list of kernels (all lists need to have the same size),
factor, and offset.
</para><para>
The value of a pixel will be given by the following function: K * P / factor + offset,
where K is the kernel and P is the neighbourhood.
</para><para>
It can take the following optional arguments: <varname>borderOp</varname>
(control how to convolve the pixels on the border of an image: 0 = use the
default color, 1 = use the pixel on the opposite side of the image, 2 = use
the border pixel, 3 = avoid border pixels), <varname>channel</varname> (1 for
color, 2 for alpha, 3 for both), <varname>x</varname>, <varname>y</varname>,
<varname>width</varname>, <varname>height</varname>.</para></listitem>
<listitem><para>Function: <function>setFillThreshold</function></para><para>
Sets the fill threshold. It takes one argument: the threshold.</para></listitem>
<listitem><para>Function: <function>fillColor</function></para><para>
Starts filling with a color. It takes two arguments: <varname>x</varname> and
<varname>y</varname>.</para></listitem>
<listitem><para>Function: <function>fillPattern</function></para><para>
Starts filling with a pattern. It takes two arguments: <varname>x</varname>
and <varname>y</varname>.</para></listitem>
<listitem><para>Function: <function>paintPolyline</function></para><para>
This function will paint a polyline. It takes two arguments: a list of x
positions, and a list of y positions.</para></listitem>
<listitem><para>Function: <function>paintLine</function></para><para>
This function will paint a line. It takes five arguments:
<varname>x1</varname>, <varname>y1</varname>, <varname>x2</varname>,
<varname>y2</varname>, and <varname>pressure</varname>.
</para></listitem>
<listitem><para>Function: <function>paintBezierCurve</function></para><para>
This function will paint a Bezier curve. It takes ten arguments:
<varname>x1</varname>, <varname>y1</varname>, <varname>p1</varname>,
<varname>cx1</varname>, <varname>cy1</varname>, <varname>cx2</varname>,
<varname>cx2</varname>, <varname>x2</varname>, <varname>y2</varname>,
<varname>p2</varname>, where (<varname>x1</varname>,<varname>y1</varname>) is
the start position, <varname>p1</varname> is the pressure at the start,
(<varname>x2</varname>,<varname>y2</varname>) is the end position,
<varname>p2</varname> is the pressure at the end.
(<varname>cx1</varname>,<varname>cy1</varname>) and
(<varname>cx2</varname>,<varname>cy2</varname>) are the positions of the
control points.</para></listitem>
<listitem><para>Function: <function>paintEllipse</function></para><para>
This function will paint an ellipse. It takes five arguments:
<varname>x1</varname>, <varname>y1</varname>, <varname>x2</varname>,
<varname>y2</varname>, <varname>pressure</varname>, where
(<varname>x1</varname>,<varname>y1</varname>) and
(<varname>x2</varname>,<varname>y2</varname>) are the positions of the two
centers.</para></listitem>
<listitem><para>Function: <function>paintPolygon</function></para><para>
This function will paint a polygon. It takes two arguments: a list of x
positions and a list of y positions.</para></listitem>
<listitem><para>Function: <function>paintRect</function></para><para>
This function will paint a rectangle. It takes five arguments:
<varname>x</varname>, <varname>y</varname>, <varname>width</varname>
<varname>height</varname>, <varname>pressure</varname>.</para></listitem>
<listitem><para>Function: <function>paintAt</function></para><para>
This function will paint at a given position.
It takes three arguments: <varname>x</varname>, <varname>y</varname>,
<varname>pressure</varname>.</para></listitem>
<listitem><para>Function: <function>setPaintColor</function></para><para>
This function sets the paint color (also called foreground color). It takes
one argument: a <classname>Color</classname>.</para></listitem>
<listitem><para>Function: <function>setBackgroundColor</function></para><para>
This function sets the background color. It takes one argument: a
<classname>Color</classname>.</para></listitem>
<listitem><para>Function: <function>setPattern</function></para><para>
This function sets the pattern used for filling. It takes one argument: a
<classname>Pattern</classname> object.</para></listitem>
<listitem><para>Function: <function>setBrush</function></para><para>
This function sets the brush used for painting. It takes one argument: a
<classname>Brush</classname> object.</para></listitem>
<listitem><para>Function: <function>setPaintOp</function></para><para>
This function defines the paint operation. It takes one argument: the name of
the paint operation.</para></listitem>
<listitem><para>Function: <function>setDuplicateOffset</function></para><para>
This function defines the duplicate offset. It takes two arguments: the
horizontal offset and the vertical offset.</para></listitem>
<listitem><para>Function: <function>setOpacity</function></para><para>
This function set the opacity of the painting. It takes one argument: the
opacity, in the range 0 to 255.</para></listitem>
<listitem><para>Function: <function>setStrokeStyle</function></para><para>
This function sets the style of the stroke. It takes one argument: 0 for none,
or 1 for brush.</para></listitem>
<listitem><para>Function: <function>setFillStyle</function></para><para>
This function sets the fill style of the <classname>Painter</classname>.
It takes one argument: 0 for none, 1 for fill with foreground color, 2 for
fill with background color, 3 for fill with pattern.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Object: <classname>Iterator</classname></para><para>
This object allows you to change pixel values one by one.
The name of some functions depends on the colorspace, for instance, if the
colorspace of the layer is RGB, you will have <function>setR</function>,
<function>setG</function> and <function>setB</function>, and for
CMYK: <function>setC</function>, <function>setM</function>,
<function>setY</function> and <function>setK</function>. In the documentation
below we will assume that the colorspace is called ABC, with three channels:
A, B and C.</para>
<itemizedlist>
<listitem><para>Functions: <function>setA</function>,
<function>setB</function>, <function>setC</function></para><para>
Those functions take one argument: the new value of one of the channels of
this pixel.</para></listitem>
<listitem><para>Function: <function>setABC</function></para><para>
Set the value of all channels. This function takes one argument: an array with
the new values for all channels.</para></listitem>
<listitem><para>Functions: <function>getA</function>,
<function>getB</function>, <function>getC</function></para><para>
Return the value of one of the channels of this pixel.</para></listitem>
<listitem><para>Function: <function>getABC</function></para><para>
Return an array with the values of all channels.</para></listitem>
<listitem><para>Function: <function>darken</function></para><para>
Darken a pixel. This function takes at least one argument:
<varname>shade</varname> (amount used to darken all color channels). This
function can take the following optional argument:
<varname>compensation</varname> (to limit the darkening).</para></listitem>
<listitem><para>Function: <function>invertColor</function></para><para>
Invert the color of a pixel.</para></listitem>
<listitem><para>Function: <function>next</function></para><para>
Increment the position, go to the next pixel.</para></listitem>
<listitem><para>Function: <function>isDone</function></para><para>
Return true if the iterator is at the end (no more pixels are
available).</para></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="developers-scripting-resources">
<title>Resources</title>
<para>
Here are hints or partial lists of resources for &krita;.
</para><para>
For <classname>Brush</classname> and <classname>Pattern</classname>: You can get
the name and the associated brush or pattern from the selector in &krita;'s
toolbar.
</para><para>
A list of ids for colorspaces in &krita;: LABA, RGBA, RGBA16, RGBAF32,
RGBAF16HALF, LMSAF32, GRAYA, GRAYA16, CMYK, CMYKA16.
</para>
</sect2>
</sect1>

13
doc/krita/developers.docbook
Unescape View File

@ -0,0 +1,13 @@
<chapter id="developers">
<title>Developer's information</title>
<para>
This chapter contains information for developers or other enthousiasts who
want to get more out of &krita;.
</para>
&developers-scripting;
&developers-plugins;
</chapter>

BIN
doc/krita/dialogs-addpalette.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-blur.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-brightnesscontrast.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-bumpmap.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-coloradjustment.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-colorrange.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-colortoalpha.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-colortransfer.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-convertimagetype.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-convertlayertype.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-cubism.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-customconvolution.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-documentinformation.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-dropshadow.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-emboss.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-filtersgallery.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-gaussiannoise.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-histogram.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-imageproperties.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-imagerestoration.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-imagesize.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-layerproperties.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-layersize.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-lenscorrection.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-newadjustmentlayer.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-newlayer.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-oilpaint.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-pixelize.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-raindrops.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-randomnoise.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-randompick.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-rotateimage.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-rotatelayer.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-roundcorners.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-separateimage.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-shearimage.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-shearlayer.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-smalltiles.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-sobel.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-substrate.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-unsharpmask.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-wave.png
View File

Binary file not shown.

BIN
doc/krita/dialogs-waveletnoise.png
View File

Binary file not shown.

51
doc/krita/faq.docbook
Unescape View File

@ -0,0 +1,51 @@
<chapter id="faq">
<title>Questions and Answers</title>
<para>
Sometimes, stuff does not work as one would like. &krita; can crash — not all
that often, these days, but still. So you might need some help. The first thing
to do is trying to determine what was going on, exactly. Try to reproduce the
problem and write down what you did before the problem occurred.
</para><para>
Then you can create a bug report: go to the <guimenu>Help</guimenu> menu and select
<guimenuitem>Report Bug</guimenuitem>. That way, we know exactly which version of
&krita; you are using. Please try to make reasonably sure that your problem has
not been reported already! Also, please try to be as complete as possible in
describing your problem.
</para><para>
You can also, if it is just that you cannot figure out how to do something
that you can do using Photoshop (or any other drawing program) using &krita;,
or if you have some other question, e-mail the &krita; developers at our
mailing list <email>kimageshop@kde.org</email>, or e-mail the program or
documentation maintainer directly at <email>boud@valdyas.org</email> or
<email>sanderkoning@kde.nl</email>, respectively.
</para>
<!-- TODO Add a set of Q&As? -->
&reporting.bugs;
&updating.documentation;
<!-- <qandaset id="faqlist">
<qandaentry>
<question>
<para>My Mouse doesn't work. How do I quit &kmyapplication;?</para>
</question>
<answer>
<para>You silly goose! Check out the <link linkend="commands">Commands
Section</link> for the answer.</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>Why can't I twiddle my documents?</para>
</question>
<answer>
<para>You can only twiddle your documents if you have the foobar.lib
installed.</para>
</answer>
</qandaentry>
</qandaset> -->
</chapter>

137
doc/krita/index.docbook
Unescape View File

@ -0,0 +1,137 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&krita;">
<!ENTITY package "koffice">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
<!ENTITY introduction SYSTEM "introduction.docbook">
<!ENTITY tutorial SYSTEM "tutorial.docbook">
<!ENTITY tutorial-starting SYSTEM "tutorial-starting.docbook">
<!ENTITY tutorial-select-layer SYSTEM "tutorial-select-layer.docbook">
<!ENTITY tutorial-quick-starts SYSTEM "tutorial-quick-starts.docbook">
<!ENTITY tutorial-tablet SYSTEM "tutorial-tablet.docbook">
<!ENTITY images SYSTEM "using-images.docbook">
<!ENTITY views SYSTEM "using-views.docbook">
<!ENTITY layers SYSTEM "using-layers.docbook">
<!ENTITY selections SYSTEM "using-selections.docbook">
<!ENTITY filters SYSTEM "using-filters.docbook">
<!ENTITY colorspaces SYSTEM "using-colorspaces.docbook">
<!ENTITY commands SYSTEM "commands.docbook">
<!ENTITY commands-toolbars SYSTEM "commands-toolbars.docbook">
<!ENTITY commands-palettes SYSTEM "commands-palettes.docbook">
<!ENTITY commands-menus SYSTEM "commands-menus.docbook">
<!ENTITY commands-dialogs SYSTEM "commands-dialogs.docbook">
<!ENTITY settings SYSTEM "settings.docbook">
<!ENTITY developers SYSTEM "developers.docbook">
<!ENTITY developers-scripting SYSTEM "developers-scripting.docbook">
<!ENTITY developers-plugins SYSTEM "developers-plugins.docbook">
<!ENTITY faq SYSTEM "faq.docbook">
<!ENTITY credits SYSTEM "credits.docbook">
<!ENTITY installation SYSTEM "installation.docbook">
]>
<book lang="&language;">
<bookinfo>
<title>The &krita; Handbook</title>
<authorgroup>
<author>
<personname>
<firstname>Boudewijn</firstname>
<surname>Rempt</surname>
</personname>
<email>boud@valdyas.org</email>
</author>
<author>
<personname>
<firstname>Casper</firstname>
<surname>Boemann</surname>
</personname>
<email>cbr@boemann.dk</email>
</author>
<author>
<personname>
<firstname>Cyrille</firstname>
<surname>Berger</surname>
</personname>
<email>cberger@cberger.net</email>
</author>
<author>
<personname>
<firstname>Sander</firstname>
<surname>Koning</surname>
</personname>
<email>sanderkoning@kde.nl</email>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2005-2006</year>
<holder>Boudewijn Rempt</holder>
<holder>Casper Boemann</holder>
<holder>Cyrille Berger</holder>
<holder>Sander Koning</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<!-- Date and version information of the documentation -->
<date>2006-09-13</date>
<releaseinfo>1.6</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>
&krita; is part of the &koffice; package. &krita; is a photo retouching, image
editing application, but above all, a paint application that will allow you to
create original art on your computer as if you were working with paint and
brushes, pencils, pen and ink &mdash; or, at least, it will one day. We are
continually working on extending &krita; and making it better in every respect.
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>koffice</keyword>
<keyword>Krita</keyword>
<keyword>image manipulation</keyword>
<keyword>graphics</keyword>
<keyword>painting</keyword>
</keywordset>
</bookinfo>
&introduction;
&tutorial;
&images;
&views;
&layers;
&selections;
&filters;
&colorspaces;
&commands;
&settings;
&developers;
&faq;
&credits;
&installation;
&documentation.index;
</book>
<!--
Local Variables:
mode: xml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
vim:tabstop=2:shiftwidth=2:expandtab
kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
-->

73
doc/krita/installation.docbook
Unescape View File

@ -0,0 +1,73 @@
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-kapp">
<title>How to obtain &krita;</title>
<!-- This first entity contains boiler plate for applications that are
part of KDE CVS. You should remove it if you are releasing your
application -->
&install.intro.documentation;
</sect1>
<sect1 id="requirements">
<title>Requirements</title>
<!--
List any special requirements for your application here. This should include:
.Libraries or other software that is not included in kdesupport,
kdelibs, or kdebase.
.Hardware requirements like amount of RAM, disk space, graphics card
capabilities, screen resolution, special expansion cards, etc.
.Operating systems the app will run on. If your app is designed only for a
specific OS, (you wrote a graphical LILO configurator for example) put this
information here.
-->
<para>
&krita; depends on the following libraries, apart from what &koffice; needs
itself:
</para>
<itemizedlist>
<listitem><para><ulink url="http://www.imagemagick.org/">Image
Magick</ulink> &mdash; X11 Image Processing and Display
Package</para></listitem>
<listitem><para><ulink url="http://www.littlecms.com/">Little CMS</ulink>
&mdash; A free color management system in 100K</para></listitem>
<listitem><para><ulink
url="http://www.openexr.com/">OpenEXR</ulink></para></listitem>
</itemizedlist>
<!-- For a list of updates, you may refer to the application web site
or the ChangeLog file, or ... -->
<para>
You can find a list of changes in the <filename>ChangeLog</filename> file or on
<ulink url="http://koffice.org/krita/">&krita;'s website</ulink>.
</para>
</sect1>
<sect1 id="compilation">
<title>Compilation and Installation</title>
<!-- This entity contains the boilerplate text for standard -->
<!-- compilation instructions. If your application requires any -->
<!-- special handling, remove it, and replace with your own text. -->
&install.compile.documentation;
</sect1>
<!--
<sect1 id="configuration">
<title>Configuration</title>
<para>Don't forget to tell your system to start the <filename>dtd</filename>
dicer-toaster daemon first, or &kmyapplication; won't work !</para>
</sect1>
-->
</appendix>

153
doc/krita/introduction.docbook
Unescape View File

@ -0,0 +1,153 @@
<chapter id="introduction">
<title>Introduction</title>
<sect1 id="introduction-krita">
<title>What is &krita;?</title>
<para>
&krita;, part of &koffice;, can do everything you want with images &mdash; or
it will be able to one day. Everything from photo retouching, image editing,
and last but not least creating original art on your computer as if you were
working with real paint and brushes, pencils, pen and ink. Every day
&krita; becomes a little better, a little more useful. We are working on it,
anyway. We, that is, Adrian, Bart, Boudewijn, Casper, Cyrille, Michael and Sven.
It could be you, too &mdash; whether you would like to help with some artwork
for the user interface, cool ideas for the todo, helpful bug reports, usability
reviews or even actual code, you will not be snubbed by us.
</para>
<para>
&krita; is as much yours as it is ours. It should be fun, innovative, and
experimental &mdash; first and foremost a pleasure to use and to hack on.
</para>
</sect1>
<sect1 id="introduction-keyfeatures">
<title>Key features</title>
<para>The most important features &krita; currently has to offer, are:</para>
<itemizedlist>
<listitem><para>Plugins: Krita is extensible through plugins. There are tools,
colorspaces, paint operations, filters and kpart-based user interface plugins.
</para></listitem>
<listitem><para>Scriptable: &krita; is scriptable in Python and Ruby using
Kross, the cross language scripting engine that originated in Kexi. The
scripting is compatible with PyQt/KDE and Korundum for adding GUI
items, such as dialog boxes.</para></listitem>
<listitem><para>Color models: &krita; uses lcms for a dependable color
workflow using icc profiles for importing, exporting, selecting paint colors,
printing, cutting and pasting. 8, 16, and 32 bit colorspaces are available
(RGB, CMYK, L*a*b*, ...) and colors can be selected from a color wheel, rgb or
grayscale sliders or with a palette.</para></listitem>
<listitem><para>Editing and viewing: Unlimited undo and redo are available.
You can cut, copy and paste between lagers and images, with conversion through
icc profiles if this is necessary. OpenGL is supported for display. The view
can be made fullscreen and can be split. Rulers are available, the
image can be zoomed, and for maximizing the workspace all palette windows can
be hidden in one go. Also a histogram palette is available.</para></listitem>
<listitem><para>Images and layers: Layers and entire images can be mirrored,
sheared, rotated and scaled, converted between colorspaces, and layers in
different colorspaces can be merged. An image can be separated into colorspace
channels.</para></listitem>
<listitem><para>Layers: Layers can be added, removed, grouped, locked, made
(in)visible, and re-ordered. Adjustment layers (layers which perform a filter
function) can be added as well. A layer can be saved as a separate image and
its colorspace can be changed.</para></listitem>
<listitem><para>Tools: Through the innovative paintOp plugin system, all
painting tools (brush, ellipse, line, etc.) can paint aliased, anti-aliased,
erase, airbrush and more.</para></listitem>
<listitem><para>Filters: &krita; can multithread the operation of some
filters. Filters can be previewed in the filter gallery. Available filters
include color adjustment, sharpen or blur, emboss, raindrops, and
more.</para></listitem>
<listitem><para>Brushes: The GIMP brush shapes can be used, both colored and
grayscale brushes and pipe brushes. Custom brushes can be created, even from
entire layers or images. Colored brushes can also be used as
masks.</para></listitem>
</itemizedlist>
<sect2 id="introduction-keyfeatures-colormanagement">
<title>Color management</title>
<para>
One of the most distinguishing features in &krita; is its color management.
If you put two screens side to side, you will notice that there is often a lot
of difference in the way they display colors. Even white, especially white, is
often not the same thing at all. On one screen it can be a dirty yellow, on
another screen a sickly bluish. Very seldom is it a creamy milk-white. The same
holds, unfortunately, for scanners, printers and digital cameras. So, if you
want to see the right colors on screen and on paper, being the colors that you
saw when taking your snapshot, you will have to compensate.
</para><para>
&krita; can do this for you: in &krita;, a color is (almost) never just a set of
numbers, one for each color channel; it is a set of numbers with information
attached. And that extra information is contained in a profile: your image has a
profile, your scanner has a profile, your camera should have a profile and your
screen has a profile. When passing information from your image to your screen,
the profiles are checked and the correct color is computed. This may cause a
little slowness, now and then, but the result is that you can work with colors,
instead of almost meaningless RGB triplets.
</para><para>
Available colorspaces are: 8 bit/channel RGB, CMYK, grayscale and wet
watercolors, 16 bit/channel RGB, CMYK, grayscale and L*a*b*, <quote>half</quote>
RGB, and 32 bit float RGB (HDR) and LMS.
</para>
</sect2>
<sect2 id="introduction-keyfeatures-imageformats">
<title>Image formats</title>
<para>
&krita; currently supports the following image formats, both for importing and
exporting, apart from its own: PNG, TIFF, JPEG, Dicom, XCF, PSD, GIF, BMP,
XPM, Targa, RGB, and OpenEXR. Additionally, &krita; can import
ICO files. PSD (the Photoshop file format) is only supported up to version 6,
from version 7 on, the Photoshop file format is closed.
</para><para>
Embedded icc profiles and exif information are preserved on export to
supporting file formats. &krita;'s native file format stores icc and exif
information.
</para>
</sect2>
</sect1>
<sect1 id="introduction-manual">
<title>About this manual</title>
<para>
We are assuming you have got a good working knowledge of &kde; and of your
operating system. The first chapter will give you a quick tour of &krita;'s
cool features; the other chapters will expand on that information.
</para>
<note><para>
This manual is not complete. The invitation to join us and help out extends to
the manual, too!
</para></note>
<para>
Should you have any questions, comments or suggestions, please contact the
documentation maintainer at <email>sanderkoning@kde.nl</email>.
</para>
</sect1>
<sect1 id="introduction-maintainer">
<title>About the application maintainer</title>
<para>
Hi! I'm Boudewijn Rempt &mdash; the current maintainer of &krita;. I was
educated as a linguist, retrained as a database developer, work as a Java
hacker, study theology and I have always liked to paint and sketch a little.
Conspiciously absent in my life have been two important things for a developer
of an image app: mathematics and experience with graphic design. That means that
I am probably not the best person to explain the niceties of using an image
editor or a paint application to you. If you catch me in an error, please don't
hesitate to mail me: <email>boud@valdyas.org</email>.
</para>
</sect1>
</chapter>

BIN
doc/krita/mainscreen.png
View File

Binary file not shown.

BIN
doc/krita/mountains-burn.png
View File

Binary file not shown.

BIN
doc/krita/mountains-color.png
View File

Binary file not shown.

BIN
doc/krita/mountains-darken.png
View File

Binary file not shown.

BIN
doc/krita/mountains-divide.png
View File

Binary file not shown.

BIN
doc/krita/mountains-dodge.png
View File

Binary file not shown.

BIN
doc/krita/mountains-hue.png
View File

Binary file not shown.

BIN
doc/krita/mountains-lighten.png
View File

Binary file not shown.

BIN
doc/krita/mountains-multiply.png
View File

Binary file not shown.

BIN
doc/krita/mountains-normal.png
View File

Binary file not shown.

BIN
doc/krita/mountains-original.png
View File

Binary file not shown.

BIN
doc/krita/mountains-overlay.png
View File

Binary file not shown.

BIN
doc/krita/mountains-saturation.png
View File

Binary file not shown.

BIN
doc/krita/mountains-screen.png
View File

Binary file not shown.

BIN
doc/krita/mountains-value.png
View File

Binary file not shown.

BIN
doc/krita/mountains.png
View File

Binary file not shown.

BIN
doc/krita/newimage.png
View File

Binary file not shown.

BIN
doc/krita/palettes-colors-gray.png
View File

Binary file not shown.

BIN
doc/krita/palettes-colors-hsv.png
View File

Binary file not shown.

BIN
doc/krita/palettes-colors-palettes.png
View File

Binary file not shown.

BIN
doc/krita/palettes-colors-rgb.png
View File

Binary file not shown.

BIN
doc/krita/palettes-colors-watercolors.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-bezier.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-brush.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-colorpicker.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-contiguousfill.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-crop.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-duplicate.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-ellipse.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-fill.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-gradient.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-histogram.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-line.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-overview.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-paintwithfilters.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-polygon.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-polyline.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-rectangle.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-select.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-selectcontiguous.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-selectmagnetic.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-selectsimilar.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-star.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-text.png
View File

Binary file not shown.

BIN
doc/krita/palettes-controlbox-transform.png
View File

Binary file not shown.

BIN
doc/krita/palettes-layers-layers.png
View File

Binary file not shown.

BIN
doc/krita/palettes-layers-scriptsmanager.png
View File

Binary file not shown.

BIN
doc/krita/preferences-color.png
View File

Binary file not shown.

BIN
doc/krita/preferences-display.png
View File

Binary file not shown.

BIN
doc/krita/preferences-general.png
View File

Binary file not shown.

BIN
doc/krita/preferences-grid.png
View File

Binary file not shown.

BIN
doc/krita/preferences-performance.png
View File

Binary file not shown.

BIN
doc/krita/preferences-sidebar.png
View File

Binary file not shown.

BIN
doc/krita/preferences-tablet.png
View File

Binary file not shown.

229
doc/krita/settings.docbook
Unescape View File

@ -0,0 +1,229 @@
<chapter id="settings">
<title>Settings</title>
<para>This chapter describes the various settings that affect the way &krita;
functions and looks.</para>
<sect1 id="settings-preferences">
<title>The <guilabel>Preferences</guilabel> dialog</title>
<para>
A number of options to configure &krita; are available via the
<guilabel>Preferences</guilabel> dialog, which is available via
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
&krita;...</guimenuitem></menuchoice>. The dialog is divided into several
sections, which you can open via the sidebar at the left, shown below.
</para>
<para>
<screenshot>
<screeninfo>The available <guilabel>Preferences</guilabel> sections</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="preferences-sidebar.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The available <guilabel>Preferences</guilabel> sections</phrase>
</textobject>
<caption><para>The available <guilabel>Preferences</guilabel> sections</para></caption>
</mediaobject>
</screenshot>
</para>
<sect2 id="settings-preferences-general">
<title>The <guilabel>General</guilabel> section</title>
<para>
<screenshot>
<screeninfo>The <guilabel>General</guilabel> section</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="preferences-general.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>General</guilabel> section</phrase>
</textobject>
<caption><para>The <guilabel>General</guilabel> section</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
This section offers three options. First of all, the setting in the
<guilabel>Cursor shape:</guilabel> dropdown box determines what the drawing
cursor looks like. You can choose between a cursor resembling the actual tool
you are working with, a normal cursor, a crosshair, and a brush-shaped cursor.
Then you can select the <guilabel>Palette Behavior</guilabel>. You can set
here when palettes may be <quote>docked</quote> (set aside at a window
border): always (<guilabel>Allow docking</guilabel>), never
(<guilabel>Allow only floating</guilabel>), or when there is enough space
(<guilabel>Allow docking only on large screens</guilabel>). The last option is
<guilabel>Palette font size:</guilabel> which determines the text size used in
the palettes. Set this to a larger value if you have trouble reading the text,
with the side effect that the palettes will take more space.
</para>
</sect2>
<sect2 id="settings-preferences-display">
<title>The <guilabel>Display</guilabel> section</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Display</guilabel> section</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="preferences-display.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Display</guilabel> section</phrase>
</textobject>
<caption><para>The <guilabel>Display</guilabel> section</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
This section contains just one option. If your graphics card and driver have
OpenGL support, you can enable it here to make drawing faster (the
processor of yor graphics card will take over part of the calculations). Be
warned, though: there are a few cases where enabling OpenGL is known to
introduce erratic behavior.
</para>
</sect2>
<sect2 id="settings-preferences-colormanagement">
<title>The <guilabel>Color Management</guilabel> section</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Color Management</guilabel> section</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="preferences-color.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Color Management</guilabel> section</phrase>
</textobject>
<caption><para>The <guilabel>Color Management</guilabel> section</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
Here you can set various options related to colorspaces in rendering, editing
and printing of images. The topmost option can be used to set the default
color model for creating new images (useful if you usually want to create CMYK
images, for instance). Use the <guilabel>Display</guilabel> options to let
&krita; know what color profile your monitor uses, and how rendering should be
done. Under <guilabel>Printing</guilabel>, you can set the color model and
profile for your printer. The next option determines what &krita; should do
when you paste an image into it that was copied from another application. If
<guilabel>Use Blackpoint compensation</guilabel> is checked, whenever a
colorspace conversion is needed, the black points of the source and
destination colorspaces are matched.
</para>
</sect2>
<sect2 id="settings-preferences-performance">
<title>The <guilabel>Performance</guilabel> section</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Performance</guilabel> section</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="preferences-performance.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Performance</guilabel> section</phrase>
</textobject>
<caption><para>The <guilabel>Performance</guilabel> section</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
Two options are available here. The <guilabel>Maximum number of tiles kept in
memory</guilabel> setting indicates how many tiles (image subparts) &krita;
will keep in memory. The default setting should be reasonable, if you are low
or very high on memory, you may want to decrease or increase this option,
respectively. The <guilabel>Swappiness:</guilabel> option determines how eager
&krita; will be to swap to disk.
</para>
</sect2>
<sect2 id="settings-preferences-tablet">
<title>The <guilabel>Tablet</guilabel> section</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Tablet</guilabel> section</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="preferences-tablet.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Tablet</guilabel> section</phrase>
</textobject>
<caption><para>The <guilabel>Tablet</guilabel> section</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
If you have a tablet device attached, you can enable it and set its pressure
sensitivity in this section.
</para><para>
You need to activate the tablet devices you want to use with &krita;. There
are three supported devices: the cursor, the eraser and the stylus. You can
activate them using the tablet sections. Only use the configuration options of
a device if you use a non-Wacom tablet, and if the behavior of the tablet is
unexpected, like moving when you press on the tablet for instance. In this
situation, you can use the dialog to make sure you have a correct interaction:
values (position, pressure, tilt...) are sent from the tablet to the computer
in a given order, it might happen that some tablets do not use the default
order. You can set this in the configuration options of a device.
</para>
</sect2>
<sect2 id="settings-preferences-grid">
<title>The <guilabel>Grid</guilabel> section</title>
<para>
<screenshot>
<screeninfo>The <guilabel>Grid</guilabel> section</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="preferences-grid.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Grid</guilabel> section</phrase>
</textobject>
<caption><para>The <guilabel>Grid</guilabel> section</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
In this section, you can fine-tune &krita;'s grid. The line styles for the
grid can be set in the <guilabel>Styles</guilabel> option set.
<guilabel>Colors</guilabel> allows you to choose the line colors for the grid.
The horizontal and vertical spacing between the main lines can be set under
<guilabel>Spacing</guilabel>, as well as the amount of subdivisions (in how
many smaller parts a grid section is subdivided). Furthermore you can set the
<guilabel>Offset</guilabel>: usually the grid is painted starting at the top
left corner, if you want the first main grid lines not to start there, you can
enter an offset (displacement) here.
</para>
</sect2>
</sect1>
</chapter>

BIN
doc/krita/tool-bezier-example.png
View File

Binary file not shown.

BIN
doc/krita/tool-bezier-example2.png
View File

Binary file not shown.

BIN
doc/krita/tool-bezier-example3.png
View File

Binary file not shown.

BIN
doc/krita/tool-bezier.png
View File

Binary file not shown.

BIN
doc/krita/tool-brush.png
View File

Binary file not shown.

BIN
doc/krita/tool-colorpicker.png
View File

Binary file not shown.

BIN
doc/krita/tool-contiguousfill.png
View File

Binary file not shown.

BIN
doc/krita/tool-crop.png
View File

Binary file not shown.

BIN
doc/krita/tool-duplicate.png
View File

Binary file not shown.

BIN
doc/krita/tool-ellipse.png
View File

Binary file not shown.

BIN
doc/krita/tool-eraseselection.png
View File

Binary file not shown.

BIN
doc/krita/tool-gradient.png
View File

Binary file not shown.

BIN
doc/krita/tool-line.png
View File

Binary file not shown.

BIN
doc/krita/tool-move.png
View File

Binary file not shown.

BIN
doc/krita/tool-paintselection.png
View File

Binary file not shown.

BIN
doc/krita/tool-paintwithfilters-example.png
View File

Binary file not shown.

BIN
doc/krita/tool-paintwithfilters.png
View File

Binary file not shown.

BIN
doc/krita/tool-pan.png
View File

Binary file not shown.

BIN
doc/krita/tool-perspectivegrid.png
View File

Binary file not shown.

BIN
doc/krita/tool-perspectivetransform.png
View File

Binary file not shown.

BIN
doc/krita/tool-polygon.png
View File

Binary file not shown.

BIN
doc/krita/tool-polyline.png
View File

Binary file not shown.

BIN
doc/krita/tool-rectangle.png
View File

Binary file not shown.

BIN
doc/krita/tool-selectbezier.png
View File

Binary file not shown.

BIN
doc/krita/tool-selectcontiguous.png
View File

Binary file not shown.

BIN
doc/krita/tool-selectelliptical.png
View File

Binary file not shown.

BIN
doc/krita/tool-selectmagnetic.png
View File

Binary file not shown.

BIN
doc/krita/tool-selectoutline.png
View File

Binary file not shown.

BIN
doc/krita/tool-selectpolygonal.png
View File

Binary file not shown.

BIN
doc/krita/tool-selectrectangular.png
View File

Binary file not shown.

BIN
doc/krita/tool-selectsimilar.png
View File

Binary file not shown.

BIN
doc/krita/tool-star.png
View File

Binary file not shown.

BIN
doc/krita/tool-text.png
View File

Binary file not shown.

BIN
doc/krita/tool-transform.png
View File

Binary file not shown.

BIN
doc/krita/tool-zoom.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-brushes-brushshapes-autobrush.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-brushes-brushshapes-custombrush.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-brushes-brushshapes-predefined.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-brushes-gradients.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-brushes-patterns-custompattern.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-brushes-patterns.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-brushesandstuff.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-edit.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-file.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-krita.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-navigation.png
View File

Binary file not shown.

BIN
doc/krita/toolbar-transformationtools.png
View File

Binary file not shown.

BIN
doc/krita/toolbars-button-zoomin.png
View File

Binary file not shown.

BIN
doc/krita/toolbars-button-zoomout.png
View File

Binary file not shown.

183
doc/krita/tutorial-quick-starts.docbook
Unescape View File

@ -0,0 +1,183 @@
<sect1 id="tutorial-quickstarts">
<title>Quick start guides</title>
<sect2 id="tutorial-quickstarts-cropimage">
<title>Crop an area and save it</title>
<para>Aim: from a picture, crop an area and save that area in a new file</para>
<para>Open &krita; with the original picture.</para>
<screenshot>
<screeninfo>The original picture</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts1.png" format="PNG"/>
</imageobject>
<textobject><phrase>The original picture</phrase></textobject>
</mediaobject>
</screenshot>
<para>Select the <guiicon>Select Rectangular</guiicon> tool in the
&krita; toolbar.</para>
<screenshot>
<screeninfo>The Select a rectangular area tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts2.png" format="PNG"/>
</imageobject>
<textobject><phrase>The Select a rectangular area tool</phrase></textobject>
</mediaobject>
</screenshot>
<para>Select the area you want to make a new picture with. &krita; makes the
outside area grey.</para>
<screenshot>
<screeninfo>The selected area</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts3.png" format="PNG"/>
</imageobject>
<textobject><phrase>The selected area</phrase></textobject>
</mediaobject>
</screenshot>
<para>Then use the
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice>
menu item or <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> to
copy the selected area.</para>
<para>Click again on the <guimenu>Edit</guimenu> menu.</para>
<para>Use the <guimenuitem>Paste into new image</guimenuitem> item.</para>
<screenshot>
<screeninfo>The <guimenu>Edit</guimenu> menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts4.png" format="PNG"/>
</imageobject>
<textobject><phrase>The <guimenu>Edit</guimenu> menu</phrase></textobject>
</mediaobject>
</screenshot>
<para>&krita; opens a new window with the selected area as new image.</para>
<screenshot>
<screeninfo>The new image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts5.png" format="PNG"/>
</imageobject>
<textobject><phrase>The new image</phrase></textobject>
</mediaobject>
</screenshot>
<para>Save the new image.</para>
</sect2>
<sect2 id="tutorial-quickstarts-drawrectangle">
<title>Draw a rectangle on your picture</title>
<para>Aim: draw a coloured rectangle on your picture</para>
<para>Open &krita; with the original picture. My picture consists of a view of
a toolbar in which I want to point an icon by putting a red rectangle around
it.</para>
<screenshot>
<screeninfo>The original picture</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts6.png" format="PNG"/>
</imageobject>
<textobject><phrase>The original picture</phrase></textobject>
</mediaobject>
</screenshot>
<para>Enable the <guilabel>Brushes and Stuff</guilabel> toolbar using
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Toolbars</guimenuitem></menuchoice>
menu.</para>
<para>Also make sure the palettes are viewed. If not, use the
<menuchoice><guimenu>View</guimenu><guimenuitem>Palettes</guimenuitem></menuchoice>
menu.</para>
<screenshot>
<screeninfo>&krita; view</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts7.png" format="PNG"/>
</imageobject>
<textobject><phrase>&krita; view</phrase></textobject>
</mediaobject>
</screenshot>
<para>Click on the <guiicon>Brush Shapes</guiicon> icon in the
<guilabel>Brushes and Stuff</guilabel> toolbar.</para>
<screenshot>
<screeninfo>The <guiicon>Brush Shapes</guiicon> icon</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts8.png" format="PNG"/>
</imageobject>
<textobject><phrase>The <guiicon>Brush Shapes</guiicon> icon</phrase></textobject>
</mediaobject>
</screenshot>
<para>Select which brush shape you want to use among the predefined
brushes.</para>
<screenshot>
<screeninfo>Selecting a brush shape</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts9.png" format="PNG"/>
</imageobject>
<textobject><phrase>Selecting a brush shape</phrase></textobject>
</mediaobject>
</screenshot>
<para>Select the drawing shape on the &krita; toolbar. I choose a
rectangle.</para>
<screenshot>
<screeninfo>Selecting the <guiicon>Rectangle</guiicon> icon</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts10.png" format="PNG"/>
</imageobject>
<textobject><phrase>Selecting the <guiicon>Rectangle</guiicon> icon</phrase></textobject>
</mediaobject>
</screenshot>
<para>In the <guilabel>Colors</guilabel> palette, select the color you want by clicking on one of the
tabs and then choosing the color.</para>
<screenshot>
<screeninfo>Choosing the color</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts11.png" format="PNG"/>
</imageobject>
<textobject><phrase>Choosing the color</phrase></textobject>
</mediaobject>
</screenshot>
<para>Finally draw your shape on your picture and save the new picture!</para>
<screenshot>
<screeninfo>Drawing</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-quick-starts12.png" format="PNG"/>
</imageobject>
<textobject><phrase>Drawing</phrase></textobject>
</mediaobject>
</screenshot>
<para>Thanks go to Anne-Marie Mahfouf for providing this tutorial.</para>
</sect2>
</sect1>

BIN
doc/krita/tutorial-quick-starts1.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts10.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts11.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts12.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts2.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts3.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts4.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts5.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts6.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts7.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts8.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-quick-starts9.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-1.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-10.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-11.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-12.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-13.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-2.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-3.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-4.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-5.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-6.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-7.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-8.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-9.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-select-layer-sample.png
View File

Binary file not shown.

263
doc/krita/tutorial-select-layer.docbook
Unescape View File

@ -0,0 +1,263 @@
<sect1 id="tutorial-select-layer">
<title>A Small selections and layers tutorial</title>
<!-- Does someone know a better way to do this? -->
<screenshot>
<screeninfo>The starting image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-sample.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The starting image</phrase>
</textobject>
<caption><para>The starting image</para></caption>
</mediaobject>
</screenshot>
<para>
The image above is the image we will work with. Start krita with this
image (in the documentation folder
<filename>$<envar>KDEDIR</envar>/share/doc/HTML/en/krita/tutorial-select-layer-sample.png</filename>)
and save it to your Home folder (by choosing <guilabel>Save Image As...</guilabel>).
Then open it in &krita; &mdash; your screen will look a bit like this (we have
zoomed in):
</para>
<screenshot>
<screeninfo>Krita with the starting image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-1.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The starting image</phrase>
</textobject>
<caption><para>The starting image</para></caption>
</mediaobject>
</screenshot>
<para>
Now try to select the outline of the head with the <guilabel>Select Outline</guilabel> tool:
</para>
<screenshot>
<screeninfo>The <guilabel>Select Outline</guilabel> tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-2.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Select Outline</guilabel> tool</phrase>
</textobject>
<caption><para>The <guilabel>Select Outline</guilabel> tool</para></caption>
</mediaobject>
</screenshot>
<para>
After you select it, it should look a bit like this picture:
</para>
<screenshot>
<screeninfo>The picture after selecting the head</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-3.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The picture after selecting the head</phrase>
</textobject>
<caption><para>The picture after selecting the head</para></caption>
</mediaobject>
</screenshot>
<para>
If you accidently select too much, you can cut that part easily off by switching the tool to <guilabel>Subtract</guilabel> mode:
</para>
<screenshot>
<screeninfo>The <guilabel>Subtract</guilabel> mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-4.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Subtract</guilabel> mode</phrase>
</textobject>
<caption><para>The <guilabel>Subtract</guilabel> mode</para></caption>
</mediaobject>
</screenshot>
<para>
Now it's time to make the edges of the selection a bit fuzzy. This can be done by applying <guilabel>Feather</guilabel> to the selection.
</para>
<screenshot>
<screeninfo><guilabel>Feather</guilabel> selection</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-5.png" format="PNG" />
</imageobject>
<textobject>
<phrase><guilabel>Feather</guilabel> selection</phrase>
</textobject>
<caption><para><guilabel>Feather</guilabel> selection</para></caption>
</mediaobject>
</screenshot>
<para>
Now cut the selection, using
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Cut</guimenuitem></menuchoice>.
Delete the current layer with
<menuchoice><guimenu>Layer</guimenu><guimenuitem>Remove
Layer</guimenuitem></menuchoice>. Paste your selection, with
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem></menuchoice>.
Now we give ourselves a bit more room to work in by resizing the image a bit.
Use the <menuchoice><guimenu>Image</guimenu><guimenuitem>Change Image
Size...</guimenuitem></menuchoice> dialog for this.
</para>
<screenshot>
<screeninfo>The <guilabel>Image Size</guilabel> dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-6.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Image Size</guilabel> dialog</phrase>
</textobject>
<caption><para>The <guilabel>Image Size</guilabel> dialog</para></caption>
</mediaobject>
</screenshot>
<para>
Add a new layer, and place it below the old layer. You do this by selecting
the new layer in the layerbox, and then pressing the little 'down' arrow at the bottom.
Now we are going to select the area around the head with a contiguous select
(the tool has a selection-with-bucketfill icon at the border).
</para>
<screenshot>
<screeninfo>The <guilabel>Select Contiguous</guilabel> tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-7.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Select Contiguous</guilabel> tool</phrase>
</textobject>
<caption><para>The <guilabel>Select Contiguous</guilabel> tool</para></caption>
</mediaobject>
</screenshot>
<para>
Make sure to select <guilabel>Sample merged</guilabel> in the tool options:
</para>
<screenshot>
<screeninfo>The <guilabel>Sample merged</guilabel> option</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-8.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Sample merged</guilabel> option</phrase>
</textobject>
<caption><para>The <guilabel>Sample merged</guilabel> option</para></caption>
</mediaobject>
</screenshot>
<para>
Feather the selection again, and invert it.
Select the <guilabel>Contiguous Fill</guilabel> tool (this is a different tool than
the <guilabel>Contiguous Select</guilabel> tool) and use it on the layer.
</para>
<screenshot>
<screeninfo>The <guilabel>Contiguous Fill</guilabel> tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-9.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Contiguous Fill</guilabel> tool</phrase>
</textobject>
<caption><para>The <guilabel>Contiguous Fill</guilabel> tool</para></caption>
</mediaobject>
</screenshot>
<para>
Deselect with <menuchoice><guimenu>Select</guimenu><guimenuitem>Deselect</guimenuitem></menuchoice>.
You'll notice some artefacts of the feathering at the sides. You can select them easily with a rectangular selection and then cut them.
</para>
<screenshot>
<screeninfo>The <guilabel>Select Rectangular</guilabel> tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-10.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Select Rectangular</guilabel> tool</phrase>
</textobject>
<caption><para>The <guilabel>Select Rectangular</guilabel> tool</para></caption>
</mediaobject>
</screenshot>
<para>
Move the shadow layer a bit down and to the right to make it look nice.
</para>
<screenshot>
<screeninfo>Moving the shadow layer</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-11.png" format="PNG" />
</imageobject>
<textobject>
<phrase>Moving the shadow layer</phrase>
</textobject>
<caption><para>Moving the shadow layer</para></caption>
</mediaobject>
</screenshot>
<para>
Now you can use the <guilabel>Crop</guilabel> tool to make the image better fit around the head.
</para>
<screenshot>
<screeninfo>The <guilabel>Crop</guilabel> tool</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-12.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Crop</guilabel> tool</phrase>
</textobject>
<caption><para>The <guilabel>Crop</guilabel> tool</para></caption>
</mediaobject>
</screenshot>
<para>
Save the image, and you're done :-)
</para>
<screenshot>
<screeninfo>The resulting image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-select-layer-13.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The resulting image</phrase>
</textobject>
<caption><para>The resulting image</para></caption>
</mediaobject>
</screenshot>
<para>
Thanks go to Bart Coppens for providing this tutorial. The original is available at <ulink url="http://www.bartcoppens.be/krita/hackergotchi.html">http://www.bartcoppens.be/krita/hackergotchi.html</ulink>.
</para>
</sect1>

117
doc/krita/tutorial-starting.docbook
Unescape View File

@ -0,0 +1,117 @@
<sect1 id="tutorial-starting">
<title>Starting to know &krita;</title>
<para>
So, let's show you all the niceties. You can start &krita; either on its own
or from the &koffice; shell. In your &kde; menus, &krita; should be placed
either under Graphics or under Office &mdash; it depends a bit on who packaged
&koffice; for you. Or do what I do: press
<keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo> (which opens the
minicli), type <userinput><command>krita</command></userinput> and
press <guibutton>OK</guibutton>.
</para>
<para>
A little later, you'll be greeted by a dialog:
</para>
<para>
<screenshot>
<screeninfo>The <guilabel>Create Document</guilabel> dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="createdocument.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>Create Document</guilabel> dialog</phrase>
</textobject>
<caption><para>The <guilabel>Create Document</guilabel> dialog</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
This is standard for &koffice;: you can create a new document, choose a
document from among your files or select a document you had opened in an earlier
session. We have got a bunch of templates here, ordered by color model. &krita;
is a very flexible application and can handle many different types of images:
<acronym>CMYK</acronym> images for printers, <acronym>RGB</acronym> images for
the web, <acronym>RGB</acronym> images with high channel depths for
photographers, watercolor images for painters &mdash; and more. For now, choose
<guilabel>Custom Document</guilabel>. That will allow
us to see the <guilabel>New Image</guilabel> dialog box:
</para>
<para>
<screenshot>
<screeninfo>The <guilabel>New Image</guilabel> dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="newimage.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The <guilabel>New Image</guilabel> dialog</phrase>
</textobject>
<caption><para>The <guilabel>New Image</guilabel> dialog</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
Here you can give your document a name, determine the dimensions and the
resolution. The combination of width/height and resolution determines how big
your image will be on screen or on paper: if your image has a resolution of
100x100 dpi, and your image is 1000x1000 pixels big, then, if everything is
configured correctly, your image will be exactly 10 inches long and 10 inches
wide if you check with a ruler, no matter the resolution of your screen or of
your printer &mdash; if shown at 100%. However, life is seldom so well-regulated
that this actually works out. For now, just think pixels, not inches.
</para>
<para>
The next group of options is a lot more interesting than resolution: &krita;
is an enormously flexible application and you can work with many kinds of
images. For this tutorial, just select <guilabel>RGB (8
bits/channel)</guilabel>. You can also select a profile. For now, we leave this
at the default setting of <guilabel>sRGB built-in - (lcms internal)</guilabel>.
</para>
<para>
In the third option group, you can select the initial canvas color and the
amount of opacity/transparency of this color. Furthermore you can
add a description of the contents. We leave these options at their default
settings as well, so click <guibutton>Create</guibutton> to actually create the new
image.
</para>
<para>
You will now see the main &krita; screen.
</para>
<para>
<screenshot>
<screeninfo>&krita;'s main screen</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mainscreen.png" format="PNG" />
</imageobject>
<textobject>
<phrase>&krita;'s main screen</phrase>
</textobject>
<caption><para>&krita;'s main screen</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
On the left hand side and on the top, there are toolbars which offer you access
to tools for painting, editing, and selecting.
You can find a more detailed description of these toolbars <link
linkend="commands-toolbars">here</link>. The actual painting area is in the
middle. On the right side of your screen, there are various palettes, which you
can read more about in <link linkend="commands-palettes">this section</link>.
Finally, there is a menu bar at the top of the screen, as usually. Read more
about it <link linkend="commands-menus">here</link>.
</para>
</sect1>

BIN
doc/krita/tutorial-tablet-1.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-tablet-2.png
View File

Binary file not shown.

BIN
doc/krita/tutorial-tablet-3.png
View File

Binary file not shown.

141
doc/krita/tutorial-tablet.docbook
Unescape View File

@ -0,0 +1,141 @@
<sect1 id="tutorial-tablet">
<title>Working with tablets</title>
<para>This tutorial is intended to describe you the first steps with working
with a tablet with &krita;. The tutorial assumes you are using &Linux;.</para>
<sect2 id="tutorial-tablet-configuring">
<title>Configuring it</title>
<para>
As any hardware it nearly works out of the box. &Linux; should recognize it
fine, but you might have to configure the X11 server by hand. The best way to
do this is to follow the instruction on the Wacom &Linux; howto: <ulink
url="http://linuxwacom.sourceforge.net/index.php/howto/main" />.
</para><para>
Then, in &krita;, you need to enable the various tools (in the
<guilabel>Tablet</guilabel> section of the
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
&krita;...</guimenuitem></menuchoice> dialog) &mdash; you can find more
information in the <link linkend="settings-preferences-tablet">tablet settings
section</link>.
</para>
</sect2>
<sect2 id="tutorial-tablet-firstcontact">
<title>First contact with the tablet</title>
<para>
There are three devices of your tablet that you can use with &krita;:
</para>
<itemizedlist>
<listitem><para>the cursor, the mouse that was shipped with the Wacom
tablet</para></listitem>
<listitem><para>the eraser, the round part on the top of the pen</para></listitem>
<listitem><para>the stylus, the thin point on the bottom of the pen</para></listitem>
</itemizedlist>
<para>
By default, when you use the stylus or the cursor on the tablet, the Brush
tool and the pixel brush painting operation will get selected. The eraser
device is associated to the <quote>pixel eraser</quote> painting operation.
But if you select a different tool or a different painting operation with one
device, &krita; will remember the association when you switch between devices.
</para>
</sect2>
<sect2 id="tutorial-tablet-outlines">
<title>Outlines of a flower</title>
<para>
Even if you knew how to draw before you started with a tablet, you will need
to adapt to the tablet. It doesn't feel the same. So I suggest to start with
something simple, like a flower, and to use a picture as a model:
</para>
<para>
<screenshot>
<screeninfo>A flower</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-tablet-1.png" format="PNG" />
</imageobject>
<textobject>
<phrase>A flower</phrase>
</textobject>
<caption><para>A flower</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
First, you will need to create a new layer for the outline. I advise you to
lock the layer with the picture, it will prevent you from making mistakes.
</para><para>
Drawing the outline of the flower seems pretty easy, but for your first
experience you will have a great difficulty to precisely follow the line on
the screen while your hand has to move on the tablet. Eventually you will get
something like this:
</para>
<para>
<screenshot>
<screeninfo>The outline of the flower</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-tablet-2.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The outline of the flower</phrase>
</textobject>
<caption><para>The outline of the flower</para></caption>
</mediaobject>
</screenshot>
</para>
</sect2>
<sect2 id="tutorial-tablet-colorization">
<title>Colorization</title>
<para>
For the colorization, you will need to create a third layer. You will
have to move it below the layer with the outlines, and do not forget to lock
the outline layer.
</para><para>
It's mostly easier than the outline part, just select the color you want to
use (either with the color selector or with the color picker), then for most
of the work you can use the fill tool: with the mouse, click on the part you
want to fill, as by default the fill tool will take the outline into
consideration. On the following image, the different colors of the heart of
the flower are not seperated by outlines, to do them I just completed the
missing outline with a yellow or brown line to create the separation between
the different colors.
</para>
<para>
<screenshot>
<screeninfo>The colored flower</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="tutorial-tablet-3.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The colored flower</phrase>
</textobject>
<caption><para>The colored flower</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
The resulting image looks and feels like old fashion clipart, mostly because
it lacks shadows and illumination, which are not covered by this tutorial.
</para>
</sect2>
</sect1>

14
doc/krita/tutorial.docbook
Unescape View File

@ -0,0 +1,14 @@
<chapter id="tutorial">
<title>Tutorial</title>
<note><para>
The toolbars and palettes shown in these tutorials may not match your
installation of &krita;. Our apologies for this inconvenience.
</para></note>
&tutorial-starting;
&tutorial-select-layer;
&tutorial-quick-starts;
&tutorial-tablet;
</chapter>

149
doc/krita/using-colorspaces.docbook
Unescape View File

@ -0,0 +1,149 @@
<chapter id="colorspaces">
<title>Colorspaces</title>
<para>
This chapter gives information on what colorspaces are, which colorspaces
&krita; offers, and what you should keep in mind when using them.
</para>
<sect1 id="colorspaces-intro">
<title>Introduction to colorspaces</title>
<sect2 id="colorspaces-intro-whatis">
<title>What is a colorspace?</title>
<para>
In short, a colorspace is a way to represent colors by specifying a number of
parameters. As parameters, one can choose for example the amounts of red,
green and blue light needed for the color. This results in the commonly known
RGB colorspace. One can visualize this as a three-dimensional space, with each
of the red, green, and blue light components being an axis in the colorspace.
A color then corresponds to a certain point in this colorspace, defined by its
coordinates on the three axes.
</para>
<note><para>
To be more precise, a colorspace is a combination of a color model (indicating
which axes are present) and a mapping function (indicating which values
correspond to which colors).
</para></note>
<para>
Not every color can be represented in every colorspace. Some colorspaces
define more, or different, colors than others. The set of colors that can be
represented in a certain colorspace is called its gamut. Because gamuts
can differ widely, it is not guaranteed that images in a certain colorspace
can be converted to another colorspace without having to substitute certain
colors for others, even if they are based on the same color model.
</para>
</sect2>
</sect1>
<sect1 id="colorspaces-list">
<title>Available colorspaces</title>
<para>
&krita; offers colorspaces based on RGB, CMYK, Lab, LMS, YCbCr, and Gray
color models. These are shortly discussed in this section.
</para>
<sect2 id="colorspaces-list-rgb">
<title>The RGB color models</title>
<para>
The abbreviation RGB stands for Red, Green, Blue, and the color model with
this name refers to the three light components that are emitted in displays
(televisions, computer monitors, etcetera) to create a certain color. This
color model is used by default in virtually any standard painting application.
</para><para>
When defining a color in the RGB model, its red, green and blue components are
specified. If all components are absent (each component is emitted at 0
percent intensity, so no light at all), the color is pure black. If all
components are fully present (100 percent intensity), the color is pure white.
If one component is present at full intensity and the other two are absent,
the pure respective color is obtained.
</para><para>
Two more examples: if both red and green are emitted at 100 percent and blue
is not emitted, pure yellow is obtained. A color with all three components at
the same intensity is a shade of gray.
</para><para>
There are various colorspaces that implement the RGB model. For example, the
so-called RGB8 colorspace represents each color with 8 bits per component.
Since 8 bits allow for 256 distinct values, the total number of different
colors that can be specified in this colorspace is 256 (red) * 256 (green) *
256 (blue), or about 16.7 million colors. In &krita;, a couple of RGB
colorspaces are available, for example RGB32, which is able to distinguish
between 4.2 billion values per component.
</para>
</sect2>
<sect2 id="colorspaces-list-cmyk">
<title>The CMYK color model</title>
<para>
CMYK is the abbreviation for Cyan, Magenta, Yellow, blacK (although officially
the K stands for Key, black is much more commonly used). This color model is
based on ink: a color is specified by the amount of ink needed for a point
to be perceived as having that color.
</para><para>
Since CMYK colors are used by printers while RGB colors are used on-screen,
one often wants to convert RGB colors to CMYK colors. As this cannot always be
done correctly, printed images may turn out to look quite different than what
is perceived on-screen.
</para>
</sect2>
<sect2 id="colorspaces-list-lab">
<title>The L*a*b* color model</title>
<para>
This color model uses three parameters for a color: its
luminance or lightness (L*, which lies between 0 for black and
100 for white), its position between absolute red and absolute green (a*,
which is negative for colors closer to green and positive for colors closer to
red), and its position between yellow and blue (b*, which is negative for
colors closer to blue and positive for colors closer to yellow).
</para>
</sect2>
<sect2 id="colorspaces-list-LMS">
<title>The LMS color model</title>
<para>
This model is based on the contribution of actual light wave lengths to the
color. The human eye is sensitive to three types of light waves, distinguished
by their wave lengths: long (L), middle (M) and short (S) waves. The eye's
sensitivity for a certain color on these three wavelengths can be expressed in
L, M and S coordinates.
</para>
</sect2>
<sect2 id="colorspaces-list-YCbCr">
<title>The YCbCr color model</title>
<para>
The YCbCr model is often used for video systems. The Y parameter indicates the
luminance or lightness of the color (which can be seen as a gray-tone), the Cb
and Cr parameters indicate the chrominance (color tone): Cb places the color
on a scale between blue and yellow, Cr indicates the place of the color
between red and green.
</para>
</sect2>
<sect2 id="colorspaces-list-Gray"><title>The Gray color model</title>
<para>
The Gray color model simply represents colors as shades of gray (with black
and white being the extremes).
</para>
</sect2>
</sect1>
</chapter>

923
doc/krita/using-filters.docbook
Unescape View File

@ -0,0 +1,923 @@
<chapter id="filters">
<title>Filters</title>
<para>
&krita; comes with a number of filters. These can be used to enhance or
otherwise modify the image, either in whole or in part. Some filters are
applied directly, others are customizable, meaning that you are presented with
a dialog in which you can tune the result to your liking before the filter is
applied. If a selection is active, a filter is applied on the selected part of
the image. If no selection is active, the entire image is modified.
</para><para>
This chapter describes the available filters in detail. To make comparing the
filters easier, each filter has been applied to the same image and each description
contains a comparison image, showing the result of applying the filter described.
The original image (with thanks to the photographer, Christian Peper) is shown
below at half the original size. The sample images demonstrating the
results of applying the filters, with the original image at the left and the
modified image at the right, are shown at 25% of the original size.
</para>
<note><para>Some filters yield reasonable results for most images. For
other filters though, quite some tweaking needs to be done before the desired
outcome is achieved. If a filter does not do what you want, it might need
more or less customising. The examples in this chapter are exaggerated to
give a good impression of the filters. You will usually want to have more
<quote>gentle</quote> modifications.</para></note>
<para>
Tip: If you want to apply a filter to everything except a certain part of your
image (for example, you want to desaturate your image except for the centre),
select the part you do not want to apply the filter to, use the
<menuchoice><guimenu>Select</guimenu><guimenuitem>Invert</guimenuitem></menuchoice>
menu option, and then apply the filter.
</para>
<para>
See the <link linkend="commands-dialogs-filters">Dialogs for working with
filters</link> section for descriptions of the settings available for the
customizable filters.
</para>
<screenshot>
<screeninfo>The original image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The original image</phrase>
</textobject>
<caption><para>The original image</para></caption>
</mediaobject>
</screenshot>
<sect1 id="filters-autocontrast">
<title>The Auto Contrast filter</title>
<para>
The Auto Contrast filter changes the contrast of your image to what should be
the best settings. Usually this works out fine, but in some cases (for example
photos taken under unusual lighting circumstances), the filter will not yield
satisfying results.
</para>
<para>
You can find the Auto Contrast filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Adjust</guisubmenu></menuchoice> menu. This filter is not customizable.
</para>
<screenshot>
<screeninfo>The image with the Auto Contrast filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-autocontrast.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Auto Contrast filter applied to it</phrase>
</textobject>
<caption><para>The image with the Auto Contrast filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-blur">
<title>The Blur filter</title>
<para>
You can use the Blur filter to blur your image (give it a fuzzy look).
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Blur</guisubmenu></menuchoice> menu.
See the section on <link linkend="commands-dialogs-filters-blur">the
<guilabel>Blur</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Blur filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-blur.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Blur filter applied to it</phrase>
</textobject>
<caption><para>The image with the Blur filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-brightnesscontrast">
<title>The Brightness / Contrast filter</title>
<para>
With this filter, you can adjust the brightness and contrast of your image.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Adjust</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-brightnesscontrast">the
<guilabel>Brightness / Contrast</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Brightness / Contrast filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-brightnesscontrast.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Brightness / Contrast filter applied to it</phrase>
</textobject>
<caption><para>The image with the Brightness / Contrast filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-bumpmap">
<title>The Bumpmap filter</title>
<para>
The Bumpmap filter takes two layers and uses one of these to convert the other
one so that it will give an illusion of depth. The object layer (the layer to be
transformed) is the actual layer that should receive the three-dimensional
looks. The bumpmap layer is a grayscale layer, which is read and used to
determine the height for each point of the object layer. Alternatively, the
same layer can be used as both object layer and bumpmap layer.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Map</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-bumpmap">the
<guilabel>Bumpmap</guilabel> dialog</link> for more information on its
settings.
</para>
<screenshot>
<screeninfo>The image with the Bumpmap filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-bumpmap.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Bumpmap filter applied to it</phrase>
</textobject>
<caption><para>The image with the Bumpmap filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-cimg">
<title>The CImg Image Restoration filter</title>
<para>
With this filter, you can perform minor enhancements to your image, for
example removing small scratches or adding a slight blur. The difference
between our sample original image and the result of applying this filter with
standard settings is virtually none.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Enhance</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-imagerestoration">the
<guilabel>Image Restoration</guilabel> dialog</link>
for more information on its settings.
</para>
</sect1>
<sect1 id="filters-coloradjustment">
<title>The Color Adjustment filter</title>
<para>
This filter allows you to change the looks of your image by increasing or
decreasing the abundance of certain colors.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Adjust</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-coloradjustment">the
<guilabel>Color Adjustment</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Color Adjustment filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-coloradjustment.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Color Adjustment filter applied to it</phrase>
</textobject>
<caption><para>The image with the Color Adjustment filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-colortoalpha">
<title>The Color to Alpha filter</title>
<para>
This filter changes a color or color range in your image to become
transparent, effectively clearing regions with those colors.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Colors</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-colortoalpha">the
<guilabel>Color to Alpha</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Color to Alpha filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-colortoalpha.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Color to Alpha filter applied to it</phrase>
</textobject>
<caption><para>The image with the Color to Alpha filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-colortransfer">
<title>The Color Transfer filter</title>
<para>
With this filter, you can re-color an image using the colors from another
image. Each color in your current image will be replaced by the most alike
color used in the other image.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Colors</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-colortransfer">the
<guilabel>Color Transfer</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Color Transfer filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-colortransfer.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Color Transfer filter applied to it</phrase>
</textobject>
<caption><para>The image with the Color Transfer filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-customconvolution">
<title>The Custom Convolution filter</title>
<para>
This filter allows you to distort your image by setting a number of
parameters.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Enhance</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-customconvolution">the
<guilabel>Custom Convolution</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Custom Convolution filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-customconvolution.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Custom Convolution filter applied to it</phrase>
</textobject>
<caption><para>The image with the Custom Convolution filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-desaturate">
<title>The Desaturate filter</title>
<para>
This filter converts your image to grayscale by setting the saturation of each
pixel's color to zero.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Adjust</guisubmenu></menuchoice> menu.
This filter is not customizable.
</para>
<screenshot>
<screeninfo>The image with the Desaturate filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-desaturate.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Desaturate filter applied to it</phrase>
</textobject>
<caption><para>The image with the Desaturate filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-edgedetection">
<title>The Edge Detection filters</title>
<para>
These filters try to detect <quote>edges</quote> (boundaries) in the picture
and modify the image such that only these edges retain their respective colors,
while the rest of the image is turned gray. Through the use of lighting the
image will then get a three-dimensional look.
</para><para>
There are four edge detection filters available. Each of these detects edges
from a different side (possibly considering other parts of the image as being
edges) and will therefore obtain a different resulting image.
</para>
<para>
You can find the filters in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Edge Detection</guisubmenu></menuchoice> menu.
These filters are not customizable.
</para>
<screenshot>
<screeninfo>The image with the Bottom Edge Detection filter applied to
it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-edgebottom.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Bottom Edge Detection filter applied to it</phrase>
</textobject>
<caption><para>The image with the Bottom Edge Detection filter applied to
it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-emboss">
<title>The Emboss filters</title>
<para>
Emboss filters work somewhat like edge detection filters, with the difference
that embossed images are entirely gray. Areas in the picture are detected and
are given a certain <quote>height level</quote>, which is made visible by using
grayscale borders, making the image look like it is three-dimensional.
</para>
<para>
You can find the filters in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Emboss</guisubmenu></menuchoice> menu.
Except for the Emboss with Variable Depth filter, these filters are not
customizable. See the section on <link
linkend="commands-dialogs-filters-emboss">the
<guilabel>Emboss</guilabel> dialog</link>
for more information on the settings of the Emboss with Variable Depth filter.
</para>
<screenshot>
<screeninfo>The image with the Emboss in All Directions filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-embossall.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Emboss in All Directions filter applied to it</phrase>
</textobject>
<caption><para>The image with the Emboss in All Directions filter applied to
it</para></caption>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>The image with the Emboss with Variable depth filter applied to
it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-embossvariable.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Emboss with Variable depth filter applied to it</phrase>
</textobject>
<caption><para>The image with the Emboss with Variable depth filter applied to
it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-gaussianblur">
<title>The Gaussian Blur filter</title>
<para>
This filter makes the image a little fuzzy by blurring it in a pseudo-random
way. A gaussian algorithm is used for finding the extent to which each part of
the image should be blurred.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Blur</guisubmenu></menuchoice> menu.
This filter is not customizable.
</para>
<screenshot>
<screeninfo>The image with the Gaussian Blur filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-gaussianblur.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Gaussian Blur filter applied to it</phrase>
</textobject>
<caption><para>The image with the Gaussian Blur filter applied to
it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-gaussiannoise">
<title>The Gaussian Noise Reduction filter</title>
<para>
With this filter, you can remove noise from your image.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Enhance</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-gaussiannoise">the
<guilabel>Gaussian Noise Reduction</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Gaussian Noise Reduction filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-gaussiannoise.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Gaussian Noise Reduction filter applied to it</phrase>
</textobject>
<caption><para>The image with the Gaussian Noise Reduction filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-invert">
<title>The Invert filter</title>
<para>
This filter inverts all colors. The Red, Green and Blue component of each pixel
are taken and subtracted from 255. This means that red becomes cyan, green
becomes purple, and blue becomes yellow. The resulting values form the new
pixel color.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Adjust</guisubmenu></menuchoice> menu.
This filter is not customizable.
</para>
<screenshot>
<screeninfo>The image with the Invert filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-invert.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Invert filter applied to it</phrase>
</textobject>
<caption><para>The image with the Invert filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-lenscorrection">
<title>The Lens Correction filter</title>
<para>
This filter can fix distortions in your image resulting from for example
<quote>pincushion</quote> lens effects, and modify some lighting.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Other</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-lenscorrection">the
<guilabel>Lens Correction</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Lens Correction filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-lenscorrection.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Lens Correction filter applied to it</phrase>
</textobject>
<caption><para>The image with the Lens Correction filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-maximizechannel">
<title>The Maximize Channel filter</title>
<para>
This filter gives each pixel in your image a new color: only the color channel
that contributes the most to the color of a pixel is retained (except for
gray pixels, which are kept gray).
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Colors</guisubmenu></menuchoice> menu.
This filter is not customizable.
</para>
<screenshot>
<screeninfo>The image with the Maximize Channel filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-maximizechannel.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Maximize Channel filter applied to it</phrase>
</textobject>
<caption><para>The image with the Maximize Channel filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-meanremoval">
<title>The Mean Removal filter</title>
<para>
This filter sharpens the image by changing the colors of neighboring pixels
with approximately the same color, so that small differences are evened out.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Enhance</guisubmenu></menuchoice> menu.
This filter is not customizable.
</para>
<screenshot>
<screeninfo>The image with the Mean Removal filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-meanremoval.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Mean Removal filter applied to it</phrase>
</textobject>
<caption><para>The image with the Mean Removal filter applied to
it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-minimizechannel">
<title>The Minimize Channel filter</title>
<para>
This filter gives each pixel in your image a new color: the color channel
that contributes the most to the color of a pixel is removed (except for
gray pixels, which are kept gray).
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Colors</guisubmenu></menuchoice> menu.
This filter is not customizable.
</para>
<screenshot>
<screeninfo>The image with the Minimize Channel filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-minimizechannel.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Minimize Channel filter applied to it</phrase>
</textobject>
<caption><para>The image with the Minimize Channel filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-oilpaint">
<title>The Oilpaint filter</title>
<para>
An oilpaint effect is given to the image by creating patch-shaped areas in which
the most important color is applied to the entire area.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Artistic</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-oilpaint">the
<guilabel>Oilpaint</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Oilpaint filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-oilpaint.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Oilpaint filter applied to it</phrase>
</textobject>
<caption><para>The image with the Oilpaint filter applied to
it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-pixelize">
<title>The Pixelize filter</title>
<para>
The image is pixelated by taking a square area and giving it the mean color
value of the pixels it contains.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Artistic</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-pixelize">the
<guilabel>Pixelize</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Pixelize filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-pixelize.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Pixelize filter applied to it</phrase>
</textobject>
<caption><para>The image with the Pixelize filter applied to
it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-raindrops">
<title>The Raindrops filter</title>
<para>
This filter makes it look like raindrops have fallen on the image by distorting
drop-shaped areas with a lens-like effect as one would see when looking
at the image through a real raindrop. Some raindrops will have a fish-eye lens
effect.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Artistic</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-raindrops">the
<guilabel>Raindrops</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Raindrops filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-raindrops.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Raindrops filter applied to it</phrase>
</textobject>
<caption><para>The image with the Raindrops filter applied to
it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-randomnoise">
<title>The Random Noise filter</title>
<para>
With this filter, random noise can be added to your image.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Other</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-randomnoise">the
<guilabel>Random Noise</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Random Noise filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-randomnoise.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Random Noise filter applied to it</phrase>
</textobject>
<caption><para>The image with the Random Noise filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-randompick">
<title>The Random Pick filter</title>
<para>
This filter distorts the image by interchanging pixels.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Other</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-randompick">the
<guilabel>Random Pick</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Random Pick filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-randompick.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Random Pick filter applied to it</phrase>
</textobject>
<caption><para>The image with the Random Pick filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-roundcorners">
<title>The Round Corners filter</title>
<para>
This filter just rounds off the corners of the image. This is done by making
the outside of the rounded corner transparent.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Map</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-roundcorners">the
<guilabel>Round Corners</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Round Corners filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-roundcorners.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Round Corners filter applied to it</phrase>
</textobject>
<caption><para>The image with the Round Corners filter applied to
it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-sharpen">
<title>The Sharpen filter</title>
<para>
This filter sharpens the image.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Enhance</guisubmenu></menuchoice> menu.
This filter is not customizable.
</para>
<screenshot>
<screeninfo>The image with the Sharpen filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-sharpen.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Sharpen filter applied to it</phrase>
</textobject>
<caption><para>The image with the Sharpen filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-smalltiles">
<title>The Small Tiles filter</title>
<para>
The picture is reduced in size and repeated multiple times.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Map</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-smalltiles">the
<guilabel>Small Tiles</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Small Tiles filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-smalltiles.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Small Tiles filter applied to it</phrase>
</textobject>
<caption><para>The image with the Small Tiles filter applied to
it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-sobel">
<title>The Sobel filter</title>
<para>
This is a more enhanced edge detection filter.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Edge Detection</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-sobel">the
<guilabel>Sobel</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Sobel filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-sobel.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Sobel filter applied to it</phrase>
</textobject>
<caption><para>The image with the Sobel filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-unsharpmask">
<title>The Unsharp Mask filter</title>
<para>
This filter sharpens part of your image. (The name <quote>unsharp</quote> is
historical: parts would be masked off while the rest would be made less sharp.)
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Enhance</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-unsharpmask">the
<guilabel>Unsharp Mask</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Unsharp Mask filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-unsharpmask.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Unsharp Mask filter applied to it</phrase>
</textobject>
<caption><para>The image with the Unsharp Mask filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-wave">
<title>The Wave filter</title>
<para>
This filter transforms your image into a wave shape.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Other</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-wave">the
<guilabel>Wave</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Wave filter applied to it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-wave.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Wave filter applied to it</phrase>
</textobject>
<caption><para>The image with the Wave filter applied to it</para></caption>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="filters-waveletnoise">
<title>The Wavelet Noise Reduction filter</title>
<para>
This filter reduces noise in the image by giving loose pixels a color close to
the surrounding area. This causes small details to be lost, but can enhance the
general view of the image when this is hampered by too many unnecessary details.
</para>
<para>
You can find the filter in the <menuchoice><guimenu>Filter</guimenu>
<guisubmenu>Enhance</guisubmenu></menuchoice> menu.
See the section on <link
linkend="commands-dialogs-filters-waveletnoise">the
<guilabel>Wavelet Noise Reduction</guilabel> dialog</link>
for more information on its settings.
</para>
<screenshot>
<screeninfo>The image with the Wavelet Noise Reduction filter applied to
it</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="crocusses-waveletnoise.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The image with the Wavelet Noise Reduction filter applied to it</phrase>
</textobject>
<caption><para>The image with the Wavelet Noise Reduction filter applied to
it</para></caption>
</mediaobject>
</screenshot>
</sect1>
</chapter>

66
doc/krita/using-images.docbook
Unescape View File

@ -0,0 +1,66 @@
<chapter id="images">
<title>Images</title>
<para>
Creating and modifying images is one of &krita;'s core functionalities. While
most of the other chapters in this manual focus on the things you can do when
painting or editing, this chapter shows you what you can do with respect to
the images themselves.
</para>
<sect1 id="images-files">
<title>Working with files</title>
<para>
Unless you are doing some quick sketching, working with &krita; will most
likely involve files. You can open existing images &mdash; &krita; can work
with a large number of file formats, see <link
linkend="introduction-keyfeatures-imageformats">Image formats</link> &mdash;
or start &krita; to create a new one. When you are done or if you want to
continue at a later time, you can easily save your work.
</para>
<variablelist>
<varlistentry><term>Opening existing files</term>
<listitem><para>When you start &krita;, you can open an existing image with
the <guibutton>Open Existing Document</guibutton> button at the lower left of
the opening dialog. You can also use the
<menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice>
menu option (<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>).
This will bring up the <guilabel>Open Document</guilabel> dialog in which you
can choose an image to open. The opening dialog and the
<guimenu>File</guimenu> menu also contain a list of the most recently used
files for quick access.</para></listitem>
</varlistentry>
<varlistentry><term>Saving your work in progress</term>
<listitem><para>With the
<menuchoice><guimenu>File</guimenu><guimenuitem>Save</guimenuitem></menuchoice>
and <menuchoice><guimenu>File</guimenu><guimenuitem>Save As...</guimenuitem></menuchoice>
menu options (or their respective shortcuts <keycombo
action="simul">&Ctrl;<keycap>S</keycap></keycombo> and <keycombo
action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo>), you can save your
work. The former option will save the modifications to the current image, the
latter option will show the <guilabel>Save Document</guilabel> dialog in which
you can give a new file name for the image. If this is the first time you save
the image, <guimenuitem>Save</guimenuitem> will ask for a file name as well.
</para></listitem>
</varlistentry>
<varlistentry><term>Creating a new image</term>
<listitem><para>From the opening dialog (available via the
<menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>
menu option or the <keycombo
action="simul">&Ctrl;<keycap>N</keycap></keycombo> keys), you can create a
fully custom document or choose one of the image templates. These templates
offer a quick way of creating a new image. See the <link
linkend="tutorial-starting">Starting to know &krita;</link> tutorial.
</para></listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>

620
doc/krita/using-layers.docbook
Unescape View File

@ -0,0 +1,620 @@
<chapter id="layers">
<title>Layers</title>
<para>
This chapter gives an overview of how layers work in &krita;.
</para>
<sect1 id="layers-background">
<title>Background information on layers</title>
<para>
Extensive use of &krita; will almost require you to have some knowledge of
layers. Using layers, you can work on one part of the image without touching
the rest of it, and most effects are best applied on a layer, instead of on
the whole image. Of course, if you do want to apply an effect to an entire
image, &krita; does offer you that possibility, and there is nothing against
it.
</para><para>
The idea behind layers is quite simple. As the name suggests, layers lie on
top of each other, and together form the layer stack. The final resulting
image is that what you see when looking through the stack from top to bottom.
This means that usually the upper layers of your image will have more or less
transparency, since you cannot look through a layer which has no transparency.
(&krita; works with opaqueness instead of transparency. A layer that is 100
percent opaque is 0 percent transparent, and vice versa.) A layer higher in
the stack gets applied later than one lower in the stack. For example, if your
image contains four layers, numbered from 1 (lowest) to 4 (highest), the
effect that layer number 4 adds to the image, is applied to the result from
applying layers 1 through 3.
</para><para>
Every image you edit in &krita; contains layers. When you create a new image,
the layer box (usually shown at the bottom right of your screen, see <link
linkend="commands-palettes-layers-layers">this section</link>) will contain
one layer. The painting and editing you do is then applied to that layer. Once
you add more layers, you can choose on which part of the image you want to
work, by selecting the respective layer. All further painting is then applied
to that layer, until you select another one.
</para><para>
Layers are also an excellent way to check whether adding certain effects (or
applying certain image modifications) come out right. Add a layer which
contains what you want to try out, and show or hide it with the eye icon in
the layer box. You can especially profit from this method if you have multiple
effects to check out: show and hide them in any combination, and decide which
you like best. And since you can move the layers around, you can also
experiment with the order in which the effects are applied.
</para><para>
See the <link linkend="tutorial-select-layer">Selections and layers
tutorial</link> for a small hands-on introduction.
</para>
</sect1>
<sect1 id="layers-layerbox">
<title>The layer box</title>
<para>The layer box is the instrument you will use most to work with layers. It
gives an overview of the layers that are present in your image, and using it
you can manage layers by adding, removing, reordering or modifying them.
</para><para>
The layer box consists of three parts. The middle part gives an overview of the
layers in the image. At the top, you can set some properties for the current
layer. At the bottom, a couple of layer management options can be found. The
next sections describe these three parts in more detail.
</para>
<sect2 id="layers-layerbox-overview">
<title>Layer overview</title>
<para>This part shows you which layers are present in your image. In a tree-like
structure, the layer group hierarchy is shown: layers that are contained within
a layer group are displayed a bit to the right to indicate their belonging to
that group.
</para><para>
For each layer, a thumbnail preview and its name are shown. The layer name
is preceded by a folder icon if it is a group layer. Furthermore, two
indicators are present: the eye icon shows whether the layer is currently
visible (an open eye indicates that the layer is visible, a closed eye
indicates that it is not), and the lock icon shows whether the layer is
locked. No changes can be made to a locked layer.
</para><para>
When you click on a layer's eye icon, its visibility is switched from on to
off or vice versa. Clicking on the lock icon enables or disables editing of
that layer. You can click on the name of the current layer to rename it.
Note that to rename a layer, it has to be the current one. You do not need to
activate a layer in order to make it (in)visible or (un)locked via the eye and
lock icons, respectively: these work directly.
</para><para>
Doubleclick on a layer entry in the list to open the <link
linkend="commands-dialogs-layers-layerproperties"><guilabel>Layer
Properties</guilabel></link> dialog. This dialog shows a layer's colorspace and
profile. You can also change its name, opacity and composite mode here.
</para>
</sect2>
<sect2 id="layers-layerbox-options">
<title>Layer options</title>
<para>
The top of the layer box contains two controls for setting properties of the
currently selected layer. The list box at the left allows you to quickly set
the layer's composite mode. The spin field and slider at the right can be used
to change the layer's opacity.
</para><para>
At the bottom of the layer box, there are five buttons. From left to right,
these are as follows. The <guibutton>New Layer</guibutton> icon brings up a
submenu from which you can choose which type of layer you want to add. This
menu can also be opened by clicking with the &RMB; on the layer box. The
<guibutton>Move Layer Down</guibutton> and <guibutton>Move Layer Up</guibutton>
buttons move the current layer one level down and up, respectively, within the
current layer group. If the layer is already the last or first within the
layer group, trying to move it further will move it out of the layer group.
The <guibutton>Layer Properties</guibutton> button opens the <link
linkend="commands-dialogs-layers-layerproperties"><guilabel>Layer
Properties</guilabel></link> dialog, just as when you would have doubleclicked
on the layer. The <guibutton>Delete Layer</guibutton> button deletes the
current layer.
</para>
</sect2>
</sect1>
<sect1 id="layers-working">
<title>Working with layers</title>
<para>
Because layers are quite important when extensively using &krita;, you can
perform a lot of operations on them. These are all available via the <link
linkend="commands-menus-layer"><guimenu>Layer</guimenu> menu</link>. Some of
the possibilities:
</para>
<variablelist>
<varlistentry><term></term><listitem><para>Add, remove, and duplicate layers;</para></listitem></varlistentry>
<varlistentry><term></term><listitem><para>Create and edit layer masks;</para></listitem></varlistentry>
<varlistentry><term></term><listitem><para>Flip, rotate, scale and shear layers;</para></listitem></varlistentry>
<varlistentry><term></term><listitem><para>Convert layers between colorspaces;</para></listitem></varlistentry>
<varlistentry><term></term><listitem><para>Save layers as images;</para></listitem></varlistentry>
<varlistentry><term></term><listitem><para>View layer histograms.</para></listitem></varlistentry>
</variablelist>
</sect1>
<sect1 id="layers-adjustment">
<title>Adjustment Layers</title>
<para>Adjustment layers are layers that consist of a filter and an optional
selection. The filter effect is applied to the composite image of all
layers under the adjustment layer in the current layer group. The big
thing is, adjustment layers apply these effects non-destructively. The
original image data is not modified.
</para><para>
Almost all &krita; filters are suitable for use in adjustment
layers -- even filters that would downgrade the image quality. For instance,
the raindrops filter converts to 8-bit RGB before working its magic. If you
would try to use this filter directly on a 16-bit L*a*b* layer, &krita; would
warn you about the conversion to RGB and back again this filter would cause.
Not so with adjustment layers: the original data isn't touched, so applying
the filter is safe.
</para><para>
What about the colorspace of an adjustment layer then? In order to examine
this issue, you need to know what happens when &krita; renders an adjustment
layer.
</para>
<sect2 id="layers-adjustment-selections">
<title>Adjustment layers and selections</title>
<para>If the currently active layer has an active selection, then that selection
will be copied and used as a mask for the adjustment layer. If there is no
active selection, then there will be no mask and the adjustment will apply to
the entire extent of the layers under the adjustment layer in the current
group. There is <emphasis>no</emphasis> way of adding a mask to an existing
adjustment layer.
</para><para>
If there is a mask in the adjustment layer, you can edit the mask using the
ordinary painting tools and painting operations.
</para>
</sect2>
<sect2 id="layers-adjustment-projection">
<title>A note on projections</title>
<para>
&krita; composites the layers bottom to top, within each layer group. The
aggregate -- or the projection as it is also called -- is then filtered by
the adjustment layer. If there are layers on top of the adjustment layer,
those are composited onto the projection. &krita; converts all layer data before
compositing, so if the bottom-most layer in an image is grayscale, all layers
are converted to grayscale before compositing -- and that means that the
adjustment layer projection will be grayscale, too.
</para><para>
With this knowledge you'll understand why &krita; can often offer better
performance working with layers on top of an adjustment layer which is on top
of a complex layer structure: &krita; uses the projection and doesn't even look
anymore at the layers under the adjustment layer. Unless, of course, you
change one of them.
</para>
</sect2>
</sect1>
<sect1 id="layers-composite">
<title>Compositing modes</title>
<para>
Layers can be composited in various ways, each yielding a different effect.
This section describes the available compositing modes. Each description is
accompanied by an example: on top of an original image (see below), a rainbow
gradient is added.
</para>
<para>
<screenshot>
<screeninfo>The original image</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-original.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The original image</phrase>
</textobject>
<caption><para>The original image</para></caption>
</mediaobject>
</screenshot>
</para>
<sect2 id="layers-composite-normal">
<title><guilabel>Normal</guilabel></title>
<para>
The <guilabel>Normal</guilabel> mode does nothing special. It adds the layer
to the image, and if no other special effects like opacity are changed, the
underlying layers will only be visible at places where the new layer is
itself transparent.
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Normal</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-normal.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Normal</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Normal</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
</sect2>
<sect2 id="layers-composite-multiply">
<title><guilabel>Multiply</guilabel></title>
<para>
The <guilabel>Multiply</guilabel> mode blends the two layers so that the
bottom layer gets <quote>colorized</quote> by the new layer. The resulting
image is generally quite dark.
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Multiply</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-multiply.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Multiply</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Multiply</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
</sect2>
<sect2 id="layers-composite-burn">
<title><guilabel>Burn</guilabel>, <guilabel>Dodge</guilabel>,
<guilabel>Divide</guilabel> and <guilabel>Screen</guilabel></title>
<para>
The <guilabel>Burn</guilabel>, <guilabel>Dodge</guilabel>,
<guilabel>Divide</guilabel> and <guilabel>Screen</guilabel> modes all add an
extra <quote>burning</quote> effect by following contours instead of using
straight lines. In addition, <guilabel>Burn</guilabel> and
<guilabel>Divide</guilabel> use the inverted colors instead of the actual
colors of the composited layer.
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Burn</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-burn.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Burn</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Burn</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Dodge</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-dodge.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Dodge</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Dodge</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Divide</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-divide.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Divide</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Divide</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Screen</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-screen.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Screen</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Screen</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
</sect2>
<sect2 id="layers-composite-overlay">
<title><guilabel>Overlay</guilabel></title>
<para>
Like <guilabel>Multiply</guilabel>, the <guilabel>Overlay</guilabel> mode
colorizes the underlying layer. The resulting image is about as light as
the original layer.
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Overlay</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-overlay.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Overlay</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Overlay</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
</sect2>
<sect2 id="layers-composite-darken">
<title><guilabel>Darken</guilabel></title>
<para>
The <guilabel>Darken</guilabel> mode darkens the underlying layer while
colorizing it to match the colors in the composited layer.
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Darken</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-darken.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Darken</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Darken</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
</sect2>
<sect2 id="layers-composite-lighten">
<title><guilabel>Lighten</guilabel></title>
<para>
The <guilabel>Lighten</guilabel> mode lightens the underlying layer while
colorizing it to match the colors in the composited layer.
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Lighten</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-lighten.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Lighten</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Lighten</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
</sect2>
<sect2 id="layers-composite-hue">
<title><guilabel>Hue</guilabel>, <guilabel>Saturation</guilabel> and
<guilabel>Value</guilabel></title>
<para>
The <guilabel>Hue</guilabel>, <guilabel>Saturation</guilabel> and
<guilabel>Value</guilabel> modes respectively apply the hue, saturation and
value components of the composited layer to the underlying layer.
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Hue</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-hue.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Hue</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Hue</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Saturation</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-saturation.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Saturation</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Saturation</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Value</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-value.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Value</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Value</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
</sect2>
<sect2 id="layers-composite-color">
<title><guilabel>Color</guilabel></title>
<para>
The <guilabel>Color</guilabel> mode colorizes the underlying layer, yielding
very strong colors.
</para>
<para>
<screenshot>
<screeninfo>The gradient applied with the <guilabel>Color</guilabel> compositing
mode</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mountains-color.png" format="PNG" />
</imageobject>
<textobject>
<phrase>The gradient applied with the <guilabel>Color</guilabel> compositing
mode</phrase>
</textobject>
<caption><para>The gradient applied with the <guilabel>Color</guilabel> compositing
mode</para></caption>
</mediaobject>
</screenshot>
</para>
</sect2>
</sect1>
<sect1 id="layers-masks">
<title>Layer Masks</title>
<para>
Basically, a layer mask is a mask that you place on your paint layer. This
will literally mask areas of the layer, so that the content underneath shows
through. You can paint on it with greyscale colors: the more black the color,
the less the layer under it will shine through, the more white, the less the
layer under it will be shown. So complete white will let nothing through,
complete black will let everything through. Basically, it is a bit like
selecting a piece of your image, and then cutting it, so that the selected
bits go away. So what is the use for a mask here? The big advantage is that it
is non-destructive: if you decide that you masked out the wrong part of your
layer, you can easily remove the mask and start anew, something a lot harder
(not to say near impossible, especially in between sessions) with regular
selection-cutting.
</para><para>
So, how to create a mask? There are 2 ways:
</para>
<itemizedlist>
<listitem><para>
Start from scratch.
<menuchoice><guimenu>Layer</guimenu><guisubmenu>Mask</guisubmenu><guimenuitem>Create
Mask</guimenuitem></menuchoice>. The mask starts with everything being
retained, that is, a complete white mask. Basically you will not see any
changes as long as you do not paint on it.
</para></listitem>
<listitem><para>
Start from the current selection.
<menuchoice><guimenu>Layer</guimenu><guisubmenu>Mask</guisubmenu><guimenuitem>Mask
From Selection</guimenuitem></menuchoice>. The selectedness will be converted
to whiteness. This means that fully selected area will be visible, fully
unselected areas will be invisible, and the rest will be partially visible,
depending on how much the area was selected.
</para></listitem>
</itemizedlist>
<sect2 id="layers-masks-editing">
<title>Editing the mask</title>
<para>
First, make sure you are editing the mask, not the layer, by making sure
<menuchoice><guimenu>Layer</guimenu><guisubmenu>Mask</guisubmenu><guimenuitem>Edit
Mask</guimenuitem></menuchoice> is checked. (This is checked by default.) Then
you can paint on the layer just like before, only now you are
painting on the mask, instead of on the layer itself. To stop painting on the
mask, you can uncheck the <guilabel>Edit Mask</guilabel> checkbox. There's
also the option to show the mask, through checking
<menuchoice><guimenu>Layer</guimenu><guisubmenu>Mask</guisubmenu><guimenuitem>Show
Mask</guimenuitem></menuchoice>. (This is not checked by
default). This option will render the entire layer as a visual representation
of the mask in greyscale, instead of the actual layer. This can be handy to
see where your mask is, but it might be not as handy when you want to edit it,
since you cannot look at the actual layer.
</para><para>
Other actions: you can also remove the mask if you are not satisfied with it,
and want to start over again, or just want to remove it, with
<menuchoice><guimenu>Layer</guimenu><guisubmenu>Mask</guisubmenu><guimenuitem>Remove
Mask</guimenuitem></menuchoice>. You can also <quote>apply</quote> the mask,
meaning that the mask will be made permanently. This means that the mask is
removed, but that its effect of transparency will be committed to the layer.
</para>
</sect2>
</sect1>
</chapter>

BIN
doc/krita/using-selections-1.png
View File

Binary file not shown.

BIN
doc/krita/using-selections-2.png
View File

Binary file not shown.

BIN
doc/krita/using-selections-3.png
View File

Binary file not shown.

BIN
doc/krita/using-selections-4.png
View File

Binary file not shown.

BIN
doc/krita/using-selections-5.png
View File

Binary file not shown.

BIN
doc/krita/using-selections-6.png
View File

Binary file not shown.

Some files were not shown because too many files have changed in this diff Show More

Write Preview
Loading…
Cancel
Save