diff --git a/package.json b/package.json
index af96077bc..b2cf4758b 100644
--- a/package.json
+++ b/package.json
@@ -102,13 +102,6 @@
"esm": "3.2.25",
"jasmine": "4.5.0",
"jsdoc": "4.0.1",
- "build-api-docs": "./bin/build-api-docs.sh",
- "postinstall": "node src-build/fix_pdfjs.js"
- "better-sqlite3": "8.1.0",
- "canvas": "2.11.0",
- "ocrad.js": "antimatter15/ocrad.js#master",
- "pdfjs-dist": "3.3.122",
- "electron": "23.1.0",
"lorem-ipsum": "2.0.8",
"rcedit": "3.0.1",
"webpack": "5.75.0",
diff --git a/src/public/app/components/root_command_executor.js b/src/public/app/components/root_command_executor.js
index d5403d990..12bf68156 100644
--- a/src/public/app/components/root_command_executor.js
+++ b/src/public/app/components/root_command_executor.js
@@ -106,6 +106,10 @@ export default class RootCommandExecutor extends Component {
await this.showAndHoistSubtree('_search');
}
+ async showUserGuideCommand() {
+ await this.showAndHoistSubtree('_userGuide');
+ }
+
async showAndHoistSubtree(subtreeNoteId) {
await appContext.tabManager.openContextWithNote(subtreeNoteId, {
activate: true,
diff --git a/src/public/app/widgets/buttons/global_menu.js b/src/public/app/widgets/buttons/global_menu.js
index 8108655b7..653cb684a 100644
--- a/src/public/app/widgets/buttons/global_menu.js
+++ b/src/public/app/widgets/buttons/global_menu.js
@@ -75,7 +75,7 @@ const TPL = `
margin-right: 5px;
}
- body.mobile .show-help-button, body.mobile .show-about-dialog-button {
+ body.mobile .show-user-guide-button, body.mobile .show-about-dialog-button {
/* hidden because these dialogs are not available for mobile */
display: none;
}
@@ -195,10 +195,10 @@ const TPL = `
-
+
- Show Help
-
+ Show User Guide
+
diff --git a/src/public/app/widgets/dialogs/help.js b/src/public/app/widgets/dialogs/help.js
index d3f8ecf4f..b15ca841b 100644
--- a/src/public/app/widgets/dialogs/help.js
+++ b/src/public/app/widgets/dialogs/help.js
@@ -1,4 +1,3 @@
-import utils from "../../services/utils.js";
import BasicWidget from "../basic_widget.js";
const TPL = `
@@ -156,8 +155,4 @@ export default class HelpDialog extends BasicWidget {
doRender() {
this.$widget = $(TPL);
}
-
- showHelpEvent() {
- utils.openDialog(this.$widget);
- }
}
diff --git a/src/services/hidden_subtree.js b/src/services/hidden_subtree.js
index a4f69cbe4..b1e86b3e3 100644
--- a/src/services/hidden_subtree.js
+++ b/src/services/hidden_subtree.js
@@ -72,6 +72,12 @@ const HIDDEN_SUBTREE_DEFINITION = {
{ type: 'label', name: 'keepCurrentHoisting' }
]
},
+ {
+ id: '_userGuide',
+ title: 'User Guide',
+ type: 'text',
+ icon: 'bx-help-circle'
+ },
{
// place for user scripts hidden stuff (scripts should not create notes directly under hidden root)
id: '_userHidden',
diff --git a/src/services/keyboard_actions.js b/src/services/keyboard_actions.js
index d665692a9..0752e3c63 100644
--- a/src/services/keyboard_actions.js
+++ b/src/services/keyboard_actions.js
@@ -273,9 +273,9 @@ const DEFAULT_KEYBOARD_ACTIONS = [
scope: "window"
},
{
- actionName: "showHelp",
+ actionName: "showUserGuide",
defaultShortcuts: ["F1"],
- description: "Shows built-in Help / cheatsheet",
+ description: "Shows User Guide",
scope: "window"
},
diff --git a/src/services/resource_dir.js b/src/services/resource_dir.js
index 862887474..0e968d42a 100644
--- a/src/services/resource_dir.js
+++ b/src/services/resource_dir.js
@@ -20,9 +20,12 @@ if (!fs.existsSync(MIGRATIONS_DIR)) {
process.exit(1);
}
+const USER_GUIDE_ZIP_DIR = path.resolve(RESOURCE_DIR, "tmp");
+
module.exports = {
RESOURCE_DIR,
MIGRATIONS_DIR,
DB_INIT_DIR,
- ELECTRON_APP_ROOT_DIR
+ ELECTRON_APP_ROOT_DIR,
+ USER_GUIDE_ZIP_DIR
};