You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hop.apache.org by ba...@apache.org on 2021/04/09 17:45:09 UTC
[incubator-hop-docs] branch asf-site updated: HOP-2743 document
file dialog usage (#69)
This is an automated email from the ASF dual-hosted git repository.
bartmaer pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-hop-docs.git
The following commit(s) were added to refs/heads/asf-site by this push:
new bb0f6d3 HOP-2743 document file dialog usage (#69)
bb0f6d3 is described below
commit bb0f6d3531852e4c2a3ba7b9a325a2125c0a9764
Author: Bart Maertens <ba...@know.bi>
AuthorDate: Fri Apr 9 19:44:34 2021 +0200
HOP-2743 document file dialog usage (#69)
---
.../ROOT/assets/images/hop-gui/file-dialog.png | Bin 0 -> 102646 bytes
.../ROOT/assets/images/icons/bookmark-add.svg | 12 ++++++
.../modules/ROOT/assets/images/icons/bookmark.svg | 1 +
.../modules/ROOT/assets/images/icons/delete.svg | 15 +++++++
.../ROOT/assets/images/icons/folder-add.svg | 13 ++++++
.../modules/ROOT/assets/images/icons/home.svg | 13 ++++++
.../ROOT/assets/images/icons/navigate-back.svg | 17 ++++++++
.../ROOT/assets/images/icons/navigate-forward.svg | 17 ++++++++
.../ROOT/assets/images/icons/navigate-up.svg | 17 ++++++++
.../modules/ROOT/assets/images/icons/preview.svg | 15 +++++++
.../modules/ROOT/assets/images/icons/project.svg | 27 ++++++++++++
.../modules/ROOT/assets/images/icons/refresh.svg | 12 ++++++
hop-user-manual/modules/ROOT/nav.adoc | 1 +
.../modules/ROOT/pages/hop-gui/file-dialog.adoc | 46 ++++++++++++++++++++-
hop-user-manual/modules/ROOT/pages/index.adoc | 2 +-
15 files changed, 206 insertions(+), 2 deletions(-)
diff --git a/hop-user-manual/modules/ROOT/assets/images/hop-gui/file-dialog.png b/hop-user-manual/modules/ROOT/assets/images/hop-gui/file-dialog.png
new file mode 100644
index 0000000..a6470f3
Binary files /dev/null and b/hop-user-manual/modules/ROOT/assets/images/hop-gui/file-dialog.png differ
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/bookmark-add.svg b/hop-user-manual/modules/ROOT/assets/images/icons/bookmark-add.svg
new file mode 100644
index 0000000..69a2e3e
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/bookmark-add.svg
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ width="24"
+ height="24"
+ viewBox="0 0 24 24"
+ >
+ <path
+ d="M 18.135758,0.71428569 A 2.4525114,2.5132275 0 0 1 20.588271,3.2275132 V 23.333333 L 12.004479,19.513227 3.4206899,23.333333 V 3.2275132 c 0,-1.4074074 1.1036301,-2.51322751 2.4525113,-2.51322751 H 18.135758 M 10.778224,5.7407406 V 8.2539681 H 8.3257128 v 2.5132269 h 2.4525112 v 2.513228 h 2.452513 v -2.513228 h 2.452512 V 8.2539681 H 13.230737 V 5.7407406 Z"
+ style="fill:#0e3a5a;fill-opacity:1;stroke-width:1.24134" />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/bookmark.svg b/hop-user-manual/modules/ROOT/assets/images/icons/bookmark.svg
new file mode 100644
index 0000000..dac777a
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/bookmark.svg
@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" /></svg>
\ No newline at end of file
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/delete.svg b/hop-user-manual/modules/ROOT/assets/images/icons/delete.svg
new file mode 100644
index 0000000..e54a422
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/delete.svg
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ width="24"
+ viewBox="0 0 24 24"
+ height="24">
+ <path
+ fill="none"
+ d="M0 0h24v24H0z" />
+ <path
+ style="fill:#0e3a5a;fill-opacity:1"
+ d="M6 19c0 1.1.9 2 2 2h8c1.1 0 2-.9 2-2V7H6v12zM19 4h-3.5l-1-1h-5l-1 1H5v2h14V4z" />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/folder-add.svg b/hop-user-manual/modules/ROOT/assets/images/icons/folder-add.svg
new file mode 100644
index 0000000..8502494
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/folder-add.svg
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ width="24"
+ height="24"
+ viewBox="0 0 24 24"
+ >
+ <path
+ d="M 9.8,3 12,5.2500001 h 8.8 A 2.2,2.2500001 0 0 1 23,7.5000002 V 18.750001 A 2.2,2.2500001 0 0 1 20.8,21 H 3.2 C 1.979,21 1,19.9875 1,18.750001 V 5.2500001 C 1,4.0012501 1.979,3 3.2,3 h 6.6 m 5.5,5.6250003 V 12 H 12 v 2.249999 h 3.3 V 17.625 h 2.2 v -3.375001 h 3.3 V 12 H 17.5 V 8.6250003 Z"
+ style="fill:#0e3a5a;fill-opacity:1;stroke-width:1.11245" />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/home.svg b/hop-user-manual/modules/ROOT/assets/images/icons/home.svg
new file mode 100644
index 0000000..bcd8309
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/home.svg
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ width="24"
+ height="24"
+ viewBox="0 0 24 24"
+ >
+ <path
+ d="m 10,22 v -7.058824 h 4 V 22 h 5 v -9.411765 h 3 L 12,2 2,12.588235 H 5 V 22 Z"
+ style="fill:#0e3a5a;fill-opacity:1;stroke-width:1.08465" />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/navigate-back.svg b/hop-user-manual/modules/ROOT/assets/images/icons/navigate-back.svg
new file mode 100644
index 0000000..c59d1aa
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/navigate-back.svg
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ height="24"
+ viewBox="0 0 24 24"
+ width="24"
+ version="1.1"
+ >
+ <path
+ d="M0 0h24v24H0z"
+ fill="none"
+ />
+ <path
+ d="M 12,7 V 2 L 2,12 12,22 V 17 H 22 V 7 Z"
+ style="fill:#0e3a5a;fill-opacity:1;stroke-width:1.25" />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/navigate-forward.svg b/hop-user-manual/modules/ROOT/assets/images/icons/navigate-forward.svg
new file mode 100644
index 0000000..b84d177
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/navigate-forward.svg
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ height="24"
+ viewBox="0 0 24 24"
+ width="24"
+ version="1.1"
+ >
+ <path
+ d="M0 0h24v24H0z"
+ fill="none"
+ />
+ <path
+ d="M 12,7 V 2 L 22,12 12,22 V 17 H 2 V 7 Z"
+ style="fill:#0e3a5a;fill-opacity:1;stroke-width:1.25" />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/navigate-up.svg b/hop-user-manual/modules/ROOT/assets/images/icons/navigate-up.svg
new file mode 100644
index 0000000..378d2a0
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/navigate-up.svg
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ height="24"
+ viewBox="0 0 24 24"
+ width="24"
+ version="1.1"
+ >
+ <path
+ d="M0 0h24v24H0z"
+ fill="none"
+ />
+ <path
+ d="M 7,12 H 2 L 12,2 22,12 H 17 V 22 H 7 Z"
+ style="fill:#0e3a5a;fill-opacity:1;stroke-width:1.25" />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/preview.svg b/hop-user-manual/modules/ROOT/assets/images/icons/preview.svg
new file mode 100644
index 0000000..d5c10dc
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/preview.svg
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ width="24"
+ viewBox="0 0 24 24"
+ height="24">
+ <path
+ fill="none"
+ d="M0 0h24v24H0z" />
+ <path
+ style="fill:#0e3a5a;fill-opacity:1"
+ d="M12 4.5C7 4.5 2.73 7.61 1 12c1.73 4.39 6 7.5 11 7.5s9.27-3.11 11-7.5c-1.73-4.39-6-7.5-11-7.5zM12 17c-2.76 0-5-2.24-5-5s2.24-5 5-5 5 2.24 5 5-2.24 5-5 5zm0-8c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z" />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/project.svg b/hop-user-manual/modules/ROOT/assets/images/icons/project.svg
new file mode 100644
index 0000000..00be7fa
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/project.svg
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ enable-background="new 0 0 42 42"
+ viewBox="0 0 42 42"
+ height="42px"
+ width="42px"
+ y="0px"
+ x="0px"
+ version="1.1">
+<text
+ style="font-style:normal;font-weight:normal;font-size:192px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none"
+ x="56.459057"
+ y="19.834593"
+ ><tspan
+ x="56.459057"
+ y="194.53062" /></text>
+<text
+ y="28.045294"
+ x="2.8174167"
+ style="font-style:normal;font-weight:normal;font-size:48.81200027px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.25422916"
+ ><tspan
+ style="stroke-width:0.25422916"
+ y="28.045294"
+ x="2.8174167"
+ >p</tspan></text>
+</svg>
\ No newline at end of file
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/refresh.svg b/hop-user-manual/modules/ROOT/assets/images/icons/refresh.svg
new file mode 100644
index 0000000..78f0510
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/refresh.svg
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ viewBox="0 0 24 24"
+ height="24"
+ width="24"
+ version="1.1">
+ <path
+ style="fill:#0e3a5a;fill-opacity:1"
+ d="m 10,3 a -9,9 0 0 1 9,9 h 3 L 18.11,15.89 18.04,16.03 14,12 h 3 a -7,7 0 0 0 -7,-7 -7,7 0 0 0 -7,7 -7,7 0 0 0 7,7 c 1.93,0 3.68,-0.79 4.94,-2.06 l 1.42,1.42 C 14.73,20 12.5,21 10,21 A -9,9 0 0 1 1,12 -9,9 0 0 1 10,3 Z" />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/nav.adoc b/hop-user-manual/modules/ROOT/nav.adoc
index 0570186..27a692f 100644
--- a/hop-user-manual/modules/ROOT/nav.adoc
+++ b/hop-user-manual/modules/ROOT/nav.adoc
@@ -11,6 +11,7 @@
* xref:hop-gui/index.adoc[Hop Gui]
** xref:hop-gui/file-dialog.adoc[File Browser]
** xref:hop-gui/perspectives.adoc[Perspectives]
+** xref:hop-gui/shortcuts.adoc[Keyboard Shortcuts]
* xref:projects/index.adoc[Projects]
** xref:projects/projects-environments.adoc[Projects & Environments]
** xref:projects/metadata.adoc[Metadata]
diff --git a/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc b/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc
index 3694a95..3f2bc67 100644
--- a/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc
+++ b/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc
@@ -1 +1,45 @@
-= Hop File Chooser Dialog
+:imagesdir: ../assets/images
+
+= Hop File Dialog
+
+The Hop File Dialog is a versatile tool you'll use often while working in Hop Gui.
+
+This dialog offers a lot more than basically selecting and saving files. Among other things, it enables you to work with VFS file sytems directly, provides file/folder information, lets you bookmark files and folders.
+
+The list below walks you through the options that are at your disposal in the Hop File Dialog.
+
+TIP: if you prefer your operating system's native file dialog instead of the Hop dialog, change the `HOP_USE_NATIVE_FILE_DIALOG` to `Y` in `Tools -> Edit Config Variables`.
+
+{nbsp} +
+
+image:hop-gui/file-dialog.png[width="65%"]
+
+. **Main Toolbar**
+.. image:icons/home.svg[width="25px"] Navigate to the user home folder
+.. image:icons/project.svg[width="25px"]Navigate to the project home folder
+.. image:icons/navigate-up.svg[width="25px"]Navigate to the parent folder
+.. image:icons/navigate-back.svg[width="25px"]Navigate to the previous path from your history
+.. image:icons/navigate-forward.svg[width="25px"]Navigate to the next path from your history
+.. image:icons/refresh.svg[width="25px"]Refresh
+. **File path**. Displays the current file path. The file path can be used to directly enter (copy/paste) your desired path. This not only works with local files, you can also use all supported xref:vfs.adoc[VFS file systems].
+. **File extensions**. This list is populated from plugins, so there may be differences in the file types you have available. By default, this list includes:
+.. Workflows
+.. Pipelines
+.. CSV files
+.. JSON files
+.. Log files
+.. Markdown files
+.. SAS 7 BDAT files
+.. SVG files
+.. TXT files
+.. XML files
+. **Bookmarks**: Bookmark your favorite files and folders for easy and fast access. Tools -> Options contains an option to specify whether you want or don't want global bookmarks in the file dialog (global by defaul).
+.. image:icons/bookmark-add.svg[width="25px"]Add the selected file or folder as a bookmark
+.. image:icons/delete.svg[width="25px"]Remove the selected bookmark
+. **File/folder browser**: Browse your current file system, create folders and toggle hidden files and folders.
+.. image:icons/folder-add.svg[width="25px"]Create folder
+.. image:icons/preview.svg[width="25px"]Show or hide hidden files and directories
+. **File/folder information**
+.. file and folder name
+.. last modified date
+.. Readable, writable, executable flags
\ No newline at end of file
diff --git a/hop-user-manual/modules/ROOT/pages/index.adoc b/hop-user-manual/modules/ROOT/pages/index.adoc
index 614e869..0d115a4 100644
--- a/hop-user-manual/modules/ROOT/pages/index.adoc
+++ b/hop-user-manual/modules/ROOT/pages/index.adoc
@@ -2,7 +2,7 @@
:imagesdir: ../assets/images
-= Index Page
+= Hop User Manual
The Apache Hop (Incubating) User Manual contains all the information you need to develop and deploy data solutions with Apache Hop.