DebaucheryLibrarian
/
ripunzel
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improved README formatting.

This commit is contained in:
DebaucheryLibrarian 2024-09-11 05:16:57 +02:00
parent 50f1621a26
commit 4e827fb9a8
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -83,8 +83,8 @@ Path patterns dictate where and how a file will be saved. Various variables and
* `{item.description}`: The description of the individual image or video * `{item.description}`: The description of the individual image or video
* `{item.date}`: The submission date of the individual image or video, formatted by the `dateFormat` configuration described below * `{item.date}`: The submission date of the individual image or video, formatted by the `dateFormat` configuration described below
* `{item.index}`: The index of the individual image or video in an album, offset by the `indexOffset` configuration described below * `{item.index}`: The index of the individual image or video in an album, offset by the `indexOffset` configuration described below
* `{*tags*.extracted}`: Whether the item has been extracted as the only item in an album * `{tags.extracted}`: Whether the item has been extracted as the only item in an album
* `{*tags*.preview}`: Whether the image is a reddit preview because it was unavailable on the original host * `{tags.preview}`: Whether the image is a reddit preview because it was unavailable on the original host
* `{ext}`: The extension of the medium. Must typically be included, but may be omitted for self (text) posts on Unix systems * `{ext}`: The extension of the medium. Must typically be included, but may be omitted for self (text) posts on Unix systems
##### Album ##### Album
@ -123,11 +123,11 @@ Many reddit users have a 'subreddit' of their own in the form of a profile (not
* `{profile.description}`: The description of the reddit user's profile * `{profile.description}`: The description of the reddit user's profile
* `{tags.over18}` (boolean): Whether the profile contains adult content and requires an 'over 18' age confirmation * `{tags.over18}` (boolean): Whether the profile contains adult content and requires an 'over 18' age confirmation
##### `{tags.*x*}` ##### `{tags.x}`
Tags are variables that will only be inserted when another variable is present. When you use a tag, you must configure a string of text that is inserted in place of a tag variable when the associated variable is available. Tags are variables that will only be inserted when another variable is present. When you use a tag, you must configure a string of text that is inserted in place of a tag variable when the associated variable is available.
#### `divider`, `{div}` and `{divs.*x*}` #### `divider`, `{div}` and `{divs.x}`
The `{div}` variable will insert an arbitrary string as configured by the `divider` option, intended, of course, to be used as a divider between other components. Similar to tags, `{divs.*x*}` will insert a divider only when the specified variable is present. For example, `{divs.item.}title` will only insert a divider when `{item.title} is present. This makes sure a filename will look like, for example, either `./20191101 - abc123 - Hello world!.jpeg` when a title is available or `./20191101 - abc123.jpg` when no title is available, instead of `20191101 - abc123 - .jpeg` when a title is not available. The `{div}` variable will insert an arbitrary string as configured by the `divider` option, intended, of course, to be used as a divider between other components. Similar to tags, `{divs.x}` will insert a divider only when the specified variable is present. For example, `{divs.item.}title` will only insert a divider when `{item.title} is present. This makes sure a filename will look like, for example, either `./20191101 - abc123 - Hello world!.jpeg` when a title is available or `./20191101 - abc123.jpg` when no title is available, instead of `20191101 - abc123 - .jpeg` when a title is not available.
##### `dateFormat` ##### `dateFormat`
Affects the representation of `{item.date}`, `{album.date}` and `{post.date}` and defaults to `YYYYMMDD`. See [this documentation](https://date-fns.org/v1.29.0/docs/format) for an overview of all available tokens. Affects the representation of `{item.date}`, `{album.date}` and `{post.date}` and defaults to `YYYYMMDD`. See [this documentation](https://date-fns.org/v1.29.0/docs/format) for an overview of all available tokens.