[games/amor] doc: Documentation updates

Antoni Bella Pérez null at kde.org
Sat Oct 9 14:42:03 BST 2021 

Git commit 11aaaa67cded7a781af8c5d5a0efef985612a606 by Antoni Bella Pérez.
Committed on 09/10/2021 at 13:41.
Pushed by bellaperez into branch 'master'.

Documentation updates

* Update date and version numbers
* Suitable tags, punctuation and some improves (update to oneko-sakura, current app)
* GUI sync
* Change http: to https:
* Rework the man page

M  +10   -17   doc/index.docbook
M  +16   -22   doc/man-amor.6.docbook

https://invent.kde.org/games/amor/commit/11aaaa67cded7a781af8c5d5a0efef985612a606

diff --git a/doc/index.docbook b/doc/index.docbook
index bf0c443..89ad41f 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -24,8 +24,8 @@
 
 <legalnotice>&FDLNotice;</legalnotice>
 
-<date>2010-02-08</date>
-<releaseinfo>2.3.1 (&kde; 4.4)</releaseinfo>
+<date>2021-10-09</date>
+<releaseinfo>2.4.0 (KDE Gear 21.08)</releaseinfo>
 
 <abstract>
 <para>
@@ -69,10 +69,9 @@ known to work at the time of this writing.</para></note>
 <para>To configure &amor;, click on the animation using your &RMB;.  A menu
 will appear containing three items:
 <guimenuitem>Configure...</guimenuitem>,
-<guimenuitem>Help...</guimenuitem>, and
-<guimenuitem>Quit</guimenuitem>.  Choose
-<guimenuitem>Configure...</guimenuitem> to configure &amor;
-</para>
+<guisubmenu>Help</guisubmenu>, and
+<guimenuitem>Quit</guimenuitem>.</para>
+<para>Choose <guimenuitem>Configure...</guimenuitem> to configure &amor;.</para>
 </sect1>
 
 <sect1 id="general-options">
@@ -80,11 +79,11 @@ will appear containing three items:
 <para>The following settings for &amor; can be changed from the Options
 dialog:</para>
 <variablelist>
-<varlistentry><term><guilabel>Theme</guilabel></term>
+<varlistentry><term><guilabel>Theme:</guilabel></term>
 <listitem><para>This determines the appearance and behavior of &amor;.
 Themes are described in the next section.</para></listitem>
 </varlistentry>
-<varlistentry><term><guilabel>Offset</guilabel></term>
+<varlistentry><term><guilabel>Offset:</guilabel></term>
 <listitem><para>This slider controls where the animation appears in
 relation to the top of the active window.  The default middle setting will
 place the animation right above the window title bar, whereas setting the
@@ -188,15 +187,9 @@ by <personname><firstname>Jean-Claude</firstname><surname>Dumas</surname></perso
 </imageobject></mediaobject>
 </entry>
 <entry><phrase>Neko</phrase></entry>
-<entry><para>Neko is a cat theme by <personname><firstname>Chris</firstname><surname>Spiegel</surname></personname>.  The graphics are
-originally from <application>Oneko</application>, which was written by
+<entry><para>Neko is a cat theme by <personname><firstname>Chris</firstname><surname>Spiegel</surname></personname>. The graphics are originally from <application>Oneko</application>, which was written by
 <personname><firstname>Masayuki</firstname><surname>Koba</surname></personname>.</para>
-<note><para><application>Oneko</application> is a small application which
-features a cat chasing the mouse cursor.  The application appears to no
-longer be maintained, but the
-<ulink url="ftp://sunsite.unc.edu/pub/Linux/X11/demos/oneko-1.1b.tar.gz">
-source code</ulink> from the last version is still
-available.</para></note></entry>
+<note><para><application>Oneko</application> is a small application which features a cat chasing the mouse cursor. The application appears to no longer be maintained, but the <ulink url="http://www.daidouji.com/oneko/">oneko-sakura</ulink> is a modified version.</para></note></entry>
 </row>
 
 <row>
