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 e246a92b83 Document the File Explorer file types and text editor
features #9070 (#9088)
e246a92b83 is described below
commit e246a92b83990f3289af45ab6374e3ce1a65e98f
Author: Ankit Garg <[email protected]>
AuthorDate: Sat Oct 24 13:09:45 2026 +0530
Document the File Explorer file types and text editor features #9070 (#9088)
List all the file types the File Explorer handles with their extensions,
including BAT and CMD, shell, Python, SQL, YAML, HTML, PDF and the text
files that are matched by name. Say that HTML and PDF are shown rendered.
Describe Find and Find/Replace in the text editor, the Pretty-print JSON
button and the Markdown preview tab.
---
.../pages/hop-gui/perspective-file-explorer.adoc | 63 +++++++++++++++++++++-
1 file changed, 62 insertions(+), 1 deletion(-)
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 735c1b3c06..4f08079acf 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
@@ -32,7 +32,7 @@ This is where xref:pipeline/pipelines.adoc[pipelines] and
xref:workflow/workflow
The project tree on the left shows the files in your project.
Files you open appear as tabs in the editor area next to the tree.
This perspective contains handlers for the most common file types known to Hop.
-These are obviously hwf (workflows) and hpl (pipelines), but also JSON, CSV,
TXT, XML, Markdown, SVG, Log and SAS 7 BDAT files.
+These are obviously hwf (workflows) and hpl (pipelines), but also many text
and document formats, listed in <<file-types>>.
The File Explorer perspective is also where you'll manage version control for
your projects through xref:hop-gui/hop-gui-git.adoc[Git integration].
NOTE: Older Hop versions had a separate Data Orchestration perspective for
editing pipelines and workflows. It has been merged into the File Explorer
perspective.
@@ -52,6 +52,67 @@ For more information on how to get started with pipelines,
see the xref:getting-
For more information on how to get started with workflows, see the
xref:getting-started/hop-gui-workflows.adoc[Workflows getting started guide].
+[[file-types]]
+== File types
+
+Besides pipelines (hpl) and workflows (hwf), the File Explorer has handlers
for these file types:
+
+[options="header",cols="2,2,5"]
+|===
+|Type |Files |Notes
+
+|JSON |`*.json` |Has a <<pretty-print-json,Pretty-print JSON>> button.
+|CSV |`*.csv` |
+|Text |`*.txt` |
+|Text files without an extension |`config`, `.gitignore`, `.profile`,
`.bashrc`, `.gitconfig`, `Dockerfile`, `Jenkinsfile`, `README`, `READ.me`
|Matched by file name.
+|XML |`*.xml` |
+|YAML |`*.yml`, `*.yaml` |
+|SQL |`*.sql` |
+|Markdown |`*.md` |Has a <<markdown-preview,preview>>.
+|Shell script |`*.sh` |
+|Windows batch and command files |`*.bat`, `*.cmd` |
+|Python |`*.py` |
+|HTML |`*.html`, `*.htm` |Shown rendered, not as text.
+|PDF |`*.pdf` |Shown rendered, not as text.
+|SVG |`*.svg` |
+|Log |`*.log` |
+|SAS 7 BDAT |`*.sas7bdat` |
+|Excel |`*.xls`, `*.xlsx` |
+|Parquet |`*.parquet`, `*.parq` |
+|Archive |`*.zip`, `*.7z`, `*.gz`, `*.rar` |
+|===
+
+To see any other file, or one of these as plain text, use *Open as text* in
the <<right-click-menu,right-click menu>>.
+
+[[text-editor]]
+== Editing text files
+
+The editor of the text based file types has the usual editing options,
including undo and redo, cut, copy and paste, and select all.
+
+=== Find and replace
+
+* Find, `Ctrl+F` (`Cmd+F` on macOS): Search for text in the file.
+* Find/Replace, `Ctrl+H` (`Cmd+H` on macOS): Search for text and replace it.
+
+Both are in the right-click menu of the editor.
+They are also in the text editor toolbar, which is shown when the option *Show
text editor toolbar* is enabled in the
xref:hop-gui/perspective-configuration.adoc[Configuration perspective].
+
+[[pretty-print-json]]
+=== Pretty-print JSON
+
+The toolbar of a JSON file has a *Pretty-print JSON* button.
+It formats the text of the editor.
+When the text is not valid JSON, it shows the error *JSON format error*
instead and leaves the text as it is.
+
+[[markdown-preview]]
+=== Markdown preview
+
+The toolbar of a Markdown file has a button *Show the rendered version of this
Markdown file in a preview tab*.
+It opens a tab called `<file> (preview)` with the rendered file.
+Pressing the button again refreshes that tab and selects it.
+While the preview tab is open, it also follows the editor: it is rendered
again a moment after you stop typing.
+The preview tab closes together with the tab of the Markdown file.
+
== File operations
The file operations are available through a number of toolbar options:
