899143db98
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.
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
|