@@ -208,7 +201,7 @@ available.</para></note></entry>
 <entry><phrase>Tux</phrase></entry>
 <entry><para>This theme features Tux, the &Linux; mascot.  The actual
 graphics come from a <application>Lemmings</application>-style game
-called <ulink url="http://pingus.seul.org/">
+called <ulink url="https://pingus.seul.org/">
 <application>Pingus</application></ulink>.  The Tux theme was created by
 <personname><firstname>Frank</firstname><surname>Pieczynski</surname></personname>.</para></entry>
 </row>
diff --git a/doc/man-amor.6.docbook b/doc/man-amor.6.docbook
index 96c68ea..f77064f 100644
--- a/doc/man-amor.6.docbook
+++ b/doc/man-amor.6.docbook
@@ -1,13 +1,15 @@
 <?xml version="1.0" ?>
 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
-<!-- <!ENTITY kdeoptions SYSTEM "kdeoptions.docbook"> -->
-<!-- <!ENTITY qtoptions SYSTEM "qtoptions.docbook"> -->
+
 <!ENTITY % English "INCLUDE">
 ]>
 
 <refentry lang="&language;">
 <refentryinfo>
-<date>2003-03-07</date>
+<title>&amor; Manual Page</title>
+<date>2021-10-09</date>
+<releaseinfo>(KDE Gear 21.08)</releaseinfo>
+<productname>&amor; 2.4.0</productname>
 </refentryinfo>
 
 <refmeta>
@@ -17,29 +19,20 @@
 
 <refnamediv>
 <refname><command>amor</command></refname>
-<refpurpose>A &kde; creature for your desktop</refpurpose>
+<refpurpose>A creature for your &plasma; desktop</refpurpose>
 </refnamediv>
 
-<refsynopsisdiv>
-<cmdsynopsis>
-<command>amor</command>
-<group><option>KDE Generic Options</option></group>
-<group><option>Qt Generic Options</option></group>
-</cmdsynopsis>
-</refsynopsisdiv>
-
-<refsect1>
+<refsect1 id="description">
 <title>Description</title>
 
 <para><acronym>AMOR</acronym> stands for <quote>Amusing Misuse Of
-Resources</quote>.  It provides several different characters who
+Resources</quote>. It provides several different characters who
 prance around your X screen doing tricks and giving you tips.</para>
 
-<para>&amor; is part of the &kde; toys package.</para>
-
 </refsect1>
 
-<refsect1>
+
+<refsect1 id="options">
 <title>Options</title>
 
 <para>&amor; is configured graphically, and does not have any
@@ -51,9 +44,10 @@ options.</para>
 <refsect1>
 <title>See Also</title>
 
-<para>You can enter
-<userinput>help:/amor</userinput> in &konqueror; to see the
-comprehensive user manual.</para>
+<para>More detailed user documentation is available from <ulink
+url="help:/amor">help:/amor</ulink> (either enter this &URL;
+into &konqueror;, or run <userinput><command>khelpcenter</command>
+<parameter>help:/amor</parameter></userinput>).</para>
 
 </refsect1>
 
@@ -65,8 +59,8 @@ comprehensive user manual.</para>
 
 <refsect1>
 <title>Authors</title>
-<para>&amor; was written by <personname><firstname>Martin</firstname><othername>R.</othername><surname>Jones</surname></personname> <email>mjones at kde.org</email>. 
- This manual page was prepared by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab at debian.org</email> for the Debian GNU/Linux system (but may be used by others).</para>
+<para>&amor; was written by &Martin.R.Jones; &Martin.R.Jones.mail;.</para>
+<para>This manual page was prepared by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab at debian.org</email> for the &Debian; &GNU;/&Linux; system (but may be used by others).</para>
 </refsect1>
 
 </refentry>

More information about the kde-doc-english mailing list