[kde-doc-english] [kig] doc: Update documentation (man + doc)

Fri Jan 29 00:51:13 UTC 2016

Git commit 173c0d85e0db376dfeac10891f6b8f929d4a5b55 by Luigi Toscano.
Committed on 28/01/2016 at 23:42.
Pushed by ltoscano into branch 'master'.

Update documentation (man + doc)

- update version data according the new release (doc and man);
- remove personal references for reviews and experiences;
- update the list of authors;
- remove installation+compilation instruction (as for new doc guideline);
- remove useless 'package' entity;
- update options in the man page.

REVIEW: 125421

M  +26   -37   doc/index.docbook
M  +8    -6    doc/man-kig.1.docbook

http://commits.kde.org/kig/173c0d85e0db376dfeac10891f6b8f929d4a5b55

diff --git a/doc/index.docbook b/doc/index.docbook
index ef3bde1..a1514bf 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -3,7 +3,6 @@
 <!ENTITY kseg "<application>KSeg</application>">
 <!ENTITY cabri "<application>Cabri</application>">
 <!ENTITY drgeo "<application>Dr.Geo</application>">
-<!ENTITY package "kdeedu">
 <!ENTITY kappname "&kig;">
 <!ENTITY % addindex "IGNORE">
 <!ENTITY % English "INCLUDE">
@@ -34,11 +33,12 @@ Devriese</holder>
 
 <legalnotice>&FDLNotice;</legalnotice>
 
-<date>2010-02-07</date> <releaseinfo>1.0 (&kde; 4.4)</releaseinfo>
+<date>2015-09-27</date>
+<releaseinfo>&kig; 1.0 (Applications 15.12)</releaseinfo>
 
 <abstract>
 <para>
-&kig; is a &kde; application for Interactive Geometry.
+&kig; is an application for Interactive Geometry by &kde;.
 </para>
 </abstract>
 
@@ -77,17 +77,16 @@ documents.</para></listitem>
 You can report problems in &kig; using the internal bug
 reporting tool
 (<menuchoice><guimenu>Help</guimenu><guimenuitem>Report
-Bug...</guimenuitem></menuchoice>), or just contact me at
-<email>toscano.pino at tiscali.it</email>.
+Bug...</guimenuitem></menuchoice>).
 </para>
 <para>
 Since &kig; supports macros and the construction of loci, it allows for
 some
 rather advanced macros to be defined. If you have created an
 interesting macro, which you think might be useful for other
