Git commit 63f6bad2f34ad2ebba1388fbaffe0f5a06a626d1 by Antoni Bella Pérez. Committed on 09/10/2021 at 15:44. Pushed by bellaperez into branch 'master'.
Documentation updates * Update date and version numbers * Remove a final whitespace * Add a keyword * Change http: to https: * Suitable tags, capitalization and punctuation M +6 -7 doc/index.docbook M +16 -20 doc/man-atlantik.6.docbook https://invent.kde.org/games/atlantik/commit/63f6bad2f34ad2ebba1388fbaffe0f5a06a626d1 diff --git a/doc/index.docbook b/doc/index.docbook index b0f808f..a2c692f 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -34,8 +34,7 @@ <abstract> <para> -&atlantik; is a &kde; client for playing &Monopoly;-like board games on the -&monopd; network. +&atlantik; is a client for playing &Monopoly;-like board games on the &monopd; network. </para> </abstract> @@ -43,7 +42,7 @@ <keywordset> <keyword>KDE</keyword> -<keyword>kdegames</keyword> +<keyword>network client</keyword> <keyword>Atlantik</keyword> <keyword>monopd</keyword> </keywordset> @@ -72,7 +71,7 @@ Internet connection, you can request a list of public Internet servers and you will not require additional software. If you want to play &atlantik; locally, on a <acronym>LAN</acronym> or on a private Internet server, you can enter the hostname and port to connect to. In this case, you will need -the <ulink url="http://gtkatlantic.gradator.net/";>&monopd;</ulink> server +the <ulink url="https://gtkatlantic.gradator.net/";>&monopd;</ulink> server software installed and running on the host you are connecting to.</para> <para>If you have problems connecting to a server, the following troubleshoot @@ -100,13 +99,13 @@ your system administrator.</para> <variablelist> <varlistentry> <term><menuchoice> -<guimenu>Game</guimenu><guimenuitem>Show Event Log</guimenuitem></menuchoice></term> +<guimenu>Game</guimenu><guimenuitem>Show Event Log...</guimenuitem></menuchoice></term> <listitem><para><action>Display</action> the event log window.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> -<guimenu>Game</guimenu><guimenuitem>Reconnect (after crash)</guimenuitem></menuchoice></term> +<guimenu>Game</guimenu><guimenuitem>Reconnect (After Crash)</guimenuitem></menuchoice></term> <listitem><para><action>Reconnect</action> to the last game. This is available only in case &atlantik; did not quit cleanly from a game (usually because it crashed), and cannot be done anymore once you connect to a server.</para></listitem> @@ -249,7 +248,7 @@ involved with tradeable items.</para> </chapter> -&documentation.index; +&documentation.index; </book> diff --git a/doc/man-atlantik.6.docbook b/doc/man-atlantik.6.docbook index 43929b8..a63df30 100644 --- a/doc/man-atlantik.6.docbook +++ b/doc/man-atlantik.6.docbook @@ -8,15 +8,16 @@ <refentry lang="&language;"> <refentryinfo> -<title>Atlantik User's Manual</title> +<title>&atlantik; Manual Page</title> <author><firstname>Lauri</firstname><surname>Watts</surname> -<contrib>Atlantik man page.</contrib> -<email>[email protected]</email></author> +<contrib>&atlantik; man page.</contrib> +&Lauri.Watts.mail;</author> <author><firstname>Pino</firstname><surname>Toscano</surname> -<contrib>Atlantik man page.</contrib> +<contrib>&atlantik; man page.</contrib> <email>[email protected]</email></author> -<date>2017-05-13</date> -<releaseinfo>Atlantik 0.7.80</releaseinfo> +<date>2021-10-10</date> +<releaseinfo>(KDE Gear 21.08)</releaseinfo> +<productname>&atlantik; 0.7</productname> </refentryinfo> <refmeta> @@ -26,13 +27,13 @@ <refnamediv> <refname>atlantik</refname> -<refpurpose>&kde; monopd client</refpurpose> +<refpurpose>A monopd client</refpurpose> </refnamediv> <refsynopsisdiv id='synopsis'> <cmdsynopsis> <command>atlantik</command> -<arg choice="opt"><replaceable>Atlantik options</replaceable></arg> +<arg choice="opt"><replaceable>options</replaceable></arg> </cmdsynopsis> </refsynopsisdiv> @@ -41,7 +42,7 @@ <title>Description</title> <para> -&atlantik; is a &kde; client for playing &Monopoly;-like board games on the +&atlantik; is a client for playing &Monopoly;-like board games on the &monopd; network. </para> @@ -57,7 +58,7 @@ board game known as &Monopoly;.</para> </refsect1> <refsect1 id="options"> -<title>Atlantik options</title> +<title>Options</title> <variablelist> <title>&atlantik; options</title> @@ -70,12 +71,12 @@ board game known as &Monopoly;.</para> <varlistentry> <term><option>-p, --port</option> <parameter>port</parameter></term> -<listitem><para>Connect to this port</para></listitem> +<listitem><para>Connect to this port.</para></listitem> </varlistentry> <varlistentry> <term><option>-g, --game</option> <parameter>game</parameter></term> -<listitem><para>Join this game</para></listitem> +<listitem><para>Join this game.</para></listitem> </varlistentry> </variablelist> @@ -84,15 +85,10 @@ board game known as &Monopoly;.</para> <refsect1> <title>See Also</title> -<simplelist> -<member>More detailed user documentation is available from <ulink +<para>More detailed user documentation is available from <ulink url="help:/atlantik">help:/atlantik</ulink> (either enter this -<acronym>URL</acronym> into &konqueror;, or run -<userinput><command>khelpcenter</command> -<parameter>help:/atlantik</parameter></userinput>).</member> -<member>kf5options(7)</member> -<member>qt5options(7)</member> -</simplelist> +&URL;, or run <userinput><command>khelpcenter</command> +<parameter>help:/atlantik</parameter></userinput>).</para> </refsect1>
