shithub: choc

Info  •  Files  •  Log  •  Branches

setup: Add help URLs for configuration windows.

The wiki now has documentation pages for most of the windows in the
setup tool. Add help URLs that link to these.

One other minor change here is that the warp button on the main menu
had to change to F2 instead of F1, which is now the help key.

--- a/src/setup/compatibility.c

+++ b/src/setup/compatibility.c

@@ -22,6 +22,8 @@

 #include "compatibility.h"

+#define WINDOW_HELP_URL "http://www.chocolate-doom.org/setup-compat"

+

 int vanilla_savegame_limit = 1;

 int vanilla_demo_limit = 1;

@@ -31,7 +33,9 @@

     window = TXT_NewWindow("Compatibility");

-    TXT_AddWidgets(window, 

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

+

+    TXT_AddWidgets(window,

                    TXT_NewCheckBox("Vanilla savegame limit",

                                    &vanilla_savegame_limit),

                    TXT_NewCheckBox("Vanilla demo limit",

--- a/src/setup/display.c

+++ b/src/setup/display.c

@@ -28,6 +28,8 @@

 #include "display.h"

 #include "config.h"

+#define WINDOW_HELP_URL "http://www.chocolate-doom.org/setup-display"

+

 extern void RestartTextscreen(void);

 typedef struct

@@ -535,6 +537,8 @@

     window = TXT_NewWindow("Advanced display options");

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

+

     TXT_SetColumnWidths(window, 35);

     TXT_AddWidgets(window,

@@ -594,6 +598,8 @@

     // Open the window

     window = TXT_NewWindow("Display Configuration");

+

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

     // Some machines can have lots of video modes.  This tries to

     // keep a limit of six lines by increasing the number of

--- a/src/setup/joystick.c

+++ b/src/setup/joystick.c

@@ -28,6 +28,8 @@

 #include "txt_joyaxis.h"

 #include "txt_joybinput.h"

+#define WINDOW_HELP_URL "http://www.chocolate-doom.org/setup-gamepad"

+

 typedef struct

 {

     char *name;  // Config file name

@@ -684,6 +686,8 @@

     txt_table_t *joystick_table;

     window = TXT_NewWindow("Gamepad/Joystick configuration");

+

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

     TXT_AddWidgets(window,

                    TXT_NewCheckBox("Enable gamepad/joystick", &usejoystick),

--- a/src/setup/keyboard.c

+++ b/src/setup/keyboard.c

@@ -25,6 +25,8 @@

 #include "joystick.h"

 #include "keyboard.h"

+#define WINDOW_HELP_URL "http://www.chocolate-doom.org/setup-keyboard"

+

 int vanilla_keyboard_mapping = 1;

 static int always_run = 0;

@@ -181,6 +183,8 @@

     window = TXT_NewWindow("Extra keyboard controls");

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

+

     table = TXT_NewTable(2);

     TXT_SetColumnWidths(table, 21, 9);

@@ -270,6 +274,8 @@

     window = TXT_NewWindow("Other keys");

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

+

     table = TXT_NewTable(2);

     TXT_SetColumnWidths(table, 25, 9);

@@ -355,6 +361,8 @@

     always_run = joybspeed >= 20;

     window = TXT_NewWindow("Keyboard configuration");

+

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

     TXT_AddWidgets(window,

                    TXT_NewSeparator("Movement"),

--- a/src/setup/mainmenu.c

+++ b/src/setup/mainmenu.c

@@ -38,6 +38,8 @@

 #include "multiplayer.h"

 #include "sound.h"

+#define WINDOW_HELP_URL "http://www.chocolate-doom.org/setup"

+

 static const int cheat_sequence[] =

 {

     KEY_UPARROW, KEY_UPARROW, KEY_DOWNARROW, KEY_DOWNARROW,

@@ -209,6 +211,8 @@

     window = TXT_NewWindow("Main Menu");

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

+

     TXT_AddWidgets(window,

           TXT_NewButton2("Configure Display",

                          (TxtWidgetSignalFunc) ConfigDisplay, NULL),

@@ -247,7 +251,7 @@

           NULL);

     quit_action = TXT_NewWindowAction(KEY_ESCAPE, "Quit");

-    warp_action = TXT_NewWindowAction(KEY_F1, "Warp");

+    warp_action = TXT_NewWindowAction(KEY_F2, "Warp");

     TXT_SignalConnect(quit_action, "pressed", QuitConfirm, NULL);

     TXT_SignalConnect(warp_action, "pressed",

                       (TxtWidgetSignalFunc) WarpMenu, NULL);

--- a/src/setup/mouse.c

+++ b/src/setup/mouse.c

@@ -25,6 +25,8 @@

 #include "mode.h"

 #include "mouse.h"

+#define WINDOW_HELP_URL "http://www.chocolate-doom.org/setup-mouse"

+

 static int usemouse = 1;

 static int mouseSensitivity = 5;

@@ -84,6 +86,8 @@

     window = TXT_NewWindow("Additional mouse buttons");

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

+

     TXT_AddWidgets(window,

                    buttons_table = TXT_NewTable(2),

                    NULL);

@@ -111,6 +115,8 @@

     txt_table_t *buttons_table;

     window = TXT_NewWindow("Mouse configuration");

+

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

     TXT_AddWidgets(window,

                    TXT_NewCheckBox("Enable mouse", &usemouse),

--- a/src/setup/sound.c

+++ b/src/setup/sound.c

@@ -25,6 +25,8 @@

 #include "mode.h"

 #include "sound.h"

+#define WINDOW_HELP_URL "http://www.chocolate-doom.org/setup-sound"

+

 typedef enum

 {

     SFXMODE_DISABLED,

@@ -236,6 +238,8 @@

     // Build the window

     window = TXT_NewWindow("Sound configuration");

+

+    TXT_SetWindowHelpURL(window, WINDOW_HELP_URL);

     TXT_SetWindowPosition(window, TXT_HORIZ_CENTER, TXT_VERT_TOP,

                                   TXT_SCREEN_W / 2, 5);