Git commit b04c5085d049781fb79d84f8bcc73edde44afd2a by Mark Penner. Committed on 14/11/2024 at 02:09. Pushed by mrp into branch 'release/24.12'.
update handbook for version 24.12.0 M +48 -40 doc/en/index.docbook M +- -- doc/en/kwave-gui-mdi.png M +- -- doc/en/kwave-gui-sdi.png M +- -- doc/en/kwave-gui-tab.png M +- -- doc/en/kwave-main.png M +- -- doc/en/kwave-plugin-playback.png https://invent.kde.org/multimedia/kwave/-/commit/b04c5085d049781fb79d84f8bcc73edde44afd2a diff --git a/doc/en/index.docbook b/doc/en/index.docbook index 836f52ecc..4fb28eaa2 100644 --- a/doc/en/index.docbook +++ b/doc/en/index.docbook @@ -3,8 +3,7 @@ <!ENTITY kwave "<application>Kwave</application>"> <!ENTITY % English "INCLUDE"> <!-- change language only here --> <!ENTITY % addindex "IGNORE"> - <!ENTITY version "20.07.70"> - <!ENTITY version_year "2020"> + <!ENTITY version "24.12.0"> <!ENTITY % ents PUBLIC "-//KDE//ENTITIES Application-Variable Entities V2.0//EN" "entities/kde-prologue.entities"> <!ENTITY url_cc_by_sa_4 "https://creativecommons.org/licenses/by-sa/4.0/";> <!ENTITY url_devel_fetching_from_git "http://kwave.sourceforge.net/doc/devel/fetching_sources_from_git.html";> @@ -15,6 +14,7 @@ <!ENTITY url_changelog "&url_prefix_gitweb;CHANGES"> <!ENTITY url_debian "https://www.debian.org";> <!ENTITY url_flac "https://xiph.org/flac/";> + <!ENTITY url_apps_kde "https://apps.kde.org/kwave";> <!ENTITY url_homepage "http://kwave.sourceforge.net/";> <!ENTITY url_id3lib "http://id3lib.sourceforge.net/";> <!ENTITY url_isrc "http://isrc.ifpi.org/";> @@ -27,7 +27,6 @@ <!ENTITY url_licenses "&url_prefix_gitweb;LICENSES"> <!ENTITY url_ogg_vorbis "https://www.xiph.org";> <!ENTITY url_rfc2361 "http://www.ietf.org/rfc/rfc2361.txt";> - <!ENTITY url_sourceforge "https://sourceforge.net";> <!ENTITY url_sox "http://sox.sourceforge.net/";> <!ENTITY url_git_web_sf "https://sourceforge.net/p/kwave/code/commit_browser";> <!ENTITY i18n-cmd_syntax "Syntax: "> @@ -312,18 +311,18 @@ </authorgroup> <copyright><year>1998-2000</year><holder>Martin Wilz</holder></copyright> - <copyright><year>&version_year;</year><holder>Thomas Eschenbacher</holder></copyright> + <copyright><year>2020</year><holder>Thomas Eschenbacher</holder></copyright> + <copyright><year>2024</year><holder>Mark Penner</holder></copyright> <legalnotice>&FDLNotice;</legalnotice> - <date>2020-07-06</date> - <releaseinfo>20.07.70</releaseinfo> + <date>2024-11-09</date> + <releaseinfo>&version;</releaseinfo> - <abstract><para>&kwave; is a simple sound editor built on &kf5-full;.</para></abstract> + <abstract><para>&kwave; is a simple sound editor built on the &kde-frameworks;.</para></abstract> <keywordset> <keyword>KDE</keyword> - <keyword>KF5</keyword> <keyword>multimedia</keyword> <keyword>sound</keyword> <keyword>audio</keyword> @@ -345,7 +344,7 @@ <chapter id="introduction"><title>Introduction</title> <para> - This is "&kwave;", a simple sound editor built on &kf5-full;. + This is "&kwave;", a simple sound editor built on the &kde-frameworks;. Its features include: <itemizedlist> <listitem><para> @@ -370,10 +369,10 @@ Recording functionality, including pre-recording </para></listitem> <listitem><para> - Playback via Qt, PulseAudio, ALSA and OSS + Playback via ALSA, PulseAudio, Qt, and OSS </para></listitem> <listitem><para> - Recording via PulseAudio, ALSA and OSS + Recording via ALSA, PulseAudio, Qt, and OSS </para></listitem> <listitem><para> MP3 import/export @@ -433,25 +432,19 @@ <itemizedlist> <listitem><para> Project Homepage<anchor id="project-homepage"/></para><para> - For information about new up-to-date releases or some other - information about this project, take a look at - the <ulink url="&url_homepage;">&kwave; homepage</ulink>. + For information about new up-to-date releases see the + <ulink url="&url_apps_kde;">&kwave; page</ulink> on apps.kde.org. + For other information take a look at the + <ulink url="&url_homepage;">&kwave; homepage</ulink> . </para></listitem> <listitem><para> - GIT Repository<anchor id="git-repository"/> + Git Repository<anchor id="git-repository"/> </para> <para> - There also is a new GIT repository hosted on &kde; servers, and a - mirror repository hosted by - <ulink url="&url_sourceforge;">SourceForge</ulink> where - you can get the sources of the latest development version. - For instructions on how to get access to the repository, read - in the chapter about - <ulink url="&url_devel_fetching_from_git;">building from GIT</ulink> - in the developer documentation. - There also is a GIT web interface on <ulink url="&url_git_web_kde;">&kde;</ulink> - and on <ulink url="&url_git_web_sf;">SourceForge</ulink> that - you can use to browse through the sources. + The git repository is hosted on &kde;'s Gitlab instance + <ulink url="&url_git_web_kde;">here</ulink>, + and there is also a mirror repository on + <ulink url="&url_git_web_sf;">SourceForge</ulink>. </para></listitem> </itemizedlist> @@ -480,7 +473,7 @@ you can find the full history here: <ulink url="&url_changelog;"> &url_changelog;</ulink> or browse through the sources on your own through the - <ulink url="&url_git_web_kde;">GIT web interface</ulink>. + <ulink url="&url_git_web_kde;">git web interface</ulink>. </para> <para> @@ -1213,9 +1206,8 @@ <para> &kwave; is able to record audio data from various sources, with all sample rates, sample formats and other modes that your sound - hardware supports. Currently &kwave; records through the old OSS - sound interface, and since v0.7.4 also the newer and more powerful - ALSA interface that is the preferred choice for linux kernel 2.6. + hardware supports. &kwave; can record with the ALSA, PulseAudio, Qt, + and OSS backends. </para> <para> The recording can be reached from the menu under @@ -1359,7 +1351,7 @@ <para> Depending on the compilation options &kwave; is able to play sounds - trough one of the following playback methods: + through one of the following playback methods: </para> <para><itemizedlist> <listitem><para> @@ -1371,9 +1363,18 @@ for you! </para></listitem> <listitem><para> + PulseAudio: + Common general purpose sound server on Linux. PulseAudio might not + be able to get as low latency as ALSA. + </para></listitem> + <listitem><para> + Qt Multimedia: + Not designed for low-latency audio, but works with large buffer sizes. + </para></listitem> + <listitem><para> OSS (Open Sound System): The oldest linux implementation, capable of mono and stereo output. - Deprecated since linux kernel 2.6, but still wide spread. + Deprecated since linux kernel 2.6. Might collide with other sound applications, only one application at a time can use OSS playback ! </para></listitem> @@ -1399,11 +1400,6 @@ </screenshot> </para> - <para> - Currently &kwave; supports only 8 and 16 bit playback, with mono or - stereo output through the OSS interface, but many also - all modes your sound hardware supports through the ALSA interface. - </para> <para> If your sound file uses more or less channels than the playback allows, all channels will be mixed together during playback. @@ -7252,8 +7248,8 @@ &kwave; does not need support for any special sound card. The sound card only has to be supported by your operating system and &kwave; uses its interface to the - operating system's sound driver through a OSS or ALSA - interface. + operating system's sound driver through an ALSA, PulseAudio, + Qt, or OSS interface. </para> </answer> </qandaentry> @@ -7464,9 +7460,13 @@ </para> <para> - Documentation copyright (C) &version_year; Thomas Eschenbacher + Documentation copyright (C) 2020 Thomas Eschenbacher <email>thomas.eschenbac...@gmx.de</email> </para> + <para> + Documentation copyright (C) 2024 Mark Penner + <email>mrp@markpenner.space</email> + </para> <!-- TRANS:CREDIT_FOR_TRANSLATORS --> &underFDL; &underGPL; @@ -7530,6 +7530,14 @@ i18n, french translations, splashscreen, beta tester </para> </listitem> + <listitem> + <para><emphasis role="bold"> + Mark Penner + <email>mrp@markpenner.space</email> + </emphasis></para><para> + development + </para> + </listitem> <listitem> <para><emphasis role="bold"> Pavel Fric diff --git a/doc/en/kwave-gui-mdi.png b/doc/en/kwave-gui-mdi.png index 022bb9b7a..3701e677e 100644 Binary files a/doc/en/kwave-gui-mdi.png and b/doc/en/kwave-gui-mdi.png differ diff --git a/doc/en/kwave-gui-sdi.png b/doc/en/kwave-gui-sdi.png index 13ccf0099..57047ea7e 100644 Binary files a/doc/en/kwave-gui-sdi.png and b/doc/en/kwave-gui-sdi.png differ diff --git a/doc/en/kwave-gui-tab.png b/doc/en/kwave-gui-tab.png index 2d0c93612..f8b6bd2e8 100644 Binary files a/doc/en/kwave-gui-tab.png and b/doc/en/kwave-gui-tab.png differ diff --git a/doc/en/kwave-main.png b/doc/en/kwave-main.png index 8468d0d5c..5e555b0bd 100644 Binary files a/doc/en/kwave-main.png and b/doc/en/kwave-main.png differ diff --git a/doc/en/kwave-plugin-playback.png b/doc/en/kwave-plugin-playback.png index f1e936863..cd1a83671 100644 Binary files a/doc/en/kwave-plugin-playback.png and b/doc/en/kwave-plugin-playback.png differ
