e1f81e5274
* docs(config): Clarify preset ordering priority Refs #1276 * docs(architecture): WIP Narrative how it works Much of this is repetition of the reference docs and some of the changes here should also be applied here. The goal is to repeat here the parts of the reference docs that may hang up a user when reading "Getting Started" without sending them off to get lost in the weeds of the reference docs. Note that this references a `Quick Start` document which is just an empty placeholder and is to be written in a subsequent change. Fixes #1279 * docs(terms): Glossary redundant with architecture Now that the introduction includes an architectural overview, that section introduces new users to necessary concepts and associated terminology and makes the terminology section redundant in that part of the docs. * docs(quick): Add a rote quick start guide This is what I came up with when I tried to write instructions requiring as little understanding as possible. Doing so really did reinforce my impression that this just shouldn't be done, that significant understanding is required for *any* use of ytdl-sub and even offering a quick start may be irresponsible. I'm still on the fence, thoughts? That said, I also think I got some good explanations out of this and a better understanding of what the next bits of the Getting Started should be. This Quick Start is currently redundant with other parts of the Getting Started pages. I suspect that I'll end up repeating and/or reorganizing parts of this Quick Start into the next bits of the Getting Started. To that end I might argue that this change is a WIP and that merging should wait. But I could also argue that this is an incremental improvement and can be merged before that other work. Your call. * docs(start): Various rST/Sphinx markup issues
50 lines
1.8 KiB
ReStructuredText
50 lines
1.8 KiB
ReStructuredText
=========
|
|
Reference
|
|
=========
|
|
|
|
This section contains direct references to the code of ``ytdl-sub`` and information on how it functions.
|
|
|
|
|
|
Terminology
|
|
-----------
|
|
|
|
Must-know terminology:
|
|
|
|
- ``subscription``: URL(s) that you want to download with specific metadata
|
|
requirements.
|
|
- ``preset``: A media profile comprised of YAML configuration that can specify anything
|
|
from metadata layout, media quality, or any feature of ytdl-sub, to apply to
|
|
subscriptions. A preset can inherit other presets.
|
|
- ``prebuilt preset``: Presets that are included in ytdl-sub. These do most of the work
|
|
defining plugins, overrides, etc in order to make downloads ready for player
|
|
consumption.
|
|
- ``override``: Verb describing the act of overriding something in a preset. For
|
|
example, the TV Show presets practically expect you to *override* the URL variable to
|
|
tell ytdl-sub where to download from.
|
|
- ``override variables``: User-defined variables that are intended to *override*
|
|
something.
|
|
- ``subscription file``: The file to specify all of your subscriptions and some override
|
|
variables.
|
|
|
|
Intermediate terminology:
|
|
|
|
- ``plugin``: Modular logic to apply to a subscription. To use a plugin, it must be
|
|
defined in a preset.
|
|
- ``config file``: An optional file where you can define custom presets and other
|
|
advanced configuration.
|
|
- ``yt-dlp``: The underlying application that handles downloading for ytdl-sub.
|
|
|
|
Advanced terminology:
|
|
|
|
- ``entry variables``: Variables that derive from a downloaded yt-dlp entry (media).
|
|
- ``static variables``: Variables that do not have a dependency to entry variables.
|
|
- ``scripting``: Syntax that allows the use of entry variables, static variables, and
|
|
functions in override variables.
|
|
|
|
|
|
.. toctree::
|
|
config_yaml
|
|
subscription_yaml
|
|
plugins
|
|
scripting/index
|
|
prebuilt_presets/index
|