Skip to content

Commit

Permalink
Merge pull request #7 from Produkt/reading-guides
Browse files Browse the repository at this point in the history
Add missing guides
  • Loading branch information
fillito authored Apr 18, 2024
2 parents 2c138a3 + 7b3a0e4 commit 41d58e6
Show file tree
Hide file tree
Showing 17 changed files with 158 additions and 5 deletions.
30 changes: 29 additions & 1 deletion docs/misc/moving-to-new-device.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,32 @@ sidebar_position: 1

# Moving to a new device

//TODO
## Keeping the content

When moving to a new device, you can take your library with you.

As explained [here](../organize-content/multiple-libraries.md), Panels creates a new library inside Files -> On my iPhone/iPad -> Panels.

:::warning

Panels device folder does not get backed up with your iPhone backup.

:::

Before deleting all content on your current iOS device, make sure to save a copy of the Panels folder somewhere (in your mac, external drive, etc.). You can also airdrop the whole folder to your new device.

Once you have your new device, install Panels and go to Files app. Go to Files -> On my iPhone/iPad -> Panels and drop all the content from your other device in there.

Once you open Panels, it will start reading and indexing its content.

:::tip

If you are using iCloud Drive or OPDS, you don't have to do anything other than just setting up the library in your new device.

:::

## Keeping your reading sessions

There is no way to "send" your reading sessions to a new device manually. The only way is to log in to Panels (via any of the sign in methods) in your old device (if you are not already) and wait for all the reading sessions to be uploaded.

On your new device, log in to the same account and the new device will start downloading all sessions.
30 changes: 30 additions & 0 deletions docs/read-content/image-filters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Image filters

Panels offers a way to tweak images in the reader for better reading experience. We like to differentiate between 3 groups: filters, transformations and shaders.

To access turn them on/off, simply tap "..." -> Image filters.

## Filters

Filters only tweak images visually.

- Reduce noise: works well for old scans with lots of color noise
- Increase sharpness

## Transformations

Transformations change the geometry/size of pages.

- Remove borders: tries to identify a vertical or horizontal border near the edge where all pixels are of a similar color.

## Shaders

Shaders are filters that take into account the image size, as well as the display size.

- Reduce moire effect: apply this filter when patterns in drawings show moire effect.

:::tip

You can apply multiple filters.

:::
4 changes: 3 additions & 1 deletion docs/read-content/incognito-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ sidebar_position: 3

# Icognito mode

// Explain what it is and what it does
Panels [stores and syncs your reading sessions](../misc/sync-reading-sessions.md). That means, for each comic you open and read, we associate some information to it (like time spent reading). We use that information to drive "Reading now" screen.

When incognito mode is enabled, those reading sessions are marked as hidden, so the information about time reading is still stored, but those comics will not appear in reading now.
27 changes: 26 additions & 1 deletion docs/read-content/live-text.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,29 @@ sidebar_position: 2

# Live text

// Explain what it is and how to enable and some options
Panels have support for detecting text & subject as well as selecting them.

To enable it, go to reader settings -> live text -> Enable Live Text.

<img src="/img/live-text-options.jpeg" alt="iPhone showing list of presets" style={{width: 400}} />

You can choose to show "Highlight" buttons for text and subjects or not, as well as which type of detection to do.

If you choose to show both buttons, you will see them appear at the bottom right:

<img src="/img/live-text-reader.png" alt="iPhone showing list of presets" style={{width: 400}} />

Tapping on the highlight text button, all detected text in the current page will be highlighted. Same applies for subjects.

<img src="/img/live-text-highlight-text.png" alt="iPhone showing list of presets" style={{width: 400}} />
<img src="/img/live-text-highlight-subject.png" alt="iPhone showing list of presets" style={{width: 400}} />

You don't need to highlight text to be able to select it. Once you select some text, you will see a menu appear with some actions to take with the selected text. Probably one of the most useful actions is Translate.

<img src="/img/live-text-selected.jpeg" alt="iPhone showing list of presets" style={{width: 400}} />

:::tip

When selecting subjects, you will have the option to create stickers from them.

:::
12 changes: 12 additions & 0 deletions docs/read-content/lock-zoom.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,15 @@ sidebar_position: 4
---

# Lock zoom

Lock zoom allows you to "fix" the zoom at a certain level, and maintain it when you move to the next pages.

First, you need to enable it. Go to Reader settings -> gestures and zoom -> Lock zoom.

<img src="/img/lock-zoom-settings.jpg" alt="iPhone showing list of presets" style={{width: 400}} />

Once enable it, after you zoom in a page, you will see the following banner appear at the bottom of the screen for a few seconds:

<img src="/img/lock-zoom-banner.jpeg" alt="iPhone showing list of presets" style={{width: 400}} />

Tapping on "Lock Zoom" will lock that zoom level. If you need to remove that lock, simply zoom out or change the zoom level.
60 changes: 58 additions & 2 deletions docs/read-content/reader-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,64 @@
sidebar_position: 1
---

# Reader configuration
# Reader presets and configurations

// Explain different reader configurations
Panels' reader supports many different configurations. To make it easy to switch between them, we introduced **Presets**.

## Presets

Presets are simply saved reader configurations. So maybe you'd like to have a reader configuration for reading Manwas and another with page curl for reading regular comics.

We provide 5 default presets:

- Standard: horizontal paginated scroll. Will set itself to double page when reading in landscape.
- Vertical scroll
- Fill screen
- Adjust to orientation
- Page curl

You can edit, rename and delete any of those configurations. Just go to reader settings -> Presets.

<img src="/img/reader-default-configurations.png" alt="iPhone showing list of presets" style={{width: 400}} />

:::tip

If you delete all presets, the app will restore them all to show default configurations.

:::

## Reader configurations

While reading, you can tap "..." -> Configure reader. This will take you to the reader configuration screen.

![Reader configurations](/img/reader-configurations.png)

Here you can feel free to configure the reader to your liking. When you finish, taping "X" will close the screen and the new configuration will be applied for the current comic, but it won't be saved as a preset. If you want to save the configuration, tap the "Save" button and give it a name.

We offer the following options to configure the reader:

- Page transition
- Paginated: scroll will move page by page
- Continuous: scroll will be free
- Page curl: paginated, with curl animation
- Scroll direction
- Horizontal
- Vertical
- Number of pages
- One
- Two
- Automatic (one or two, based on screen width -- usually, landscape orientation will default to 2 pages)
- Page fitting
- Fit: the page will resize to fit into the page
- Fill: the page will resize to fill the page, overflowing vertically or horizontally depending on the image and screen size/orientation
- Automatic
- Background color
- Black
- White
- Dynamic background
- Single color: Panels will analyze each page and extract the most prominent color to apply to the background
- Immersive: Panels will calculate different prominent colors and will fade between them, creating an immersive experience

Examples of immersive dynamic color using Invincible vol. 1
<img src="/img/reader-immersive-1.png" alt="iPhone showing list of presets" style={{width: 400}} />
<img src="/img/reader-immersive-2.png" alt="iPhone showing list of presets" style={{width: 400}} />
Binary file added static/img/live-text-highlight-subject.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 static/img/live-text-highlight-text.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 static/img/live-text-options.jpeg
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 static/img/live-text-reader.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 static/img/live-text-selected.jpeg
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 static/img/lock-zoom-banner.jpeg
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 static/img/lock-zoom-settings.jpg
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 static/img/reader-configurations.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 static/img/reader-default-configurations.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 static/img/reader-immersive-1.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 static/img/reader-immersive-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 41d58e6

Please sign in to comment.