Skip to content

Commit

Permalink
info.md proofreading
Browse files Browse the repository at this point in the history
  • Loading branch information
user committed Dec 8, 2024
1 parent 8cc772f commit 4b0110d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions avtdl/ui/info/info.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## avtdl - Web interface

When avtdl is running, web interface is available on <http://localhost:8080>, unless different port is specified in
configuration. It makes configuration process more grafical at the expense of flexibility YAML provides.
configuration. It makes managing complex configuration easier at the expense of flexibility YAML provides.

### Configuration editor

Web interface follows [configuration file structure](https://github.com/15532th/avtdl#configuration-file-format), with
application-wide options in `Settings`, producers and consumers entities defined in `Actors` and then combined together
application-wide options in `Settings`, producers and consumers entities defined in `Actors` and then combined
in `Chains` sections.

<figure>
Expand All @@ -18,7 +18,7 @@ in `Chains` sections.
Configuration file is saved under the same name it was loaded on the application startup. Backups of a few most recent
versions are made by appending a number to the name (`config.yml` would be moved to `config.yml.0` and so on).

When existing configuration file is loaded into the web interface, edited and stored back on disk, it will preserve defined functionality, but not formatting. Parser tries to preserve comments, parenthesses, flow style, but indentation levels are normalized, options with default values are omitted, the `defaults` sections are expanded into corresponding entities and then removed.
When existing configuration file is loaded into the web interface, edited and stored back on disk, it will preserve defined functionality, but not formatting. Parser tries to preserve comments, parentheses, flow style, but indentation levels are normalized, options with default values are omitted, the `defaults` sections are expanded into corresponding entities and then removed.

### Actors

Expand All @@ -39,7 +39,7 @@ Each option has a tooltip with option description, however, it does not include

Single chain is represented by a vertical stack of `cards`, each defining one or more entities of a single actor. Records move top to bottom, from every entity of one `card` to every entity of the next one.

The following picture shows a chain named "archive". It references two entities of the [rss](https://github.com/15532th/avtdl/blob/master/PLUGINS.md#rss---youtube-channel-rss-feed-monitor) montitor, "ChannelName" and "AnotherChannelName". Records, produced by these entities, are passed into the "ytachive" entity of the [execute](https://github.com/15532th/avtdl/blob/master/PLUGINS.md#execute---run-pre-defined-shell-command) action.
The following picture shows a chain named "archive". It references two entities of the [rss](https://github.com/15532th/avtdl/blob/master/PLUGINS.md#rss---youtube-channel-rss-feed-monitor) monitor, "ChannelName" and "AnotherChannelName". Records, produced by these entities, are passed into the "ytachive" entity of the [execute](https://github.com/15532th/avtdl/blob/master/PLUGINS.md#execute---run-pre-defined-shell-command) action.

<figure>
<p align="center" width="100%">
Expand Down

0 comments on commit 4b0110d

Please sign in to comment.