dtourolle
352e59498b
The packages now carry the manual, but nothing in the application opened it: the help sheet listed gestures and stopped there. The help sheet gains a Manual button beside Done, and Settings a Manual row under About beside the version. Both go through dr_ui::manual, which finds the installed page through dr_plat::system_data_dirs (the package's share directory on Linux, the executable's directory on Windows), and a development build also in the checkout it was compiled from. A copy with no manual says so on the status line rather than doing nothing. On the desktop the page goes to the system browser. A section is a URL fragment, and xdg-open's generic mode and Windows' FileProtocolHandler both turn a file: URL into a path and drop the fragment, so a section is opened through a one-line redirect page written to the data directory: the opener gets a plain path, which every opener keeps, and the browser follows the redirect to index.html#section itself. The launcher behind the sign-in's open_in_browser is split out so both share it; the https check stays with the sign-in. Android has no path to give a browser: an asset is not a file, a copy in private storage is unreadable to other apps, a file: URI across apps is refused, and a content: URI leaves the browser resolving every picture against the provider. So ManualActivity, a WebView reading file:///android_asset/manual/index.html straight out of the APK, shows it, started by class name with the section as an extra. JavaScript is off, links off the page go to the browser, and the theme is day-night so the page's own light and dark follow the system. A test checks that the manifest, the Java class and dr_ui agree on the name and the extra.
254 lines
11 KiB
Markdown
254 lines
11 KiB
Markdown
# DarkRoom, shown
|
|
|
|
A tour of what the application does, one picture per thing. Every image on
|
|
this page was captured from the desktop build driving itself — nothing is a
|
|
mock-up, and nothing has been retouched outside DarkRoom. Where a feature is
|
|
better seen moving, it moves.
|
|
|
|
The requirements behind each feature are in [requirements.md](../dev/requirements.md);
|
|
the reasoning is in the design documents linked from each section. This page
|
|
is only about what you see.
|
|
|
|
The photographs are the author's. None show a person.
|
|
|
|
## Opening a library
|
|
|
|
DarkRoom opens on a library: a folder on this machine, a folder a sync
|
|
client keeps, or a Nextcloud account. A folder needs no password and uploads
|
|
nothing.
|
|
|
|
|
|
|
|
Once a folder is named, it is the library — you are not asked for it again,
|
|
and `Open library` opens it whole. `Subfolder…` narrows the scan to part of
|
|
it. The formats ticked are what the scan looks for; RAW is on and JPEG off
|
|
by default, because a RAW editor's sensible default is the file the camera
|
|
wrote first.
|
|
|
|
|
|
|
|
## The library
|
|
|
|
|
|
|
|
Photographs are ordered by capture time, with a month heading where each
|
|
begins. The strip on the left is the timeline — drag it to jump to a year.
|
|
The bar above the grid filters by rating, flag, colour label and where the
|
|
file is (on this device, or only on the server).
|
|
|
|
### Rating and flagging
|
|
|
|
Hover a cell and the stars appear; click one. The filter chips above the grid
|
|
count what each rating holds, and clicking `3+` shows only those.
|
|
|
|
|
|
|
|
Colour labels work as Lightroom's do: `6` red, `7` yellow, `8` green, `9`
|
|
blue, on the photograph under the pointer or on the selection, and the same
|
|
key again takes the label off. `Label` on the selection bar offers all five,
|
|
purple included, and `None`. Each label is drawn with its initial on it, so
|
|
it reads without telling the colours apart, and the filter bar has a chip for
|
|
each. In develop, the top bar names the open photograph's label and sets it,
|
|
and the same keys work there.
|
|
|
|
### Getting about
|
|
|
|
Drag the timeline to scrub through years; Ctrl and the wheel resize the
|
|
thumbnails.
|
|
|
|
|
|
|
|
|
|
|
|
### Selecting several
|
|
|
|
`Select` in the header — or Ctrl-click — starts a selection. Shift-click picks
|
|
a range. The bar at the foot of the grid is everything a selection can be done
|
|
to: collections, keywords, presets, export, and merging to a panorama.
|
|
|
|
|
|
|
|
`Keywords` on that bar opens a sheet; type a word and press return, and it
|
|
is on every photograph selected. The list below the field is every keyword
|
|
the library has, ticked where the selection carries it.
|
|
|
|
|
|
|
|
### Collections
|
|
|
|
`+` at the head of the sidebar makes one. Drag a photograph — or the whole
|
|
selection — onto its row to file it there; click the row to see it. A
|
|
photograph can be in several, and the badge on its cell counts them.
|
|
|
|
|
|
|
|
Collections nest. Drag one onto another to put it inside; `+` with a
|
|
collection selected — or `New collection inside` from its menu — makes a
|
|
child. A parent shows everything its children hold, and its count says so.
|
|
Right-click a row (hold it, on a tablet) for the menu: rename, nest,
|
|
move back to the top level, keep it offline, delete.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Developing a photograph
|
|
|
|
Click a thumbnail to open it. The column on the right is every adjustment;
|
|
the strip at its head narrows it to one group.
|
|
|
|
|
|
|
|
|
|
|
|
### Light
|
|
|
|
Exposure, contrast, highlights, shadows, blacks, whites and a tone curve.
|
|
Hold `Before` to see the photograph as it was.
|
|
|
|
|
|
|
|
### Looking closer
|
|
|
|
Double-click for 1:1; drag to move about; double-click again to fit. The
|
|
wheel zooms to any amount in between.
|
|
|
|
|
|
|
|
### White balance from the photograph
|
|
|
|
Press `pick` in the White Balance group, then click something neutral —
|
|
a white wall, a grey card, the air conditioner here. The picker sets the
|
|
sliders from the photograph, not from where they were: below, the frame
|
|
is dragged cold first and one click puts it right. A blown highlight is
|
|
refused, since a clipped pixel has no colour left to balance.
|
|
|
|
|
|
|
|
### Composing
|
|
|
|
Crop by dragging the frame's corners, straighten with the slider, lock a
|
|
ratio from the chips. `Done composing` returns to the photograph.
|
|
|
|
|
|
|
|
### Local adjustments
|
|
|
|
`Local` in the rail turns the column into a mask stack. `Find subjects` runs a
|
|
segmentation model over the photograph; what it recognises appears as a list
|
|
of categories with how much of the frame each covers. Click one and it is a
|
|
mask — then every slider below edits only that region.
|
|
|
|
|
|
|
|
|
|
|
|
A mask is a stack of parts. Paint into it, subtract a gradient from it, grow
|
|
or shrink its edge, choose how it falls off. `Show masks as` draws the mask
|
|
tinted, as alpha, or as an outline; the eye on its row switches it off.
|
|
|
|
|
|
|
|
Linear and radial gradients, a tone range and a colour range are the other
|
|
ways to make one; each can be combined with any other.
|
|
|
|
### Repair
|
|
|
|
`Repair` in the rail: click a mark and it is covered from a source DarkRoom
|
|
chooses beside it. Drag either circle to move it; the size, feather and
|
|
opacity are in the panel. Heal blends; clone copies.
|
|
|
|
|
|
|
|
### Film
|
|
|
|
The `Film` chooser at the head of Adjust applies a spectral simulation of a
|
|
named stock; below it, the print exposure and push controls a film has and a
|
|
sensor does not.
|
|
|
|
|
|
|
|
### History, snapshots, presets
|
|
|
|
Every change is a step; `Undo` and the History panel walk them. `Snapshot`
|
|
keeps the current state under a name. `Presets…` saves the settings to
|
|
apply elsewhere, and imports `.xmp` from other applications.
|
|
|
|
|
|
|
|
## Merging a panorama
|
|
|
|
Select the frames, then `Merge to panorama` from the selection bar. The
|
|
frames are read, aligned, and drawn on the suggested projection with each one
|
|
outlined where it landed — twelve hand-held portrait frames across an alpine
|
|
valley, here. Change the projection (a 150° sweep on a flat perspective is
|
|
what the middle of the film shows, and why cylindrical is suggested), ask for
|
|
the border to be filled rather than cropped, then `Merge`. The composite is
|
|
written beside its sources as a DNG and appears in the grid with the merge
|
|
as the first step in its history.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Export
|
|
|
|
`Export` in the develop header, or `Export N` from a selection. Format,
|
|
size, colour space, sharpening, naming and where the file goes are in
|
|
Settings, and apply to every export until changed. An export with no folder
|
|
set is refused, and the header says so.
|
|
|
|
|
|
|
|
## Settings
|
|
|
|
|
|
|
|
Background activity with progress, thumbnail and face indexing, storage on
|
|
this device, display and colour, export defaults, what is written to XMP
|
|
sidecars, and a diagnostics bundle for a bug report.
|
|
|
|
## People
|
|
|
|
Face detection and identity run over the library and group faces by person;
|
|
the `Identity` page is where suggestions are confirmed, rejected and split,
|
|
and `People` on the filter bar narrows the grid to someone. Not pictured
|
|
here, for the obvious reason — [faces.md](../dev/faces.md) has the design.
|
|
|
|
## Where things are written down
|
|
|
|
| Feature | Design |
|
|
|---|---|
|
|
| Local masks and segmentation | [segmentation.md](../dev/segmentation.md), [mask-editing.md](../dev/mask-editing.md) |
|
|
| Repair | [spot-removal.md](../dev/spot-removal.md) |
|
|
| Panorama | [panorama.md](../dev/panorama.md) |
|
|
| Faces and identity | [faces.md](../dev/faces.md) |
|
|
| Gestures, generated from the code | [gestures.md](../gestures.md) |
|
|
| Navigation and layout | [ui-navigation.md](../dev/ui-navigation.md) |
|
|
| Sync and storage | [storage.md](../dev/storage.md) |
|
|
|
|
## How this page is made
|
|
|
|
[`tools/manual/`](../../tools/manual/README.md) drives the desktop build on
|
|
a private X server and records each scene; `record.sh <library>` re-makes
|
|
every picture here. Run it after a change to the interface and commit what
|
|
changed. The pictures are in LFS.
|
|
|
|
The application carries this page. `cargo run -p traceability -- manual`
|
|
renders it to `index.html` beside it, which the packages install with the
|
|
pictures and the app opens from Help, from Settings, and from the "See it"
|
|
link beside a gesture on the help sheet. CI fails when the two differ.
|
|
|
|
Making it the first time turned up nine faults, each fixed in its own
|
|
commit before the pictures were taken: the folder picker could not choose
|
|
the top level, month headings overprinted each other, a category mask
|
|
widened the column off the window, the mask tint outlived its mode, the
|
|
first sync uploaded an empty thumbnail shard, a merge that ran out of GPU
|
|
memory left the page on Stop for ever, the export settings promised to ask
|
|
for a folder and did not, the keyword sheet sent its keys to the grid, and
|
|
an empty trash told you to check your library folder.
|