diff --git a/help/C/Makefile b/help/C/Makefile new file mode 100644 index 0000000..c58c185 --- /dev/null +++ b/help/C/Makefile @@ -0,0 +1,3 @@ +build: + @ducktype -o . duck/*.duck + @for f in *.page; do sed -i "2s/^/\n/" $$f; done diff --git a/help/C/duck/image-properties.duck b/help/C/duck/image-properties.duck new file mode 100644 index 0000000..2097a8a --- /dev/null +++ b/help/C/duck/image-properties.duck @@ -0,0 +1,20 @@ += Image Properties + [topic] +@link[guide >index#additional-features] + +@desc View detailed properties of the selected image. + +Loupe allows users to view an image's properties. All images will have the following +basic properties: + +* Image size +* Image format +* File size +* File creation date +* File modification date + +If the file has $link[href="https://en.wikipedia.org/wiki/Exif"](Exif) metadata, it +will be shown below the basic properties. + +To view the selected image's properties, press the $gui(Image Properties) +($media[type="image" src="figures/help-about-symbolic.svg"](help-about-symbolic)) button. \ No newline at end of file diff --git a/help/C/duck/index.duck b/help/C/duck/index.duck new file mode 100644 index 0000000..65d2fcb --- /dev/null +++ b/help/C/duck/index.duck @@ -0,0 +1,22 @@ += $media[type="image" its:translate="no" src="figures/org.gnome.Loupe.svg" height="48px" width="48px"] Loupe Image Viewer + [guide] + +@desc Browse through your images and inspect their metadata. + +== Introduction + +Loupe is an image viewer that supports modern image formats. It provides: + +* Fast GPU accelerated image rendering with tiled rendering for SVGs +* Extendable and sandboxed raster image decoding +* Extensive support for touchpad and touchscreen gestures +* Accessible presentation of the most important metadata + +== Getting Started + [#getting-started .2column] + +== Additional Features + [#additional-features .2column] + +== Technical Information + [#technical-information .2column] diff --git a/help/C/duck/opening-images.duck b/help/C/duck/opening-images.duck new file mode 100644 index 0000000..c594bbb --- /dev/null +++ b/help/C/duck/opening-images.duck @@ -0,0 +1,49 @@ += Opening Images + [topic] +@link[guide >index#getting-started] + +@desc Open and browse through pictures via the file chooser, file manager, or drag and drop. + +== Opening Files + +=== From The File Chooser + +Loupe allows users to pick images with the file chooser at any time. + +[steps] +* Click the $gui(Open Files…) button, the $gui[style="menuitem"](Open…) menu item, or press $keyseq($key(Ctrl)$key(O)). The $gui(Open Image) file dialog will appear. +* Select the image you want to open, then click $gui(Open). + +Loupe will open with the selected image showing, and the other images in the directory can be reached by browsing. + +=== From The File Manager + +Users can also open images in Loupe directly from their file manager. + +[steps] +* Open your preferred file manager application. +* Navigate to the image you want to view in Loupe. +* If Loupe is set as your default image viewer, use the file manager's function for opening files. +* If Loupe is not your default image viewer, you will need to select $gui(Open With…) or similar in the file manager, and pick Loupe. + +=== Drag & Drop + +Loupe also accepts local image files dragged from other applications. + +[steps] +* In the source application, begin dragging the image. +* Drag the image over the Loupe main window. A blue highlighted area should appear. +* Drop the image while it's still hovered over the main window. + +== Browsing + +When opening an image from the file chooser or file manager, Loupe will load other files +in the parent directory of the image and sort them in alphabetical order. Users can +browse the other images in the directory with the $gui(Previous Image) ($media[type="image" src="figures/go-previous-symbolic.svg"](go-previous-symbolic)) +and $gui(Next Image) ($media[type="image" src="figures/go-next-symbolic.svg"](go-next-symbolic)) buttons. +Keyboard users can also use the following shortcuts: + +* $key(→) to go to the next image. +* $key(←) to go to the previous image. +* $key(Home) to jump to the first image in the directory. +* $key(End) to jump to the last image in the directory. diff --git a/help/C/duck/sending-to-other-apps.duck b/help/C/duck/sending-to-other-apps.duck new file mode 100644 index 0000000..5cd96a2 --- /dev/null +++ b/help/C/duck/sending-to-other-apps.duck @@ -0,0 +1,24 @@ += Sending Images To Other Apps + [topic] +@link[guide >index#additional-features] + +@desc Learn how to send, copy, and drag images from Loupe to other apps. + +== "Open With…" Action + +[steps] +* Click the $gui[style="menuitem"](Open With…) menu item. A dialog with a list of applications will appear. +* Select the application you want to open the image with. + +== Copy & Paste + +[steps] +* Click the $gui(Copy to Clipboard) ($media[type="image" src="figures/edit-copy-symbolic.svg"](edit-copy-symbolic)) button. A toast notifying you that the image is in your clipboard will appear. +* Paste your image in your application of choice. + +== Drag & Drop + +[steps] +* Zoom out from the image completely. +* Click and hold the selected image. +* Drag the image to your application of choice. \ No newline at end of file diff --git a/help/C/duck/supported-formats.duck b/help/C/duck/supported-formats.duck new file mode 100644 index 0000000..1ec145f --- /dev/null +++ b/help/C/duck/supported-formats.duck @@ -0,0 +1,11 @@ += Supported Image Formats + [topic] +@link[guide >index#technical-information] + +Loupe uses $link[href=https://gitlab.gnome.org/sophie-h/glycin](glycin) for +loading images. You can check $link[href=https://gitlab.gnome.org/sophie-h/glycin#supported-image-formats](glycin's README) +for more details about the formats supported by the default loaders and the features +provided by each format. + +Glycin's loaders are configurable, and new loaders can be created by third-parties, +so the supported formats on your system may vary. \ No newline at end of file diff --git a/help/C/duck/trashing-images.duck b/help/C/duck/trashing-images.duck new file mode 100644 index 0000000..d32ea02 --- /dev/null +++ b/help/C/duck/trashing-images.duck @@ -0,0 +1,10 @@ += Moving Images to Trash + [topic] +@link[guide >index#additional-features] + +@desc Move unwanted images to the trash directly from Loupe. + +If a user wants to remove an image, they can press the $gui(Move To Trash) +($media[type="image" src="figures/user-trash-symbolic.svg"](user-trash-symbolic)) +button. A toast will appear allowing them to restore the image with the $gui(Undo) +button. \ No newline at end of file diff --git a/help/C/duck/viewing-images.duck b/help/C/duck/viewing-images.duck new file mode 100644 index 0000000..ee1bb17 --- /dev/null +++ b/help/C/duck/viewing-images.duck @@ -0,0 +1,48 @@ += Viewing Images + [topic] +@link[guide >index#getting-started] + +@desc Learn how to view an image at different scales and orientations. + +== Zooming + +Users can zoom in with the $gui(Zoom In) ($media[type="image" src="figures/zoom-in-symbolic.svg"](zoom-in-symbolic)) +button and zoom out with the $gui(Zoom Out) ($media[type="image" src="figures/zoom-out-symbolic.svg"](zoom-out-symbolic)) +button. They can also use the following keyboard shortcuts: + +* $keyseq($key(Ctrl)$key(+)) or $key(+) to zoom in. +* $keyseq($key(Ctrl)$key(-)) or $key(-) to zoom out. +* $keyseq($key(Ctrl)$key(0)) or $key(0) to zoom to the best fitting size for the window size. +* $keyseq($key(Ctrl)$key(1)) or $key(1) to zoom to the image's original scale. +* $keyseq($key(Ctrl)$key(2)) or $key(2) to zoom to 200% of the image's original scale. + +Touchpad and touchscreen users can also zoom with a two-finger pinch gesture. + +== Panning + +Mouse and touchpad users can pan the view when zoomed in by clicking and dragging the image. +Touchscreen users can use a single-finger drag gesture to pan the view. Users with a keyboard +can also use the following keyboard shortcuts: + +* $keyseq($key(Ctrl)$key(←)) to pan left. +* $keyseq($key(Ctrl)$key(→)) to pan right. +* $keyseq($key(Ctrl)$key(↑)) to pan up. +* $keyseq($key(Ctrl)$key(↓)) to pan down. + +== Rotating + +Users can use the $gui(Rotate Right) ($media[type="image" src="figures/object-rotate-right-symbolic.svg"](object-rotate-right-symbolic)) +and $gui(Rotate Left) ($media[type="image" src="figures/object-rotate-left-symbolic.svg"](object-rotate-left-symbolic)) +buttons under $gui[style="menuitem"](Rotate) in the main menu to rotate clockwise and +counter-clockwise. They can also use the following keyboard shortcuts: + +* $keyseq($key(Ctrl)$key(R)) to rotate clockwise. +* $keyseq($key(Ctrl)$key(Shift)$key(R)) to rotate counter-clockwise. + +Touchpad and touchscreen users can also use a two-finger rotate gesture. + +== Fullscreen + +Loupe has a simple fullscreen mode. Users can toggle fullscreen mode by pressing the $gui(Toggle Fullscreen) +($media[type="image" src="figures/view-fullscreen-symbolic.svg"](view-fullscreen-symbolic) / $media[type="image" src="figures/view-restore-symbolic.svg"](view-restore-symbolic)) button. +Keyboard users can also use $key(F11) to toggle fullscreen mode. \ No newline at end of file diff --git a/help/C/figures/edit-copy-symbolic.svg b/help/C/figures/edit-copy-symbolic.svg new file mode 100644 index 0000000..5964403 --- /dev/null +++ b/help/C/figures/edit-copy-symbolic.svg @@ -0,0 +1,4 @@ + + + + diff --git a/help/C/figures/go-next-symbolic.svg b/help/C/figures/go-next-symbolic.svg new file mode 100644 index 0000000..0ff48be --- /dev/null +++ b/help/C/figures/go-next-symbolic.svg @@ -0,0 +1,4 @@ + + + + diff --git a/help/C/figures/go-previous-symbolic.svg b/help/C/figures/go-previous-symbolic.svg new file mode 100644 index 0000000..1b7901f --- /dev/null +++ b/help/C/figures/go-previous-symbolic.svg @@ -0,0 +1,4 @@ + + + + diff --git a/help/C/figures/help-about-symbolic.svg b/help/C/figures/help-about-symbolic.svg new file mode 100644 index 0000000..1232984 --- /dev/null +++ b/help/C/figures/help-about-symbolic.svg @@ -0,0 +1,4 @@ + + + + diff --git a/help/C/figures/object-rotate-left-symbolic.svg b/help/C/figures/object-rotate-left-symbolic.svg new file mode 100644 index 0000000..6814faa --- /dev/null +++ b/help/C/figures/object-rotate-left-symbolic.svg @@ -0,0 +1,4 @@ + + + + diff --git a/help/C/figures/object-rotate-right-symbolic.svg b/help/C/figures/object-rotate-right-symbolic.svg new file mode 100644 index 0000000..2794d53 --- /dev/null +++ b/help/C/figures/object-rotate-right-symbolic.svg @@ -0,0 +1,4 @@ + + + + diff --git a/help/C/figures/org.gnome.Loupe.svg b/help/C/figures/org.gnome.Loupe.svg new file mode 100644 index 0000000..e0a23e2 --- /dev/null +++ b/help/C/figures/org.gnome.Loupe.svg @@ -0,0 +1,185 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/help/C/figures/user-trash-symbolic.svg b/help/C/figures/user-trash-symbolic.svg new file mode 100644 index 0000000..b6f8bd1 --- /dev/null +++ b/help/C/figures/user-trash-symbolic.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/help/C/figures/view-fullscreen-symbolic.svg b/help/C/figures/view-fullscreen-symbolic.svg new file mode 100644 index 0000000..e65d6d6 --- /dev/null +++ b/help/C/figures/view-fullscreen-symbolic.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/help/C/figures/view-restore-symbolic.svg b/help/C/figures/view-restore-symbolic.svg new file mode 100644 index 0000000..3bd41d8 --- /dev/null +++ b/help/C/figures/view-restore-symbolic.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/help/C/figures/zoom-in-symbolic.svg b/help/C/figures/zoom-in-symbolic.svg new file mode 100644 index 0000000..818bc69 --- /dev/null +++ b/help/C/figures/zoom-in-symbolic.svg @@ -0,0 +1,4 @@ + + + + diff --git a/help/C/figures/zoom-out-symbolic.svg b/help/C/figures/zoom-out-symbolic.svg new file mode 100644 index 0000000..b40f0b2 --- /dev/null +++ b/help/C/figures/zoom-out-symbolic.svg @@ -0,0 +1,4 @@ + + + + diff --git a/help/C/image-properties.page b/help/C/image-properties.page new file mode 100644 index 0000000..9259864 --- /dev/null +++ b/help/C/image-properties.page @@ -0,0 +1,37 @@ + + + + + + View detailed properties of the selected image. + + Image Properties +

Loupe allows users to view an image's properties. All images will have the following + basic properties:

+ + +

Image size

+
+ +

Image format

+
+ +

File size

+
+ +

File creation date

+
+ +

File modification date

+
+
+

If the file has Exif metadata, it + will be shown below the basic properties.

+

To view the selected image's properties, press the Image Properties + (help-about-symbolic) button.

+
diff --git a/help/C/index.page b/help/C/index.page index fa1c4e3..fb90e47 100644 --- a/help/C/index.page +++ b/help/C/index.page @@ -1,19 +1,40 @@ - + + + + + Browse through your images and inspect their metadata. + + <media type="image" its:translate="no" src="figures/org.gnome.Loupe.svg" height="48px" width="48px"/> Loupe Image Viewer +
+ Introduction +

Loupe is an image viewer that supports modern image formats. It provides:

+ + +

Fast GPU accelerated image rendering with tiled rendering for SVGs

+
+ +

Extendable and sandboxed raster image decoding

+
+ +

Extensive support for touchpad and touchscreen gestures

+
+ +

Accessible presentation of the most important metadata

+
+
+
+
+ Getting Started +
+
+ Additional Features +
+
+ Technical Information +
diff --git a/help/C/opening-images.page b/help/C/opening-images.page new file mode 100644 index 0000000..a3ba414 --- /dev/null +++ b/help/C/opening-images.page @@ -0,0 +1,85 @@ + + + + + + Open and browse through pictures via the file chooser, file manager, or drag and drop. + + Opening Images +
+ Opening Files +
+ From The File Chooser +

Loupe allows users to pick images with the file chooser at any time.

+ + +

Click the Open Files… button, the Open… menu item, or press CtrlO. The Open Image file dialog will appear.

+
+ +

Select the image you want to open, then click Open.

+
+
+

Loupe will open with the selected image showing, and the other images in the directory can be reached by browsing.

+
+
+ From The File Manager +

Users can also open images in Loupe directly from their file manager.

+ + +

Open your preferred file manager application.

+
+ +

Navigate to the image you want to view in Loupe.

+
+ +

If Loupe is set as your default image viewer, use the file manager's function for opening files.

+
+ +

If Loupe is not your default image viewer, you will need to select Open With… or similar in the file manager, and pick Loupe.

+
+
+
+
+ Drag & Drop +

Loupe also accepts local image files dragged from other applications.

+ + +

In the source application, begin dragging the image.

+
+ +

Drag the image over the Loupe main window. A blue highlighted area should appear.

+
+ +

Drop the image while it's still hovered over the main window.

+
+
+
+
+
+ Browsing +

When opening an image from the file chooser or file manager, Loupe will load other files + in the parent directory of the image and sort them in alphabetical order. Users can + browse the other images in the directory with the Previous Image (go-previous-symbolic) + and Next Image (go-next-symbolic) buttons. + Keyboard users can also use the following shortcuts:

+ + +

→ to go to the next image.

+
+ +

← to go to the previous image.

+
+ +

Home to jump to the first image in the directory.

+
+ +

End to jump to the last image in the directory.

+
+
+
+
diff --git a/help/C/sending-to-other-apps.page b/help/C/sending-to-other-apps.page new file mode 100644 index 0000000..f94e613 --- /dev/null +++ b/help/C/sending-to-other-apps.page @@ -0,0 +1,50 @@ + + + + + + Learn how to send, copy, and drag images from Loupe to other apps. + + Sending Images To Other Apps +
+ "Open With…" Action + + +

Click the Open With… menu item. A dialog with a list of applications will appear.

+
+ +

Select the application you want to open the image with.

+
+
+
+
+ Copy & Paste + + +

Click the Copy to Clipboard (edit-copy-symbolic) button. A toast notifying you that the image is in your clipboard will appear.

+
+ +

Paste your image in your application of choice.

+
+
+
+
+ Drag & Drop + + +

Zoom out from the image completely.

+
+ +

Click and hold the selected image.

+
+ +

Drag the image to your application of choice.

+
+
+
+
diff --git a/help/C/supported-formats.page b/help/C/supported-formats.page new file mode 100644 index 0000000..bf7b34f --- /dev/null +++ b/help/C/supported-formats.page @@ -0,0 +1,19 @@ + + + + + + + Supported Image Formats +

Loupe uses glycin for + loading images. You can check glycin's README + for more details about the formats supported by the default loaders and the features + provided by each format.

+

Glycin's loaders are configurable, and new loaders can be created by third-parties, + so the supported formats on your system may vary.

+
diff --git a/help/C/trashing-images.page b/help/C/trashing-images.page new file mode 100644 index 0000000..095bda1 --- /dev/null +++ b/help/C/trashing-images.page @@ -0,0 +1,18 @@ + + + + + + Move unwanted images to the trash directly from Loupe. + + Moving Images to Trash +

If a user wants to remove an image, they can press the Move To Trash + (user-trash-symbolic) + button. A toast will appear allowing them to restore the image with the Undo + button.

+
diff --git a/help/C/viewing-images.page b/help/C/viewing-images.page new file mode 100644 index 0000000..e225d7a --- /dev/null +++ b/help/C/viewing-images.page @@ -0,0 +1,80 @@ + + + + + + Learn how to view an image at different scales and orientations. + + Viewing Images +
+ Zooming +

Users can zoom in with the Zoom In (zoom-in-symbolic) + button and zoom out with the Zoom Out (zoom-out-symbolic) + button. They can also use the following keyboard shortcuts:

+ + +

Ctrl+ or + to zoom in.

+
+ +

Ctrl- or - to zoom out.

+
+ +

Ctrl0 or 0 to zoom to the best fitting size for the window size.

+
+ +

Ctrl1 or 1 to zoom to the image's original scale.

+
+ +

Ctrl2 or 2 to zoom to 200% of the image's original scale.

+
+
+

Touchpad and touchscreen users can also zoom with a two-finger pinch gesture.

+
+
+ Panning +

Mouse and touchpad users can pan the view when zoomed in by clicking and dragging the image. + Touchscreen users can use a single-finger drag gesture to pan the view. Users with a keyboard + can also use the following keyboard shortcuts:

+ + +

Ctrl← to pan left.

+
+ +

Ctrl→ to pan right.

+
+ +

Ctrl↑ to pan up.

+
+ +

Ctrl↓ to pan down.

+
+
+
+
+ Rotating +

Users can use the Rotate Right (object-rotate-right-symbolic) + and Rotate Left (object-rotate-left-symbolic) + buttons under Rotate in the main menu to rotate clockwise and + counter-clockwise. They can also use the following keyboard shortcuts:

+ + +

CtrlR to rotate clockwise.

+
+ +

CtrlShiftR to rotate counter-clockwise.

+
+
+

Touchpad and touchscreen users can also use a two-finger rotate gesture.

+
+
+ Fullscreen +

Loupe has a simple fullscreen mode. Users can toggle fullscreen mode by pressing the Toggle Fullscreen + (view-fullscreen-symbolic / view-restore-symbolic) button. + Keyboard users can also use F11 to toggle fullscreen mode.

+
+
diff --git a/help/meson.build b/help/meson.build index 7d09c73..4183703 100644 --- a/help/meson.build +++ b/help/meson.build @@ -1,8 +1,30 @@ sources = [ - 'index.page' + 'image-properties.page', + 'index.page', + 'opening-images.page', + 'sending-to-other-apps.page', + 'supported-formats.page', + 'trashing-images.page', + 'viewing-images.page', +] + +media = [ + 'figures' / 'edit-copy-symbolic.svg', + 'figures' / 'go-next-symbolic.svg', + 'figures' / 'go-previous-symbolic.svg', + 'figures' / 'help-about-symbolic.svg', + 'figures' / 'object-rotate-left-symbolic.svg', + 'figures' / 'object-rotate-right-symbolic.svg', + 'figures' / 'org.gnome.Loupe.svg', + 'figures' / 'user-trash-symbolic.svg', + 'figures' / 'view-fullscreen-symbolic.svg', + 'figures' / 'view-restore-symbolic.svg', + 'figures' / 'zoom-in-symbolic.svg', + 'figures' / 'zoom-out-symbolic.svg', ] gnome.yelp( meson.project_name(), sources: sources, + media: media, )