diff --git a/.github/workflows/appimage-build.yml b/.github/workflows/appimage-build.yml
index aebf52d1..85a57801 100644
--- a/.github/workflows/appimage-build.yml
+++ b/.github/workflows/appimage-build.yml
@@ -37,6 +37,7 @@ jobs:
liblua5.4-dev libpci-dev libperl-dev libssl-dev libayatana-appindicator3-dev \
perl python3 python3-minimal python3-dev python3-cffi mono-devel desktop-file-utils \
fonts-noto-color-emoji breeze-gtk-theme \
+ python3-venv \
patchelf file curl
- name: Configure
@@ -206,6 +207,10 @@ jobs:
export ZOITECHAT_LIBDIR="$APPDIR/usr/lib/zoitechat/plugins"
fi
+ if [ -f "$APPDIR/usr/share/doc/zoitechat/html/index.html" ]; then
+ export ZOITECHAT_DOCDIR="$APPDIR/usr/share/doc/zoitechat/html"
+ fi
+
if [ -d "$APPDIR/usr/share/glib-2.0/schemas" ]; then
export GSETTINGS_SCHEMA_DIR="$APPDIR/usr/share/glib-2.0/schemas${GSETTINGS_SCHEMA_DIR:+:$GSETTINGS_SCHEMA_DIR}"
fi
diff --git a/.github/workflows/windows-build.yml b/.github/workflows/windows-build.yml
index edfe089f..58547e5f 100644
--- a/.github/workflows/windows-build.yml
+++ b/.github/workflows/windows-build.yml
@@ -113,6 +113,13 @@ jobs:
New-Item -Path $pyDir -Name "${{ matrix.platform }}" -ItemType Junction -Value $pyRoot | Out-Null
}
+ # Runs while Python 3.14 is still the active interpreter; the installer
+ # packages rel\offline-docs as the "Offline Documentation" component and
+ # skips it if this step could not build the docs.
+ - name: Build offline documentation
+ run: |
+ python data\misc\build_offline_docs.py --output ..\zoitechat-build\${{ matrix.platform }}\rel\offline-docs
+
- uses: actions/setup-python@v6
with:
python-version: '3.8.10'
diff --git a/data/meson.build b/data/meson.build
index 975205fa..db232d5f 100644
--- a/data/meson.build
+++ b/data/meson.build
@@ -6,4 +6,29 @@ if get_option('gtk-frontend')
subdir('icons')
subdir('misc')
subdir('man')
+
+ # Fetch and build the offline manual so Help->Contents works without
+ # connectivity. 'auto' skips with a warning when the docs cannot be
+ # fetched (e.g. network-less distro builds, which ship docs themselves);
+ # 'enabled' makes that a hard error.
+ offline_docs_opt = get_option('offline-docs')
+ if not offline_docs_opt.disabled()
+ offline_docs_args = [
+ '--repo', get_option('offline-docs-repo'),
+ '--output', join_paths(meson.current_build_dir(), 'offline-docs'),
+ '--stamp', '@OUTPUT@',
+ ]
+ if offline_docs_opt.enabled()
+ offline_docs_args += ['--strict']
+ endif
+ custom_target('offline-docs',
+ output: 'offline-docs.stamp',
+ command: [find_program('python3'), files('misc/build_offline_docs.py')] + offline_docs_args,
+ build_by_default: true,
+ )
+ meson.add_install_script(files('misc/install_offline_docs.py'),
+ join_paths(meson.current_build_dir(), 'offline-docs'),
+ offline_docs_dir,
+ )
+ endif
endif
diff --git a/data/misc/build_offline_docs.py b/data/misc/build_offline_docs.py
new file mode 100644
index 00000000..ddd206cf
--- /dev/null
+++ b/data/misc/build_offline_docs.py
@@ -0,0 +1,133 @@
+#!/usr/bin/env python3
+"""Build ZoiteChat's offline HTML documentation for bundling with releases.
+
+Clones the ZoiteChat/documentation repository, preferring a tag that
+matches this source tree's version so the bundled manual matches the
+application, and builds it with Sphinx into --output. Used by the
+meson build (offline-docs option) and by the Windows CI workflow.
+
+Sphinx is installed into a throwaway virtualenv so the invoking Python
+(which the Windows build also bundles pieces of) is left untouched.
+
+Unless --strict is given, any failure prints a warning (GitHub Actions
+annotation syntax) and exits 0: builds then simply fall back to opening
+the online manual instead of failing outright.
+"""
+
+import argparse
+import pathlib
+import re
+import shutil
+import subprocess
+import sys
+import tempfile
+
+DEFAULT_REPO = "https://github.com/ZoiteChat/documentation.git"
+
+
+def project_version() -> str:
+ meson_build = pathlib.Path(__file__).resolve().parents[2] / "meson.build"
+ match = re.search(r"version\s*:\s*'([^']+)'", meson_build.read_text(encoding="utf-8"))
+ if not match:
+ raise RuntimeError(f"could not parse project version from {meson_build}")
+ return match.group(1)
+
+
+def run(argv, **kwargs) -> None:
+ print("+", " ".join(str(arg) for arg in argv), flush=True)
+ subprocess.run(argv, check=True, **kwargs)
+
+
+def clone_docs(repo: str, version: str, target: pathlib.Path) -> str:
+ # A missing tag falls through to the default branch so the docs may be
+ # newer than the app, which beats shipping none at all.
+ for ref in (f"v{version}", version, None):
+ cmd = ["git", "clone", "--depth", "1"]
+ if ref:
+ cmd += ["--branch", ref]
+ cmd += [repo, str(target)]
+ try:
+ run(cmd)
+ return ref or "default branch"
+ except subprocess.CalledProcessError:
+ shutil.rmtree(target, ignore_errors=True)
+ raise RuntimeError(f"could not clone {repo}")
+
+
+def find_source_dir(checkout: pathlib.Path) -> pathlib.Path:
+ for candidate in (checkout, checkout / "docs", checkout / "doc"):
+ if (candidate / "conf.py").is_file():
+ return candidate
+ raise RuntimeError(f"no Sphinx conf.py found in {checkout}")
+
+
+def venv_python(venv_dir: pathlib.Path) -> pathlib.Path:
+ if sys.platform == "win32":
+ return venv_dir / "Scripts" / "python.exe"
+ return venv_dir / "bin" / "python"
+
+
+def build(output: pathlib.Path, repo: str, version: str) -> None:
+ with tempfile.TemporaryDirectory(prefix="zoitechat-docs-") as tmp:
+ tmp_dir = pathlib.Path(tmp)
+ checkout = tmp_dir / "documentation"
+ html_dir = tmp_dir / "html"
+ venv_dir = tmp_dir / "venv"
+
+ ref = clone_docs(repo, version, checkout)
+ print(f"building documentation from {ref}", flush=True)
+ source_dir = find_source_dir(checkout)
+
+ run([sys.executable, "-m", "venv", str(venv_dir)])
+ python = venv_python(venv_dir)
+ requirements = source_dir / "requirements.txt"
+ if not requirements.is_file():
+ requirements = checkout / "requirements.txt"
+ if requirements.is_file():
+ run([python, "-m", "pip", "install", "--quiet", "-r", str(requirements)])
+ run([python, "-m", "pip", "install", "--quiet", "sphinx"])
+ else:
+ run([python, "-m", "pip", "install", "--quiet", "sphinx", "sphinx_rtd_theme"])
+
+ run([python, "-m", "sphinx", "-b", "html", str(source_dir), str(html_dir)])
+ if not (html_dir / "index.html").is_file():
+ raise RuntimeError("Sphinx build produced no index.html")
+
+ if output.exists():
+ shutil.rmtree(output)
+ shutil.copytree(html_dir, output,
+ ignore=shutil.ignore_patterns(".doctrees", ".buildinfo"))
+
+ file_count = sum(1 for path in output.rglob("*") if path.is_file())
+ print(f"offline documentation staged at {output} ({file_count} files)", flush=True)
+
+
+def main() -> int:
+ parser = argparse.ArgumentParser(description=__doc__)
+ parser.add_argument("--output", required=True, type=pathlib.Path,
+ help="directory to stage the built HTML tree into")
+ parser.add_argument("--repo", default=DEFAULT_REPO,
+ help="documentation git repository to build from")
+ parser.add_argument("--version", default=None,
+ help="app version used to pick a matching docs tag "
+ "(default: parsed from meson.build)")
+ parser.add_argument("--strict", action="store_true",
+ help="fail on error instead of emitting a warning")
+ parser.add_argument("--stamp", type=pathlib.Path, default=None,
+ help="file to touch on completion (meson target output)")
+ args = parser.parse_args()
+
+ try:
+ build(args.output, args.repo, args.version or project_version())
+ except Exception as error: # noqa: BLE001 - degrade to website-only help
+ if args.strict:
+ raise
+ print(f"::warning::offline documentation not bundled: {error}", flush=True)
+
+ if args.stamp:
+ args.stamp.write_text("ok\n", encoding="utf-8")
+ return 0
+
+
+if __name__ == "__main__":
+ sys.exit(main())
diff --git a/data/misc/install_offline_docs.py b/data/misc/install_offline_docs.py
new file mode 100644
index 00000000..92abc61c
--- /dev/null
+++ b/data/misc/install_offline_docs.py
@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+"""Meson install helper: copy the built offline docs into the install tree.
+
+Silently skips when the docs were not built (offline-docs=auto without
+network); Help->Contents then falls back to the online manual.
+"""
+
+import os
+import pathlib
+import shutil
+import sys
+
+src = pathlib.Path(sys.argv[1])
+dest_arg = pathlib.PurePath(sys.argv[2])
+
+if not (src / "index.html").is_file():
+ print("offline documentation was not built; skipping install")
+ sys.exit(0)
+
+if dest_arg.is_absolute():
+ # An absolute offline-docs-dir lands outside the prefix; honour DESTDIR
+ destdir = os.environ.get("DESTDIR", "")
+ dest = pathlib.Path(destdir + str(dest_arg)) if destdir else pathlib.Path(dest_arg)
+else:
+ dest = pathlib.Path(os.environ["MESON_INSTALL_DESTDIR_PREFIX"]) / dest_arg
+
+if dest.exists():
+ shutil.rmtree(dest)
+dest.parent.mkdir(parents=True, exist_ok=True)
+shutil.copytree(src, dest)
+print(f"Installed offline documentation to {dest}")
diff --git a/meson.build b/meson.build
index 7c26197a..09acd901 100644
--- a/meson.build
+++ b/meson.build
@@ -35,6 +35,16 @@ config_h.set_quoted('PACKAGE_NAME', meson.project_name())
config_h.set_quoted('GETTEXT_PACKAGE', 'zoitechat')
config_h.set_quoted('LOCALEDIR', join_paths(get_option('prefix'),
get_option('datadir'), 'locale'))
+
+# Where Help->Contents looks for locally installed documentation before
+# falling back to the online manual. Packagers that ship the HTML docs
+# elsewhere can point this at their doc directory.
+offline_docs_dir = get_option('offline-docs-dir')
+if offline_docs_dir == ''
+ offline_docs_dir = join_paths(get_option('datadir'), 'doc', 'zoitechat', 'html')
+endif
+config_h.set_quoted('ZOITECHATDOCDIR', join_paths(get_option('prefix'), offline_docs_dir))
+
config_h.set10('ENABLE_NLS', true)
# Optional features
diff --git a/meson_options.txt b/meson_options.txt
index 04b0265e..ec4e1ea6 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -33,6 +33,15 @@ option('install-appdata', type: 'boolean',
option('install-plugin-metainfo', type: 'boolean', value: false,
description: 'Installs metainfo files for enabled plugins, useful when distros create split packages'
)
+option('offline-docs', type: 'feature', value: 'auto',
+ description: 'Fetch, build and install the offline HTML documentation (needs network at build time); auto skips with a warning when unavailable'
+)
+option('offline-docs-dir', type: 'string', value: '',
+ description: 'Directory searched for offline HTML documentation (index.html), absolute or relative to prefix. Defaults to $datadir/doc/zoitechat/html'
+)
+option('offline-docs-repo', type: 'string', value: 'https://github.com/ZoiteChat/documentation.git',
+ description: 'Git repository the offline documentation is built from'
+)
# Plugins
option('with-checksum', type: 'boolean',
diff --git a/src/fe-gtk/menu.c b/src/fe-gtk/menu.c
index 740b22c4..56416ea9 100644
--- a/src/fe-gtk/menu.c
+++ b/src/fe-gtk/menu.c
@@ -138,7 +138,6 @@ struct mymenu
#define XCMENU_MARKUP 2
#define XCMENU_MNEMONIC 4
-/* execute a userlistbutton/popupmenu command */
static void
nick_command (session * sess, char *cmd)
@@ -149,7 +148,6 @@ nick_command (session * sess, char *cmd)
handle_command (sess, cmd, TRUE);
}
-/* fill in the %a %s %n etc and execute the command */
void
nick_command_parse (session *sess, char *cmd, char *nick, char *allnick)
@@ -178,7 +176,6 @@ nick_command_parse (session *sess, char *cmd, char *nick, char *allnick)
}
}
- /* this can't overflow, since popup->cmd is only 256 */
len = strlen (cmd) + strlen (nick) + strlen (allnick) + 512;
buf = g_malloc (len);
@@ -191,7 +188,6 @@ nick_command_parse (session *sess, char *cmd, char *nick, char *allnick)
g_free (buf);
}
-/* userlist button has been clicked */
void
userlist_button_cb (GtkWidget * button, char *cmd)
@@ -208,7 +204,6 @@ userlist_button_cb (GtkWidget * button, char *cmd)
if (sess->type == SESS_DIALOG)
{
- /* fake a selection */
nicks = g_new (char *, 2);
nicks[0] = g_strdup (sess->channel);
nicks[1] = NULL;
@@ -216,7 +211,6 @@ userlist_button_cb (GtkWidget * button, char *cmd)
}
else
{
- /* find number of selected rows */
nicks = userlist_selection_list (sess->gui->user_tree, &num_sel);
if (num_sel < 1)
{
@@ -227,7 +221,6 @@ userlist_button_cb (GtkWidget * button, char *cmd)
}
}
- /* create "allnicks" string */
allnicks = g_malloc (((NICKLEN + 1) * num_sel) + 1);
*allnicks = 0;
@@ -241,7 +234,6 @@ userlist_button_cb (GtkWidget * button, char *cmd)
if (!nick)
nick = nicks[0];
- /* if not using "%a", execute the command once for each nickname */
if (!using_allnicks)
nick_command_parse (sess, cmd, nicks[i], "");
@@ -265,19 +257,16 @@ userlist_button_cb (GtkWidget * button, char *cmd)
g_free (allnicks);
}
-/* a popup-menu-item has been selected */
static void
popup_menu_cb (GtkWidget * item, char *cmd)
{
char *nick;
- /* the userdata is set in menu_quick_item() */
nick = g_object_get_data (G_OBJECT (item), "u");
if (!nick) /* userlist popup menu */
{
- /* treat it just like a userlist button */
userlist_button_cb (NULL, cmd);
return;
}
@@ -389,7 +378,6 @@ menu_quick_sub (char *name, GtkWidget *menu, GtkWidget **sub_item_ret, int flags
if (!name)
return menu;
- /* Code to add a submenu */
sub_menu = menu_new ();
if (flags & XCMENU_MARKUP)
{
@@ -411,7 +399,6 @@ menu_quick_sub (char *name, GtkWidget *menu, GtkWidget **sub_item_ret, int flags
*sub_item_ret = sub_item;
if (flags & XCMENU_DOLIST)
- /* We create a new element in the list */
submenu_list = g_slist_prepend (submenu_list, sub_menu);
return sub_menu;
}
@@ -419,7 +406,6 @@ menu_quick_sub (char *name, GtkWidget *menu, GtkWidget **sub_item_ret, int flags
static GtkWidget *
menu_quick_endsub (void)
{
- /* Just delete the first element in the linked list pointed to by first */
if (submenu_list)
submenu_list = g_slist_remove (submenu_list, submenu_list->data);
@@ -450,10 +436,7 @@ is_in_path (char *cmd)
char **argv;
int argc;
- /* special-case these default entries. */
- /* 123456789012345678 */
if (strncmp (prog, "gnome-terminal -x ", 18) == 0)
- /* don't check for gnome-terminal, but the thing it's executing! */
prog += 18;
if (g_shell_parse_argv (prog, &argc, &argv, NULL))
@@ -472,7 +455,6 @@ is_in_path (char *cmd)
return 0;
}
-/* syntax: "LABEL~ICON~STUFF~ADDED~LATER~" */
static void
menu_extract_icon (char *name, char **label, char **icon)
@@ -485,7 +467,6 @@ menu_extract_icon (char *name, char **label, char **icon)
{
if (*p == '~')
{
- /* escape \~ */
if (p == name || p[-1] != '\\')
{
if (!start)
@@ -512,7 +493,6 @@ menu_extract_icon (char *name, char **label, char **icon)
}
}
-/* append items to "menu" using the (struct popup*) list provided */
void
menu_create (GtkWidget *menu, GSList *list, char *target, int check_path)
@@ -539,14 +519,12 @@ menu_create (GtkWidget *menu, GSList *list, char *target, int check_path)
} else if (!g_ascii_strncasecmp (pop->name, "ENDSUB", 6))
{
- /* empty sub menu due to no programs in PATH? */
if (check_path && childcount < 1)
gtk_widget_destroy (subitem);
subitem = NULL;
if (tempmenu != menu)
tempmenu = menu_quick_endsub ();
- /* If we get here and tempmenu equals menu that means we havent got any submenus to exit from */
} else if (!g_ascii_strncasecmp (pop->name, "SEP", 3))
{
@@ -556,10 +534,8 @@ menu_create (GtkWidget *menu, GSList *list, char *target, int check_path)
{
char *icon, *label;
- /* default command in zoitechat.c */
if (pop->cmd[0] == 'n' && !strcmp (pop->cmd, "notify -n ASK %s"))
{
- /* don't create this item if already in notify list */
if (!target || notify_is_in_list (current_sess->server, target))
{
list = list->next;
@@ -572,7 +548,6 @@ menu_create (GtkWidget *menu, GSList *list, char *target, int check_path)
if (!check_path || pop->cmd[0] != '!')
{
menu_quick_item (pop->cmd, label, tempmenu, 0, target, icon);
- /* check if the program is in path, if not, leave it out! */
} else if (is_in_path (pop->cmd))
{
childcount++;
@@ -586,7 +561,6 @@ menu_create (GtkWidget *menu, GSList *list, char *target, int check_path)
list = list->next;
}
- /* Let's clean up the linked list from mem */
while (submenu_list)
submenu_list = g_slist_remove (submenu_list, submenu_list->data);
}
@@ -640,10 +614,8 @@ menu_nickinfo_cb (GtkWidget *menu, session *sess)
if (!is_session (sess))
return;
- /* issue a /WHOIS */
g_snprintf (buf, sizeof (buf), "WHOIS %s %s", str_copy, str_copy);
handle_command (sess, buf, FALSE);
- /* and hide the output */
sess->server->skip_next_whois = 1;
}
@@ -653,7 +625,6 @@ copy_to_clipboard_cb (GtkWidget *item, char *url)
gtkutil_copy_to_clipboard (item, NULL, url);
}
-/* returns boolean: Some data is missing */
static gboolean
menu_create_nickinfo_menu (struct User *user, GtkWidget *submenu)
@@ -665,7 +636,6 @@ menu_create_nickinfo_menu (struct User *user, GtkWidget *submenu)
gboolean missing = FALSE;
GtkWidget *item;
- /* let the translators tweak this if need be */
fmt = _("%-11s %s");
g_snprintf (unknown, sizeof (unknown), "%s", _("Unknown"));
@@ -756,14 +726,11 @@ fe_userlist_update (session *sess, struct User *user)
if (!nick_submenu || !str_copy)
return;
- /* not the same nick as the menu? */
if (sess->server->p_cmp (user->nick, str_copy))
return;
- /* get rid of the "show" signal */
g_signal_handlers_disconnect_by_func (nick_submenu, menu_nickinfo_cb, sess);
- /* destroy all the old items */
items = gtk_container_get_children (GTK_CONTAINER (nick_submenu));
iter = items;
while (iter)
@@ -774,7 +741,6 @@ fe_userlist_update (session *sess, struct User *user)
}
g_list_free (items);
- /* and re-create them with new info */
needs_refresh = menu_create_nickinfo_menu (user, nick_submenu) ||
!user->hostname || !user->realname || !user->servername;
@@ -816,7 +782,6 @@ menu_nickmenu (session *sess, GdkEventButton *event, char *nick, int num_sel)
submenu_list = 0; /* first time through, might not be 0 */
- /* more than 1 nick selected? */
if (num_sel > 1)
{
g_snprintf (buf, sizeof (buf), _("%d nicks selected."), num_sel);
@@ -861,7 +826,6 @@ menu_nickmenu (session *sess, GdkEventButton *event, char *nick, int num_sel)
menu_popup (menu, event, NULL);
}
-/* stuff for the View menu */
static void
menu_showhide_cb (session *sess)
@@ -1025,7 +989,6 @@ menu_fullscreen_toggle (GtkWidget *wid, gpointer ud)
#ifdef WIN32
if (!prefs.hex_gui_win_state) /* not maximized */
{
- /* other window managers seem to handle this */
gtk_window_resize (GTK_WINDOW (parent_window),
prefs.hex_gui_win_width, prefs.hex_gui_win_height);
gtk_window_move (GTK_WINDOW (parent_window),
@@ -1051,7 +1014,6 @@ open_url_cb (GtkWidget *item, char *url)
{
char buf[512];
- /* pass this to /URL so it can handle irc:// */
g_snprintf (buf, sizeof (buf), "URL %s", url);
handle_command (current_sess, buf, FALSE);
}
@@ -1066,7 +1028,6 @@ menu_urlmenu (GdkEventButton *event, char *url)
str_copy = g_strdup (url);
menu = menu_new ();
- /* more than 51 chars? Chop it */
if (g_utf8_strlen (str_copy, -1) >= 52)
{
tmp = g_strdup (str_copy);
@@ -1081,14 +1042,12 @@ menu_urlmenu (GdkEventButton *event, char *url)
}
menu_quick_item (0, 0, menu, XCMENU_SHADED, 0, 0);
- /* Two hardcoded entries */
if (strncmp (str_copy, "irc://", 6) == 0 ||
strncmp (str_copy, "ircs://",7) == 0)
menu_quick_item_with_callback (open_url_cb, _("Connect"), menu, str_copy);
else
menu_quick_item_with_callback (open_url_cb, _("Open Link in Browser"), menu, str_copy);
menu_quick_item_with_callback (copy_to_clipboard_cb, _("Copy Selected Link"), menu, str_copy);
- /* custom ones from urlhandlers.conf */
menu_create (menu, urlhandler_list, str_copy, TRUE);
menu_add_plugin_items (menu, "\x4$URL", str_copy);
menu_popup (menu, event, NULL);
@@ -1356,7 +1315,6 @@ menu_newserver_tab (GtkWidget * wid, gpointer none)
int oldf = prefs.hex_gui_tab_newtofront;
prefs.hex_gui_tab_chans = 1;
- /* force focus if setting is "only requested tabs" */
if (prefs.hex_gui_tab_newtofront == 2)
prefs.hex_gui_tab_newtofront = 1;
new_ircwindow (NULL, NULL, SESS_SERVER, 0);
@@ -1740,10 +1698,67 @@ menu_ctcpguiopen (void)
editlist_gui_open (NULL, NULL, ctcp_list, buf, "ctcpreply", "ctcpreply.conf", ctcp_help);
}
+/* Returns the index.html of a locally installed copy of the documentation,
+ * or NULL if none is available. Callers own the returned string. */
+static char *
+menu_docs_local_index (void)
+{
+ const char *env_docdir;
+ char *path;
+
+ env_docdir = g_getenv ("ZOITECHAT_DOCDIR");
+ if (env_docdir && env_docdir[0])
+ {
+ path = g_build_filename (env_docdir, "index.html", NULL);
+ if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
+ return path;
+ g_free (path);
+ }
+
+ /* Docs the user placed in the config dir; works on every platform,
+ * including portable installs and Flatpak (host-readable, unlike /app) */
+ path = g_build_filename (get_xdir (), "offline-docs", "index.html", NULL);
+ if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
+ return path;
+ g_free (path);
+
+#ifdef WIN32
+ /* The installer's "Offline Documentation" component; ZOITECHATDOCDIR is
+ * relative to the install dir on Windows and must not be resolved
+ * against the CWD, which depends on how the app was launched */
+ if (!g_path_is_absolute (ZOITECHATDOCDIR))
+ {
+ char *install_dir = g_win32_get_package_installation_directory_of_module (NULL);
+
+ if (!install_dir)
+ return NULL;
+ path = g_build_filename (install_dir, ZOITECHATDOCDIR, "index.html", NULL);
+ g_free (install_dir);
+ }
+ else
+ path = g_build_filename (ZOITECHATDOCDIR, "index.html", NULL);
+#else
+ path = g_build_filename (ZOITECHATDOCDIR, "index.html", NULL);
+#endif
+ if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
+ return path;
+ g_free (path);
+
+ return NULL;
+}
+
static void
menu_docs (GtkWidget *wid, gpointer none)
{
- fe_open_url ("https://docs.zoitechat.org/en/latest/");
+ char *local_index = menu_docs_local_index ();
+
+ if (local_index)
+ {
+ fe_open_url (local_index);
+ g_free (local_index);
+ }
+ else
+ fe_open_url ("https://docs.zoitechat.org/en/latest/");
}
/*static void
@@ -2252,7 +2267,6 @@ menu_canacaccel (GtkWidget *widget, guint signal_id, gpointer user_data)
return gtk_widget_is_sensitive (widget);
}
-/* === STUFF FOR /MENU === */
static GtkMenuItem *
menu_find_item (GtkWidget *menu, char *name)
@@ -2318,7 +2332,6 @@ menu_find_path (GtkWidget *menu, char *path)
char name[128];
int len;
- /* grab the next part of the path */
s = strchr (path, '/');
len = s - path;
if (!s)
@@ -2372,7 +2385,6 @@ menu_foreach_gui (menu_entry *me, void (*callback) (GtkWidget *, menu_entry *, c
list = list->next;
continue;
}
- /* do it only once for tab sessions, since they share a GUI */
if (!sess->gui->is_tab || !tabdone)
{
callback (sess->gui->menu, me, NULL);
@@ -2392,13 +2404,11 @@ menu_update_cb (GtkWidget *menu, menu_entry *me, char *target)
if (item)
{
gtk_widget_set_sensitive (item, me->enable);
- /* must do it without triggering the callback */
if (GTK_IS_CHECK_MENU_ITEM (item))
gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), me->state);
}
}
-/* radio state changed via mouse click */
static void
menu_radio_cb (GtkCheckMenuItem *item, menu_entry *me)
{
@@ -2406,15 +2416,12 @@ menu_radio_cb (GtkCheckMenuItem *item, menu_entry *me)
if (gtk_check_menu_item_get_active (item))
me->state = 1;
- /* update the state, incase this was changed via right-click. */
- /* This will update all other windows and menu bars */
menu_foreach_gui (me, menu_update_cb);
if (me->state && me->cmd)
handle_command (current_sess, me->cmd, FALSE);
}
-/* toggle state changed via mouse click */
static void
menu_toggle_cb (GtkCheckMenuItem *item, menu_entry *me)
{
@@ -2422,8 +2429,6 @@ menu_toggle_cb (GtkCheckMenuItem *item, menu_entry *me)
if (gtk_check_menu_item_get_active (item))
me->state = 1;
- /* update the state, incase this was changed via right-click. */
- /* This will update all other windows and menu bars */
menu_foreach_gui (me, menu_update_cb);
if (me->state)
@@ -2594,7 +2599,6 @@ fe_menu_add (menu_entry *me)
if (!pango_parse_markup (me->label, -1, 0, NULL, &text, NULL, NULL))
return NULL;
- /* return the label with markup stripped */
return text;
}
@@ -2610,7 +2614,6 @@ fe_menu_update (menu_entry *me)
menu_foreach_gui (me, menu_update_cb);
}
-/* used to add custom menus to the right-click menu */
static void
menu_add_plugin_mainmenu_items (GtkWidget *menu)
@@ -2644,7 +2647,6 @@ menu_add_plugin_items (GtkWidget *menu, char *root, char *target)
}
}
-/* === END STUFF FOR /MENU === */
GtkWidget *
menu_create_main (void *accel_group, int bar, int away, int toplevel,
@@ -2677,13 +2679,11 @@ menu_create_main (void *accel_group, int bar, int away, int toplevel,
else
menu_bar = menu_new ();
- /* /MENU needs to know this later */
g_object_set_data (G_OBJECT (menu_bar), "accel", accel_group);
g_signal_connect (G_OBJECT (menu_bar), "can-activate-accel",
G_CALLBACK (menu_canacaccel), 0);
- /* set the initial state of toggles */
mymenu[MENUBAR_OFFSET].state = !prefs.hex_gui_hide_menu;
mymenu[MENUBAR_OFFSET+1].state = prefs.hex_gui_topicbar;
mymenu[MENUBAR_OFFSET+2].state = !prefs.hex_gui_ulist_hide;
@@ -2722,7 +2722,6 @@ menu_create_main (void *accel_group, int bar, int away, int toplevel,
mymenu[METRE_OFFSET+3].state = 1;
}
- /* change Close binding to ctrl-shift-w when using emacs keys */
settings = gtk_widget_get_settings (menu_bar);
if (settings)
{
@@ -2738,7 +2737,6 @@ menu_create_main (void *accel_group, int bar, int away, int toplevel,
}
}
- /* Away binding to ctrl-alt-a if the _Help menu conflicts (FR/PT/IT) */
{
char *help = _("_Help");
char *under = strchr (help, '_');
@@ -2775,7 +2773,6 @@ menu_create_main (void *accel_group, int bar, int away, int toplevel,
if (mymenu[i].id == MENU_ID_USERMENU)
usermenu = menu;
menu_item = gtk_menu_item_new_with_mnemonic (_(mymenu[i].text));
- /* record the English name for /menu */
g_object_set_data (G_OBJECT (menu_item), "name", mymenu[i].text);
#ifdef HAVE_GTK_MAC /* Added to app menu, see below */
if (!bar || mymenu[i].id != MENU_ID_ZOITECHAT)
@@ -2827,7 +2824,6 @@ normalitem:
togitem:
g_object_set_data (G_OBJECT (item), "zc-key-action", (gpointer) menu_get_key_action_name (i));
menu_add_keybinding_accel (item, accel_group, menu_get_key_action_name (i));
- /* must avoid callback for Radio buttons */
gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), mymenu[i].state);
/*gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item),
mymenu[i].state);*/
@@ -2867,7 +2863,6 @@ togitem:
group = NULL;
submenu = menu_new ();
item = create_icon_menu (_(mymenu[i].text), mymenu[i].image, TRUE);
- /* record the English name for /menu */
g_object_set_data (G_OBJECT (item), "name", mymenu[i].text);
gtk_menu_item_set_submenu (GTK_MENU_ITEM (item), submenu);
gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
@@ -2889,13 +2884,10 @@ togitem:
submenu = NULL;
}
- /* record this GtkWidget * so it's state might be changed later */
if (mymenu[i].id != 0 && menu_widgets)
- /* this ends up in sess->gui->menu_item[MENU_ID_XXX] */
menu_widgets[mymenu[i].id] = item;
#ifdef HAVE_GTK_MAC
- /* We want ZoiteChat to be the app menu, not including Quit or ZoiteChat itself */
if (bar && item && i <= CLOSE_OFFSET + 1 && mymenu[i].id != MENU_ID_ZOITECHAT)
{
if (!submenu || mymenu[i].type == M_MENUSUB)
diff --git a/win32/config.h.tt b/win32/config.h.tt
index 2860f6d4..6a807341 100644
--- a/win32/config.h.tt
+++ b/win32/config.h.tt
@@ -9,6 +9,7 @@
#define PACKAGE_VERSION "<#= [string]::Join('.', $versionParts) #>"
#define ZOITECHATLIBDIR ".\\plugins"
#define ZOITECHATSHAREDIR "."
+#define ZOITECHATDOCDIR "offline-docs"
#define OLD_PERL
#define GETTEXT_PACKAGE "zoitechat"
#define PACKAGE_TARNAME "zoitechat-<#= [string]::Join('.', $versionParts) #>"
diff --git a/win32/installer/zoitechat.iss.tt b/win32/installer/zoitechat.iss.tt
index 1c8204ec..b89ef9a0 100644
--- a/win32/installer/zoitechat.iss.tt
+++ b/win32/installer/zoitechat.iss.tt
@@ -49,6 +49,7 @@ Name: "icons"; Description: "Create Shortcuts"; Types: custom; Flags: disablenou
Name: "icons\desktopicon"; Description: "Create Desktop Shortcut"; Types: custom; Flags: disablenouninstallwarning
Name: "icons\quicklaunchicon"; Description: "Create Quick Launch Shortcut"; Types: custom; Flags: disablenouninstallwarning
Name: "translations"; Description: "Translations"; Types: normal custom; Flags: disablenouninstallwarning
+Name: "docs"; Description: "Offline Documentation"; Types: normal custom; Flags: disablenouninstallwarning
Name: "spell"; Description: "Spelling Dictionaries"; Types: custom; Flags: disablenouninstallwarning
Name: "plugins"; Description: "Plugins"; Types: custom; Flags: disablenouninstallwarning
Name: "plugins\checksum"; Description: "Checksum"; Types: custom; Flags: disablenouninstallwarning
@@ -109,6 +110,9 @@ Source: "share\themes\MS-Windows\*"; DestDir: "{app}\share\themes\MS-Windows"; F
Source: "share\glib-2.0\schemas\*"; DestDir: "{app}\share\glib-2.0\schemas"; Flags: ignoreversion createallsubdirs recursesubdirs skipifsourcedoesntexist; Components: libs
Source: "share\icons\hicolor\*"; DestDir: "{app}\share\icons\hicolor"; Flags: ignoreversion createallsubdirs recursesubdirs skipifsourcedoesntexist; Components: libs
Source: "share\locale\*"; DestDir: "{app}\share\locale"; Flags: ignoreversion createallsubdirs recursesubdirs; Components: translations
+; Staged at build time by data\misc\build_offline_docs.py; absent when the
+; docs could not be built, in which case Help->Contents opens the website
+Source: "offline-docs\*"; DestDir: "{app}\offline-docs"; Flags: ignoreversion createallsubdirs recursesubdirs skipifsourcedoesntexist; Components: docs
Source: "etc\fonts\*"; DestDir: "{app}\etc\fonts"; Flags: ignoreversion createallsubdirs recursesubdirs; Components: libs
Source: "atk-1.0-0.dll"; DestDir: "{app}"; Flags: ignoreversion; Components: libs