~ubuntu-branches/ubuntu/edgy/koffice/edgy-updates

« back to all changes in this revision

Viewing changes to doc/koffice/index.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Ben Burton
  • Date: 2004-05-09 11:33:00 UTC
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040509113300-xi5t1z4yxe7n03x7
Tags: upstream-1.3.1
ImportĀ upstreamĀ versionĀ 1.3.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<?xml version="1.0" ?>
2
 
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [
 
2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
3
3
 <!ENTITY kappname "&koffice;">
 
4
 <!ENTITY package "koffice">
4
5
 <!ENTITY % addindex "IGNORE">
5
6
 <!ENTITY % English "INCLUDE" > <!-- change language only here -->
6
7
]>
7
8
 
8
9
<book lang="&language;">
9
10
<bookinfo>
10
 
<title>KOffice</title>
 
11
<title>&koffice;</title>
11
12
<subtitle>A General Introduction</subtitle>
12
13
<authorgroup>
13
14
<author>
75
76
<member>&kword; (a frames-based wordprocessor)</member>
76
77
<member>&kspread; (a spreadsheet application)</member> 
77
78
<member>&kpresenter; (screen and slide presentations)</member>
78
 
<member>&killustrator; (a vector drawing application)</member>
79
 
<member>&krayon; (a bitmap image editor)</member>
 
79
<member>&kontour; (a vector drawing application)</member>
 
80
 
80
81
<member>&kformula; (an editor for mathematical formulae)</member>
81
82
<member>&kchart; (a charts/graphs drawing application)</member>
82
83
<member>&kivio; <!-- FIXME --></member>
118
119
 
119
120
</chapter> 
120
121
 
121
 
<chapter id="firststeps">
 
122
<chapter id="first-steps">
122
123
<title>First steps in &koffice;</title>
123
124
<para></para>
124
125
</chapter>
151
152
 
152
153
<para>
153
154
The alternative to this is KParts. Its philosophy is simple: let every
154
 
application do what it does best. [I think this para needs more
155
 
elaboration -- kt.]
 
155
application do what it does best. 
156
156
</para>
157
157
 
158
 
<sect1 id="compounddocs">
 
158
<sect1 id="compound-docs">
159
159
<title>Compound documents with KParts</title>
160
160
 
161
161
<para> 
181
181
</sect1>
182
182
 
183
183
 
184
 
<sect1 id="kpartstryit">
 
184
<sect1 id="kparts-try-it">
185
185
<title>Using KParts in your document</title>
186
186
 
187
187
<para>
206
206
<step>
207
207
<para>
208
208
Chose <guimenuitem>Create KSpread table frame</guimenuitem> from the
209
 
<guimenu>Tools</guimenu> menu. (FIXME: I think this menu structure was
210
 
supposed to be changed). You'll notice that the mouse cursor has changed
211
 
to a cross. This form of the cursor indicates that you are supposed to
212
 
select an area.  
 
209
<guimenu>Tools</guimenu> menu. You'll notice that the mouse cursor has
 
210
changed to a cross. This form of the cursor indicates that you are
 
211
supposed to select an area.
213
212
</para>
214
213
</step> 
215
214
<step>
300
299
 
301
300
<sect2><title>How to Get Correct Printout</title>
302
301
 
303
 
<para>
304
 
While &koffice; automatically can handle all X11 fonts <emphasis>on
305
 
screen</emphasis>, printout can pose a problem: on most systems,
306
 
printing is done via <application>ghostscript</application>. Now, while
307
 
&koffice; knows the font names used by X Windows, it does normally
 
302
<para> While &koffice; automatically can handle all X11 fonts
 
303
<emphasis>on screen</emphasis>, printout can pose a problem: on most
 
304
systems, printing is done via
 
305
<application>ghostscript</application>. Now, while &koffice; knows the
 
306
font names used by X Windows, it does normally
308
307
<emphasis>not</emphasis> know the font names used by
309
 
ghostscript. &koffice; tries to guess these names, which unfortunately
310
 
doesn't work all of the time.
311
 
</para>
 
308
<application>ghostscript</application>. &koffice; tries to guess these
 
309
names, which unfortunately doesn't work all of the time.  </para>
312
310
 
313
311
<para>
314
312
This problem can be solved, although this is not that easy. Actually,
365
363
functionality than saving, loading, printing, &etc;
366
364
</para>
367
365
 
