Adding info about Video files. Adding docs for multiple external usb drives.

This commit is contained in:
Roland 2024-03-10 16:41:56 -06:00
parent 356ec0364f
commit 7be4718bdd
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
16 changed files with 191 additions and 44 deletions

View file

@ -27,11 +27,11 @@ Archive files are named using three parts:
If archiving `https://wrolpi.org/getting-started`, the resulting files might be named as follows:
```
wrolpi.org/2023-01-01-12-00-00_Getting Started.html
wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.html
wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.txt
wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.json
wrolpi.org/2023-01-01-12-00-00_Getting Started.png
/media/wrolpi/archive/wrolpi.org/2023-01-01-12-00-00_Getting Started.html
/media/wrolpi/archive/wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.html
/media/wrolpi/archive/wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.txt
/media/wrolpi/archive/wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.json
/media/wrolpi/archive/wrolpi.org/2023-01-01-12-00-00_Getting Started.png
```
WROLPi will attempt to extract the Readability and create a screenshot from the Singlefile. If this is not possible,

View file

@ -31,22 +31,30 @@ save them to the `map` directory. After they have been downloaded, you will need
You can manually import a PBF file using the **import_map.sh** script:
`/opt/wrolpi/scripts/import_map.sh /media/wrolpi/map/austria-231121.osm.pbf`
```shell
/opt/wrolpi/scripts/import_map.sh /media/wrolpi/map/austria-231121.osm.pbf
```
Multiple maps can be imported like so:
`/opt/wrolpi/scripts/import_map.sh /media/wrolpi/map/one.osm.pbf /media/wrolpi/map/two.osm.pbf /media/wrolpi/map/three.osm.pbf`
```shell
/opt/wrolpi/scripts/import_map.sh /media/wrolpi/map/one.osm.pbf /media/wrolpi/map/two.osm.pbf /media/wrolpi/map/three.osm.pbf
```
## Reset Map
If your map is not working, maps cannot be imported, or some other reason, you can reset the map database using the
reset script:
`/opt/wrolpi/scripts/reset_map.sh`
```shell
/opt/wrolpi/scripts/reset_map.sh
```
Next, run the repair script:
`/opt/wrolpi/repair.sh`
```shell
/opt/wrolpi/repair.sh
```
Browse to your map, you should see the default map. If you do not, you may need to clear your browse's cache. Next,
Browse to your map, you should see the default map. If you do not, you may need to clear your browse's cache. Finally,
import your desired maps.

View file

@ -0,0 +1,37 @@
# Video Files
WROLPi creates several files when downloading a video:
1. A video file.
2. Caption files. The suffix may be prefixed with the language like so: `.en.vtt` or `.es.vtt`
3. An "info" json file. This file contains large amounts of information about the video: Channel name, Source ID,
comments, Like count, etc.
4. A poster file (thumbnail).
These files all share the same filename but have different suffixes.
| File Suffix | Purpose |
|-------------|------------------------------|
| .mp4 | The video. |
| .vtt | The captions. |
| .info.json | Information about the video. |
| .jpg | The poster (thumbnail). |
Video files are named using three parts:
1. The Channel Name.
2. The Published Date (upload date).
3. The Source ID (a unique string of characters linking to the video, i.e `0xfMLNVFq2Y`)
4. The title of the video.
The above order is important, it allows the videos to be viewed chronologically in the file browser. The Source ID
is important because it prevents a conflict if a Channel uploads a video with the same name on the same day.
Example file names for a video:
```
/media/videos/wrolpi/WROLPi_20230909_0xfMLNVFq2Y_WROLPi v0.11 beta demo.mp4
/media/videos/wrolpi/WROLPi_20230909_0xfMLNVFq2Y_WROLPi v0.11 beta demo.en.vtt
/media/videos/wrolpi/WROLPi_20230909_0xfMLNVFq2Y_WROLPi v0.11 beta demo.info.json
/media/videos/wrolpi/WROLPi_20230909_0xfMLNVFq2Y_WROLPi v0.11 beta demo.jpg
```

View file

@ -8,6 +8,8 @@ Videos Module (`/videos`) allows browsing all video files.
In the context of WROLPi, a Video refers to a set of [similarly named files](files.md) created during
download. A single video file is also supported.
![video-page.png](video-page.png)
## Video Format
As of the writing of this article, WROLPi favors MP4 files due to their small size and universal support.
@ -67,4 +69,19 @@ When the indexes for a Video are generated for searching, they are searched in t
1. Title
2. Description
3. Subtitles
3. Subtitles
## Videos without WROLPi
WROLPi comes with VLC pre-installed, this application allows you to watch video files, even if the React App is not
working. VLC also displays captions when the caption file is named like the video file (see
[Video Files](../videos/files.md)).
### Raspberry Pi
VLC can be launched by navigating: `Applicaions Menu > Sound & Video > VLC Media Player`
![wrolpi-launch-vlc.png](wrolpi-launch-vlc.png)
Any video file can be opened by navigating `Media > Open File`. VLC will automatically display captions files that
WROLPi has downloaded.

Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

View file

@ -28,4 +28,18 @@ WROLPi will search any Zim file found in the `zims` directory, but not every pro
subscription list. If you would like to download a specific Zim file, use the **Files Downloader** and save the file to
the `zims` directory. (You may need to restart your WROLPi for the new Zim file to be found.)
![Downloading a Zim file using the Files Downloader](zim-file-downloader.png)
![Downloading a Zim file using the Files Downloader](zim-file-downloader.png)
## Kiwix without WROLPi
WROLPi comes with Kiwix pre-installed, this application allows you to use your zim files even if the React App is not
working.
### Raspberry Pi
Kiwix can be started by navigating: `Applications Menu > Education > Kiwix`
![kiwix-rpi-application-start.png](kiwix-rpi-application-start.png)
Any zim file can be opened using the "Open" button on the top right of the Kiwix application. Zim files are usually
stored in `/media/wrolpi/zims`.

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB