[kstars] doc: remove obsolete stuff from kstars documentation

Burkhard Lück lueck at hube-lueck.de
Mon Nov 28 12:44:22 UTC 2016


Git commit bc40bd3db5ea78b5966763be13c7dba288e21f7f by Burkhard Lück.
Committed on 28/11/2016 at 12:43.
Pushed by lueck into branch 'master'.

remove obsolete stuff from kstars documentation

remove entity kappname + package, no longer used
replace entity help.menu.documentation with link to fundamentals
remove install.docbook, completely outdated and useless
remove obsolete entities reporting.bugs+updating.documentation
fix build link
REVIEW:129572

M  +4    -2    doc/commands.docbook
M  +1    -4    doc/faq.docbook
M  +0    -4    doc/index.docbook
D  +0    -87   doc/install.docbook

https://commits.kde.org/kstars/bc40bd3db5ea78b5966763be13c7dba288e21f7f

diff --git a/doc/commands.docbook b/doc/commands.docbook
index 64e1bf3..dbb9d9f 100644
--- a/doc/commands.docbook
+++ b/doc/commands.docbook
@@ -1039,8 +1039,10 @@ of the &kde; Fundamentals.
 
 <sect2 id="helpmenu">
 <title>Help Menu</title>
-
-&help.menu.documentation;
+<para>
+&kstars; has the common &kde; <guimenu>Help</guimenu> menu item, for more information read the section
+about the <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.
+</para>
 
 </sect2>
 
diff --git a/doc/faq.docbook b/doc/faq.docbook
index d481035..8e2bfa3 100644
--- a/doc/faq.docbook
+++ b/doc/faq.docbook
@@ -1,9 +1,6 @@
 <chapter id="faq">
 <title>Questions and Answers</title>
 
-&reporting.bugs;
-&updating.documentation;
-
 <qandaset id="faqlist">
 
 <qandaentry>
@@ -244,7 +241,7 @@ It depends on the image, but many of the images restrict against commercial usag
 Yes, definitely!  Introduce yourself on our mailing list:
 <email>kstars-devel at kde.org</email>.  If you want to
 help with the coding, download the latest <ulink
-url="http://techbase.kde.org/Projects/Edu/KStars/Building_KStars">&kstars; Git</ulink> version of the
+url="http://techbase.kde.org/Projects/Edu/KStars/Building_KStars_KF5">&kstars; Git</ulink> version of the
 code and dive right in.  There are several README files in the
 distribution that explain some of the code's subsystems.  If you
 need ideas of what to work on, see the TODO file.  You can submit
diff --git a/doc/index.docbook b/doc/index.docbook
index 75d8819..235306f 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,7 +1,5 @@
 <?xml version="1.0" ?>
 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
-  <!ENTITY kappname "&kstars;">
-  <!ENTITY package "kdeedu">
   <!ENTITY astroinfo SYSTEM "astroinfo.docbook">
   <!ENTITY blackbody SYSTEM "blackbody.docbook">
   <!ENTITY calc-angdist SYSTEM "calc-angdist.docbook">
@@ -38,7 +36,6 @@
   <!ENTITY horizon SYSTEM "horizon.docbook">
   <!ENTITY hourangle SYSTEM "hourangle.docbook">
   <!ENTITY indi SYSTEM "indi.docbook">
-  <!ENTITY install SYSTEM "install.docbook">
   <!ENTITY julianday SYSTEM "julianday.docbook">
   <!ENTITY leapyear SYSTEM "leapyear.docbook">
   <!ENTITY lightcurves SYSTEM "lightcurves.docbook">
@@ -242,7 +239,6 @@ We are very interested in your feedback; please report bugs or feature requests
 &indi;        <!-- INDI-->
 &faq;         <!--Questions and Answers-->
 &credits;     <!--Credits and License-->
-&install;     <!--Installation-->
 
 &documentation.index;
 
diff --git a/doc/install.docbook b/doc/install.docbook
deleted file mode 100644
index 0ced0e8..0000000
--- a/doc/install.docbook
+++ /dev/null
@@ -1,87 +0,0 @@
-<appendix id="installation">
-<title>Installation</title>
-
-<sect1 id="getting-kstars">
-<title>How to obtain &kstars;</title>
-<para>
-&kstars; is distributed with &kde; as part of the kdeedu "Edutainment"
-module.
-</para>
-<!--
-<para>
-We also occasionally make an independent release.  These independent
-releases will be available as a gzipped tar archive from the following
-website:
-<ulink
- url="http://prdownloads.sourceforge.net/kstars/">http://prdownloads.sourceforge.net/kstars/</ulink>.
-</para>
-<para>
-Independent releases are announced through the
-<email>kstars-announce at lists.sourceforge.net</email> mailing list.
-Releases are also posted to <ulink url="http://edu.kde.org/kstars">the
-&kstars; home page</ulink>,
-<ulink url="http://www.kde-apps.org/content/show.php?content=9862">kde-apps.org</ulink>, and 
-<ulink url="http://freshmeat.net/projects/kstars">freshmeat.net</ulink>.
-</para>
--->
-<para>
-&kstars; is been packaged by many Linux/BSD distributions, including Fedora, openSUSE,
-Ubuntu, and Mandriva. Some distributions package &kstars; as a separate application, some
-just provide a kdeedu package, which includes &kstars;.
-</para><para>
-If you would like the latest Git development version of &kstars;, please
-follow <ulink url="http://techbase.kde.org/Projects/Edu/KStars/Building_KStars">these instructions</ulink>.
-</para>
-</sect1>
-
-<sect1 id="requirements">
-<title>Requirements</title>
-<para>
-In order to successfully run &kstars;, you need &kde; >=4.0 and
-&Qt;>=4.3.
-</para>
-<para>
-To compile &kstars;, you will also have to have the following packages
-installed:
-<itemizedlist>
-<listitem><para>kdelibs-devel</para></listitem>
-<listitem><para>qt-devel</para></listitem>
-<listitem><para>zlib-devel</para></listitem>
-<listitem><para>fam-devel</para></listitem>
-<listitem><para>png-devel</para></listitem>
-<listitem><para>jpeg-devel</para></listitem>
-<listitem><para>cmake</para></listitem>
-</itemizedlist></para>
-
-<para>
-On my system, &kstars; uses about 60 MB of system memory with the
-default settings.  Most of this usage is due to the loaded object
-databases.  You can dramatically reduce the memory footprint by
-reducing the faint limit for stars in the Configuration Window, or
-eliminating catalogs of objects (NGC, IC, comets, asteroids, &etc;).
-If &kstars; is idling, it uses very little <acronym>CPU</acronym>;
-but it will use as much as you have got when panning or zooming.
-</para>
-</sect1>
-
-<sect1 id="compilation">
-<title>Compilation and Installation</title>
-
-&install.compile.documentation;
-
-</sect1>
-
-<sect1 id="configuration">
-<title>Configuration</title>
-<para>
-At this point, there are no special configuration options or
-requirements.  If &kstars; complains that there are missing data files,
-become <systemitem class="username">root</systemitem> and manually copy
-all files in <filename class="directory">kstars/data/</filename> to
-<filename class="directory">$(KDEDIR)/apps/kstars/</filename> (If you
-do not have <systemitem class="username">root</systemitem> privileges,
-copy them to
-<filename class="directory">~/.kde/share/apps/kstars/.</filename>)
-</para>
-</sect1>
-</appendix>


More information about the kde-doc-english mailing list