368
 
<para>
369
 
Thanks to the <quote>action</quote> concept of &Qt; and &kde;, you can freely customize
370
 
&koffice; menu bars and tool bars. Unfortunately, at the moment, there are no
371
 
easy-to-use dialogs to do this. &koffice; stores its &GUI; configuration in
372
 
&XML; files and you'll have to edit those. Hopefully, this situation will
373
 
change in the future; for now, you'll need some basic knowledge of how
374
 
an &XML; document works (or <acronym>HTML</acronym>, which is a subset
375
 
of &XML;). [The <quote>action</quote> concept needs to be discussed in
376
 
more detail -- kt.] 
377
 
</para>
 
366
<para> Thanks to the <quote>action</quote> concept of &Qt; and &kde;,
 
367
you can freely customize &koffice; menu bars and tool
 
368
bars. Unfortunately, at the moment, there are no easy-to-use dialogs
 
369
to do this. &koffice; stores its &GUI; configuration in &XML; files
 
370
and you'll have to edit those. Hopefully, this situation will change
 
371
in the future; for now, you'll need some basic knowledge of how an
 
372
&XML; document works (or <acronym>HTML</acronym>, which is a subset of
 
373
&XML;). [The <quote>action</quote> concept needs to be discussed in
 
374
more detail -- kt.]  </para>
378
375
 
379
376
<para>
380
377
Normally, each &koffice; application has at least two of those &XML;
433
430
 
434
431
<para>
435
432
For detailed information on the different &koffice; applications, please
436
 
consult their respective manuals.  [FIXME: how do I provide links to
437
 
them? Do we need set-tag?]
 
