Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions autotag_metadata/ui/guided_tour.py
Original file line number Diff line number Diff line change
Expand Up @@ -359,13 +359,13 @@ def _build_steps(self) -> list[TourStep]:
[app.ledFolder, app.btnBrowse, app.btnActivate],
),
TourStep(
"2. Filter which files",
"2.1 Filter which files",
"Restrict tagging to matching files with comma-separated globs "
"(e.g. <code>*.csv,*.tsv</code>), and tick <b>Recursive</b> to include sub-folders.",
[app._patterns_label, app.ledFilePatterns, app.cbRecursiveWatch],
),
TourStep(
"2.5 Sidecar suffix",
"2.2 Sidecar suffix",
"The <b>Suffix</b> field controls the sidecar file name. Leave it empty for the "
"default <code>.metadata.yaml</code>, or type a custom extension "
"(e.g. <code>.ec-lab.metadata.yaml</code>) to distinguish sidecar families.",
Expand Down Expand Up @@ -459,15 +459,29 @@ def _build_steps(self) -> list[TourStep]:
on_enter=self._show_views,
),
TourStep(
"5. Drop files on demand",
"5. The live file",
"The <b>Live file</b> is a YAML file kept in sync with the editor. Press "
"<b>Select…</b> to choose one, <b>Use</b> to watch it — then edits in your "
"external editor flow back into this document and vice versa — and <b>Open</b> "
"to launch it in your default editor.",
[
app.ledTemporaryLoc,
app.btnSelectTemporaryFile,
app.btnOpenTemporaryFile,
app.btnUseTemporaryFile,
],
on_enter=self._show_form,
),
TourStep(
"6. Drop files on demand",
"The <b>Drop files</b> toggle opens a drop zone for tagging individual files "
"without watching a folder. Drag files onto the zone and they are tagged with "
"the current metadata. The <b>Log</b> panel shows what happened.",
[dropzone_btn, app._dropzone_dock],
on_enter=self._reveal_dropzone,
),
TourStep(
"6. The Log",
"7. The Log",
"The <b>Log</b> toggle reveals the log panel at the bottom. Every tagging event, "
"warning, and error is recorded here so you can see exactly what happened and "
"which files were processed.",
Expand Down
Binary file modified doc/images/tour-00-welcome-to-autotag-metadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-01-1-choose-a-folder-to-watch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/tour-02-2-1-filter-which-files.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/images/tour-02-2-filter-which-files.png
Binary file not shown.
Binary file added doc/images/tour-03-2-2-sidecar-suffix.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/images/tour-03-2-5-sidecar-suffix.png
Binary file not shown.
Binary file modified doc/images/tour-04-3-1-switch-between-views.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-05-3-2-the-form-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-06-3-3-the-yaml-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-07-3-4-fixing-a-syntax-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-08-4-1-open-the-library.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-09-4-2-the-library-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-10-4-3-load-a-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-11-4-4-extend-with-a-snippet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-12-4-5-zoom-into-a-subtree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-13-4-6-split-into-panels.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour-14-4-7-save-the-layout-as-a-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/images/tour-15-5-drop-files-on-demand.png
Binary file not shown.
Binary file added doc/images/tour-15-5-the-live-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/tour-16-6-drop-files-on-demand.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/images/tour-16-6-the-log.png
Binary file not shown.
Binary file added doc/images/tour-17-7-the-log.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/images/tour-17-you-re-ready.png
Binary file not shown.
Binary file added doc/images/tour-18-you-re-ready.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/tour.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 15 additions & 1 deletion doc/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,26 @@ three-panel layout onto `curation`, `experimental`, and `system` at once:
A saved view restores a multi-panel layout, each panel zoomed onto a different part of the document.
```

### Editing in an external editor with the live file

The **Live file** is a YAML file kept in sync with the editor. Press **Select…** to choose one,
**Use** to watch it — edits made in an external, schema-aware editor then flow back into this
document and vice versa — and **Open** to launch it in your default editor.
Comment on lines +188 to +190

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least without the GUI in front of me, it sounds a bit obscure what is going on here. :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me it seems clear, but I'm biased.


```{figure} images/tour-15-5-the-live-file.png
:alt: The live-file controls on the editor bar
:width: 100%

The live file mirrors the current metadata to a file so an external editor can validate it as you
type.
```

### Tagging on demand and watching the log

Besides watching a folder, the **Drop files** toggle opens a drop zone. Drag files or folders onto
it to tag them immediately with the current metadata, without activating a watch:

```{figure} images/tour-15-5-drop-files-on-demand.png
```{figure} images/tour-16-6-drop-files-on-demand.png
:alt: The Drop files zone
:width: 100%

Expand Down
Loading