Rework of the help page.

Add a screenshot.

Signed-off-by: gregory guy <gregory-tde@laposte.net>
pull/1/head
gregory guy 4 years ago
parent a212e6154c
commit d923b6d208
No known key found for this signature in database
GPG Key ID: 3BCCA0F7AB4536F4

@ -1,7 +1,7 @@
file( GLOB _files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.html ) file( GLOB _files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.html )
install( install(
FILES ${_files} kpacman.gif FILES ${_files} kpacman.gif screenshot.png
DESTINATION ${HTML_INSTALL_DIR}/en/${PROJECT_NAME} DESTINATION ${HTML_INSTALL_DIR}/en/${PROJECT_NAME}
) )

@ -117,8 +117,12 @@ problems. Basically a long version of the abstract. Don't include a
revision history. (see installation appendix comment) --> revision history. (see installation appendix comment) -->
<para> <para>
&kapp; is a program that lets you do absolutely nothing. Please report &kapp; is a classic arcade game from the 80s in which you have
any problems or feature requests to the KDE mailing lists. to finish the tables by eating all the pac-gums (dots) to score as many points
as possible.
</para>
<para>Eat the dots and escape the ghosts with our hero.
You can eat the big spot when needed and eat the ghosts when the color changes.
</para> </para>
</chapter> </chapter>
@ -128,7 +132,8 @@ any problems or feature requests to the KDE mailing lists.
<!-- This chapter should tell the user how to use your app. You should use as <!-- This chapter should tell the user how to use your app. You should use as
many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
your application. --> your application. -->
<para>Use the arrows from the keyboard to move &kapp;.</para>
<para>Here is a screenshot of the game.</para>
<para> <para>
<!-- Note that all graphics should be in .png format. Use no gifs because of <!-- Note that all graphics should be in .png format. Use no gifs because of
@ -140,9 +145,6 @@ patent issues. -->
<imageobject> <imageobject>
<imagedata fileref="screenshot.png" format="PNG"/> <imagedata fileref="screenshot.png" format="PNG"/>
</imageobject> </imageobject>
<imageobject>
<imagedata fileref="screenshot.eps" format="EPS"/>
</imageobject>
<textobject> <textobject>
<phrase>Screenshot</phrase> <phrase>Screenshot</phrase>
</textobject> </textobject>
@ -150,27 +152,6 @@ patent issues. -->
</screenshot> </screenshot>
</para> </para>
<sect1 id="kapp-features">
<title>More Kapp features</title>
<para>It slices! It dices! and it comes with a free toaster!</para>
<para>
The Stquiggle Tool <guiicon><inlinemediaobject>
<imageobject>
<imagedata fileref="stquiggle.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="stquiggle.eps" format="EPS"/>
</imageobject>
<textobject>
<phrase>Stquiggle</phrase>
</textobject>
</inlinemediaobject></guiicon> is used to draw stquiggly lines all over
the &kpacman; main window. It's not a bug, it's a feature!
</para>
</sect1>
</chapter> </chapter>
<chapter id="commands"> <chapter id="commands">
@ -236,8 +217,7 @@ used for apps that use plugins or that provide their own scripting hooks
and/or development libraries. --> and/or development libraries. -->
<para> <para>
Programming &kpacman; plugins is a joy to behold. Just read through the next Doc to make plugins has yet to be written...
66 pages of API's to learn how!
</para> </para>
<!-- Use refentries to describe APIs. Refentries are fairly complicated and you <!-- Use refentries to describe APIs. Refentries are fairly complicated and you
@ -268,19 +248,10 @@ application work. -->
<para>My Mouse doesn't work. How do I quit &kapp;?</para> <para>My Mouse doesn't work. How do I quit &kapp;?</para>
</question> </question>
<answer> <answer>
<para>You silly goose! Check out the <link linkend="commands">Commands <para>Please Check out the <link linkend="commands">Commands
Section</link> for the answer.</para> Section</link> for the answer.</para>
</answer> </answer>
</qandaentry> </qandaentry>
<qandaentry>
<question>
<para>Why can't I twiddle my documents?</para>
</question>
<answer>
<para>You can only twiddle your documents if you have the foobar.lib
installed.</para>
</answer>
</qandaentry>
</qandaset> </qandaset>
</chapter> </chapter>
@ -338,11 +309,9 @@ Documentation copyright 1999 George N. Ugnacious <email>gnu@kde.org</email>
<title>How to obtain Kpacman</title> <title>How to obtain Kpacman</title>
<para> <para>
&kpacman; is part of the KDE project &kpacman; is part of the TDE project
<ulink url="http://www.kde.org">http://www.kde.org</ulink>. <ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/kpacman.git">https://mirror.git.trinitydesktop.org/gitea/TDE/kpacman</ulink>.
&kpacman; can be found in the tdeutils package on </para>
<ulink url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>, the
main ftp site of the KDE project. </para>
</sect1> </sect1>
<sect1 id="requirements"> <sect1 id="requirements">
@ -360,22 +329,19 @@ information here.
--> -->
<para> <para>
In order to successfully use &kpacman;, you need KDE 1.1. Foobar.lib is required In order to successfully build &kapp;, the tdelibs and libtdegames libraries from the TDE project are required.
in order to support the advanced &kpacman; features. &kpacman; uses about 5 megs of
memory to run, but this may vary depending on your platform and
configuration.
</para> </para>
<para> <para>
All required libraries as well as &kpacman; itself can be found All required libraries as well as &kapp; itself can be found
on <ulink url="ftp://ftp.kapp.org">The &kpacman; home page</ulink>. on <ulink url="https://mirror.git.trinitydesktop.org/gitea/explore/repos">The TDE's home dev page</ulink>.
</para> </para>
<!-- For a list of updates, you may refer to the application web site <!-- For a list of updates, you may refer to the application web site
or the ChangeLog file, or ... --> or the ChangeLog file, or ... -->
<para> <para>
You can find a list of changes at <ulink You can find a list of changes (not currently updated) at <ulink
url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>. url="https://mirror.git.trinitydesktop.org/gitea/TDE/kpacman/src/branch/master/ChangeLog">Changelog</ulink>.
</para> </para>
</sect1> </sect1>
@ -383,25 +349,19 @@ url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>.
<title>Compilation and Installation</title> <title>Compilation and Installation</title>
<para> <para>
In order to compile and install KApp on your system, type the following in the base In order to compile and install &kapp; on your system, type the following in the base
directory of the Icon Editor distribution: directory of the &kapp; sources:
<screen width="40"> <screen width="40">
<prompt>%</prompt> <userinput>./configure</userinput> <prompt>%</prompt> <userinput>mkdir -p build</userinput>
<prompt>%</prompt> <userinput>make</userinput> <prompt>%</prompt> <userinput>cd build</userinput>
<prompt>%</prompt> <userinput>make install</userinput> <prompt>%</prompt> <userinput>cmake ../</userinput>
<prompt>%</prompt> <userinput>make V=1</userinput>
<prompt>#</prompt> <userinput>make install</userinput>
</screen> </screen>
</para> </para>
<para>Since KApp uses autoconf and automake you should have not trouble compiling it. <para>Since &kapp; uses Cmake, you should have not trouble compiling it.</para>
Should you run into problems please report them to the KDE mailing lists.</para> <para> Please have a look on the 'install' file for more options.</para>
</sect1>
<sect1 id="configuration">
<title>Configuration</title>
<para>Don't forget to tell your system to start the <filename>dtd</filename>
dicer-toaster daemon first, or KApp won't work !</para>
</sect1> </sect1>

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Loading…
Cancel
Save