diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/audiocd-howto.docbook | 96 | ||||
| -rw-r--r-- | doc/burndialog_audio.png | bin | 0 -> 19980 bytes | |||
| -rw-r--r-- | doc/burndialog_progress.png | bin | 0 -> 22348 bytes | |||
| -rw-r--r-- | doc/cdcloning_dialog.png | bin | 0 -> 22862 bytes | |||
| -rw-r--r-- | doc/cdcloning_reading.png | bin | 0 -> 15181 bytes | |||
| -rw-r--r-- | doc/cdcopy-howto.docbook | 86 | ||||
| -rw-r--r-- | doc/cdcopy_done.png | bin | 0 -> 22164 bytes | |||
| -rw-r--r-- | doc/cdcopy_reading.png | bin | 0 -> 19386 bytes | |||
| -rw-r--r-- | doc/cdcopy_settings.png | bin | 0 -> 21191 bytes | |||
| -rw-r--r-- | doc/cdcopy_writing.png | bin | 0 -> 22480 bytes | |||
| -rw-r--r-- | doc/commands.docbook | 700 | ||||
| -rw-r--r-- | doc/dcop.docbook | 104 | ||||
| -rw-r--r-- | doc/index.docbook | 340 | ||||
| -rw-r--r-- | doc/select_audiofiles.png | bin | 0 -> 46007 bytes | |||
| -rw-r--r-- | doc/select_project.png | bin | 0 -> 25449 bytes |
16 files changed, 1330 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..6385fe8 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = k3b + diff --git a/doc/audiocd-howto.docbook b/doc/audiocd-howto.docbook new file mode 100644 index 0000000..b993db5 --- /dev/null +++ b/doc/audiocd-howto.docbook @@ -0,0 +1,96 @@ +<sect1 id="audiocdcdreating"> + <title> + Quickguide: Burning an Audio-CD in 4 Steps + </title> + <para> + This Quickguide shows you how to create a AudioCD with &k3b;. To reproduce + these steps you need a working &k3b; and a directory in which you have + audiofiles. + </para> + <sect2> + <title>Step 1</title> + <para> + When you start &k3b; you should see something like this. + <screenshot> + <screeninfo>Here you can select one of four projects &k3b; offers</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="select_project.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> + </screenshot> + </para> + </sect2> + <sect2> + <title>Step 2</title> + <para> + Now you click on "New Audio CD Project" + <screenshot> + <screeninfo>This is a dialog where you can select which files you want to burn on a CD</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="select_audiofiles.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> + </screenshot> + </para> + <para> + The files you see on the top-part of &k3b; can be dropped with the mouse to the bottom-widget. + Another way is to right-click on a file an select <action>Add to Project</action>. In order to rearrange + the order of the audio-tracks you can simply move the tracks with the left mouse-button. The properties + of the tracks can be changed by clicking with the &RMB; and choosing <action>Properties</action>. + As soon as you like the arrangement of the tracks click on <action>Burn...</action> in the right-bottom + corner. + </para> + <note> + <para> + When you burn AudioCD from <acronym>MP3</acronym>s or other lossy compressed music, remember that if you encode this CD back to <acronym>MP3</acronym>, you'll get poorer quality regardless the bitrate you use. To check whether AudioCD was burnt from lossy format, try <ulink url="http://true-audio.com/analyzer.project">auCDtect</ulink>. + </para> + </note> + </sect2> + <sect2> + <title>Step 3</title> + <screenshot> + <screeninfo>This is a dialog where you can decide the settings for the CD.</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="burndialog_audio.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> + </screenshot> + <para> + In this dialog you can control the settings of the burning itself. The default-settings of &k3b; + are probably correct for you. In the top-right corner you can control the speed. One last + step before the actual burning you can give the CD a title by choosing <guibutton>CD-Text</guibutton> and + selecting <guilabel>Write CD-Text</guilabel>. The two which are probably most important for you + are <guilabel>Title</guilabel> and <guilabel>Performer</guilabel>. As soon as you are content with + the settings click on <guibutton>Burn</guibutton>. + </para> + </sect2> + <sect2> + <title>Step 4</title> + <para> + <screenshot> + <screeninfo>In this dialog you can see the progress of you burning</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="burndialog_progress.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> + </screenshot> + In this dialog is nothing you can do. Just wait for you computer to finish the session. + </para> + </sect2> +</sect1> diff --git a/doc/burndialog_audio.png b/doc/burndialog_audio.png Binary files differnew file mode 100644 index 0000000..936ea3b --- /dev/null +++ b/doc/burndialog_audio.png diff --git a/doc/burndialog_progress.png b/doc/burndialog_progress.png Binary files differnew file mode 100644 index 0000000..8a0ac30 --- /dev/null +++ b/doc/burndialog_progress.png diff --git a/doc/cdcloning_dialog.png b/doc/cdcloning_dialog.png Binary files differnew file mode 100644 index 0000000..cb93f6e --- /dev/null +++ b/doc/cdcloning_dialog.png diff --git a/doc/cdcloning_reading.png b/doc/cdcloning_reading.png Binary files differnew file mode 100644 index 0000000..d7c0b4c --- /dev/null +++ b/doc/cdcloning_reading.png diff --git a/doc/cdcopy-howto.docbook b/doc/cdcopy-howto.docbook new file mode 100644 index 0000000..ded1ae0 --- /dev/null +++ b/doc/cdcopy-howto.docbook @@ -0,0 +1,86 @@ +<sect1 id="cdcopyhowto"> + <title> + Quickguide: Copying a Data-CD in 4 Steps + </title> + <para> + This Quickguide shows you how to create a Data-CD with &k3b;. To reproduce + these steps you need a working &k3b; and the CD you wish to copy inserted in your + CD-ROM. + </para> + <sect2> + <title>Step 1</title> + <para> + To copy a Data-CD you select <guimenu>Tools</guimenu>,<guimenu>CD</guimenu><guimenu>Copy CD...</guimenu> + You will see a dialog where you can set up the burning. + <screenshot> + <screeninfo>In this dialog you can select the settings you want to use for the burning.</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="cdcopy_settings.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> + </screenshot> + </para> + </sect2> + <sect2> + <title>Step 2</title> + <para> + After you have set up &k3b; click on <guimenu>Start CD Copy</guimenu>. You will get a dialog similar to this: + <screenshot> + <screeninfo>In this dialog you can watch to progress of the copying. As soon as the writing of the + image-file is done you will be asked for a emtpy CD on which the data will be burned.</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="cdcopy_reading.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> + </screenshot> + </para> + <para> + In this dialog you can watch to progress of the copying. As soon as the writing of the + image-file is done you will be asked for a emtpy CD on which the data will be burned. + </para> + </sect2> + <sect2> + <title>Step 3</title> + <screenshot> + <screeninfo>&k3b; is burning the Image file. You have to wait until the <guilabel>Overall process</guilabel> + is at 100%</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="cdcopy_writing.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> + </screenshot> + <para> + &k3b; is burning the Image file. You have to wait until the <guilabel>Overall process</guilabel> + is at 100%. + </para> + </sect2> + <sect2> + <title>Step 4</title> + <para> + <screenshot> + <screeninfo>In this dialog you can see the result of your burning</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="cdcopy_done.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> + </screenshot> + &k3b; has finished the burning. Click on <guilabel>Close</guilabel> to close the dialog. + </para> + </sect2> +</sect1> diff --git a/doc/cdcopy_done.png b/doc/cdcopy_done.png Binary files differnew file mode 100644 index 0000000..20cd3d4 --- /dev/null +++ b/doc/cdcopy_done.png diff --git a/doc/cdcopy_reading.png b/doc/cdcopy_reading.png Binary files differnew file mode 100644 index 0000000..d2611ed --- /dev/null +++ b/doc/cdcopy_reading.png diff --git a/doc/cdcopy_settings.png b/doc/cdcopy_settings.png Binary files differnew file mode 100644 index 0000000..bb8a1aa --- /dev/null +++ b/doc/cdcopy_settings.png diff --git a/doc/cdcopy_writing.png b/doc/cdcopy_writing.png Binary files differnew file mode 100644 index 0000000..6761ea1 --- /dev/null +++ b/doc/cdcopy_writing.png diff --git a/doc/commands.docbook b/doc/commands.docbook new file mode 100644 index 0000000..a6f69ae --- /dev/null +++ b/doc/commands.docbook @@ -0,0 +1,700 @@ +<!-- The original version had the title 'Command Reference' +with one sect1 sub-chapter called 'The main window'. +However, the only features described were the menu entries, +so a rename of this chapter does make sense. --> + +<chapter id="commands"> + <title>The Menu Entries</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 Project</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Creates a new project.</action> + You have to choose the project type (Audio CD, Data DVD, ...). + </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>Opens an existing project</action> which + can be selected with KDE's Open File dialog. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul">&Ctrl;<keycap>R</keycap> + </keycombo> + </shortcut> + <guimenu>File</guimenu> + <guimenuitem>Open Recent</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This is a shortcut to <action>re-open recently opened + projects</action>. The sub-menu belonging to this item + contains a list of these projects, clicking on a specific file + will open it again. + </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 the current project.</action> + If there has already been a save of the document then this + will overwrite the previously saved file without asking + for the user's consent. If it is the first save of a new + document the Save As dialog will be invoked. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>File</guimenu> + <guimenuitem>Save As...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Saves the current project with a new + file name.</action> KDE's Save As dialog appears to specify + name and directory of the new project file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>File</guimenu> + <guimenuitem>Save All</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Saves all open projects.</action> + This is the same as selecting + <menuchoice> + <guimenu>File</guimenu> + <guimenuitem>Save</guimenuitem> + </menuchoice> for each of them. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul">&Ctrl;<keycap>C</keycap> + </keycombo> + </shortcut> + <guimenu>File</guimenu> + <guimenuitem>Close</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Closes the current project.</action> + If a project has been modified but not yet saved + then &k3b; will ask what to do. + You can choose to save or discard the changes, + and you also have the opportunity to cancel closing + and keep the project open. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>File</guimenu> + <guimenuitem>Close All</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Closes all open projects.</action> For each unsaved + project &k3b; will ask what to do, just like it does when + <menuchoice> + <guimenu>File</guimenu> + <guimenuitem>Close</guimenuitem> + </menuchoice> is selected. + </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 &k3b;</action> after closing all of its open + projects. For every unsaved project &k3b; will ask what to do, + just like it does when + <menuchoice> + <guimenu>File</guimenu> + <guimenuitem>Close</guimenuitem> + </menuchoice> is selected. + </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>Add Files...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + When this item is selected, the appearing dialog + <action>lets you choose one or more files to be added + to the project.</action> This has the same effect as dragging + files directly from the Contents View into the Project View. + If the current project is a data disc project, + the added files will appear in the disc's root directory. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Project</guimenu> + <guimenuitem>Clear Project</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Removes all files and directories + from the current project.</action> + The project itself remains open. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul">&Ctrl;<keycap>B</keycap> + </keycombo> + </shortcut> + <guimenu>Project</guimenu> + <guimenuitem>Burn...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens the Burn dialog for the current project.</action> + This is in fact the same as the Properties dialog - the only + difference is that there is an additional Burn button which + causes &k3b; to burn a disc from project data. The Burn dialog + won't open if the project does not contain any files. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul">&Ctrl;<keycap>P</keycap> + </keycombo> + </shortcut> + <guimenu>Project</guimenu> + <guimenuitem>Properties...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens the Properties dialog for the current project. + </action> Here you can specify a lot of options concerning + the project. Every project type has got a different set of + options, most of them can be explained by using What's This + (accessible by right-mouse-clicking). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Project</guimenu> + <guimenuitem>Import Session</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This Item only appears if a Data CD/DVD or Video DVD project + is active. It causes K3b to <action>import the file entries + from the previous session to the current project</action>. + You can use this when compiling files for multi-session discs. + Hence that data from the previous session is always included, + even if you don't choose to make use of this command. + It just helps to know what's on the disc already. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Project</guimenu> + <guimenuitem>Clear Imported Session</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This Item only appears if a Data CD/DVD or Video DVD project + is active. It causes K3b to <action>remove the file entries + from the current project that were imported</action> by + <menuchoice> + <guimenu>Project</guimenu> + <guimenuitem>Import Session</guimenuitem> + </menuchoice> while keeping all of the other data + in the project. Hence that making use of this command doesn't + actually remove anything from the disc that will be burned, + it just hides these files again. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Project</guimenu> + <guimenuitem>Edit Boot Images</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This Item only appears if a Data CD/DVD or Video DVD project + is active. <action>Here you can specify boot images</action> + in order to create bootable CDs or DVDs. A boot image can be + a direct copy of a floppy or hard disk (for example, created + by the dd shell command) as well as another disc's boot image. + In any case it's a single file containing a complete, bootable + system that is burned as a normal file. In order to let the + computer know that the disc contains a boot image, the burning + application creates a boot catalog file whose name can be + determined in the dialog window. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </sect1> + + +<!-- This menu has been deleted in 0.12. Instead, the command has moved + to the project view, being a button there. + <sect1 id="pluginmenu"> + <title>The <guimenu>Plugin</guimenu> Menu</title> + <para> + <variablelist> + <varlistentry> + <term> + <menuchoice> + <guimenu>Plugins</guimenu> + <guimenuitem>Rename Audio Files...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + Allows you to <action>rename audio files</action> + in a data project using their meta information. + The new file names are defined by patterns + containing information like title or artist name. + </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>Copy CD...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens the CD Copy dialog.</action> + Without the need of a project file, it provides + the ability to copy a CD's content to another disc. + Alternatively, you can choose only to create an image + of the source CD which can be burned anytime. There is + also an option to clone the CD instead of normal + copying, which should be preferred when copying CDs + with defective sectors or Video CDs. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Copy DVD...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens the DVD Copy dialog.</action> + Without the need of a project file, it provides + the ability to copy a DVD's content to another disc. + Alternatively, you can choose only to create an image + of the source DVD which can be burned anytime. + Video transcoding within the DVD Copy dialog + is not yet supported, so the destination disc + has to be large enough to contain all of the + source disc's (video) data in its original form. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Erase CD-RW...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens the Erase CD-RW dialog.</action> + With its help you can clear the contents of a CD-RW, + or part of it. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Format DVD±RW...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens the DVD Formatting dialog.</action> + With its help you can format a DVD-R(W) or DVD+R(W), + which causes the disc's contents to be deleted. + &k3b; gives the choice between the "Overwrite" and + "Incremental" writing modes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Burn CD Image...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Burns a previously created CD image.</action> + The Burn CD Image dialog asks to select an + <literal role="extension">*.iso</literal>, + <literal role="extension">*.cue</literal> or + <literal role="extension">*.toc</literal> file + as data source that you can instantly burn by pressing + the Start button. + (Nero <literal role="extension">*.nrg</literal> files + are currently not supported, so you have to make use + of other tools like <ulink + url="http://gregory.kokanosky.free.fr/v4/linux/nrg2iso.en.html"> + <application>Nrg2Iso</application></ulink>.) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Burn DVD ISO Image...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Burns a previously created DVD image.</action> + The Burn Iso9660 Image dialog asks to select an + <literal role="extension">*.iso</literal> file as data + source that you can instantly burn by pressing + the Start button. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Encode Video...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>A DVD video that has already been ripped can be + encoded</action> with a little help from the Encoding Video + dialog. This dialog box normally opens after ripping the DVD + from within the Contents View, but can also be used standalone. + It contains information about the ripped DVD video, encoding + options and even video resizing and cropping abilities. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Diskinfo</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Shows information about the inserted disk.</action> + This information will be displayed in the Contents View and + covers disk properties like type, size and track length + of the CD or DVD in your drive. + </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>Pops up a list of &k3b;'s toolbars.</action> + If a toolbar entry is checked, it means that + the toolbar is currently visible. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Show/Hide Statusbar</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This enables you to <action>show or hide the small bar + at the bottom of the main window</action> containing + various information about &k3b;'s status and activities. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Show Directories</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Toggles the visibility of the Directory View.</action> + This view enables you to select directories and disc drives. + When selected, their contents will appear in the Contents View. + Disc drives have also got a context menu providing functions + like Disk Info, (un)mounting the drive or ejecting the medium. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Show Contents</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Toggles the visibility of the Contents View.</action> + This view enables you to select files that can be dragged + into the Project View in order to add them to the project. + The Contents View also acts as an interface to rip + audio CDs and video discs when a disc drive containing + an appropriate CD/DVD is selected in the Directory View. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Show Document Header</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Toggles the visibility of the document header</action> + belonging to the Project View. This is a small bar that is + only visible if the Project View contains any open projects. + The document header has no functionality, yet it's nice + eye candy and improves clarity by separating + the Project View from the other views. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure Shortcuts...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This command <action>opens a dialog box where the key bindings + for &k3b;'s menu commands may be changed</action>. + After selecting one of the available commands + from the upper part of the dialog, the shortcut + for this action can be changed in the lower part. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure Toolbars...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This command <action>opens a dialog box where the toolbars + can be customized</action>. The drop down box on top + of the dialog determines which toolbar can be edited + at the moment. The Available Actions list on the left contains + all commands that can be added to the toolbar, + the Current Actions list on the right shows the ones + that are already there. Items can be added by selecting + the appropriate command out of the Available Actions list and + pressing the right button to move it to the Current Actions + list. Removing an item works the other way round. + The up and down buttons change the commands's position + within the toolbar. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>&k3b; Setup</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + This <action>opens &k3bsetup;</action> which helps setting the + right permissions needed by &k3b; in order to burn + CDs and DVDs. Linux' user rights management permits program + execution and access to disc drives if no permissions have + been granted by the administrator. &k3bsetup; cannot set + permissions without administrator privileges, so you have + to enter the root password when starting up. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure &k3b;...</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens the Options dialog</action> + where general program settings can be configured. + Although most of &k3b;'s functionality should work out + of the box, this dialog allows to customize and fine-tune + the program. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </sect1> + + + <sect1 id="helpmenu"> + <title>The <guimenu>Help</guimenu> Menu</title> +<!-- Assuming you have a standard help menu (help, what's this, about &k3b;, +about KDE) then the documentation is already written. The following entity +is valid anywhere that a variablelist is valid. -->&help.menu.documentation; + </sect1> + +</chapter> +<!-- ______________________________________________ using this editor width-->
\ No newline at end of file diff --git a/doc/dcop.docbook b/doc/dcop.docbook new file mode 100644 index 0000000..82b05a6 --- /dev/null +++ b/doc/dcop.docbook @@ -0,0 +1,104 @@ +<chapter id="dcop"> + <title>The &k3b; &DCOP; Interface</title> + <para>&k3b; features, like many other &kde; applications as well, a + &DCOP; interface which makes it possible to control a part of it's + functionality from ⪚ a shellscript.</para> + <para>To use these &DCOP; functions you can either use the + <command>dcop</command> commandline program or the more convenient + <application>Kdcop</application> application. Both provide the same + functionality so it's mostly a matter of taste and context of usage when + deciding which way to choose.</para> + <para>This chapter assumes that you're using the <command>dcop</command> + commandline program. To access &k3b;'s &DCOP; functions, make sure that + &k3b; is started and then enter something like this at a console: +<screen> +<prompt>#</prompt> <command>dcop</command> <option>k3b</option> <option>K3bInterface</option> <replaceable>[function]</replaceable> +</screen> +</para> + +<para>Besides the generic &DCOP; functions available to all &kde; +applications, &k3b;'s DCOP interface mainly consists of two parts as described below.</para> + +<sect1> +<title>The default K3bInterface</title> + +<para>The default K3b DCOP interface provides functionality like copyCD, formatDVD, and methods for creating new projects.</para> + +<programlisting> +DCOPRef createDataCDProject() +DCOPRef createAudioCDProject() +DCOPRef createMixedCDProject() +DCOPRef createVideoCDProject() +DCOPRef createMovixCDProject() +DCOPRef createDataDVDProject() +DCOPRef createVideoDVDProject() +DCOPRef createMovixDVDProject() +DCOPRef openProject(KURL url) +QValueList<DCOPRef> projects() +DCOPRef currentProject() +void copyCd() +void copyDvd() +void eraseCdrw() +void formatDvd() +void burnCdImage(KURL url) +void burnDvdImage(KURL url) +</programlisting> + +<para>As result from one of the createXXXProject methods one gets a DCOP reference to the newly created project: + +<programlisting>DCOPRef(k3b,K3bProject-0)</programlisting> + +Alternatively you may create a project using the command line: + +<screen> +<prompt>#</prompt> <command>k3b</command> <replaceable>--audiocd</replaceable> +</screen> + +and then retrieve a reference to this project with + +<screen> +<prompt>#</prompt> <command>dcop</command> <option>k3b</option> <option>K3bInterface</option> <replaceable>currentProject</replaceable> +</screen> + +Using this reference it is possible to manipulate the project using the <link linkend="k3bprojectinterface">K3bProjectInterface</link>.</para> + +</sect1> + +<sect1 id="k3bprojectinterface"> +<title>K3bProjectInterface</title> + +<programlisting> +void addUrls(KURL::List urls) +void addUrl(KURL url) +void burn() +</programlisting> + +<para>K3b offers the K3bProjectInterface as listed above or the more powerful K3bDataProjectInterface which only applies to data projects (CD and DVD): + +<programlisting> +void createFolder(QString name) +void createFolder(QString name,QString parent) +void addUrl(KURL url,QString parent) +void addUrls(KURL::List urls,QString parent) +void removeItem(QString path) +void renameItem(QString path,QString newName) +void setVolumeID(QString id) +</programlisting> +</para> + +<para>Using this it is possible to fill a data project with files and folders from a script. +The following script for example creates a new data project, adds several folders to the project, and adds files to the newly created folders: + +<programlisting> +#!/bin/bash +PROJECT=$(dcop k3b K3bInterface createDataCDProject) +dcop $PROJECT createFolder test +dcop $PROJECT createFolder foo +dcop $PROJECT createFolder bar /foo +dcop $PROJECT addUrl /home/trueg/somefile.txt /foo/bar +</programlisting> + +</para> + +</sect1> +</chapter> diff --git a/doc/index.docbook b/doc/index.docbook new file mode 100644 index 0000000..fcb6f96 --- /dev/null +++ b/doc/index.docbook @@ -0,0 +1,340 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.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 kappname "&k3b;"> + <!ENTITY package "kdeextragear-1"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &k3b; Handbook</title> + +<authorgroup> + <author> + <firstname>Carsten</firstname> + <surname>Niehaus</surname> + </author> + <author> + <firstname>Jakob</firstname> + <surname>Petsovits</surname> + </author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + + +<copyright> + <year>2003-2004</year> +<holder>Carsten Niehaus</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 --> + +<abstract> +<para> + &k3b; is a CD and DVD burning application for &kde; with a comfortable user interface. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeextragear</keyword> +<keyword>cdrecord</keyword> +<keyword>DVD</keyword> +<keyword>CD</keyword> +<keyword>burning</keyword> +<keyword>ripping</keyword> +<keyword>iso</keyword> +<keyword>K3b</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<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>. +</para> +</chapter> + +<!-- the GUI comands --> +&k3b-commands; + +<chapter id="howtos"> + <title>HOWTOs for a quickstart to &k3b;</title> + + &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>KDEDIR</envar>/lib/kde3/plugins</filename> to the + plugin search path (replace $<envar>KDEDIR</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 © 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> + +<para> + In order to successfully use &k3b;, you need &kde; >= 3.1 and &Qt; >= 3.1. +</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). +</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. +</para> +<para> + &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: +</para> + +<para> +cdparanoia: A Compact Disc Digital Audio (CDDA) extraction tool, +commonly known on the net as a 'ripper'. +</para> + +<para> +Ogg Vorbis library: Ogg Vorbis is a completely open, patent-free, +professional audio encoding and streaming technology with all the benefits +of Open Source, and in direct competition with the MP3 format. +Used by the Ogg Vorbis Decoder and Encoder plugins. +</para> + +<para> +MAD (MPEG Audio Decoder) Library: A high-quality MPEG audio decoder, +supporting the MPEG-1, MPEG-2 and MPEG 2.5 formats. All three audio +layers Layer I, Layer II, and Layer III (i.e. MP3) are fully implemented. +Used by the MP3 Decoder plugin. +</para> + +<para> +LAME: A highly evolved MP3 encoder, with quality and speed able to rival +state of the art commercial encoders. Used by the MP3 Encoder plugin. +</para> + +<para> +FLAC: A free, open source codec for lossless audio compression and +decompression. Used by the FLAC Decoder plugin and the +External Audio Encoder plugin, so you can read and write FLAC files. +</para> + +<para> +Libsndfile, FFmpeg, FLAC, Musepack decoders: Other libraries for processing a +broad range of audio file formats. For example, with FFmpeg it is possible to +decode WMA files in order to burn them onto audio CDs. +Used by the respective plugins. +</para> + +<para> +SoX: A utility that can convert between various audio file formats. +Used by the SoX Audio Encoder plugin. +</para> + +<para> +transcode: A Linux text-console utility for video stream processing. +You need this if you want to rip DVD video. +</para> + +<para> +VCDImager: A full-featured mastering suite for authoring, +disassembling and analyzing Video CDs and Super Video CDs. +</para> + +<para> +Normalize: A tool for adjusting the volume of audio files to a standard level. +This is useful for things like creating mixed CDs and MP3 collections, where +different recording levels on different albums can cause the volume to vary +greatly from song to song. +</para> + +<para> +eMovix: A tiny Linux distribution that is burned on CD together with video +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> + +<!-- 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> + +</appendix> + +&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 +--> diff --git a/doc/select_audiofiles.png b/doc/select_audiofiles.png Binary files differnew file mode 100644 index 0000000..b50a8a9 --- /dev/null +++ b/doc/select_audiofiles.png diff --git a/doc/select_project.png b/doc/select_project.png Binary files differnew file mode 100644 index 0000000..9cedf35 --- /dev/null +++ b/doc/select_project.png |