433
consult their respective manuals.  <!-- (use ulink to help:/appname/ -->
 
434
<!-- for the meantime - it's a hack, but it's the best we have -->
 
435
<!-- presently. [FIXME: how do I provide links to them? Do we --> 
 
436
<!-- need set-tag?] --> 
438
437
</para>
439
438
 
440
439
</sect1>
455
454
</para></listitem>
456
455
<listitem>
457
456
<para>
458
 
<ulink url="http://www.kde.org">The K Desktop Environment
459
 
(&kde;)</ulink>. The most advanced and absolutely free desktop
 
457
&kde-http;. The most advanced and absolutely free desktop
460
458
environment for unix-like operating systems. &koffice; makes use of the
461
459
&kde; libraries.
462
460
</para></listitem>
506
504
<para>
507
505
This manual is copyright by Jost Schenck. It can be distributed
508
506
freely, as long as this copyright notice is included. You may change
509
 
it as long as you send me the changes or commit them to KDE CVS.
510
 
I'll not be liable for anything resulting from the use of this
511
 
manual.
 
507
it as long as you send me the changes or commit them to &kde;
 
508
<acronym>CVS</acronym>.  I'll not be liable for anything resulting
 
509
from the use of this manual.
512
510
</para>
513
511
 
514
512
<para>
515
 
The other KOffice manuals are copyrighted by their respective authors.
 
513
The other &koffice; manuals are copyrighted by their respective authors.
516
514
</para>
517
515
 
518
516
&underFDL;
519
517
&underGPL;
520
518
 
521
519
</chapter>
522
 
 
523
520
  
524
521
<appendix id="installation">
525
522
<title>Installation</title>
526
523
 
527
 
<sect1 id="Requirements">
 
524
<sect1 id="requirements">
528
525
<title>System Requirements</title>
529
526
 
530
527
<para>
531
 
In order to install and use KOffice you must have:
 
528
In order to install and use &koffice; you must have:
532
529
</para>
533
530
 
534
531
<itemizedlist>
535
532
<listitem><para>
536
 
A functioning Unix system (for example, Linux or BSD)
537
 
with a configured X Window System (for example, XFree86).
 
533
A functioning &UNIX; system (for example, &Linux; or BSD)
 
534
with a configured &X-Window; (for example, XFree86).
538
535
</para></listitem>
539
536
<listitem><para>
540
 
The Qt 2.1 libraries from Troll Tech. See
 
537
The &Qt; 2.1 libraries from Troll Tech. See
541
538
<ulink url="ftp://ftp.troll.no/">ftp://ftp.troll.no/</ulink>
542
539
for more information.
543
540
</para></listitem>
544
541
<listitem><para>
545
 
The K Desktop Environment 2.0 (KDE 2.0). KOffice cannot be compiled
546
 
with earlier versions of KDE. Information on obtaining and installing
547
 
KDE 2.0 can be found at:
548
 
<ulink url="http://www.kde.org">http://www.kde.org.</ulink>
 
542
The K Desktop Environment 2.0 (&kde; 2.0). &koffice; cannot be compiled
 
543
with earlier versions of &kde;. Information on obtaining and installing
 
544
&kde; 2.0 can be found at: &kde-http;
549
545
</para></listitem>
550
546
<listitem><para>
551
547
Permission to install software on your computer. If you are on a
555
551
</itemizedlist>
556
552
 
557
553
<para>
558
 
Please note that, while you need the KDE 2.0 libraries on your system,
559
 
you can still use KOffice in a different desktop environment (for example,
560
 
KDE 1.1, UDE or GNOME).
 
554
Please note that, while you need the &kde; 2.0 libraries on your system,
 
555
you can still use &koffice; in a different desktop environment (for example,
 
556
&kde; 1.1, UDE or GNOME).
561
557
</para>
562
558
 
563
559
<para>
564
 
If you plan on <link linkend="FromSource">compiling KOffice from
 
560
If you plan on <link linkend="from-source">compiling &koffice; from
565
561
source code</link> you will also need:
566
562
</para>
567
563
 
568
564
<itemizedlist>
569
565
<listitem><para>
570
 
Automake 1.4 or newer.  This can be downloaded from:
 
566
<command>automake</command> 1.4 or newer.  This can be downloaded from:
571
567
<ulink url="ftp://ftp.gnu.org/pub/gnu/automake/">ftp://ftp.gnu.org/pub/gnu/automake/</ulink>
572
568
</para></listitem>
573
569
<listitem><para>
574
 
Autoconf 2.13 or later.  This can be downloaded from:
 
570
<command>autoconf</command> 2.13 or later.  This can be downloaded from:
575
571
<ulink url="ftp://ftp.gnu.org/pub/gnu/autoconf/">ftp://ftp.gnu.org/pub/gnu/autoconf/</ulink>
576
572
</para></listitem>
577
573
<listitem><para>
579
575
<ulink url="http://egcs.cygnus.com/">http://egcs.cygnus.com/</ulink>
580
576
</para></listitem>
581
577
<listitem><para>
582
 
Troll Tech's Qt 2.1 development packages. These can be downloaded from
 
578
Troll Tech's &Qt; 2.1 development packages. These can be downloaded from
583
579
<ulink url="ftp://ftp.troll.no/">ftp://ftp.troll.no/</ulink>
584
580
</para></listitem>
585
581
</itemizedlist>
593
589
<para>
594
590
If you want to obtain the most current binary version of KOffice,
595
591
you can find more information by following this link:
596
 
<link linkend="GettingBinaries">Getting Binary Packages</link>.
 
592
<link linkend="getting-binaries">Getting Binary Packages</link>.
597
593
</para>
598
594
 
599
595
<para>
601
597
the source code and compile it yourself.  Instructions on where to obtain the
602
598
current source code (and what to do with the source code once you have it)
603
599
can be found by following this link:
604
 
<link linkend="GettingSource">Getting the source code</link>.
 
600
<link linkend="getting-source">Getting the source code</link>.
605
601
</para> 
606
602
 
607
 
<note><para>
608
 
Please see the <ulink url="http://koffice.kde.org">KOffice homepage</ulink>
609
 
for further details. That is where you can always find the most up-to-date
610
 
information on both source and binary distributions!
611
 
</para></note>
 
603
<note><para> Please see the <ulink
 
604
url="http://koffice.kde.org">&koffice; homepage</ulink> for further
 
605
details. That is where you can always find the most up-to-date
 
606
information on both source and binary distributions!  </para></note>
612
607
 
613
608
</sect1>
614
609
 
615
610
 
616
 
<sect1 id="GettingBinaries">
 
611
<sect1 id="getting-binaries">
617
612
<title>Getting Binary Packages</title>
618
613
 
619
614
<para>
633
628
<ulink url="http://www.kde.org/mirrors.html">http://www.kde.org/mirrors.html</ulink>
634
629
</para>
635
630
 
636
 
<note><para>
637
 
It is important that you use a binary package which is compatible with your system.
638
 
If you use the Linux operating system and are unable to find a binary package
639
 
at the KOffice web site or one of its mirrors, you may be able to obtain one
640
 
from the website of your distribution.
641
 
</para></note>
 
631
<note><para> It is important that you use a binary package which is
 
632
compatible with your system.  If you use the &Linux; operating system
 
633
and are unable to find a binary package at the &koffice; web site or
 
634
one of its mirrors, you may be able to obtain one from the website of
 
635
your distribution.  </para></note>
642
636
 
643
637
</sect1>
644
638
 
645
639
 
646
 
<sect1 id="FromBinaries">
 
640
<sect1 id="from-binaries">
647
641
<title>From Binary Packages</title>
648
642
 
649
643
<para>
650
644
To install &koffice; from precompiled binaries, you should:
651
645
</para>
652
646
 
653
 
<orderedlist numeration="arabic">
654
 
<listitem><para>
655
 
Ensure your computer has all of the required software installed and
656
 
in working condition (excluding KOffice of course). You can find the
657
 
system requirements by following this link:
658
 
<link linkend="Requirements">System Requirements</link>.
659
 
</para></listitem>
660
 
<listitem><para>
661
 
Download the KOffice binary into a temporary directory.
662
 
</para></listitem>
663
 
<listitem><para>
664
 
If the filename ends in .rpm (Redhat Package Management file),
665
 
KOffice can be installed with the following command:
666
 
<screen>
667
 
<prompt>$</prompt> <command>rpm -U <replaceable>filename</replaceable></command>
668
 
</screen>
669
 
If the filename ends in .deb (Debian Package file), KOffice can be
670
 
installed with the following command:
671
 
<screen>
672
 
<prompt>$</prompt> <command>dpkg -i <replaceable>filename</replaceable></command>
673
 
</screen>
674
 
If the filename ends in .tar.gz or .tgz (a tarball file), KOffice can be
675
 
installed with the following command:
676
 
<screen>
677
 
<prompt>$</prompt> <command>cd /</command>
678
 
<prompt>$</prompt> <command>tar -xzvf <replaceable>filename</replaceable></command>
679
 
</screen>
680
 
</para></listitem>
681
 
<listitem><para>
682
 
That's all. KOffice should now be installed on your system.
683
 
</para></listitem>
684
 
</orderedlist>
685
 
 
686
 
<note><para>
687
 
If you have a graphical front-end for package management, such as
688
 
KPackage or GnoRPM, installed on your system, you may find that more
689
 
convenient to use than a command line. Consult the program's
690
 
documentation to find out how to install with it.
691
 
</para></note>
 
647
<procedure>
 
648
<step>
 
649
<para>Ensure your computer has all of the required software installed
 
650
and in working condition (excluding &koffice; of course). You can find
 
651
the system requirements by following this link: <link
 
652
linkend="requirements">System Requirements</link>.</para></step>
 
653
<step><para>Download the &koffice; binary into a temporary
 
654
directory.</para></step>
 
655
<step><para>If the filename ends in <literal
 
656
role="extension">.rpm</literal> (&RedHat; Package Management file),
 
657
&koffice; can be installed with the following command:
 
658
<screen><prompt>$</prompt>
 
659
<userinput><command>rpm</command><option>-U</option><replaceable>filename</replaceable></userinput></screen>. </para>
 
660
<para>If thefilename ends in <literal role="extension">.deb</literal> (Debian Package file), &koffice; can be installed with the following command:
 
661
<screen><prompt>$</prompt> <userinput><command>dpkg</command><option>-i</option>
 
662
<replaceable>filename</replaceable></userinput></screen>
 
663
</para>
 
664
<para>If the filename ends in <literal
 
665
role="extension">.tar.gz</literal> or <literal
 
666
role="extension">.tgz</literal> (a tarball file), &koffice; can be
 
667
installed with the following commands:</para>
 
668
 
 
669
<screen>
 
670
<prompt>$</prompt> <userinput><command>cd</command> /</userinput>
 
671
<prompt>$</prompt> <userinput><command>tar</command> <option>-xzvf</option> <replaceable>filename</replaceable></userinput>
 
672
</screen>
 
673
 
 
674
</step>
 
675
<step><para>
 
676
That's all. &koffice; should now be installed on your system.
 
677
</para></step>
 
678
</procedure>
 
679
 
 
680
<note><para> If you have a graphical front-end for package management,
 
681
such as &kpackage; or <application>GnoRPM</application>, installed on
 
682
your system, you may find that more convenient to use than a command
 
683
line. Consult the program's documentation to find out how to install
 
684
with it.  </para></note>
692
685
 
693
686
</sect1>
694
687
 
695
688
 
696
 
<sect1 id="GettingSource">
 
689
<sect1 id="getting-source">
697
690
<title>Getting Source Code</title>
698
691
 
699
692
<para>
700
693
You can download the current source code from:
701
 
</para>
702
 
 
703
 
<para>
704
694
<ulink url="http://koffice.kde.org/">http://koffice.kde.org/</ulink>
705
 
</para>
706
 
 
707
 
<para>
708
695
or from one of many mirror sites. The current list of mirror sites
709
696
can be found at:
710
697
</para>
716
703
</sect1>
717
704
 
718
705
 
719
 
<sect1 id="FromSource">
 
706
<sect1 id="from-source">
720
707
<title>From Source Code</title>
721
708
 
722
709
<para>
723
 
If you want to build KWord from source code, you should:
 
710
If you want to build &kword; from source code, you should:
724
711
</para>
725
712
 
726
 
<orderedlist numeration="arabic">
727
 
<listitem><para>
 
713
<procedure>
 
714
<step><para>
728
715
Ensure your computer has all the required software installed and
729
 
in working condition (excluding KOffice of course). You can find
 
716
in working condition (excluding &koffice; of course). You can find
730
717
the system requirements by following this link:
731
 
<link linkend="Requirements">System Requirements</link>.
732
 
</para></listitem>
733
 
<listitem><para>
734
 
Download the KOffice source file (***insert filenames (srpm and tar)
735
 
here***) into a temporary directory.
736
 
</para></listitem>
737
 
<listitem><para>
738
 
If the filename ends in .src.rpm (Redhat Package Management file),
739
 
the source code for KOffice can be installed with:
740
 
<screen>
741
 
<prompt>$</prompt> <command>rpm -U <replaceable>filename</replaceable></command>
742
 
</screen>
743
 
If the filename ends in .src.tar.gz or .src.tgz (a tarball file),
744
 
the source code for KOffice can be installed with:
745
 
<screen>
746
 
<prompt>$</prompt> <command>tar -xzvf <replaceable>filename</replaceable></command>
747
 
</screen>
748
 
</para></listitem>
749
 
<listitem><para>
750
 
The source code for KOffice should now be installed on your
751
 
system.
752
 
</para></listitem>
753
 
</orderedlist>
 
718
<link linkend="requirements">System Requirements</link>.
 
719
</para></step>
 
720
<step><para>
 
721
Download the &koffice; source file <!-- ***insert filenames (srpm and -->
 
722
<!-- tar) here*** --> into a temporary directory.
 
723
</para></step>
 
724
<step><para>
 
725
If the filename ends in <literal role="extension">.src.rpm</literal>
 
726
(&RedHat; Package Management file), the source code for &koffice; can
 
727
be installed with: 
 
728
<screen><prompt>$</prompt> <userinput><command>rpm</command><option>-U</option><replaceable>filename</replaceable></userinput></screen></para>
754
729
 
755
 
<para>
756
 
STUFF
757
 
</para>
 
730
<para>If the filename ends in <literal role="extension">.src.tar.gz</literal> or <literal role="extension">.src.tgz</literal> (a tarball file),
 
731
the source code for &koffice; can be installed with:
 
732
<screen><prompt>$</prompt> <userinput><command>tar</command> <option>-xzvf</option> <replaceable>filename</replaceable></userinput></screen>
 
733
</para></step>
 
734
<step><para>The source code for &koffice; should now be installed on
 
735
your system.</para></step>
 
736
</procedure>
758
737
 
759
738
</sect1>
760
739
 
761
740
 
762
 
<sect1 id="CompilingProblems">
 
741
<sect1 id="compiling-problems">
763
742
<title>Problems with Compilation</title>
764
743
 
765
744
<para>
766
 
Problems STUFF
 
745
To be written
767
746
</para>
768
747
 
769
748
</sect1>