From 305beeb1d5430f59c32096921402739697ac800f Mon Sep 17 00:00:00 2001 From: Darrell Anderson Date: Sat, 25 Jan 2014 16:24:27 -0600 Subject: [PATCH] Add KNetwalk help handbook. --- doc/knetwalk/CMakeLists.txt | 9 + doc/knetwalk/Makefile.am | 3 + doc/knetwalk/index.docbook | 334 ++++++++++++++++++++++++++++++++++ knetwalk/src/knetwalk.desktop | 8 +- knetwalk/src/main.cpp | 4 +- 5 files changed, 349 insertions(+), 9 deletions(-) create mode 100644 doc/knetwalk/CMakeLists.txt create mode 100644 doc/knetwalk/Makefile.am create mode 100644 doc/knetwalk/index.docbook diff --git a/doc/knetwalk/CMakeLists.txt b/doc/knetwalk/CMakeLists.txt new file mode 100644 index 00000000..879715a8 --- /dev/null +++ b/doc/knetwalk/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION knetwalk ) diff --git a/doc/knetwalk/Makefile.am b/doc/knetwalk/Makefile.am new file mode 100644 index 00000000..41691557 --- /dev/null +++ b/doc/knetwalk/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/knetwalk/index.docbook b/doc/knetwalk/index.docbook new file mode 100644 index 00000000..7e1c7d6c --- /dev/null +++ b/doc/knetwalk/index.docbook @@ -0,0 +1,334 @@ + +KNetwalk"> + + + + +]> + + + +The &knetwalk; Handbook + + + +Fela +Winkelmolen + +
fela.kde@gmail.com
 + + +EugeneTrounev +
eugene.trounev@gmail.com
 + +&tde-authors; + + + + +2007 +Fela Winkelmolen + + +&tde-copyright-date; +&tde-team; + + +&FDLNotice; + +2007-11-13 +3.0.0 + + + +&knetwalk; is a game for system administrators. + + + +TDE +tdegames +game +logic game +knetwalk + + + + +Introduction + + +&knetwalk; is a single player logic game. + + + +The object of the game is to start the LAN, connecting all the terminals to the server, in as few turns as possible. + + + + +How to Play + + +The player is presented with a rectangular grid containing a server, several terminals, and pieces of wire. The object of the game is to rotate these elements until every client is connected to the server, and no wires are left unconnected. Optionally, you can try to get a high score by minimizing the number of rotations needed. + + + +Left clicking on a square rotates it counterclockwise, while right clicking rotates it clockwise. Middle clicking on a square marks it as blocked and prevents it from being rotated unless it gets unblocked by another middle click; this can be very useful for marking squares which are known to be in the correct orientation. The status bar displays the number of clicks so far. + + + + + +Game Rules, Strategies and Tips + + +Rules + +There is only one possible correct solution for every game. +When playing the Very hard difficulty level connections can wrap from left to right and from top to bottom. +The game ends when every terminal and every wire is connected to the server. +The score represents the number of clicks it took to complete the game. The lower the score the better. + + + + +Strategies and Tips + +Start seeking for squares which orientation can be easily determined. +Once you are sure of the orientation of a square you can mark it using the &MMB;. This is particularly usefull in harder games. +Look for I-shaped and T-shaped wires near the borders, and L-shaped wires near the edges. The position of these squares can be easily determined, unless you are playing the Very hard difficulty level. +When playing the Very hard difficulty level a good place to start looking is near empty squares, if present, and near regions containing many terminals grouped together. +Even when playing with the same difficulty level some games are easier than others, restart the game if you want to get a different board. +If you want to get a good score, only do a move when you are sure. + + + + + + +Interface Overview + + +<guimenu>Game</guimenu> Menu + + + + + +&Ctrl;N + +Game +New + + + +Starts a new game. It creates a random board using the current difficulty level. + + + + + + + +&Ctrl;H + +Game +Show High Scores + + +Shows a dialog containing the High Scores for the various difficulty levels. + + + + + + + +&Ctrl;Q + +Game +Quit + + + +Quits the program. + + + + + + + + +<guimenu>Settings</guimenu> Menu + + + + + +Settings +Show Toolbar + + + +Toggles on and off the display of the toolbar. + + + + + + +Settings +Show Statusbar + + + +Toggles on and off the display of the statusbar. + + + + + + + + +Settings +Difficulty + + +Lets you set the difficulty level from a sub-menu. +There are four levels of difficulty: + +Easy: 5 rows, 5 columns, without wrapping. +Medium: 7 rows, 7 columns, without wrapping. +Hard: 9 rows, 9 columns, without wrapping. +Very hard: 9 rows, 9 columns, with wrapping. + + + + + + +Settings +Configure Shortcuts... + + +Opens a dialog which lets you redefine all the keyboard shortcuts. + + + + + +Settings +Configure Toolbars... + +Displays a &tde; standard dialog where you can configure the toolbar icons. + + + +SettingsConfigure +Notifications... +This item displays a standard &tde; notifications configuration +dialog, where you can change the notifications (sounds, visible messages, +&etc;) used by &knetwalk;. + + + + + + +<guimenu>Help</guimenu> Menu + +&help.menu.documentation; + + + + +Shortcuts + +The default shortcuts are: + + +Shortcuts + + + +Start a new game + +&Ctrl;N + + + +Show High Scores + +&Ctrl;H + + + +Quit + +&Ctrl;Q + + + +Help +F1 + + +What's this? + +&Shift;F1 + + + + +
