Updating Channel page docs. Adding new Databases docs, as well as docs about the new map database.

This commit is contained in:
Roland 2025-01-04 10:50:27 -07:00
parent 7b306bc7d9
commit 6e25ca098d
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
15 changed files with 174 additions and 40 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 25 KiB

Before After
Before After

View file

@ -11,8 +11,8 @@ that have recently been created, and are not yet in the database.
## Refreshing
WROLPi can search any file in your media directory, this can only be accomplished after a full files refresh has been
completed.
WROLPi can search any file in your media directory, this can only be accomplished after a full refresh of your files has
been completed.
> To refresh all your files, click the **Files** link in the top navigation bar, then click **Refresh** found at the
> bottom of the files table.
@ -38,6 +38,23 @@ The tool buttons are as displayed:
5. **New Directory** button
* Allows you to create a new directory in the directory selected (or, the top directory if no directory is
selected.)
6. **Ignore** button
* Allows you to skip any directories (and their files) from indexing and searching. (Useful if you have a directory
with many thousands of small files, such as a git repo)
## Tags
WROLPi creates and manages a `tags` directory, this directory contains links to files you have tagged. This is the
[secondary](../../system/primary-secondary-tertiary.md) method to access your tags. **You should never manually add
files to this directory, they will be deleted.**
If a file is tagged with multiple tags, the file link will be placed in a directory containing the names of the tags,
separated by commas (alphabetically). For example, if you tagged a video at
`videos/WROLPi/WROLPi_20230909_0xfMLNVFq2Y_WROLPi v0.11 beta demo.mp4` with the tags "WROL" and "Computers",
then a link to the video will be created in
`tags/Computers, WROL/WROLPi_20230909_0xfMLNVFq2Y_WROLPi v0.11 beta demo.mp4`
All files in the **FileGroup** will be linked in the same directory.
## File Preview

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 55 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Before After
Before After

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

View file

@ -13,19 +13,46 @@ download. A single video file is also supported.
## Video Format
As of the writing of this article, WROLPi favors MP4 files due to their small size and universal support.
WROLPi will index many other video formats, but it will always download an MP4 (this may be changed in the
future).
WROLPi will index many other video formats.
## Downloading
## Downloading Videos
WROLPi will download a video (and related files) to that video's channel's directory. If you downloaded a
WROLPi will download a video (and related files) to that video's channel's directory. For example, if you downloaded a
video from the WROLPi channel, then your video will be stored in `videos/WROLPi` by default.
It is possible to override the default download directory by opening the Advanced accordion on the Videos
download modal:
![Videos Download Modal](video-download-modal.png)
### Download Options
* **Videos Tags**
* All selected Tags will be applied to every video downloaded.
* **Destination**
* Override the default download directory by choosing a directory using the **Destination** input.
* **Video Resolutions**
* Download each video in the first resolution matched. If you select "1080p, 720p" and a video has both resolutions
available, it will use
1080p, if no 1080p is available, then 720p will be downloaded, if neither resolutions is available an error will
be reported.
* **Video Format**
* The file format the video will be encapsulated in.
* `mp4` is the most universally compatible (but proprietary).
* `mkv` is an open-standard media format.
* **Channel Tag**
* The selected Tag will be applied to any new Channel created in the process of downloading these videos. The
Channel will be placed in the respective tag directory in the `videos` directory.
## Download Channels/Playlists
WROLPi can download all videos from a channel, or playlist. This is done using the `Download > Channel/Playlist`
download button.
![img.png](channel-download-modal.png)
### Download Options
* **Videos Tags**
* All selected Tags will be applied to every video downloaded.
## Channel
A Channel contains all videos downloaded from the origin channel (the third-party site from which the video
@ -38,27 +65,64 @@ that you have not downloaded.
### Creating a Channel
There are two methods to create a channel: the simplest is by downloading a video, which will automatically create the
channel for you. Alternatively, you can manually create a channel by navigating to the New Channel Page
channel for you.
Alternatively, you can manually create a channel by navigating to the New Channel Page
(`/videos/channel/new`). Access this page by clicking **Videos**, selecting the **Channels** tab, and then clicking
**New Channel**.
![New Channel page](channel-new-page.png)
Enter the new channel's name and its directory. All other fields are optional (be sure to enable
`Create this directory, if it doesn't exist` if necessary).
* Note: When entering a Channel's URL, you may need to append `/videos` to ensure the videos are downloaded to the
correct location.
Enter the new channel's name and its directory.
### Editing a Channel
To edit a Channel, navigate to the Channels (`/videos/channels`) page and click the 'Edit' button on the right. You will
be directed to the following page:
![Channel Edit Page](channel-edit-page.png)
![img.png](channel-edit-page.png)
On this page, you can modify the download frequency, the channel name, or the URL. Currently, it is not possible to
change the channel's directory.
On this page, you can modify the channel name, or the directory.
**Warning:** If you change the Channel's directory, all files in the directory (video or not) will be moved to the new
directory you specified. If the automatic move fails somehow, you will need to manually move the files to the correct
directory, then refresh your files. You will probably need to manually re-apply any tags to your videos again. If you
are unsure what your previous tags were, open the `tags.yaml` config of the previous day (`/media/wrolpi/tags/backup`)
to see what tags you had applied.
#### Details
Under the **Details** dropdown, you will see the Channel's URL and RSS URL (if available).
**Tip:** You can use the RSS URL to download new videos from a Channel quickly after they are released.
#### Channel Tag
You can also tag a Channel here. Only one Tag can be applied to a Channel. After clicking the **Tag** button, the
following modal will suggest moving your Channel (and it's files) under the respective tag directory in the `videos`
directory. You can uncheck "Move to directory" if you do not want to use the suggested directory.
![img.png](channel-tag-modal.png)
#### Buttons
**Delete**
* Used to delete the Channel. The files in the Channel's directory will not be deleted.
**Refresh**
* Refresh the files in the Channel's directory. Useful if you manually alter files in the directory.
**Tag**
* Add or replace the Tag of the Channel.
#### Downloads
You can add or update Downloads for this Channel.
#### Statistics
At the bottom of this page you will see the statistics of the channel's video files. This is useful if you want to be
sure that all videos were found during a refresh.
@ -79,7 +143,7 @@ working. VLC also displays captions when the caption file is named like the vide
### Raspberry Pi
VLC can be launched by navigating: `Applicaions Menu > Sound & Video > VLC Media Player`
VLC can be launched by navigating: `Applications Menu > Sound & Video > VLC Media Player`
![wrolpi-launch-vlc.png](wrolpi-launch-vlc.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Before After
Before After