Git commit d303884ffbf0305b22fcd5118149a72f611b4181 by Antoni Bella Pérez. Committed on 10/10/2020 at 19:32. Pushed by bellaperez into branch 'master'.
Documentation fixes * Use more entities * Change http: to https: * And some punctuation M +3 -2 docs/checkXML5/man-checkXML5.1.docbook M +4 -4 docs/kf5options/man-kf5options.7.docbook M +12 -12 docs/meinproc5/man-meinproc5.1.docbook M +12 -12 docs/qt5options/man-qt5options.7.docbook https://invent.kde.org/frameworks/kdoctools/commit/d303884ffbf0305b22fcd5118149a72f611b4181 diff --git a/docs/checkXML5/man-checkXML5.1.docbook b/docs/checkXML5/man-checkXML5.1.docbook index c6a54d5c..7eca7963 100644 --- a/docs/checkXML5/man-checkXML5.1.docbook +++ b/docs/checkXML5/man-checkXML5.1.docbook @@ -19,7 +19,7 @@ <refnamediv> <refname><command>checkXML5</command></refname> -<refpurpose>An &XML; lint tool for &kde; DocBook &XML; documents.</refpurpose> +<refpurpose>An &XML; lint tool for &kde; DocBook &XML; documents</refpurpose> </refnamediv> <refsynopsisdiv> @@ -32,7 +32,7 @@ <title>Description</title> <para><command>checkXML5</command> is a tool to check for syntax errors in &kde; -DocBook &XML; files. It can also be used for other DocBook based +DocBook &XML; files. It can also be used for other DocBook based &XML; files, but you should use the less specific xmllint(1) tool if you are not writing or otherwise working on &kde; documentation.</para> @@ -43,3 +43,4 @@ documentation.</para> <para>meinproc5(1) xmllint(1)</para> </refsect1> </refentry> + diff --git a/docs/kf5options/man-kf5options.7.docbook b/docs/kf5options/man-kf5options.7.docbook index de95cd44..2ced6c75 100644 --- a/docs/kf5options/man-kf5options.7.docbook +++ b/docs/kf5options/man-kf5options.7.docbook @@ -5,7 +5,7 @@ <refentry lang="&language;"> <refentryinfo> -<title>Frameworks Command Line Documentation</title> +<title>&frameworks; Command Line Documentation</title> <author>&Lauri.Watts; &Lauri.Watts.mail;</author> <date>2016-05-13</date> <releaseinfo>Frameworks 5.22</releaseinfo> @@ -19,7 +19,7 @@ <refnamediv> <refname>kf5options</refname> -<refpurpose>Common commandline options for all applications based on KDE Frameworks 5</refpurpose> +<refpurpose>Common commandline options for all applications based on &kf5-full;</refpurpose> </refnamediv> <refsynopsisdiv> @@ -41,7 +41,7 @@ <variablelist> <varlistentry> <term><option>-h</option> <option>--help</option></term> -<listitem><para>This lists the options available at the command line</para> +<listitem><para>This lists the options available at the command line.</para> </listitem> </varlistentry> @@ -83,7 +83,7 @@ file can put its own name into the exec command. <refsect1> <title>Authors</title> <para>Man page originally written by &Lauri.Watts; &Lauri.Watts.mail; for kdelibs4</para> -<para>Updated to Frameworks 5 by &Burkhard.Lueck; &Burkhard.Lueck.mail;</para> +<para>Updated to &frameworks; 5 by &Burkhard.Lueck; &Burkhard.Lueck.mail;</para> </refsect1> </refentry> diff --git a/docs/meinproc5/man-meinproc5.1.docbook b/docs/meinproc5/man-meinproc5.1.docbook index e2fc3588..b64aa261 100644 --- a/docs/meinproc5/man-meinproc5.1.docbook +++ b/docs/meinproc5/man-meinproc5.1.docbook @@ -47,7 +47,7 @@ Also, based on the information from http://olympus.het.brown.edu/cgi-bin/man/man <refnamediv> <refname><command>meinproc5</command></refname> -<refpurpose>&kde; translator for XML</refpurpose> +<refpurpose>&kde; translator for &XML;</refpurpose> </refnamediv> <refsynopsisdiv> @@ -79,7 +79,7 @@ Also, based on the information from http://olympus.het.brown.edu/cgi-bin/man/man <refsect1> <title>Description</title> -<para><command>meinproc5</command> converts DocBook files to HTML. +<para><command>meinproc5</command> converts DocBook files to &HTML;. </para> </refsect1> @@ -101,7 +101,7 @@ Show help about options. <term><option>-v</option><option>--version</option></term> <listitem> <para> -Show version information +Show version information. </para> </listitem> </varlistentry> @@ -118,7 +118,7 @@ Show version information <term><option>--cache</option> <parameter>file</parameter></term> <listitem> <para> -Create a cache file for the document +Create a cache file for the document. </para> </listitem> </varlistentry> @@ -126,7 +126,7 @@ Create a cache file for the document <varlistentry> <term><option>--check</option></term> <listitem> -<para>Check the document for validity</para> +<para>Check the document for validity.</para> <screen>The output can be a bit daunting, since one small mistake can cause a cascade of errors. The trick is to look at the first error, fix that error, save the file, and run <command>meinproc5</command> again. </screen> @@ -155,7 +155,7 @@ Output whole document to stdout. <term><option>--stylesheet</option> <parameter>xsl</parameter></term> <listitem> <para> -Stylesheet to use +Stylesheet to use. </para> </listitem> </varlistentry> @@ -164,7 +164,7 @@ Stylesheet to use <term><option>--srcdir</option> <parameter>dir</parameter></term> <listitem> <para> - Set the root directory to look for kdoctools + Set the root directory to look for kdoctools. </para> </listitem> </varlistentry> @@ -191,16 +191,16 @@ The most common way to run <command>meinproc5</command> is simply as </userinput> </literallayout> where <replaceable>docbook-file</replaceable> is usually index.docbook. -This command creates HTML pages from the DocBook file. -Note that these pages are only viewable in KDE-based browsers (like Konqueror). +This command creates &HTML; pages from the DocBook file. +Note that these pages are only viewable in &kde;-based browsers (like &konqueror;). </para> <para> -If you need to view the HTML output in another browser (for example, if you're placing it on line), use +If you need to view the &HTML; output in another browser (for example, if you're placing it on line), use <literallayout> <userinput><command>meinproc5</command> --stylesheet <replaceable>stylesheet-name</replaceable> <replaceable>docbook-file</replaceable> </userinput> </literallayout> -where <replaceable>stylesheet-name</replaceable> is the full path to one of the XSL +where <replaceable>stylesheet-name</replaceable> is the full path to one of the &XSL; stylesheets in <kdoctools_installation_prefix>/share/kf5/kdoctools/customization/. To produce output suitable for the web, you can use <command>kde-web.xsl</command> or <command>kde-chunk-online.xsl</command>. See the README @@ -216,7 +216,7 @@ file in that directory for more details. <refsect1> <title>Bugs</title> -<para>Please use <ulink url="https://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/qt5options/man-qt5options.7.docbook b/docs/qt5options/man-qt5options.7.docbook index 05772598..a79816a7 100644 --- a/docs/qt5options/man-qt5options.7.docbook +++ b/docs/qt5options/man-qt5options.7.docbook @@ -5,11 +5,11 @@ <refentry lang="&language;"> <refentryinfo> -<title>Qt Command Line Documentation</title> +<title>&Qt; Command Line Documentation</title> <author>&Lauri.Watts; &Lauri.Watts.mail;</author> <author>&Burkhard.Lueck; &Burkhard.Lueck.mail;</author> <date>2016-06-04</date> -<releaseinfo>&Qt; 5.4</releaseinfo> +<releaseinfo>Qt 5.4</releaseinfo> <productname>KDE Frameworks</productname> </refentryinfo> @@ -20,7 +20,7 @@ <refnamediv> <refname>qt5options</refname> -<refpurpose>Common commandline options for all applications based on the Qt toolkit</refpurpose> +<refpurpose>Common commandline options for all applications based on the &Qt; toolkit</refpurpose> </refnamediv> <refsynopsisdiv> @@ -47,7 +47,7 @@ <arg choice="opt"><option>-dialogs=</option> <replaceable>[xp|none]</replaceable></arg> <arg choice="opt"><option>-fontengine=</option> <replaceable>freetype</replaceable></arg> <!--https://doc.qt.io/qt-5/qcommandlineparser.html --> -<arg choice="opt"><option>-h, --help and -? on Windows</option></arg> +<arg choice="opt"><option>-h, --help and -? on &Windows;</option></arg> <arg choice="opt"><option>-v --version</option></arg> </cmdsynopsis> </refsynopsisdiv> @@ -65,8 +65,8 @@ <option>-style=</option> <replaceable>style</replaceable> / <option>-style</option> <replaceable>style</replaceable> </term> <listitem><para> -Set the application GUI style. Possible values depend on the system configuration. -If Qt is compiled with additional styles or has additional styles as plugins these will be available to the -style command line option.</para> +Set the application &GUI; style. Possible values depend on the system configuration. +If &Qt; is compiled with additional styles or has additional styles as plugins these will be available to the -style command line option.</para> </listitem> </varlistentry> @@ -115,7 +115,7 @@ where block is optional and will make the application wait until a debugger conn <option>-platform</option> <replaceable>platformName[:options]</replaceable> </term> <listitem><para> -Specify the Qt Platform Abstraction (QPA) plugin. +Specify the &Qt; Platform Abstraction (QPA) plugin. </para></listitem> </varlistentry> @@ -151,7 +151,7 @@ Specify additional plugins to load. The argument may appear multiple times. <option>-qwindowgeometry</option> <replaceable>geometry</replaceable> </term> <listitem><para> -Specify the window geometry for the main window using the X11-syntax. For example: -qwindowgeometry 100x100+50+50 +Specify the window geometry for the main window using the &X11;-syntax. For example: -qwindowgeometry 100x100+50+50 </para></listitem> </varlistentry> @@ -187,7 +187,7 @@ Restore the application from an earlier session. <option>-display</option> <replaceable>hostname:screen_number</replaceable> </term> <listitem><para> -Switch displays on X11. Overrides the DISPLAY environment variable. +Switch displays on &X11;. Overrides the DISPLAY environment variable. </para></listitem> </varlistentry> @@ -196,7 +196,7 @@ Switch displays on X11. Overrides the DISPLAY environment variable. <option>-geometry</option> <replaceable>geometry</replaceable> </term> <listitem><para> -Specify the window geometry for the main window on X11. For example: -geometry 100x100+50+50. +Specify the window geometry for the main window on &X11;. For example: -geometry 100x100+50+50 </para></listitem> </varlistentry> @@ -221,7 +221,7 @@ Use the FreeType font engine. <!--https://doc.qt.io/qt-5/qcommandlineparser.html --> <varlistentry> <term> -<option>-h, --help and -? on Windows</option> +<option>-h, --help and -? on &Windows;</option> </term> <listitem><para> Print all options and the application description. @@ -251,7 +251,7 @@ Display the version string of the application. <refsect1> <title>Authors</title> <para>Man page originally written by &Lauri.Watts; &Lauri.Watts.mail;</para> -<para>Updated to Frameworks 5 by &Burkhard.Lueck; &Burkhard.Lueck.mail;</para> +<para>Updated to &frameworks; 5 by &Burkhard.Lueck; &Burkhard.Lueck.mail;</para> <para>The infos for this man page are from <ulink url="https://doc.qt.io/qt-5/qapplication.html#QApplication";>QApplication documentation</ulink>, <ulink url="https://doc.qt.io/qt-5/qguiapplication.html#QGuiApplication";>QGuiApplication documentation</ulink> and <ulink url="https://doc.qt.io/qt-5/qcommandlineparser.html";>QCommandLineParser documentation</ulink>.</para>