+ + + + + + +Credits and License + + +&knetwalk; + + +Program copyright 2004 - 2007 by Andi Peredri, Thomas Nagy and Fela Winkelmolen fela.kde@gmail.com + + +Documentation copyright 2007 by Fela Winkelmolen fela.kde@gmail.com + + + + +&underFDL; +&underGPL; + + + +&documentation.index; + + + diff --git a/knetwalk/src/knetwalk.desktop b/knetwalk/src/knetwalk.desktop index b27289bf..24b9fa60 100644 --- a/knetwalk/src/knetwalk.desktop +++ b/knetwalk/src/knetwalk.desktop @@ -1,13 +1,7 @@ [Desktop Entry] Type=Application Exec=knetwalk -caption "%c" %i %m -# Restore the following key and remove this comment when a help handbook -# is written. Disabling this key prevents populating the main handbook -# table of contents with a non-existent document, which results in a -# main handbook error message of -# 'There is no documentation available for /xyz/index.html.' -# Also disable this key when there exists only a useless template handbook. -# DocPath=knetwalk/index.html +DocPath=knetwalk/index.html Name=KNetwalk Name[bn]=কে-নেটওয়াক Name[fi]=KNetwalk diff --git a/knetwalk/src/main.cpp b/knetwalk/src/main.cpp index 0a1b9438..b3c4110a 100644 --- a/knetwalk/src/main.cpp +++ b/knetwalk/src/main.cpp @@ -24,7 +24,7 @@ #include "mainwindow.h" static const char description[] = -I18N_NOOP("KNetWalk, a game for system administrators."); +I18N_NOOP("KNetwalk, a game for system administrators."); static const char version[] = "1.0"; @@ -39,7 +39,7 @@ static TDECmdLineOptions options[] = int main(int argc, char ** argv) { - TDEAboutData about("knetwalk", I18N_NOOP("knetwalk"), version, description, + TDEAboutData about("knetwalk", I18N_NOOP("KNetwalk"), version, description, TDEAboutData::License_GPL, I18N_NOOP("(C) 2004, 2005 Andi Peredri, ported to KDE by Thomas Nagy"), 0, "tnagyemail-mail@yahoo.fr"); about.addAuthor( "Andi Peredri", 0, "andi@ukr.net" );