-people, please mail it to me at
-<email>toscano.pino at tiscali.it</email>, so I can include it in the
-distribution (if you do this, it will be licensed under the
+people, please open a review request for the change, so that
+it can be evaluated for the inclusion in the distribution
+(if you do this, it will be licensed under the
 terms of &kig;'s license, the <ulink
 url="http://www.gnu.org/licenses/licenses.html#GPL">GPL</ulink>,
 so that other people can freely use and adapt it).
@@ -876,8 +875,8 @@ basically that everyone should have the same rights to use
 Free software programs are developed in a very open
 spirit, and its developers are usually very responsive to
 user feedback. Therefore, if you have any questions,
-complaints, or whatever about &kig;, please let the author
-know at <email>toscano.pino at tiscali.it</email>.
+complaints, or whatever about &kig;, please contact the
+kde-edu mailing list at <email>kde-edu at kde.org</email>.
 </para>
 </listitem>
 <listitem>
@@ -957,10 +956,22 @@ support for other formats is planned.
 <title>Credits and License</title>
 
 <para>
-&kig;
+Main authors:
+</para>
+<para>
+&kig; copyright 2011-2015 David E. Narvaez
+<email>david.narvaez at computer.org</email>
+</para>
+<para>
+&kig; copyright 2002-2013 Maurizio Paolini
+<email>paolini at dmf.unicatt.it</email>
+</para>
+<para>
+&kig; copyright 2004-2010 Pino Toscano
+<email>pino at kde.org</email>
 </para>
 <para>
-&kig; copyright 2002-2004 Dominique Devriese
+&kig; copyright 2002-2005 Dominique Devriese
 <email>devriese at kde.org</email>
 </para>
 
@@ -981,23 +992,6 @@ Reviewed by &Philip.Rodrigues; &Philip.Rodrigues.mail;.
 &underFDL; &underGPL;
 </chapter>
 
-<appendix id="installation">
-<title>Installation</title>
-
-<sect1 id="getting-kig">
-<title>How to obtain &kig;</title>
-
-&install.intro.documentation;
-
-</sect1>
-
-<sect1 id="compilation">
-<title>Compilation and Installation</title>
-&install.compile.documentation;
-</sect1>
-
-</appendix>
-
 <appendix id="contributing">
 <title>Contribute</title>
 <sect1 id="kig-is-free">
@@ -1007,10 +1001,7 @@ Reviewed by &Philip.Rodrigues; &Philip.Rodrigues.mail;.
 url="http://www.gnu.org/philosophy/philosophy.html#AboutFreeSoftware">
 Free Software</ulink>. This means that its source code is
 freely available on the Internet, and everyone can use it,
-read it, modify it, and distribute it. I work on it as a
-hobby project, and I have already learned a lot about
-programming, C++, &kde;/&Qt;, math, software collaboration and open
-source projects in the process.
+read it, modify it, and distribute it.
 </para>
 </sect1>
 
@@ -1022,10 +1013,8 @@ rights that &kig;'s license gives you. As with all free
 software, you are allowed (and encouraged) to fix problems
 you encounter while using it, to add features you miss, to
 distribute your modified program, and to send these
-modifications to me at <email>toscano.pino at tiscali.it</email>, so
-that I can include them in the next version for others to
-enjoy. Please note I personally have no financial interest in this
-project whatsoever.
+modifications back for inclusion through the review tools
+available for the KDE community.
 </para>
 <para>
 If you are uncertain of your rights to use this software, or
diff --git a/doc/man-kig.1.docbook b/doc/man-kig.1.docbook
index 91e8f62..781be1e 100644
--- a/doc/man-kig.1.docbook
+++ b/doc/man-kig.1.docbook
@@ -10,8 +10,9 @@
 <firstname>Ben</firstname>
 <surname>Burton</surname>
 </personname><email>bab at debian.org</email></author>
-<date>2010-10-06</date>
-<productname>K Desktop Environment</productname>
+<date>2015-08-27</date>
+<releaseinfo>&kig; 1.0 (Applications 15.12)</releaseinfo>
+<productname>KDE Applications</productname>
 </refentryinfo>
 
 <refmeta>
@@ -21,7 +22,7 @@
 
 <refnamediv>
 <refname><command>kig</command></refname>
-<refpurpose>an interactive geometry program for &kde;</refpurpose>
+<refpurpose>an interactive geometry program by &kde;</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
@@ -31,8 +32,7 @@
 <group choice="opt"><option>-o, --outfile <replaceable>filename</replaceable></option>
 </group>
 </group>
-<arg choice="opt">KDE Generic Options</arg>
-<arg choice="opt">Qt Generic Options</arg>
+<arg choice="opt">options</arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -99,7 +99,9 @@ url="http://edu.kde.org/kig/">&kde; Edutainment website</ulink>.</para>
 <personname><firstname>Franco</firstname><surname>Pasquarelli</surname></personname>
 <email>pasqui at dmf.bs.unicatt.it</email>,
 <personname><firstname>Pino</firstname><surname>Toscano</surname></personname>
-<email>toscano.pino at tiscali.it</email>, and others.</para>
+<email>toscano.pino at tiscali.it</email>,
+<personname><firstname>David E.</firstname><surname>Narvaez</surname></personname>
+<email>david.narvaez at computer.org</email>, and others.</para>
 <para>This man page based on the one prepared for Debian by
 <personname><firstname>Ben</firstname><surname>Burton</surname></personname>
 <email>bab at debian.org</email>.</para>
