This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hop.git
The following commit(s) were added to refs/heads/main by this push:
new 228bdeea2c Document all the File Explorer right-click options and
update the toolbar screenshots. #9011 (#9031)
228bdeea2c is described below
commit 228bdeea2cd7a29e12db3760d10b793f13e356f8
Author: Adalennis <[email protected]>
AuthorDate: Tue Oct 20 15:27:05 2026 +0200
Document all the File Explorer right-click options and update the toolbar
screenshots. #9011 (#9031)
---
...perspective-explorer-git-toolbar-operations.png | Bin 95126 -> 53829 bytes
.../hop-gui/perspective-explorer-toolbar-items.png | Bin 94694 -> 54264 bytes
.../pages/hop-gui/perspective-file-explorer.adoc | 63 +++++++++++++--------
3 files changed, 40 insertions(+), 23 deletions(-)
diff --git
a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/perspective-explorer-git-toolbar-operations.png
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/perspective-explorer-git-toolbar-operations.png
index 1ba4594938..df554376fa 100644
Binary files
a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/perspective-explorer-git-toolbar-operations.png
and
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/perspective-explorer-git-toolbar-operations.png
differ
diff --git
a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/perspective-explorer-toolbar-items.png
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/perspective-explorer-toolbar-items.png
index 06e9279140..31fce2443b 100644
Binary files
a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/perspective-explorer-toolbar-items.png
and
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/perspective-explorer-toolbar-items.png
differ
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspective-file-explorer.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspective-file-explorer.adoc
index 63deef3846..1b7f2c4b0f 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspective-file-explorer.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspective-file-explorer.adoc
@@ -56,19 +56,47 @@ For more information on how to get started with workflows,
see the xref:getting-
The file operations are available through a number of toolbar options:
-image::hop-gui/perspective-explorer-toolbar-items.png[File explorer toolbar
items]
+image::hop-gui/perspective-explorer-toolbar-items.png[File explorer toolbar
items,width=438]
* Open selected file: Use the right arrow or double-click to open a selected
file. You can also open a file simply by double-clicking it. The file is opened
in a new tab in the editor area; pipelines and workflows open in their graph
editor. Select multiple files with `Ctrl` (`Cmd` on macOS) or `Shift` to open
them all at once.
* Create folder: Add a new folder. This works on a single selected folder.
-* Expand all folders: Display all nested folders in the directory tree.
-* Collapse all folders: Hide all nested folders in the directory tree.
-* Delete: Remove a selected file or folder. Only one file or folder at a time.
+* Expand All: Display all nested folders in the directory tree.
+* Collapse All: Hide all nested folders in the directory tree.
+* Delete: Remove the selected files and folders.
* Rename: Rename a file or folder. Only one file or folder at a time.
* Refresh: Refresh the file list.
* Show or hide files: Show or hide files or directories.
* Select opened file (`ALT+F1`): Select the file of the active editor tab in
the tree.
-New pipelines, workflows and files are created from the file explorer's
right-click menu rather than the toolbar; see the "Right-click menu options"
section below.
+New pipelines, workflows and files are created from the right-click menu
rather than the toolbar.
+
+[[right-click-menu]]
+=== Right-click menu
+
+Right-click a file or folder in the tree to open this menu.
+Options that don't apply to the selection are greyed out.
+
+* Create pipeline..., Create workflow..., Create file...: Create a new, empty
pipeline, workflow or file inside the selected folder and open it. For a file
you choose its name and file type. Only available when one folder is selected.
+* Create folder: Create a new folder inside the selected folder. Only
available when one folder is selected.
+* Expand All, Collapse All: Show or hide all nested folders in the tree.
+* Refresh folder: Read the selected folder, or the folder of the selected
file, again from disk.
+* Open: Open the selected files. A file opens in a new tab in the editor area;
pipelines and workflows open in their graph editor.
+* Open as text: Open the selected file as plain text, whatever its type. Only
available for a single file.
+* Open in explorer: Show the selected file or folder in the file manager of
your operating system. Only available for local files.
+* Open in VFS File Explorer: Open the location of the selection in the
xref:hop-gui/vfs-file-explorer.adoc[VFS File Explorer].
+* Rename: Change the name of the selected file or folder. Only one at a time.
+* Copy name, Copy path: Copy the name or the full path of the selection to the
clipboard, one line per selected item.
+* Find references: Search the project for the files that use the selected
pipeline or workflow. The results are listed in a tab at the bottom, where a
double-click opens them. Only available for a single pipeline or workflow.
+* Git Info, Git Add, Git Revert, Git Clean, Git Commit: The Git operations
described in <<git-right-click-menu>>.
+* Delete: Remove the selected files and folders. Make sure to use this
carefully, as it permanently deletes them from your directory.
+
+Plugins add their own options to this menu:
+
+* Edit as Hop install spec, with the
xref:hop-tools/hop-marketplace.adoc[Marketplace] plugin: Open a YAML or JSON
file in the Hop install spec editor. It does nothing for other files.
+* Lint This File, Lint This Folder, with the
xref:hop-tools/hop-lint.adoc[Lint] plugin: Check the selected file or folder
against the lint rules.
+* Exclude From Linting..., with the Lint plugin: Ask for a reason and exclude
the selection from linting in the project's lint policy. When the selection is
already excluded, it is included again.
+
+image::hop-gui/hop-gui-file-explorer-right-menu.png[Right-click menu in the
File Explorer perspective,width=245]
== Toggling the File Explorer Panel
@@ -118,29 +146,18 @@
image::hop-gui/perspective-explorer-git-visual-diff-example.png[Git visual diff
Small information icons will be added to the various transforms, actions and
hops to indicate if they were changed, deleted or added.
-=== Right-click menu options
-The right-click menu in Apache Hop Git integration offers several useful
options to help manage your files and Git operations directly from the
interface. Here’s a breakdown of each option:
-
-* Create pipeline: Create a new, empty pipeline inside the selected folder and
open it. Only available when a folder is selected.
-* Create workflow: Create a new, empty workflow inside the selected folder and
open it. Only available when a folder is selected.
-* Create file: Create a new, empty file inside the selected folder, choosing
its name and file type, and open it. Only available when a folder is selected.
-* Create folder: Create a new folder within the selected directory. This is
useful for organizing workflows, pipelines, and other project resources. Only
available when a folder is selected.
-* Expand all folders: Reveals all nested folders in the project directory
tree. Useful for getting a full overview of your project structure without
opening folders one by one.
-* Collapse all folders: Closes all expanded folders, showing only the
top-level directory. Helps reset the view or reduce visual clutter.
-* Open: Opens the selected file or folder. The file opens in a new tab in the
editor area; workflows and pipelines open in their graph editor.
-* Rename: Allows you to change the name of the selected file or folder,
helping you keep your project files organized and clearly labeled.
-* Copy name: Copies the name of the selected file or folder to your clipboard,
making it easy to paste and reference elsewhere.
-* Copy path: Copies the full path of the selected file or folder to your
clipboard, useful for quick navigation or sharing the location with others.
+[[git-right-click-menu]]
+=== Git options in the right-click menu
+
+When the project is in a Git repository, the <<right-click-menu,right-click
menu>> also has these options:
+
* Git Info: Displays detailed information about the Git status of the selected
file, including any recent changes.
* Git Add: Stages the selected file(s) for commit, meaning the changes are
prepared for inclusion in your next Git commit.
* Git Revert: Restores modified files in the selection from the last committed
version (HEAD). A new staged file is only unstaged and stays on disk; deleting
it is Git Clean. A dialog lets you pick the files.
* Git Clean: Deletes files that git does not track from disk, after you pick
them in a dialog.
* Git Commit: Opens the xref:hop-gui/perspective-git-commit.adoc[Git commit
perspective], where you review your changes and commit them with a message. In
Hop Web it opens a commit dialog instead.
-* Delete: Removes the selected file or folder from your project. Make sure to
use this carefully, as it permanently deletes the item from your directory.
-
-image::hop-gui/hop-gui-file-explorer-right-menu.png[git right-click menu
options in the explorer perspective]
-==== Git operations
+=== Git operations
Here are the basic git operations that are supported:
@@ -154,5 +171,5 @@ Push, pull and the branch operations are in the branch menu
of the status bar an
You can access these operations from the toolbar above the file explorer tree:
-image::hop-gui/perspective-explorer-git-toolbar-operations.png[git toolbar
items in the explorer perspective]
+image::hop-gui/perspective-explorer-git-toolbar-operations.png[git toolbar
items in the explorer perspective,width=437]
