Updated docs (#462)

* Update documentation * Mention dropping folders in Projects pane. * Add info on adding "setarch x86" to build commands in project settings. * Mention status bar in Appearance menu and overview in the quick start ReadMe page. * Rename "Output pane" to "Info pane", incl. screenshot file names. * Add "Go to symbol" to Outline context menu. * Add search panel in "Search results" tab of the Info pane. * Add "Run" pop-up menu to "Console bar". * Add "Appearance" section to Genio settings. * Add "Build file path" in Project settings. * Remove "Defaults" button in Project settings screenshots. * Add "Set active" in Project menu. * Docs: Proper legend for overview screenshot Put a proper legend for the numbered sections of the overview screenshot below the image. Link to sections of the docs. * Docs: Optimizing PNGs Saving ~40% on filesize by virtually invisible lossy PNG compression with: pngquant --force --output "${!i}" --speed 1 --nofs --quality 90 oxipng -o max -a -p -s
Genio-The-Haiku-IDE · Dec 13, 2024 · 3808c9f · 3808c9f
1 parent f5881d8
commit 3808c9f
Show file tree

Hide file tree

Showing 78 changed files with 55 additions and 20 deletions.
diff --git a/.genio b/.genio
diff --git a/documentation/ReadMe.html b/documentation/ReadMe.html
@@ -37,10 +37,19 @@ <h1>Genio's User Documentation</h1>
 
 <h1>Quick start</h1>
 
-<p>For orientation, let's start with a quick overview of Genio's main window, with its <span class="menu">Projects</span> pane to the left (1), <span class="menu">Output</span> pane at the bottom (2), the <span class="menu">Outline</span> pane at the right (3), the <span class="menu">Editor</span> view in the middle (4), and <span class="menu">Menu and Toolbar</span> at the top (5).</p>
+<p>For orientation, let's start with a quick overview of Genio's main window:</p>
 
 <p style="text-align:center"><img src="./images/main_window.png" style="border:none" alt="Genio's main window" /></p>
 
+<table summary="layout" align="center">
+<tr><td>① The <a href="panes.html#projects-pane"><span class="menu">Projects</span></a> pane to the left<br />
+② The <a href="panes.html#info-pane"><span class="menu">Info</span></a> pane at the bottom<br />
+③ The <a href="panes.html#outline-pane"><span class="menu">Outline</span></a> pane at the right</td>
+<td width="100px"></td>
+<td>④ The <a href="editor.html"><span class="menu">Editor</span></a> view in the middle<br />
+⑤ The <a href="menus.html"><span class="menu">Menus</span></a> and <a href="toolbar.html"><span class="menu">Toolbar</span></a> at the top<br />
+⑥ The <span class="menu">Statusbar</span> at the bottom</td></tr>
+</table>
 
 <h2><a id="open-project" name="open-project">Open/create a new project</a></h2>
 

diff --git a/documentation/images/editor-completion-1.png b/documentation/images/editor-completion-1.png
diff --git a/documentation/images/editor-completion-2.png b/documentation/images/editor-completion-2.png
diff --git a/documentation/images/editor-completion-3.png b/documentation/images/editor-completion-3.png
diff --git a/documentation/images/editor-correction.png b/documentation/images/editor-correction.png
diff --git a/documentation/images/editor-linked_info.png b/documentation/images/editor-linked_info.png
diff --git a/documentation/images/editor-status.png b/documentation/images/editor-status.png
diff --git a/documentation/images/editor-view.png b/documentation/images/editor-view.png
diff --git a/documentation/images/genio-settings-build.png b/documentation/images/genio-settings-build.png
diff --git a/documentation/images/genio-settings-editor.png b/documentation/images/genio-settings-editor.png
diff --git a/documentation/images/genio-settings-editor_find.png b/documentation/images/genio-settings-editor_find.png
diff --git a/documentation/images/genio-settings-editor_visual.png b/documentation/images/genio-settings-editor_visual.png
diff --git a/documentation/images/genio-settings-general.png b/documentation/images/genio-settings-general.png
diff --git a/documentation/images/genio-settings-general_appearance.png b/documentation/images/genio-settings-general_appearance.png
diff --git a/documentation/images/genio-settings-general_startup.png b/documentation/images/genio-settings-general_startup.png
diff --git a/documentation/images/genio-settings-lsp.png b/documentation/images/genio-settings-lsp.png
diff --git a/documentation/images/genio-settings-source_control.png b/documentation/images/genio-settings-source_control.png
diff --git a/documentation/images/genio_logo.png b/documentation/images/genio_logo.png
diff --git a/documentation/images/icons/info-box_32.png b/documentation/images/icons/info-box_32.png
diff --git a/documentation/images/icons/kIconBack_1.png b/documentation/images/icons/kIconBack_1.png
diff --git a/documentation/images/icons/kIconBuild.png b/documentation/images/icons/kIconBuild.png
diff --git a/documentation/images/icons/kIconClean.png b/documentation/images/icons/kIconClean.png
diff --git a/documentation/images/icons/kIconClose.png b/documentation/images/icons/kIconClose.png
diff --git a/documentation/images/icons/kIconDebug.png b/documentation/images/icons/kIconDebug.png
diff --git a/documentation/images/icons/kIconFileList.png b/documentation/images/icons/kIconFileList.png
diff --git a/documentation/images/icons/kIconFind.png b/documentation/images/icons/kIconFind.png
diff --git a/documentation/images/icons/kIconFold_4.png b/documentation/images/icons/kIconFold_4.png
diff --git a/documentation/images/icons/kIconForward_2.png b/documentation/images/icons/kIconForward_2.png
diff --git a/documentation/images/icons/kIconLocked.png b/documentation/images/icons/kIconLocked.png
diff --git a/documentation/images/icons/kIconRedo.png b/documentation/images/icons/kIconRedo.png
diff --git a/documentation/images/icons/kIconReplace.png b/documentation/images/icons/kIconReplace.png
diff --git a/documentation/images/icons/kIconRun.png b/documentation/images/icons/kIconRun.png
diff --git a/documentation/images/icons/kIconSave.png b/documentation/images/icons/kIconSave.png
diff --git a/documentation/images/icons/kIconSaveAll.png b/documentation/images/icons/kIconSaveAll.png
diff --git a/documentation/images/icons/kIconShowPunctuation.png b/documentation/images/icons/kIconShowPunctuation.png
diff --git a/documentation/images/icons/kIconTerminal.png b/documentation/images/icons/kIconTerminal.png
diff --git a/documentation/images/icons/kIconUndo.png b/documentation/images/icons/kIconUndo.png
diff --git a/documentation/images/icons/kIconWinNav.png b/documentation/images/icons/kIconWinNav.png
diff --git a/documentation/images/icons/kIconWinOutline.png b/documentation/images/icons/kIconWinOutline.png
diff --git a/documentation/images/icons/kIconWinStat.png b/documentation/images/icons/kIconWinStat.png
diff --git a/documentation/images/icons/kIconWrapLines.png b/documentation/images/icons/kIconWrapLines.png
diff --git a/documentation/images/main_window.png b/documentation/images/main_window.png
diff --git a/documentation/images/menus-edit.png b/documentation/images/menus-edit.png
diff --git a/documentation/images/menus-file.png b/documentation/images/menus-file.png
diff --git a/documentation/images/menus-genio.png b/documentation/images/menus-genio.png
diff --git a/documentation/images/menus-git.png b/documentation/images/menus-git.png
diff --git a/documentation/images/menus-project.png b/documentation/images/menus-project.png
diff --git a/documentation/images/menus-search.png b/documentation/images/menus-search.png
diff --git a/documentation/images/menus-view.png b/documentation/images/menus-view.png
diff --git a/documentation/images/menus-window.png b/documentation/images/menus-window.png
diff --git a/documentation/images/open_remote_project.png b/documentation/images/open_remote_project.png
diff --git a/documentation/images/panes-info_build_log.png b/documentation/images/panes-info_build_log.png
diff --git a/documentation/images/panes-info_console_io.png b/documentation/images/panes-info_console_io.png
diff --git a/documentation/images/panes-info_problems.png b/documentation/images/panes-info_problems.png
diff --git a/documentation/images/panes-info_search_results.png b/documentation/images/panes-info_search_results.png
diff --git a/documentation/images/panes-outline.png b/documentation/images/panes-outline.png
diff --git a/documentation/images/panes-output_build_log.png b/documentation/images/panes-output_build_log.png
diff --git a/documentation/images/panes-output_console_io.png b/documentation/images/panes-output_console_io.png
diff --git a/documentation/images/panes-output_problems.png b/documentation/images/panes-output_problems.png
diff --git a/documentation/images/panes-output_search_results.png b/documentation/images/panes-output_search_results.png
diff --git a/documentation/images/panes-projects.png b/documentation/images/panes-projects.png
diff --git a/documentation/images/panes-source_control.png b/documentation/images/panes-source_control.png
diff --git a/documentation/images/project-settings-build.png b/documentation/images/project-settings-build.png
diff --git a/documentation/images/project-settings-build_debug.png b/documentation/images/project-settings-build_debug.png
diff --git a/documentation/images/project-settings-build_release.png b/documentation/images/project-settings-build_release.png
diff --git a/documentation/images/project-settings-general.png b/documentation/images/project-settings-general.png
diff --git a/documentation/images/project-settings-run.png b/documentation/images/project-settings-run.png
diff --git a/documentation/images/toolbar-console_bar.png b/documentation/images/toolbar-console_bar.png
diff --git a/documentation/images/toolbar-find_bar.png b/documentation/images/toolbar-find_bar.png
diff --git a/documentation/images/toolbar-replace_bar.png b/documentation/images/toolbar-replace_bar.png
diff --git a/documentation/images/toolbar-toolbar.png b/documentation/images/toolbar-toolbar.png
diff --git a/documentation/images/up.png b/documentation/images/up.png
diff --git a/documentation/menus.html b/documentation/menus.html
@@ -116,6 +116,8 @@ <h2>
 
 <p style="margin-top: 2.2em"><span class="menu">Open project…</span> and <span class="menu">Open remote project…</span> are described on the QuickStart page under <a href="ReadMe.html#local">Local project</a> and <a href="ReadMe.html#remote">Remote project</a>.</p>
 
+<p>Under <span class="menu">Set active</span> you find all currently open projects. Only one can be chosen and is then the target for actions like building, cleaning or finding a string in the project.</p>
+
 <p><span class="menu">Build project</span> and <span class="menu">Clean project</span> will build or clean the active project according to the set <span class="menu">Build mode</span>, either as "release" or "debug".</p>
 
 <p><span class="menu">Run target</span> will launch the built binary.</p>
@@ -146,7 +148,7 @@ <h2>
 
 <img src="./images/menus-window.png" class="floatleft" style="margin-bottom: 4em" alt="Window menu" />
 
-<p style="margin-top: 2.2em">You can show/hide panes and toolbar under <span class="menu">Appearance</span>.</p>
+<p style="margin-top: 2.2em">You can show/hide panes and tool- and statusbar under <span class="menu">Appearance</span>.</p>
 
 <p>Genio's window can be made <span class="menu">Fullscreen</span> (<span class="key">ALT</span>&nbsp;<span class="key">ENTER</span>).</p>
 

diff --git a/documentation/panes.html b/documentation/panes.html
@@ -31,18 +31,18 @@
 	<a href="#projects-pane">The Projects pane</a><br />
 	<a href="#projects-projects">┣━ Projects</a><br />
 	<a href="#projects-source-control">┗━ Source control</a><br />
-	<a href="#output-pane">The Output pane</a><br />
-	<a href="#output-problems">┣━ Problems</a><br />
-	<a href="#output-build-log">┣━ Build log</a><br />
-	<a href="#output-console-io">┣━ Console I/O</a><br />
-	<a href="#output-search-results">┗━ Search results</a><br />
+	<a href="#info-pane">The Info pane</a><br />
+	<a href="#info-problems">┣━ Problems</a><br />
+	<a href="#info-build-log">┣━ Build log</a><br />
+	<a href="#info-console-io">┣━ Console I/O</a><br />
+	<a href="#info-search-results">┗━ Search results</a><br />
 	<a href="#outline-pane">The Outline pane</a>
 </td></tr>
 </tbody></table>
 
 <h1>The Panes</h1>
 
-<p>Genio's main window contains three panes besides the toolbar and the editor view: The Projects pane on the left, the Outline pane on the right, and the Output pane at the bottom. They can be toggled on and off with the first three icons in the toolbar, or from the menu <span class="menu">Window|Appearance</span>.</p>
+<p>Genio's main window contains three panes besides the toolbar and the editor view: The Projects pane on the left, the Outline pane on the right, and the Info pane at the bottom. They can be toggled on and off with the first three icons in the toolbar, or from the menu <span class="menu">Window|Appearance</span>.</p>
 
 
 <h2>
@@ -67,6 +67,8 @@ <h3>
 <p>A right-click on files or folders inside the project allows you to rename, delete or open a file with its preferred application, etc.</p>
 
 <p>Double-clicking a file opens it in the editor view, if it's a text file. Filetypes unsupported by Genio get opened in their preferred application. For example, a Bookmark file opens in WebPositive and an icon in Icon-O-Matic.</p>
+
+<p>You can drop a folder from a Tracker window onto the pane to add it as another project.</p>
 <p style="clear:left"></p>
 
 
@@ -90,26 +92,26 @@ <h3>
 
 <h2>
 <a href="#"><img src="./images/up.png" style="border:none;float:right" alt="index" /></a>
-<a id="output-pane" name="output-pane">The Output pane</a></h2>
+<a id="info-pane" name="info-pane">The Info pane</a></h2>
 
-<p>The Output pane consists of four tabs: <span class="menu">Problems</span>, the <span class="menu">Build log</span>, the <span class="menu">Console I/O</span> and <span class="menu">Search results</span>.</p>
+<p>The Info pane consists of four tabs: <span class="menu">Problems</span>, the <span class="menu">Build log</span>, the <span class="menu">Console I/O</span> and <span class="menu">Search results</span>.</p>
 
 
 <h3>
 <a href="#"><img src="./images/up.png" style="border:none;float:right" alt="index" /></a>
-<a id="output-problems" name="output-problems">Problems</a></h3>
+<a id="info-problems" name="info-problems">Problems</a></h3>
 
-<p style="text-align:center"><img src="./images/panes-output_problems.png" style="border:none" alt="Problems" /></p>
+<p style="text-align:center"><img src="./images/panes-info_problems.png" style="border:none" alt="Problems" /></p>
 
 <p>Clang is continuously analyzing the current file in the editor view and reports any problems it thinks it has found. Sometimes those are false positives and can be ignored. Often it's very helpful, however, to spot typos or missing commas etc.<br />
 A right-click on a row offers to fix the issue, if possible.</p>
 
 
 <h3>
 <a href="#"><img src="./images/up.png" style="border:none;float:right" alt="index" /></a>
-<a id="output-build-log" name="output-build-log">Build log</a></h3>
+<a id="info-build-log" name="info-build-log">Build log</a></h3>
 
-<p style="text-align:center"><img src="./images/panes-output_build_log.png" style="border:none" alt="Build log" /></p>
+<p style="text-align:center"><img src="./images/panes-info_build_log.png" style="border:none" alt="Build log" /></p>
 
 <p>When you're building your project, the "Build log" tab pops up, showing the build process.<br />
 Warnings and errors are printed in red, showing in which file, on what line and column the error was encountered. Click on it, and you're transported right to it.</p>
@@ -120,9 +122,9 @@ <h3>
 
 <h3>
 <a href="#"><img src="./images/up.png" style="border:none;float:right" alt="index" /></a>
-<a id="output-console-io" name="output-console-io">Console I/O</a></h3>
+<a id="info-console-io" name="info-console-io">Console I/O</a></h3>
 
-<p style="text-align:center"><img src="./images/panes-output_console_io.png" style="border:none" alt="Console I/O" /></p>
+<p style="text-align:center"><img src="./images/panes-info_console_io.png" style="border:none" alt="Console I/O" /></p>
 
 <p>If you execute a command from the <span class="menu">Git</span> menu, like <span class="cli">git status</span>, or choose to <span class="menu">Run console program</span> or <span class="menu">Run target</span> from the <a href="toolbar.html">Toolbar</a>, its output will appear in the "Console I/O" tab.</p>
 
@@ -131,12 +133,14 @@ <h3>
 
 <h3>
 <a href="#"><img src="./images/up.png" style="border:none;float:right" alt="index" /></a>
-<a id="output-search-results" name="output-search-results">Search results</a></h3>
+<a id="info-search-results" name="info-search-results">Search results</a></h3>
 
-<p style="text-align:center"><img src="./images/panes-output_search_results.png" style="border:none" alt="Search results" /></p>
+<p style="text-align:center"><img src="./images/panes-info_search_results.png" style="border:none" alt="Search results" /></p>
 
 <p>If you click the icon <span class="menu">Find in project</span> in the <a href="toolbar.html">Find bar</a>, this tab will show all the hits from all files of the currently active project. Double-click to jump to the search result.</p>
 
+<p>To the right is a search panel that is similar to the 'Find bar'. It is in fact synced with the 'Find bar' whenever you do a <span class="menu">Find in project</span> there. The additional <span class="menu">Project</span> menu let's you select another but the currently active project as a search target.</p>
+
 
 <h2>
 <a href="#"><img src="./images/up.png" style="border:none;float:right" alt="index" /></a>
@@ -148,7 +152,7 @@ <h2>
 
 <p>Double-clicking an entry jumps to it in the file currently open in the editor.</p>
 
-<p>Right-clicking an entry, you can choose <span class="menu">Rename symbol…</span> from the context menu to change the name of that symbol in the whole project.</p>
+<p>Right-clicking an entry opens a context menu where <span class="menu">Go to symbol</span> does the same as a double-click and <span class="menu">Rename symbol…</span> changes the name of that symbol in the whole project.</p>
 <p>For this to work correctly in all situations, you need to create a compile database file (<tt>compile_commands.json</tt>). See <a href="./settings-lsp.html">Configuring Clangd / LSP</a> on how that can be done very easily.</p>
 
 <p style="clear:left"></p>

diff --git a/documentation/settings-genio.html b/documentation/settings-genio.html
@@ -30,6 +30,7 @@
 <tr class="index"><td>
 	<a href="#general">General</a><br />
 	<a href="#general_startup"> ┗━ Startup</a><br />
+	<a href="#general_appearance"> ┗━ Appearance</a><br />
 	<a href="#editor">Editor</a><br />
 	<a href="#editor_visual">┣━ Visual</a><br />
 	<a href="#editor_find"> ┗━ Find</a><br />
@@ -43,6 +44,8 @@ <h1><a id="genio" name="genio">The Genio Settings</a></h1>
 
 <p>From the list on the left, you choose the different settings categories.</p>
 
+<p><span class="button">Defaults</span> will reset all settings to their defaults.</p>
+
 <h2>
 <a href="#"><img src="./images/up.png" style="border:none;float:right" alt="index" /></a>
 <a id="general" name="general">General</a></h2>
@@ -73,7 +76,16 @@ <h2>
 
 <p style="text-align:center"><img src="./images/genio-settings-general_startup.png" style="border:none;padding:15px" alt="Genio settings: General / Startup" /></p>
 
-<p>These settings determine how Genio will behave on startup: if the projects and files that were open when you last quit Genio are reloaded, and which panes etc. are to be shown by default when Genio launches.</p>
+<p>These settings determine how Genio will behave on startup. You decide if the projects and files that were open when you last quit Genio are reloaded when it launches.</p>
+
+
+<h2>
+<a href="#"><img src="./images/up.png" style="border:none;float:right" alt="index" /></a>
+<a id="general_appearance" name="general_appearance">General / Appearance</a></h2>
+
+<p style="text-align:center"><img src="./images/genio-settings-general_appearance.png" style="border:none;padding:15px" alt="Genio settings: General / Appearance" /></p>
+
+<p>These settings determine Genio's default look. Besides setting which panes and bars are shown by default when Genio launches, you can also opt to <span class="menu">Use smaller icons in toolbar</span> to save precious space.</p>
 
 
 <h2>

diff --git a/documentation/settings-project.html b/documentation/settings-project.html
@@ -59,6 +59,8 @@ <h2>
 <p>Here you chose to build either in <span class="menu">release</span> or <span class="menu">debug</span> mode when invoking <span class="menu">Project|Build project</span> (<span class="key">ALT</span>&nbsp;<span class="key">B</span>) or via the toolbar icon.<br />
 There's also the <span class="menu">Project|Build mode</span> menu to quickly switch between the two modes.</p>
 
+<p>You can set a <span class="menu">Build file path</span> if, for example, your Makefile isn't in the project's top folder but in a "source" subfolder.</p>
+
 <h3>
 <a href="#"><img src="./images/up.png" style="border:none;float:right" alt="index" /></a>
 <a id="project-build_release" name="project-build_release">Build / Release</a></h3>
@@ -84,6 +86,7 @@ <h3>
 
 <p>If you haven't configured your build commands correctly, the corresponding icon in the toolbar will be inactive.</p>
 
+<div class="box-info">If you're on 32bit Haiku and need to compile with a modern compiler instead of the default <tt>gcc 2.95</tt>, you can prepend <tt>setarch x86</tt> to the build commands so they say for example: <tt>setarch x86 make -j$(nproc)</tt>.</div>
 
 <h3>
 <a href="#"><img src="./images/up.png" style="border:none;float:right" alt="index" /></a>

diff --git a/documentation/toolbar.html b/documentation/toolbar.html
@@ -201,8 +201,13 @@ <h2>
 <p style="text-align:center"><img src="./images/toolbar-console_bar.png" alt="Console bar" /></p>
 
 <p>The text field acts like a command prompt with the active project's top folder as working directory. You can execute any command and see the output in the <a href="panes.html#console-io">Console I/O</a> tab of the output pane.</p>
+
 <p>Hitting <span class="key">TAB</span> or <span class="key">ENTER</span> or click <span class="button">Run</span> to execute the entered command line.</p>
 
+<p><span class="key">ESC</span> closes the Console bar.</p>
+
+<p>Previous commands can be found in the <span class="menu">Run</span> pop-up menu.</p>
+
 <hr />
 <a href="panes.html" style="border:none;float:left">Back: Panes</a>
 <a href="menus.html" style="border:none;float:right">Next: Menus</a>