[multimedia/kwave] doc/en: update documentation for export_k3b plugin

Mark Penner null at kde.org
Fri Jan 3 13:07:24 GMT 2025


Git commit e5ebf85717c3dc164f471e1baab8aeff1f68f319 by Mark Penner.
Committed on 03/01/2025 at 12:30.
Pushed by mrp into branch 'master'.

update documentation for export_k3b plugin

M  +11   -39   doc/en/index.docbook
A  +-    --    doc/en/kwave-plugin-export_k3b.png

https://invent.kde.org/multimedia/kwave/-/commit/e5ebf85717c3dc164f471e1baab8aeff1f68f319

diff --git a/doc/en/index.docbook b/doc/en/index.docbook
index 4fb28eaa2..d651aa733 100644
--- a/doc/en/index.docbook
+++ b/doc/en/index.docbook
@@ -5295,16 +5295,6 @@
 		<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
 		<listitem>
 		    <variablelist>
-			<varlistentry>
-			    <term><replaceable>filename</replaceable></term>
-			    <listitem>
-				<para>
-				    The name of the K3b project file, will be used as
-				    base name for the exported file names.
-				</para>
-			    </listitem>
-			</varlistentry>
-
 			<varlistentry>
 			    <term><replaceable>pattern</replaceable></term>
 			    <listitem>
@@ -5391,39 +5381,21 @@
 			    </listitem>
 			</varlistentry>
 
+			<varlistentry>
+			    <term><replaceable>project file</replaceable></term>
+			    <listitem>
+				<para>
+				    The name of the K3b project file, which will also be used
+				    as the base name for the exported file names.
+				</para>
+			    </listitem>
+			</varlistentry>
+
 			<varlistentry>
 			    <term><replaceable>export location</replaceable></term>
 			    <listitem>
 				<para>
-				    Determines where the blocks should be saved.
-				    <informaltable frame='all'>
-					<tgroup cols='2'>
-					    <thead>
-						<row>
-						    <entry align='left'>value</entry>
-						    <entry align='left'>description</entry>
-						</row>
-					    </thead>
-					    <tbody>
-						<row>
-						    <entry>&no-i18n-tag;<command>0</command></entry>
-						    <entry>
-							Save to the same directory as the
-							K3b project file.
-						    </entry>
-						</row>
-						<row>
-						    <entry>&no-i18n-tag;<command>1</command></entry>
-						    <entry>
-							Save into a subdirectory of the directory of the
-							K3b project file, using the K3b project file
-							name as base and appending
-							<quote><command><literal>.dir</literal></command></quote>.
-						    </entry>
-						</row>
-					    </tbody>
-					</tgroup>
-				    </informaltable>
+				    The location where the blocks should be saved.
 				</para>
 			    </listitem>
 			</varlistentry>
diff --git a/doc/en/kwave-plugin-export_k3b.png b/doc/en/kwave-plugin-export_k3b.png
new file mode 100644
index 000000000..92ae611a5
Binary files /dev/null and b/doc/en/kwave-plugin-export_k3b.png differ



More information about the kde-doc-english mailing list