Add new section in help handbook for k3bsetup help and add

respective desktop file with appropriate DocPath.
This is in support of bug report 1930.
pull/1/head
Darrell Anderson 10 years ago
parent 71da187116
commit 9a4bae9fbd

@ -1,6 +1,6 @@
<chapter id="dcop">
<title>The &k3b; &DCOP; Interface</title>
<para>&k3b; features, like many other &kde; applications as well, a
<para>&k3b; features, like many other &tde; applications as well, a
&DCOP; interface which makes it possible to control a part of it's
functionality from &eg; a shellscript.</para>
<para>To use these &DCOP; functions you can either use the
@ -16,7 +16,7 @@
</screen>
</para>
<para>Besides the generic &DCOP; functions available to all &kde;
<para>Besides the generic &DCOP; functions available to all &tde;
applications, &k3b;'s DCOP interface mainly consists of two parts as described below.</para>
<sect1>

@ -1,17 +1,16 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY k3b "<application>K3b</application>">
<!ENTITY cdrdao "<application>cdrdao</application>">
<!ENTITY dvdtools "<application>DVD+RW-Tools</application>">
<!ENTITY mkisofs "<application>mkisofs</application>">
<!ENTITY cdrecord "<application>cdrecord</application>">
<!ENTITY k3bsetup "<application>K3bSetup</application>">
<!ENTITY k3b-commands SYSTEM "commands.docbook">
<!ENTITY k3b-audiocd-howto SYSTEM "audiocd-howto.docbook">
<!ENTITY k3b-cdcopy-howto SYSTEM "cdcopy-howto.docbook">
<!ENTITY k3b-dcop SYSTEM "dcop.docbook">
<!ENTITY k3b "<application>K3b</application>">
<!ENTITY cdrdao "<application>cdrdao</application>">
<!ENTITY dvdtools "<application>DVD+RW-Tools</application>">
<!ENTITY mkisofs "<application>mkisofs</application>">
<!ENTITY cdrecord "<application>cdrecord</application>">
<!ENTITY k3bsetup "<application>K3bSetup</application>">
<!ENTITY k3b-commands SYSTEM "commands.docbook">
<!ENTITY k3b-audiocd-howto SYSTEM "audiocd-howto.docbook">
<!ENTITY k3b-cdcopy-howto SYSTEM "cdcopy-howto.docbook">
<!ENTITY k3b-dcop SYSTEM "dcop.docbook">
<!ENTITY kappname "&k3b;">
<!ENTITY package "kdeextragear-1">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
@ -22,41 +21,34 @@
<title>The &k3b; Handbook</title>
<authorgroup>
<author>
<firstname>Carsten</firstname>
<surname>Niehaus</surname>
</author>
<author>
<firstname>Jakob</firstname>
<surname>Petsovits</surname>
</author>
<author><firstname>Carsten</firstname><surname>Niehaus</surname></author>
<author><firstname>Jakob</firstname><surname>Petsovits</surname></author>
<author>&tde-authors;</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2003-2004</year>
<year>2003-2004</year>
<holder>Carsten Niehaus</holder>
</copyright>
<copyright>
<year>&tde-copyright-date;</year>
<holder>&tde-team;</holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation -->
<legalnotice>&FDLNotice;</legalnotice>
<date>2005-06-21</date>
<releaseinfo>0.03.00</releaseinfo>
<!-- Abstract about this handbook -->
<date>Reviewed: &tde-release-date;</date>
<releaseinfo>&tde-release-version;</releaseinfo>
<abstract>
<para>
&k3b; is a CD and DVD burning application for &kde; with a comfortable user interface.
&k3b; is a CD and DVD burning application for &tde; with a comfortable user interface.
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>kdeextragear</keyword>
<keyword>TDE</keyword>
<keyword>cdrecord</keyword>
<keyword>DVD</keyword>
<keyword>CD</keyword>
@ -72,18 +64,47 @@
<title>Introduction</title>
<para>
&k3b; is a CD and DVD burning application for Linux systems
optimized for &kde;. It provides a comfortable user interface
to perform most CD/DVD burning tasks like creating an Audio CD
from a set of audio files or copying a CD.
While the experienced user can take influence in all steps
of the burning process, the beginner may find comfort
in the automatic settings and the reasonable &k3b; defaults
which allow a quick start. The actual burning in K3b is done
by the command line utilities
<application>cdrecord</application>,
<application>cdrdao</application>, and
<application>growisofs</application>.
&k3b; is a CD and DVD burning application for Linux systems
optimized for &tde;. It provides a comfortable user interface
to perform most CD/DVD burning tasks like creating an Audio CD
from a set of audio files or copying a CD.
While the experienced user can take influence in all steps
of the burning process, the beginner may find comfort
in the automatic settings and the reasonable &k3b; defaults
which allow a quick start. The actual burning in K3b is done
by the command line utilities
<application>cdrecord</application>,
<application>cdrdao</application>, and
<application>growisofs</application>.
</para>
</chapter>
<chapter id="pre-setup"><title>Pre-setup</title>
<para>When you run &k3b; for the first time, you may find &k3b; informing you
that no optical writer drivers have been found, meaning you will not be able to
write to any optical discs. There is no need to panic as &k3b; will open a
configuration window which will help you get various tools used by &k3b; up and
running. This includes viewing the user group that owns those applications. You
should not need to change this as &k3b; will apply the correct permissions on external
programs itself. These programs are generally <command>cdrecord</command>,
<command>growisofs</command> and <command>cdrdao</command>. If preferred, one can
tell &k3b; to use the <guilabel>burning</guilabel> user group and point it to the
optical drive. Below is an image of the configuration window where these settings
are possible.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="k3bsetup.png" format="PNG"/>
</imageobject>
<textobject>
<phrase></phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
</chapter>
@ -91,151 +112,34 @@
&k3b-commands;
<chapter id="howtos">
<title>HOWTOs for a quickstart to &k3b;</title>
<title>HOWTOs for a quickstart to &k3b;</title>
&k3b-audiocd-howto;
&k3b-cdcopy-howto;
&k3b-audiocd-howto;
&k3b-cdcopy-howto;
</chapter>
<!-- now the desciption of the DCOP-Interface -->
&k3b-dcop;
<chapter id="faq">
<title>Questions and Answers</title>
<!-- (OPTIONAL but recommended) This chapter should include all of the silly
(and not-so-silly) newbie questions that fill up your mailbox. This chapter
should be reserved for BRIEF questions and answers! If one question uses more
than a page or so then it should probably be part of the
"Using this Application" chapter instead. You should use links to
cross-reference questions to the parts of your documentation that answer them.
This is also a great place to provide pointers to other FAQ's if your users
must do some complicated configuration on other programs in order for your
application work. -->
&reporting.bugs;
&updating.documentation;
<qandaset id="faqlist">
<qandaentry>
<question>
<para>
Compiling &k3b; fails with undefined type "struct KComboBox".
</para>
</question>
<answer>
<para>
The QTDesigner tool <application>uic</application> is not able to find the kde widget plugins.
To solve this run <application>qtconfig</application> and add
<filename class="directory">$<envar>TDEDIR</envar>/lib/trinity/plugins</filename> to the
plugin search path (replace $<envar>TDEDIR</envar> with your kde base dir).
</para>
</answer>
</qandaentry>
<!-- This is a template for a new Q&A-set
<qandaentry>
<question>
<para>
QUESTION
</para>
</question>
<answer>
<para>
ANSWER
</para>
</answer>
</qandaentry>
-->
</qandaset>
</chapter>
<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>
&k3b;
</para>
<para>
Program copyright 1999-2005 Sebastian Trueg <email>trueg@k3b.org</email>
and the K3b team
</para>
<para>
Contributors:
<itemizedlist>
<listitem><para>Thomas Froescher <email>tfroescher@k3b.org</email></para>
</listitem>
<listitem><para>Christian Kvasny <email>chris@k3b.org</email></para>
</listitem>
<listitem><para>Klaus-Dieter Krannich <email>kd@k3b.org</email></para>
</listitem>
</itemizedlist>
</para>
<para>
Documentation Copyright &copy; 2003-2004 Carsten Niehaus <email>cniehaus@kde.org</email>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL; <!-- FDL: do not remove -->
<!-- Determine which license your application is licensed under,
and delete all the remaining licenses below:
(NOTE: All documentation are licensed under the FDL,
regardless of what license the application uses) -->
&underGPL; <!-- GPL License -->
</chapter>
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-kapp">
<title>How to obtain &k3b;</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; ok, removed -->
<para>
The main information site for &k3b; is
<ulink url="http://www.k3b.org/">www.k3b.org</ulink>.
For the most current version of &k3b;, feedback and
community help as well as &k3b; news and other information,
this is the place to go.
</para>
</sect1>
<sect1 id="requirements">
<chapter id="requirements">
<title>Requirements</title>
<para>
In order to successfully use &k3b;, you need &kde; &gt;= 3.1 and &Qt; &gt;= 3.1.
To use &k3b; you need &tde;.
</para>
<para>
&cdrdao;: Records audio or data CD-Rs in disk-at-once (DAO)
mode based on a textual description of the CD contents (toc-file).
&cdrdao;: Records audio or data CD-Rs in disk-at-once (DAO)
mode based on a textual description of the CD contents (toc-file).
</para>
<para>
&cdrecord;/&mkisofs;: Records any kind of CD-Rs. &cdrecord; contains all of &cdrdao;'s features and extended functionality and therefore is &k3b;'s standard choice for CD burning. In some cases, &cdrdao; reaches better audio CD burning quality though.
&cdrecord;/&mkisofs;: Records any kind of CD-Rs. &cdrecord; contains all of &cdrdao;'s features and extended functionality and therefore is &k3b;'s standard choice for CD burning. In some cases, &cdrdao; reaches better audio CD burning quality though.
</para>
<para>
&dvdtools;: The &dvdtools; are used to burn and format DVD+R(W) and DVD-R(W) media.
&dvdtools;: The &dvdtools; are used to burn and format DVD+R(W) and DVD-R(W) media.
</para>
<para>
Optionally &k3b; can make use of all these libraries:
Optionally &k3b; can make use of all these libraries:
</para>
<para>
@ -303,38 +207,33 @@ files. eMovix contains all the software to boot from a CD and automatically
play every video file localized in the CD root.
</para>
<!-- 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 to &k3b; at <ulink
url="http://www.k3b.org">http://www.k3b.org</ulink>.
</para>
</sect1>
<sect1 id="compilation">
<title>Compilation and Installation</title>
</chapter>
<!-- 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. -->
<chapter id="credits">
<title>Credits and License</title>
&install.compile.documentation;
<para>
&k3b;
</para>
<para>
Program copyright 1999-2005 Sebastian Trueg <email>trueg@k3b.org</email>
and the K3b team
</para>
<para>
Contributors:
<itemizedlist>
<listitem><para>Thomas Froescher</para>
</listitem>
<listitem><para>Christian Kvasny</para>
</listitem>
<listitem><para>Klaus-Dieter Krannich</para>
</listitem>
</itemizedlist>
</para>
</sect1>
&underFDL;
&underGPL;
</appendix>
</chapter>
&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
-->

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

@ -97,6 +97,7 @@ X-TDE-Library=k3bsetup2
X-TDE-ModuleType=Library
X-TDE-RootOnly=true
Categories=Application;System;X-TDE-System;
DocPath=k3b/index.html#pre-setup
GenericName=CD & DVD Burning Setup
GenericName[af]=CD & DVD Skryf Opstelling
GenericName[ar]=العام اعداد كتابة القرص المدمج (CD) و القرص المرئي الرقمي (DVD)

Loading…
Cancel
Save