diff --git a/doc/en/index.docbook b/doc/en/index.docbook --- a/doc/en/index.docbook +++ b/doc/en/index.docbook @@ -833,9 +833,9 @@ can be resized, moved, tiled, cascaded or minimized. - You can select a window from the Windows + You can select a window from the Window menu or cycle through the sub-windows with - &Ctrl;Tab. + &Ctrl; . screenshot of &kwave; in MDI mode @@ -859,9 +859,9 @@ some popular Internet browsers. - You can activate a tab via the Windows + You can activate a tab via the Window menu or cycle through the tabs with - &Ctrl;Tab. + &Ctrl; . screenshot of &kwave; in TAB mode @@ -958,16 +958,15 @@ It is also possible to pass &kwave; text commands, encoded as a - special URIuniversal resource identifier, + special &URI;universal resource identifier, this will be described in a later section. - GUI Type + &GUI; Type The parameter --gui=SDI|MDI|TAB - lets &kwave; start in one of the three possible - GUI modes: + lets &kwave; start in one of the three possible &GUI; modes: SDI, MDI or TAB. @@ -1001,7 +1000,7 @@ The command line option --iconic lets &kwave; start up minimized (iconified). This might be useful when you want to - start &kwave; without GUI interaction, ⪚ when running from a script. + start &kwave; without &GUI; interaction, ⪚ when running from a script. This option also implicitly disables the splash screen! @@ -1515,14 +1514,14 @@ - Space + &Space; PlayPause : Pause the playback at the current position. Only available when the playback is running. - Space + &Space; PlayContinue : Continue the playback from the position where it has been paused. Only available if the playback is paused. @@ -1591,103 +1590,103 @@ Zooming in and out - + - zoom to whole signal: - selects a zoom factor that makes the whole signal visible in the - current window. + zoom in: + zooms in to see more details, magnifies by factor 3. - menu entry: + menu entry / keyboard shortcut: - ViewZoom to whole signal + &Ctrl;+ + ViewZoom In toolbar button: - - zoom all button + + zoom in - - + + - zoom to 100%: - zooms in up to a scale where on sample is represented by on pixel - on the screen. + zoom out: + zooms in to see less details, shrinks by factor 3. - menu entry: + menu entry / keyboard shortcut: - ViewZoom to 100% + &Ctrl;- + ViewZoom Out toolbar button: - - zoom to 100% button + + zoom out - + - zoom in: - zooms in to see more details, magnifies by factor 3. + zoom selection: + zooms to a factor where the current selection is completely + visible in the current view. menu entry / keyboard shortcut: - &Ctrl;+ - ViewZoom In + &Ctrl;&Space; + ViewZoom to Selection toolbar button: - - zoom in button + + zoom to selection - - + + - zoom out: - zooms in to see less details, shrinks by factor 3. + zoom to whole signal: + selects a zoom factor that makes the whole signal visible in the + current window. - menu entry / keyboard shortcut: + menu entry: - &Ctrl;- - ViewZoom Out + ViewZoom to whole signal toolbar button: - - zoom out button + + zoom all - + - zoom selection: - zooms to a factor where the current selection is completely - visible in the current view. + zoom to 100%: + zooms in up to a scale where on sample is represented by on pixel + on the screen. - menu entry / keyboard shortcut: + menu entry: - &Ctrl;Space - ViewZoom to Selection + ViewZoom to 100% toolbar button: - - zoom to selection button + + zoom to 100% @@ -1705,42 +1704,44 @@ Scrolling left and right - - - scroll left: - scrolls to the start of the signal by 1/3 of the current view. + + + goto position: + opens a dialog to enter the position where you want scrolls the current view. menu entry / keyboard shortcut: - cursor Left - ViewScroll left + &Ctrl;G + ViewGo to Position... - - toolbar button: - - scroll left button - - - - - scroll right: - scrolls to the end of the signal by 1/3 of the current view. + + + to begin: + scrolls the current view so that it starts + at the beginning of the signal. menu entry / keyboard shortcut: - cursor right - ViewScroll right + &Ctrl;&Home; + ViewBegin + + + + to end: + scrolls the current view so that it ends at the end of the signal. + - toolbar button: - - scroll right button - + menu entry / keyboard shortcut: + + &Ctrl;&End; + ViewEnd + @@ -1751,14 +1752,14 @@ menu entry / keyboard shortcut: - Page up + &PgUp; ViewPrevious Page toolbar button: - previous page button + previous page @@ -1770,43 +1771,54 @@ menu entry / keyboard shortcut: - Page down + &PgDn; ViewNext Page toolbar button: - next page button + next page - - - to begin: - scrolls the current view so that it starts - at the beginning of the signal. + + + scroll right: + scrolls to the end of the signal by 1/3 of the current view. menu entry / keyboard shortcut: - &Ctrl;Home - ViewBegin + &Right; + ViewScroll right + + toolbar button: + + scroll right + + - - - to end: - scrolls the current view so that it ends at the end of the signal. + + + scroll left: + scrolls to the start of the signal by 1/3 of the current view. menu entry / keyboard shortcut: - &Ctrl;End - ViewEnd + &Left; + ViewScroll left + + toolbar button: + + scroll left + + @@ -1821,18 +1833,18 @@ - single click with left mouse button: + single click with &LMB;: directly move the current view to the clicked position. - double click with left mouse button: + double click with &LMB;: directly move the current view to the clicked position and additionally zoom in. - double click with left mouse button, with + double click with &LMB;, with &Shift; pressed: directly move the current view to the clicked position and additionally zoom out. @@ -1845,7 +1857,7 @@ Vertical zoom You can zoom the current view vertically by pressing the - Alt key and scrolling with the mouse wheel. + &Alt; key and scrolling with the mouse wheel. @@ -1907,20 +1919,21 @@ The easiest way of selecting a range of samples is just to do that with mouse. It works like you are used from other applications: just press - the left mouse button at the point you want to let the selection start + the &LMB; at the point you want to let the selection start and release the button where you want it to end. If you want to adjust or move the selection's start or end, you can move the mouse cursor near to the start or the end of the selection until it changes from the standard arrow cursor into the left-right arrow cursor and then - press the left mouse button and adjust. + press the &LMB; and adjust. You can also extend or shrink the selection to a specific point by holding - down the &Shift; key while clicking with the left mouse button. Depending + down the &Shift; key while clicking with the &LMB;. Depending on which border is nearer, the left or right border of the selection will - be set to a new position. + be set until the new position. If there was nothing selected, will be set + from the beginning. There are also some functions available via the menu and of course some @@ -1934,17 +1947,17 @@ - remove any selection and select "nothing": + select a range: - N - EditSelectionNothing + R + EditSelectionRange the currently visible area: V - EditSelectionVisible + EditSelectionVisible Area @@ -1969,18 +1982,25 @@ (Hint: use the "-" key from the numeric keypad!) + + remove any selection and select "nothing": + + N + EditSelectionNothing + + expand the selection to the start of the signal (first sample): - &Shift;Home - EditSelectionto start + &Shift;&Home; + EditSelectionTo Start expand the selection to the end of the signal (last sample): - &Shift;End - EditSelectionto end + &Shift;&End; + EditSelectionTo End @@ -1998,16 +2018,16 @@ select the area between the next two labels that are right from the current selection or up to the end of the signal: - &Shift;&Ctrl;N - EditSelectionto next labels + &Ctrl;&Shift;N + EditSelectionTo Next Labels select the area between the previous two labels that are left from the current selection or up to the start of the signal: - &Shift;&Ctrl;P - EditSelectionto previous labels + &Ctrl;&Shift;P + EditSelectionTo Previous Labels @@ -2067,8 +2087,8 @@ a &kwave; window. Per default the drag operation is done in move mode where the selected range is deleted from the original place and inserted at the drop position. - By pressing the Ctrl key you can - modify this and drag in copy mode instead. + By pressing the &Ctrl; key you can modify this and drag in + copy mode instead. @@ -2162,7 +2182,7 @@ Automization and Scripting with &kwave; &kwave; since its first version uses an internal text command language. - This command language is used internally for menu handling, GUI control, + This command language is used internally for menu handling, &GUI; control, builtin effects and plugin invocations. The commands will be described later in the section . @@ -2187,7 +2207,7 @@ Numerical parameters can be given as fixed point numbers or - as floating point numbers, using a dot as decimal separator. + as floating point numbers, using a dot as decimal separator. String parameters are automatically trimmed (all white space @@ -2208,8 +2228,7 @@ Example: fileinfo(Comments,"This is an \"example\" comment.") - This example consists of the command - fileinfo and has two + This example consists of the command fileinfo() and has two parameters: the keyword Comments and the text "This is an \"example\" comment.". (These parameters are explained in the corresponding section in the command reference). @@ -2226,18 +2245,18 @@ Command Line which are used to start &kwave; in iconified mode or without splash screen, you can pass text commands on the command line, encoded in a - special URI format: + special &URI; format: kwave:command[?parameter[,parameter ...] ] - The rules for transforming a &kwave; text command into a valid URI + The rules for transforming a &kwave; text command into a valid &URI; are as follows: - The URI starts with the word kwave, followed + The &URI; starts with the word kwave, followed by a : and the command name. @@ -2250,8 +2269,8 @@ All special characters in command name and parameters have to - be URL encoded. Here a list of the translations: - URL Encoding Translation Table + be &URL; encoded. Here a list of the translations: +
&URL; Encoding Translation Table @@ -2380,9 +2399,9 @@ of a script. If you want to implement a possibility for the user to end a script, you can use the command msgbox(text). - This shows a message box with the two - buttons OK (which lets the script - continue) and Cancel (which + This shows a message box with the two buttons + OK (which lets the script + continue) and Cancel (which returns an error code and stops the script). @@ -2390,7 +2409,7 @@ Lines that consist only of an identifier, followed by a : are treated labels. They can be referenced - later in the script by the special keyword GOTO + later in the script by the special keyword GOTO Note: Please don't mix up the keyword GOTO with the text command @@ -2605,7 +2624,7 @@ &i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_close;</command>() - Closes the current file. If the GUI is configured to MDI or Tab mode, + Closes the current file. If the &GUI; is configured to MDI or Tab mode, this also closes the corresponding sub-window. @@ -2797,7 +2816,7 @@ button. If the playback is currently running, it skips forward by 1/10 of the visible range. If the playback is not running, this does the same as the command - &no-i18n-cmd_view_scroll_right;. + &no-i18n-cmd_view_scroll_right;(). See also @@ -2834,7 +2853,7 @@ &i18n-cmd_syntax;<command>&no-i18n-cmd_insert_at;</command>(<replaceable>pos</replaceable>) Inserts the content of the clipboard at the given position, - like the command &no-i18n-cmd_paste;()(). + like the command &no-i18n-cmd_paste;(). If the clipboard is currently empty, this function does nothing. @@ -2855,7 +2874,7 @@ and sample rate settings of the signal. If the index is higher than or equal to the current number of tracks, it will be appended as the last track, same as by the command - &no-i18n-cmd_add_track;(). + &no-i18n-cmd_add_track;(). The index of all existing tracks at and after the given index will be incremented by one. @@ -2921,7 +2940,7 @@ &i18n-cmd_syntax;<command>&no-i18n-cmd_label_edit;</command>(<replaceable>index</replaceable>) - Opens a window in which the user can edit the position and the + Opens a dialog window in which the user can edit the position and the description of a label, which is identified by its index (starting from zero). If no label with the given index exists, this command does nothing. @@ -3000,8 +3019,7 @@ that will be executed when the menu entry gets activated. If a menu entry does not have a corresponding command (for example if it is a sub menu and not menu entry), - you should use the special - command ignore(). + you should use the special command ignore(). @@ -3178,18 +3196,16 @@ &i18n-cmd_syntax;<command>&no-i18n-cmd_msgbox;</command>(<replaceable>text</replaceable>) Shows a message box with some text - and the two buttons OK - (returns without error code) and - Cancel (returns and error - code). You can use this command to give the user a possibility - to abort a running script. + and the two buttons OK (returns without error code) and + Cancel (returns and error code). You can use this command + to give the user a possibility to abort a running script. Parameterstext: A message that will be shown in the message box, should - contain a question that can be answered with OK - or Cancel + contain a question that can be answered with OK + or Cancel. @@ -3241,7 +3257,7 @@ button. If the playback is currently running, it skips forward to the next label. If the playback is not running, this does the same as the command - &no-i18n-cmd_view_scroll_next_label;. + &no-i18n-cmd_view_scroll_next_label;(). See also @@ -3262,7 +3278,7 @@ Opens a file, which can be either a sound file or a &kwave; script. If no file name is passed, then a dialog window will be opened that - allows to select an existing file. Depending on the GUI mode the + allows to select an existing file. Depending on the &GUI; mode the file will be opened in the context of a new sub-window (MDI and tab) or in a new main window (SDI, if there was already something loaded). @@ -3285,7 +3301,7 @@ &i18n-cmd_syntax;<command>&no-i18n-cmd_openrecent;</command>(<replaceable>filename</replaceable>) Practically the same as the command - &no-i18n-cmd_open;, but intended to be used + &no-i18n-cmd_open;(), but intended to be used internally for the list of recently opened files in the menu FileOpen Recent @@ -3300,7 +3316,7 @@ See also - &no-i18n-tag;&no-i18n-cmd_open; + &no-i18n-tag;&no-i18n-cmd_open;() @@ -3393,7 +3409,7 @@ &i18n-cmd_syntax;<command>&no-i18n-cmd_plugin_execute;</command>(<replaceable>name</replaceable>, [<replaceable>parameter</replaceable> ...]) - Similar to the command &no-i18n-cmd_plugin;(), + Similar to the command &no-i18n-cmd_plugin;(), but without calling the setup function of the plugin if no parameters were passed. @@ -3437,7 +3453,7 @@ button. If the playback is currently running, it skips back to the previous label or start of the selection. If the playback is not running, this does the same as the command - &no-i18n-cmd_view_scroll_prev_label;. + &no-i18n-cmd_view_scroll_prev_label;(). See also @@ -3458,7 +3474,7 @@ Closes the current main window, including all sub-windows. In SDI mode this is the same as the command - &no-i18n-cmd_close;(). + &no-i18n-cmd_close;(). See also @@ -3478,7 +3494,7 @@ Corresponds to the Redo toolbar button and repeats one operation that has been reverted with - &no-i18n-cmd_undo;. + &no-i18n-cmd_undo;(). See also @@ -3493,7 +3509,7 @@ &i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_redo_all;</command>() - Similar to &no-i18n-cmd_redo;, but re-does + Similar to &no-i18n-cmd_redo;(), but re-does as many operations as possible. @@ -3547,7 +3563,7 @@ button. If the playback is currently running, it skips backward by 1/10 of the visible range. If the playback is not running, this does the same as the command - &no-i18n-cmd_view_scroll_left;. + &no-i18n-cmd_view_scroll_left;(). See also @@ -3570,7 +3586,7 @@ button. Saves the current file if it has modifications. If the file does not already have a name (⪚ a file that has just been created and does not yet have a file name), this - command does the same as &no-i18n-cmd_saveas;. + command does the same as &no-i18n-cmd_saveas;(). See also @@ -3601,7 +3617,7 @@ &i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_saveselect;</command>() - This command does the same as &no-i18n-cmd_save;, + This command does the same as &no-i18n-cmd_save;(), but saves only the currently selected range and the activated tracks instead of the whole file. @@ -3616,9 +3632,9 @@ &no-i18n-cmd_select_gui_type; - &i18n-cmd_syntax;<command>&no-i18n-cmd_select_gui_type;</command>(mode) + &i18n-cmd_syntax;<command>&no-i18n-cmd_select_gui_type;</command>(<replaceable>mode</replaceable>) - Select a GUI mode, which can be either SDI, MDI or Tab mode. + Select a &GUI; mode, which can be either SDI, MDI or Tab mode. Please be aware that this changes will immediately take effect! @@ -3638,7 +3654,7 @@ &i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_select_track_all;</command>() Mark all tracks enabled. This is the same as - calling the command &no-i18n-tag;&no-i18n-cmd_select_track_on;() + calling the command &no-i18n-tag;&no-i18n-cmd_select_track_on;() for all existing tracks. @@ -3656,7 +3672,7 @@ Invert the enabled state of all tracks. This is the same as calling the command - &no-i18n-cmd_select_track_toggle;() + &no-i18n-cmd_select_track_toggle;() for all existing tracks. @@ -3673,7 +3689,7 @@ &i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_select_track_none;</command>() Mark all tracks disabled. This is the same as - calling the command &no-i18n-cmd_select_track_off;() + calling the command &no-i18n-cmd_select_track_off;() for all existing tracks. @@ -3687,7 +3703,7 @@ &no-i18n-cmd_select_track_off; - &i18n-cmd_syntax;<command>&no-i18n-cmd_select_track_off;</command>(index) + &i18n-cmd_syntax;<command>&no-i18n-cmd_select_track_off;</command>(<replaceable>index</replaceable>) Disables a single track, so that it does not get affected by most operations. @@ -3702,7 +3718,7 @@ &no-i18n-cmd_select_track_on; - &i18n-cmd_syntax;<command>&no-i18n-cmd_select_track_on;</command>(index) + &i18n-cmd_syntax;<command>&no-i18n-cmd_select_track_on;</command>(<replaceable>index</replaceable>) Enables a single track, so that it gets affected by all operations. @@ -3716,7 +3732,7 @@ &no-i18n-cmd_select_track_toggle; - &i18n-cmd_syntax;<command>&no-i18n-cmd_select_track_toggle;</command>(index) + &i18n-cmd_syntax;<command>&no-i18n-cmd_select_track_toggle;</command>(<replaceable>index</replaceable>) Enables a track if it is currently disabled, or disables it if it is currently enabled. @@ -3951,7 +3967,7 @@ &i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_undo_all;</command>() - Similar to &no-i18n-tag;&no-i18n-cmd_undo;, but reverts + Similar to &no-i18n-tag;&no-i18n-cmd_undo;(), but reverts as many operations as possible. @@ -4187,8 +4203,8 @@ Activates a sub-window, identified by its window title. If the sub-window is minimized it will be restored. - Only available if in MDI and tab mode. - This command is internally used by the Window menu. + Only available if in MDI and Tab mode. + This command is internally used by the Window menu. Parameters @@ -4298,7 +4314,7 @@ &i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_window_next_sub;</command>() - Activates the next sub-window when in MDI or tab mode. If the next + Activates the next sub-window when in MDI or Tab mode. If the next sub-window is minimized it will be restored. @@ -4309,7 +4325,7 @@ &i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_window_prev_sub;</command>() - Activates the previous sub-window when in MDI or tab mode. If the previous + Activates the previous sub-window when in MDI or Tab mode. If the previous sub-window is minimized it will be restored. @@ -4396,9 +4412,9 @@ See also - description of the parameter + Description of the parameter hotkey - of the &no-i18n-cmd_menu; command. + of the &no-i18n-cmd_menu;() command. @@ -4530,7 +4546,7 @@ &i18n-plugin_lbl_type; - gui + &GUI; &i18n-plugin_lbl_description; @@ -5391,10 +5407,10 @@ Saves all sections between markers into a separate file and creates a K3b project file. After having successfully written all files it is possible to start K3b and - burn the result to an audio CD. + burn the result to an audio &CD;. This is useful for splitting a file with a recording that consists of several parts, which are separated by labels, and then burn it - to an audio CD with multiple tracks, including CD text meta data + to an audio &CD; with multiple tracks, including &CD; text meta data which is extracted from the descriptions of the labels. @@ -5427,7 +5443,7 @@ of a section. It supports the following wildcards which will be replaced by the corresponding content - when creating the CD text meta data: + when creating the &CD; text meta data: @@ -5603,7 +5619,7 @@ &i18n-plugin_lbl_type; - gui + &GUI; &i18n-plugin_lbl_description; @@ -5885,7 +5901,7 @@ &i18n-plugin_lbl_type; - gui + &GUI; &i18n-plugin_lbl_description; @@ -6249,8 +6265,8 @@ A speed factor below 1.0 pitches the signal down (lower voice, makes voices sound older), factor 1.0 does no change and a - factor above 1.0 pitches the signal up (higher voice, mickey - mouse effect). + factor above 1.0 pitches the signal up (higher voice, Mickey + Mouse effect). The implementation is based on the work of @@ -7877,7 +7893,7 @@ Mark Donohoe (&kde;) donohoe@kde.org - some icons and bitmaps for toolbar and GUI + some icons and bitmaps for toolbar and &GUI;