-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: add missing macros - converted to snippet file * docs: wrap variables table in collapsible details element * add type column and new skipDuplicate vars * fix(types): update integer types for SkipDuplicateProfileID and Size fields * add imdb id
- Loading branch information
Showing
2 changed files
with
80 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
<details> | ||
<summary>Click to view supported variables</summary> | ||
|
||
| Variable | Type | Description | | ||
| -------------------------------- | -------- | ------------------------------------------ | | ||
| `{{.Artists}}` | string | Artists | | ||
| `{{.Audio}}` | []string | Audio codecs/formats array | | ||
| `{{.AudioChannels}}` | string | Audio channels configuration | | ||
| `{{.AudioFormat}}` | string | Audio format | | ||
| `{{.Bitrate}}` | string | Release bitrate | | ||
| `{{.Bonus}}` | []string | Bonus features array | | ||
| `{{.Categories}}` | []string | Categories | | ||
| `{{.Category}}` | string | Category | | ||
| `{{.Codec}}` | []string | Video codecs array | | ||
| `{{.Container}}` | string | Container format | | ||
| `{{.CurrentDay}}` | int | Current Day | | ||
| `{{.CurrentHour}}` | int | Current Hour | | ||
| `{{.CurrentMinute}}` | int | Current Minute | | ||
| `{{.CurrentMonth}}` | int | Current Month | | ||
| `{{.CurrentSecond}}` | int | Current Second | | ||
| `{{.CurrentYear}}` | int | Current Year | | ||
| `{{.Day}}` | int | Release day | | ||
| `{{.Description}}` | string | Release description | | ||
| `{{.DownloadURL}}` | string | Download URL | | ||
| `{{.Episode}}` | int | Parsed episode | | ||
| `{{.FilterID}}` | int | Filter identifier | | ||
| `{{.FilterName}}` | string | Filter name | | ||
| `{{.Freeleech}}` | bool | Freeleech status | | ||
| `{{.FreeleechPercent}}` | int | Freeleech percentage | | ||
| `{{.Group}}` | string | Release group | | ||
| `{{.GroupID}}` | string | GroupID | | ||
| `{{.HasCue}}` | bool | Has .cue file | | ||
| `{{.HasLog}}` | bool | Has log file | | ||
| `{{.HDR}}` | string | Parsed HDR (DV, HDR, HDR10) | | ||
| `{{.Implementation}}` | string | Implementation type | | ||
| `{{.Indexer}}` | string | Indexer identifier | | ||
| `{{.IndexerIdentifier}}` | string | Indexer identifier | | ||
| `{{.IndexerIdentifierExternal}}` | string | External indexer identifier | | ||
| `{{.IndexerName}}` | string | Indexer name | | ||
| `{{.InfoUrl}}` | string | Info URL | | ||
| `{{.IsDuplicate}}` | bool | Is duplicate release | | ||
| `{{.Language}}` | []string | Language array | | ||
| `{{.Leechers}}` | int | Number of leechers | | ||
| `{{.LogScore}}` | int | Log score for music releases | | ||
| `{{.MagnetURI}}` | string | Magnet link URI | | ||
| `{{.MetaIMDB}}` | string | IMDB ID | | ||
| `{{.Month}}` | int | Release month | | ||
| `{{.Origin}}` | string | Release origin | | ||
| `{{.Other}}` | []string | Other attributes array | | ||
| `{{.PreTime}}` | string | Pre time | | ||
| `{{.Proper}}` | bool | Is proper release | | ||
| `{{.Protocol}}` | string | Protocol type | | ||
| `{{.RecordLabel}}` | string | Record label | | ||
| `{{.Region}}` | string | Region information | | ||
| `{{.Repack}}` | bool | Is repack release | | ||
| `{{.Resolution}}` | string | Parsed resolution (1080p) | | ||
| `{{.Season}}` | int | Parsed season | | ||
| `{{.Seeders}}` | int | Number of seeders | | ||
| `{{.Size}}` | uint | Size (in bytes) | | ||
| `{{.SizeString}}` | string | SizeString (including unit string) | | ||
| `{{.SkipDuplicateProfileID}}` | int | Skip duplicate profile ID | | ||
| `{{.SkipDuplicateProfileName}}` | string | Skip duplicate profile name | | ||
| `{{.Source}}` | string | Parsed source (BluRay, WEB-DL) | | ||
| `{{.Tags}}` | string | Release tags (comma separated) | | ||
| `{{.Title}}` | string | Parsed title (That Movie) | | ||
| `{{.TorrentDataRawBytes}}` | []byte | Raw torrent file data | | ||
| `{{.TorrentHash}}` | string | Torrent hash | | ||
| `{{.TorrentID}}` | string | TorrentID | | ||
| `{{.TorrentName}}` | string | Release name as announced | | ||
| `{{.TorrentPathName}}` | string | Path to downloaded .torrent file in `/tmp` | | ||
| `{{.TorrentTmpFile}}` | string | Temporary torrent file path | | ||
| `{{.TorrentUrl}}` | string | Full url to download torrent | | ||
| `{{.Type}}` | string | Type e.g. episode | | ||
| `{{.Uploader}}` | string | Release uploader | | ||
| `{{.Website}}` | string | Website URL | | ||
| `{{.Year}}` | int | Parsed year | | ||
|
||
</details> |