[frameworks/kdelibs4support] docs: Documentation fixes
Antoni Bella Pérez
null at kde.org
Sat Oct 10 20:35:07 BST 2020
Git commit 5de31cb4e273c3ff126eda932a6862a91c252069 by Antoni Bella Pérez.
Committed on 10/10/2020 at 19:34.
Pushed by bellaperez into branch 'master'.
Documentation fixes
* Use more entities
* Change http: to https:
* Sync GUI messages
* And some punctuation
M +4 -4 docs/kcontrol5/kcm_ssl/index.docbook
M +4 -4 docs/kdebugdialog5/index.docbook
M +20 -20 docs/kf5-config/man-kf5-config.1.docbook
https://invent.kde.org/frameworks/kdelibs4support/commit/5de31cb4e273c3ff126eda932a6862a91c252069
diff --git a/docs/kcontrol5/kcm_ssl/index.docbook b/docs/kcontrol5/kcm_ssl/index.docbook
index f5d3ef17e..7a355b2b9 100644
--- a/docs/kcontrol5/kcm_ssl/index.docbook
+++ b/docs/kcontrol5/kcm_ssl/index.docbook
@@ -40,10 +40,10 @@ certificates</guilabel> are further categorized by the organization that issued
them.</para>
<screenshot id="screenshot-module">
-<screeninfo>The SSL Versions and Certificates Module</screeninfo>
+<screeninfo>The SSL Versions and Certificates module</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="module.png" format="PNG"/></imageobject>
-<textobject><phrase>The SSL Versions and Certificates module.</phrase></textobject>
+<textobject><phrase>The SSL Versions and Certificates module</phrase></textobject>
</mediaobject>
</screenshot>
@@ -51,7 +51,7 @@ them.</para>
<title>Viewing the Details of a Certificate</title>
<para>Select a certificate under a listed organization, and click on the
-<guibutton>Display</guibutton> underneath the list to view the details of the
+<guibutton>Display...</guibutton> underneath the list to view the details of the
certificate.</para>
<screenshot id="screenshot-details">
@@ -86,7 +86,7 @@ holding the &Ctrl; key and then clicking on the <guibutton>Enable</guibutton> or
<title>Adding a Certificate</title>
<!--link file selector dialog to buildingblocks when its done-->
-<para>First, click on the <guibutton>Add</guibutton> button below the certificate
+<para>First, click on the <guibutton>Add...</guibutton> button below the certificate
list. It will open the file selector dialog allowing you to locate where the
certificate files are stored. After locating the certificate file, select it
and click on the <guibutton>Open</guibutton> button to add it.</para>
diff --git a/docs/kdebugdialog5/index.docbook b/docs/kdebugdialog5/index.docbook
index 54f694561..93964d251 100644
--- a/docs/kdebugdialog5/index.docbook
+++ b/docs/kdebugdialog5/index.docbook
@@ -34,10 +34,10 @@ It features a simple and a full mode.</para>
<guilabel>Disable all debug output</guilabel> has to be unchecked.</para>
<note>
-<para>Only for applications using the Frameworks library kdelibs4support.</para>
-<para>kDebug() has been deprecated in &kde; Frameworks 5, in favour of &Qt;'s builtin categorized
-logging, see<ulink url="http://doc.qt.io/qt-5/qloggingcategory.html">QLoggingCategory</ulink>.
-Use the program <ulink url="https://commits.kde.org/kdebugsettings">kdebugsettings</ulink>
+<para>Only for applications using the &frameworks; library kdelibs4support.</para>
+<para>kDebug() has been deprecated in &kf5-full;, in favour of &Qt;'s builtin categorized
+logging, see<ulink url="https://doc.qt.io/qt-5/qloggingcategory.html">QLoggingCategory</ulink>.
+Use the program <ulink url="https://invent.kde.org/utilities/kdebugsettings">KDebugSettings</ulink>
to enable/disable qCDebug.
</para>
</note>
diff --git a/docs/kf5-config/man-kf5-config.1.docbook b/docs/kf5-config/man-kf5-config.1.docbook
index ecc84b1d1..3152ddbd5 100644
--- a/docs/kf5-config/man-kf5-config.1.docbook
+++ b/docs/kf5-config/man-kf5-config.1.docbook
@@ -23,7 +23,7 @@
<refnamediv>
<refname><command>kf5-config</command></refname>
-<refpurpose>Prints &Qt; and Frameworks installation paths</refpurpose>
+<refpurpose>Prints &Qt; and &frameworks; installation paths</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -50,14 +50,14 @@
<refsect1>
<title>Description</title>
-<para>kf5-config is a command line program used to retrieve information
-about Frameworks installation or user paths.</para>
+<para><command>kf5-config</command> is a command line program used to retrieve information
+about &frameworks; installation or user paths.</para>
-<para>Use this program to determine where the various aspects of the Frameworks
+<para>Use this program to determine where the various aspects of the &frameworks;
installation reside on your system.
</para>
-<note><para>kf5-config is mostly a deprecated replacement for kde4-config, while the
+<note><para><command>kf5-config</command> is mostly a deprecated replacement for kde4-config, while the
recommended tool to use instead is qtpaths (which is shipped with &Qt;).
</para></note>
</refsect1>
@@ -69,63 +69,63 @@ recommended tool to use instead is qtpaths (which is shipped with &Qt;).
<varlistentry>
<term><option>--expandvars</option></term>
<listitem>
-<para>expand ${prefix} and ${exec_prefix} in output</para>
+<para>Expand ${prefix} and ${exec_prefix} in output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--prefix</option></term>
<listitem>
-<para>Compiled in prefix for Frameworks libraries</para>
+<para>Compiled in prefix for &frameworks; libraries.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--exec-prefix</option></term>
<listitem>
-<para>Compiled in exec_prefix for Frameworks libraries</para>
+<para>Compiled in exec_prefix for &frameworks; libraries.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--libsuffix</option></term>
<listitem>
-<para>Compiled in library path suffix</para>
+<para>Compiled in library path suffix.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--localprefix</option></term>
<listitem>
-<para>Prefix in $<envar>HOME</envar> used to write files</para>
+<para>Prefix in $<envar>HOME</envar> used to write files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem>
-<para>Version of &Qt; and compiled in version string for Frameworks libraries and kf5-config</para>
+<para>Version of &Qt; and compiled in version string for &frameworks; libraries and <command>kf5-config</command>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--kde-version</option></term>
<listitem>
-<para>Compiled in version string for Frameworks libraries</para>
+<para>Compiled in version string for &frameworks; libraries.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--types</option></term>
<listitem>
-<para>Print a list of all available &kde; resource types</para>
+<para>Print a list of all available &kde; resource types.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--path <replaceable>type</replaceable></option></term>
<listitem>
-<para>Search path for the specified <replaceable>type</replaceable></para>
+<para>Search path for the specified <replaceable>type</replaceable>.</para>
</listitem>
</varlistentry>
@@ -139,35 +139,35 @@ recommended tool to use instead is qtpaths (which is shipped with &Qt;).
<varlistentry>
<term><option>--install <replaceable>type</replaceable></option></term>
<listitem>
-<para>Prefix to install resource files to</para>
+<para>Prefix to install resource files to.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--qt-prefix</option></term>
<listitem>
-<para>Installation prefix for &Qt;</para>
+<para>Installation prefix for &Qt;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--qt-binaries</option></term>
<listitem>
-<para>Location of installed &Qt; binaries</para>
+<para>Location of installed &Qt; binaries.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--qt-libraries</option></term>
<listitem>
-<para>Location of installed &Qt; libraries</para>
+<para>Location of installed &Qt; libraries.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--qt-plugins</option></term>
<listitem>
-<para>Location of installed &Qt; plugins</para>
+<para>Location of installed &Qt; plugins.</para>
</listitem>
</varlistentry>
@@ -177,7 +177,7 @@ recommended tool to use instead is qtpaths (which is shipped with &Qt;).
<refsect1>
<title>Examples</title>
-<para>Print the top-level Frameworks installation directory:</para>
+<para>Print the top-level &frameworks; installation directory:</para>
<para>
<prompt>%</prompt><userinput> <command>kf5-config --prefix</command>
</userinput>
More information about the kde-doc-english
mailing list