[frameworks/kservice] docs: Documentation fixes
Antoni Bella Pérez
null at kde.org
Sat Oct 10 20:29:56 BST 2020
Git commit 52bc3e9234e08ce3a2e5dbce6eb780814e66a0ee by Antoni Bella Pérez.
Committed on 10/10/2020 at 19:29.
Pushed by bellaperez into branch 'master'.
Documentation fixes
* Use more entities
* Change http: to https:
* And some punctuation
M +7 -7 docs/desktoptojson/man-desktoptojson.8.docbook
M +10 -10 docs/kbuildsycoca5/man-kbuildsycoca5.8.docbook
https://invent.kde.org/frameworks/kservice/commit/52bc3e9234e08ce3a2e5dbce6eb780814e66a0ee
diff --git a/docs/desktoptojson/man-desktoptojson.8.docbook b/docs/desktoptojson/man-desktoptojson.8.docbook
index 27c287e..6f0e73c 100644
--- a/docs/desktoptojson/man-desktoptojson.8.docbook
+++ b/docs/desktoptojson/man-desktoptojson.8.docbook
@@ -6,7 +6,7 @@
<refentry lang="&language;">
<refentryinfo>
-<title>&kde; Frameworks: KService</title>
+<title>&kde-frameworks;: KService</title>
<author>
<firstname>Scarlett</firstname>
<surname>Clark</surname>
@@ -65,9 +65,9 @@
<refsect1>
<title>Description</title>
-<para>The KService framework uses information contained in <filename class="extension">.desktop</filename> files to locate services, including plugins for Qt5-based applications and libraries. The Qt5 plugin system, however, uses JSON data embedded in the plugin itself. <command>desktoptojson</command> allows the information contained in a <filename class="extension">.desktop</filename> file to also be used as the embedded data for a Qt5 plugin by converting the <filename class="extension">.desktop</filename> file entries into JSON data.</para>
+<para>The KService framework uses information contained in <filename class="extension">.desktop</filename> files to locate services, including plugins for Qt5-based applications and libraries. The Qt5 plugin system, however, uses &JSON; data embedded in the plugin itself. <command>desktoptojson</command> allows the information contained in a <filename class="extension">.desktop</filename> file to also be used as the embedded data for a Qt5 plugin by converting the <filename class="extension">.desktop</filename> file entries into &JSON; data.</para>
-<para>The generated JSON data is a JSON object that maps the entries from the <literal>[Desktop Entry]</literal> group of the <filename class="extension">.desktop</filename> file. Any other groups are ignored. Most entries are just converted to JSON strings, but certain entries (such as <literal>Hidden</literal> and <literal>X-KDE-PluginInfo-EnabledByDefault</literal>) are known to be boolean values and converted as such, and similarly some (such as <literal>X-KDE-ServiceTypes</literal> and <literal>X-KDE-PluginInfo-Depends</literal>) are always converted to arrays of strings.</para>
+<para>The generated &JSON; data is a &JSON; object that maps the entries from the <literal>[Desktop Entry]</literal> group of the <filename class="extension">.desktop</filename> file. Any other groups are ignored. Most entries are just converted to &JSON; strings, but certain entries (such as <literal>Hidden</literal> and <literal>X-KDE-PluginInfo-EnabledByDefault</literal>) are known to be boolean values and converted as such, and similarly some (such as <literal>X-KDE-ServiceTypes</literal> and <literal>X-KDE-PluginInfo-Depends</literal>) are always converted to arrays of strings.</para>
</refsect1>
@@ -86,7 +86,7 @@
<varlistentry>
<term><option>--output <replaceable>JSON-FILE</replaceable></option></term>
<listitem>
-<para>The file to write the generated JSON data to.</para>
+<para>The file to write the generated &JSON; data to.</para>
</listitem>
</varlistentry>
@@ -112,7 +112,7 @@
<refsect1>
<title>Usage</title>
<para>
-Most users of this utility will use the CMake macro
+Most users of this utility will use the &cmake; macro
<function>kservice_desktop_to_json</function> as part of the process of building
a plugin.
<programlisting language="cmake">
@@ -121,7 +121,7 @@ add_library(myplugin MODULE ${myplugin_SRCS})
kservice_desktop_to_json(myplugin myplugin.desktop)
]]>
</programlisting>
-This will produce the JSON file <filename>myplugin.json</filename>, which can be
+This will produce the &JSON; file <filename>myplugin.json</filename>, which can be
referenced from the <function>K_PLUGIN_FACTORY_WITH_JSON</function> or
<function>Q_PLUGIN_METADATA</function> macros.
</para>
@@ -131,7 +131,7 @@ referenced from the <function>K_PLUGIN_FACTORY_WITH_JSON</function> or
<refsect1>
<title>Bugs</title>
-<para>Please use <ulink url="http://bugs.kde.org">KDE's bugtracker</ulink> to report bugs.</para>
+<para>Please use <ulink url="https://bugs.kde.org">&kde;'s bugtracker</ulink> to report bugs.</para>
</refsect1>
</refentry>
diff --git a/docs/kbuildsycoca5/man-kbuildsycoca5.8.docbook b/docs/kbuildsycoca5/man-kbuildsycoca5.8.docbook
index 3148e53..eeba59a 100644
--- a/docs/kbuildsycoca5/man-kbuildsycoca5.8.docbook
+++ b/docs/kbuildsycoca5/man-kbuildsycoca5.8.docbook
@@ -18,7 +18,7 @@
<author>
<firstname>Alex</firstname>
<surname>Merry</surname>
-<contrib>Updated the documentation for &kde; Frameworks 5.</contrib>
+<contrib>Updated the documentation for &kf5-full;.</contrib>
<affiliation>
<address><email>alexmerry at kde.org</email></address>
</affiliation>
@@ -37,7 +37,7 @@
<refnamediv>
<refname><command>kbuildsycoca5</command></refname>
-<refpurpose>Rebuilds the KService desktop file system configuration cache.</refpurpose>
+<refpurpose>Rebuilds the KService desktop file system configuration cache</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -57,7 +57,7 @@
<para>
<command>kbuildsycoca5</command> builds binary cache of the data stored in
-<literal role="extension">.desktop</literal> and MIME type <literal
+<literal role="extension">.desktop</literal> and &MIME; type <literal
role="extension">.xml</literal> files that the KService framework uses to find
plugins, applications and other services.
</para>
@@ -82,7 +82,7 @@ it if necessary, when any of the files whose data is cached are changed.
<varlistentry>
<term><option>--global</option></term>
<listitem>
-<para>Ignores any user-set files (in <varname>XDG_DATA_HOME</varname>). This is currently only supported on Unix systems.</para>
+<para>Ignores any user-set files (in <varname>XDG_DATA_HOME</varname>). This is currently only supported on &UNIX; systems.</para>
</listitem>
</varlistentry>
@@ -96,21 +96,21 @@ it if necessary, when any of the files whose data is cached are changed.
<varlistentry>
<term><option>--nosignal</option></term>
<listitem>
-<para>Ordinarily, <command>kbuildsycoca5</command> sends a signal over D-Bus once the cache is updated to all the applications that use KService so that they are always working with the latest information. This option suppresses that behaviour.</para>
+<para>Ordinarily, <command>kbuildsycoca5</command> sends a signal over &DBus; once the cache is updated to all the applications that use KService so that they are always working with the latest information. This option suppresses that behaviour.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--menutest</option></term>
<listitem>
-<para>Test the generation of the application menu database. Does not actually build the cache.</para>
+<para>Test the generation of the application menu database. Does not actually build the cache.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--testmode</option></term>
<listitem>
-<para>Use the QStandardPaths "test mode" to avoid interfering with user data. This is intended for use with unit tests.</para>
+<para>Use the QStandardPaths "test mode" to avoid interfering with user data. This is intended for use with unit tests.</para>
</listitem>
</varlistentry>
@@ -168,8 +168,8 @@ Show version information.
<varlistentry>
<term><filename><varname>cachedir</varname>/ksycoca5_[lang]_[sha1-of-dirs]</filename></term>
<listitem>
-<para>The KService cache generated by <command>kbuildsycoca5</command>. On Unix systems, <varname>cachedir</varname>
-is typically <filename class="directory"><envar>XDG_CONFIG_HOME</envar></filename></para>
+<para>The KService cache generated by <command>kbuildsycoca5</command>. On &UNIX; systems, <varname>cachedir</varname>
+is typically <filename class="directory"><envar>XDG_CACHE_HOME</envar></filename>.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -189,7 +189,7 @@ is typically <filename class="directory"><envar>XDG_CONFIG_HOME</envar></filenam
<refsect1>
<title>Bugs</title>
-<para>Please use <ulink url="http://bugs.kde.org">KDE's bugtracker</ulink> to report bugs.</para>
+<para>Please use <ulink url="https://bugs.kde.org">&kde;'s bugtracker</ulink> to report bugs.</para>
</refsect1>
</refentry>
More information about the kde-doc-english
mailing list