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

Add new section in help handbook for k3bsetup help and add

Browse Source 
respective desktop file with appropriate DocPath.
This is in support of bug report 1930.
pull/1/head
Darrell Anderson 12 years ago
parent 71da187116
commit 9a4bae9fbd
4 changed files with 100 additions and 200 deletions
Show Stats Download Patch File Download Diff File

4
doc/dcop.docbook
Unescape Escape View File

@ -1,6 +1,6 @@
<chapter id="dcop"> <chapter id="dcop">
<title>The &k3b; &DCOP; Interface</title> <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 &DCOP; interface which makes it possible to control a part of it's
functionality from &eg; a shellscript.</para> functionality from &eg; a shellscript.</para>
<para>To use these &DCOP; functions you can either use the <para>To use these &DCOP; functions you can either use the
@ -16,7 +16,7 @@
</screen> </screen>
</para> </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> applications, &k3b;'s DCOP interface mainly consists of two parts as described below.</para>
<sect1> <sect1>

235
doc/index.docbook
Unescape Escape View File

@ -11,7 +11,6 @@
<!ENTITY k3b-cdcopy-howto SYSTEM "cdcopy-howto.docbook"> <!ENTITY k3b-cdcopy-howto SYSTEM "cdcopy-howto.docbook">
<!ENTITY k3b-dcop SYSTEM "dcop.docbook"> <!ENTITY k3b-dcop SYSTEM "dcop.docbook">
<!ENTITY kappname "&k3b;"> <!ENTITY kappname "&k3b;">
<!ENTITY package "kdeextragear-1">
<!ENTITY % addindex "IGNORE"> <!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"> <!ENTITY % English "INCLUDE">
]> ]>
@ -22,41 +21,34 @@
<title>The &k3b; Handbook</title> <title>The &k3b; Handbook</title>
<authorgroup> <authorgroup>
<author> <author><firstname>Carsten</firstname><surname>Niehaus</surname></author>
<firstname>Carsten</firstname> <author><firstname>Jakob</firstname><surname>Petsovits</surname></author>
<surname>Niehaus</surname> <author>&tde-authors;</author>
</author>
<author>
<firstname>Jakob</firstname>
<surname>Petsovits</surname>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS --> <!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup> </authorgroup>
<copyright> <copyright>
<year>2003-2004</year> <year>2003-2004</year>
<holder>Carsten Niehaus</holder> <holder>Carsten Niehaus</holder>
</copyright> </copyright>
<copyright>
<year>&tde-copyright-date;</year>
<holder>&tde-team;</holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation --> <!-- Translators: put here the copyright notice of the translation -->
<legalnotice>&FDLNotice;</legalnotice> <legalnotice>&FDLNotice;</legalnotice>
<date>2005-06-21</date> <date>Reviewed: &tde-release-date;</date>
<releaseinfo>0.03.00</releaseinfo> <releaseinfo>&tde-release-version;</releaseinfo>
<!-- Abstract about this handbook -->
<abstract> <abstract>
<para> <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> </para>
</abstract> </abstract>
<keywordset> <keywordset>
<keyword>KDE</keyword> <keyword>TDE</keyword>
<keyword>kdeextragear</keyword>
<keyword>cdrecord</keyword> <keyword>cdrecord</keyword>
<keyword>DVD</keyword> <keyword>DVD</keyword>
<keyword>CD</keyword> <keyword>CD</keyword>
@ -73,7 +65,7 @@
<para> <para>
&k3b; is a CD and DVD burning application for Linux systems &k3b; is a CD and DVD burning application for Linux systems
optimized for &kde;. It provides a comfortable user interface optimized for &tde;. It provides a comfortable user interface
to perform most CD/DVD burning tasks like creating an Audio CD to perform most CD/DVD burning tasks like creating an Audio CD
from a set of audio files or copying a CD. from a set of audio files or copying a CD.
While the experienced user can take influence in all steps While the experienced user can take influence in all steps
@ -85,6 +77,35 @@
<application>cdrdao</application>, and <application>cdrdao</application>, and
<application>growisofs</application>. <application>growisofs</application>.
</para> </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> </chapter>
<!-- the GUI comands --> <!-- the GUI comands -->
@ -98,130 +119,13 @@
</chapter> </chapter>
<!-- now the desciption of the DCOP-Interface -->
&k3b-dcop; &k3b-dcop;
<chapter id="requirements">
<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">
<title>Requirements</title> <title>Requirements</title>
<para> <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>
<para> <para>
&cdrdao;: Records audio or data CD-Rs in disk-at-once (DAO) &cdrdao;: Records audio or data CD-Rs in disk-at-once (DAO)
@ -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. play every video file localized in the CD root.
</para> </para>
<!-- For a list of updates, you may refer to the application web site </chapter>
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>
<!-- This entity contains the boilerplate text for standard --> <chapter id="credits">
<!-- compilation instructions. If your application requires any --> <title>Credits and License</title>
<!-- special handling, remove it, and replace with your own text. -->
&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> </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
-->

BIN
doc/k3bsetup.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 86 KiB

1
k3bsetup/k3bsetup2.desktop
Unescape Escape View File

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

Write Preview
Loading…
Cancel
Save