Expanding Videos and Archives help.

.idea/runConfigurations/mkdocs.xml

@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/venv/bin/mkdocs" />
-    <option name="PARAMETERS" value="serve -a 0.0.0.0:8085" />
+    <option name="PARAMETERS" value="serve -a 0.0.0.0:8086" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="false" />
     <option name="MODULE_MODE" value="false" />

docs/archives/files.md

@@ -2,30 +2,29 @@
 
 WROLPi creates several files when archiving a webpage:
 
-1. A [Singlefile](#singlefile) which stores an exact copy of the web page.
-2. A [Readability](#readability) file.
+1. A [Singlefile](index.md#singlefile) that stores an exact copy of the web page.
+2. A [Readability](index.md#readability) file.
 3. A Readability text file.
 4. A Readability JSON file.
 5. A screenshot file of the web page.
 
-These files are all share the same file name, but different suffixes.
+These files all share the same filename but have different suffixes.
 
 | File Suffix       | Purpose                                    |
 |-------------------|--------------------------------------------|
 | .html             | The Singlefile.                            |
 | .readability.html | The Readability extract of the Singlefile. |
 | .readability.txt  | The article text extracted by Readability. |
-| .readability.json | Data from Readability (URL/author/etc).    |
+| .readability.json | Data from Readability (URL/author/etc.).   |
 | .png              | The screenshot of the web page.            |
 
 Archive files are named using three parts:
 
-1. The domain directory
-2. The archive date time (YYYY-mm-dd-HH-MM-SS).
+1. The domain directory.
+2. The archive date time (YYYY-MM-DD-HH-MM-SS).
 3. The title of the web page.
 
-If archiving [https://wrolpi.org/getting-started](https://wrolpi.org/getting-started), the resulting files would be
-named like so:
+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
@@ -35,5 +34,5 @@ wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.json
 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
-WROLPi will still keep the lone Singlefile.
+WROLPi will attempt to extract the Readability and create a screenshot from the Singlefile. If this is not possible,
+WROLPi will still keep the lone Singlefile.

docs/archives/index.md

@@ -1,32 +1,44 @@
 # Archives
 
-The Archives module allows viewing, organizing, and downloading of webpages as SingleFile files. Each Archive's URL
-is retained, they are organized by their domain in the Domains tab.
+The Archives module allows for viewing, organizing, and downloading webpages as SingleFile files. Each Archive's URL is
+retained and organized by domain in the Domains tab. The Archives page (`/archive`) sorts entries by the most recently
+published articles.
+
+In the context of WROLPi, an Archive refers to a set of [similarly named files](files.md) created while archiving.
+A single SingleFile file is also supported.
 
 ![An Archive page](archive-page.png)
 
 ## Singlefile
 
-A Singlefile is an HTML file which contains encoded copies of all files necessary to render a webpage. Normally a
-webpage will link to many resources outside the page you are viewing, this causes problems when you attempt to save the
-webpage because you will need to download and organize all of these files. Singlefile solves this problem by encoding
-and embedding all the related files within a single HTML file.
+A [Singlefile](https://github.com/gildas-lormeau/SingleFile) is an HTML file which contains encoded copies of all files
+necessary to render a webpage. Normally, a webpage will link to many resources outside the page you are viewing, which
+causes problems when you attempt to save the webpage because you will need to download and organize all these files.
+Singlefile solves this problem by encoding and embedding all the related files within a single HTML file.
 
-The Singlefile project has many advantages.
+The Singlefile project has many advantages:
 
-* A single HTML file that can be easily shared with others.
-* All that is necessary to view the archive is a compatible browser. No external files or services.
-* An exact copy that handles rendering of Javascript that the page will contain.
-* Images and style is preserved.
+* It creates a single HTML file that can be easily shared with others.
+* All that is necessary to view the archive is a compatible browser; no external files or services are needed.
+* It provides an exact copy that handles the rendering of Javascript the page contains.
+* Images and style are preserved.
 
 ## Readability
 
 [Readability](https://github.com/mozilla/readability) is a Mozilla project which extracts the article from a web page.
-Because a web page is made up of many HTML, CSS, Javascript words that we do not want to search, WROLPi uses Readability
-to extract the words that will be indexed.
+Because a web page comprises many HTML, CSS, and Javascript elements that we do not want to search, WROLPi uses
+Readability to extract the words that will be indexed.
 
 ![A preview of the Readability extract of wrolpi.org](readability-preview.png)
 
 ## Domain
 
-A domain is the host of the archived URL. For example, the host of https://wrolpi.org/getting-started is wrolpi.org.
+A domain is the host of the archived URL. For example, the host of `https://wrolpi.org/getting-started` is `wrolpi.org`.
+
+## Searching
+
+When the indexes for an Archive are generated for searching, they are searched in the following order of precedence:
+
+1. Title
+2. HTML Metadata Description
+3. Readability Text

docs/videos/index.md

@@ -2,5 +2,61 @@
 
 ## Overview
 
-The Videos module facilitates the viewing, organizing, and downloading of videos files.  The main page of the Videos
-Module (/videos) allows the searching of all video files found during a file refresh of the media directory.
+The Videos module facilitates the viewing, organizing, and downloading of video files. The main page of the
+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 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).
+
+## Downloading
+
+WROLPi will download a video (and related files) to that video's channel's directory. 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)
+
+## Channel
+
+A Channel contains all videos downloaded from the origin channel (the third-party site from which the video
+was downloaded). When viewing a video, you will notice that the Older/Newer videos at the bottom of a page
+are videos within the same channel. WROLPi will attempt to create a Channel for each video that you download.
+
+A Channel can also be a directory of video files. This is useful when you have a collection of related videos
+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
+(`/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.
+
+### 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)
+
+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.
+
+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.