Skip to content

use tabs for metadata docs that covers multiple library types #1495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

use tabs for metadata docs that covers multiple library types #1495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d64168c
use tabs for video metadata examples
felix920506 Aug 9, 2025
431cf45
add query parameters
felix920506 Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/general/server/media/_metadata-images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Images can either be provided as external files within the media folders, or emb
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<Tabs defaultValue={props.defaultTab}>
<TabItem value='music' label='Music'>
```txt
Album
Expand All @@ -19,7 +19,7 @@ import TabItem from '@theme/TabItem';
```
When no images are provided for music, Jellyfin will take the cover image from the first track that has an embedded cover image.
</TabItem>
<TabItem value='movies' label='Movies'>
<TabItem value="movies" label='Movies'>
```txt
Movie (2035)
├── cover.jpg
Expand Down
21 changes: 15 additions & 6 deletions docs/general/server/media/_video-3d.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,17 @@

The tags are case-insensitive and must be surrounded by either a space, hyphen `-`, dot `.`, or underscore `_`.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs defaultValue={props.defaultTab} queryString="libType">
<TabItem value="movies" label="Movies">
```txt
Awesome 3D Movie (2022).3D.FTAB.mp4
Awesome 3D Movie (2022)_3D_htab.mp4
Awesome 3D Movie (2022)-3d-hsbs.mp4
```

```txt
S01E01 Some Episode.3d.ftab.mp4
S01E02 Some Other Episode.3d.ftab.mp4
S01E03 Yet another episode.3d.hsbs.mp4
```

Additionally, 3D filename tags can be combined with the grouping functionality in movie and music video libraries. All text before the hyphen must match the folder name.

```txt
Expand All @@ -36,3 +35,13 @@ Movies
├── Awesome 3D Movie (2022) - 3D.hsbs.mp4
└── Awesome 3D Movie (2022) - 1080p.mp4
```

</TabItem>
<TabItem value="shows" label="Shows">
```txt
S01E01 Some Episode.3d.ftab.mp4
S01E02 Some Other Episode.3d.ftab.mp4
S01E03 Yet another episode.3d.hsbs.mp4
```
</TabItem>
</Tabs>
26 changes: 22 additions & 4 deletions docs/general/server/media/_video-external-extras.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ Supported folder types are:
- `extras` - Generic catch all for extras of an unknown type.
- `trailers`

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs defaultValue={props.defaultTab} queryString="libType">
<TabItem value="movies" label="Movies">
```txt
Best_Movie_Ever (2019)
├── Best_Movie_Ever (2019).mp4
Expand All @@ -30,7 +35,8 @@ Best_Movie_Ever (2019)
└── extras
└── Home recreation.mp4
```

</TabItem>
<TabItem value="shows" label="Shows">
```txt
Awesome TV Show (2024)
├── Season 1
Expand All @@ -40,6 +46,8 @@ Awesome TV Show (2024)
└── interviews
└── Interview with the Director.mp4
```
</TabItem>
</Tabs>

### File Name

Expand All @@ -51,19 +59,24 @@ Supported filenames are:
- `sample`
- `theme` - Audio file of the theme song

<Tabs defaultValue={props.defaultTab} queryString="libType">
<TabItem value="movies" label="Movies">
```txt
Best_Movie_Ever (2019)
├── Best_Movie_Ever (2019) - 1080P.mp4
└── theme.mp3
```

</TabItem>
<TabItem value="shows" label="Shows">
```txt
Awesome TV Show (2024)
├── Season 1
│ ├── S01E01 episode name.mp4
│ └── theme.flac
└── sample.mp4
```
</TabItem>
</Tabs>

### File Suffix

Expand All @@ -89,19 +102,24 @@ If you would rather keep everything in a single folder, you can append special s
- `-short`
- `-other`
- `-extra`
<!-- markdownlint-enable MD038 -->
<!-- markdownlint-enable MD038 -->

<Tabs defaultValue={props.defaultTab} queryString="libType">
<TabItem value="movies" label="Movies">
```txt
Best_Movie_Ever (2019)
├── Best_Movie_Ever (2019) - 1080P.mp4
├── Preview Trailer.trailer.mp4
└── Making of The Best Movie Ever-behindthescenes.mp4
```

</TabItem>
<TabItem value="shows" label="Shows">
```txt
Awesome TV Show (2024)
├── Season 1
│ ├── S01E01 episode name.mp4
│ └── Preview Trailer.trailer.mp4
└── making of awesome tv show-behindthescenes.mp4
```
</TabItem>
</Tabs>
10 changes: 9 additions & 1 deletion docs/general/server/media/_video-external-streams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

External Subtitles and audio tracks can be added with file suffixes.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs defaultValue={props.defaultTab} queryString="libType">
<TabItem value="movies" label="Movies">
```txt
/Movies
/Film (1986)
Expand All @@ -14,7 +19,8 @@ External Subtitles and audio tracks can be added with file suffixes.
Film.en.sdh.srt
Film.English Commentary.en.mp3
```

</TabItem>
<TabItem value="shows" label="Shows">
```txt
/Shows
/Show (2021)
Expand All @@ -23,6 +29,8 @@ External Subtitles and audio tracks can be added with file suffixes.
Show (2021) S01E01 Title.ja.ass
Show (2021) S01E01 Title.commentary.ja.aac
```
</TabItem>
</Tabs>

Each title/flag field can be a generic string, or a special flag. A file can have multiple flags, separated with `.`

Expand Down
10 changes: 9 additions & 1 deletion docs/general/server/media/_video-multipart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,27 @@

Content that is split into multiple files can be stacked together if named correctly. Files should be named as follows:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs defaultValue={props.defaultTab} queryString="libType">
<TabItem value="movies" label="Movies">
```txt
Movie Name (2010)
├── Movie Name-cd1.mkv
├── Movie Name-cd2.mkv
└── Movie Name-cd3.mkv
```

</TabItem>
<TabItem value="shows" label="Shows">
```txt
Show (2025)
└──Season 1
├── S01E01-part-1.mkv
└── S01E01-part-2.mkv
```
</TabItem>
</Tabs>

The separator is optional between `<parttype>` and `<partnumber>`. `<partnumber>` can be any number, or the letters a-d.

Expand Down
10 changes: 5 additions & 5 deletions docs/general/server/media/movies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,24 +59,24 @@ import VideoMetadataProviders from './\_video-metadata-providers.md';

import ExternalStreams from './\_video-external-streams.md';

<ExternalStreams />
<ExternalStreams defaultTab="movies"/>

import Multiversion from './\_video-multiversion.md';

<Multiversion />

import Video3D from './\_video-3d.md';

<Video3D />
<Video3D defaultTab="movies"/>

import Multipart from './\_video-multipart.md';

<Multipart />
<Multipart defaultTab="movies"/>

import ExternalExtras from './\_video-external-extras.md';

<ExternalExtras />
<ExternalExtras defaultTab="movies"/>

import MetadataImages from './\_metadata-images.md';

<MetadataImages />
<MetadataImages defaultTab="movies"/>
10 changes: 5 additions & 5 deletions docs/general/server/media/music-videos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,24 @@ The folders and video files can be named however you want, since no metadata fet

import ExternalStreams from './\_video-external-streams.md';

<ExternalStreams />
<ExternalStreams defaultTab="movies"/>

import Multiversion from './\_video-multiversion.md';

<Multiversion />

import Video3D from './\_video-3d.md';

<Video3D />
<Video3D defaultTab="movies"/>

import Multipart from './\_video-multipart.md';

<Multipart />
<Multipart defaultTab="movies"/>

import ExternalExtras from './\_video-external-extras.md';

<ExternalExtras />
<ExternalExtras defaultTab="movies"/>

import MetadataImages from './\_metadata-images.md';

<MetadataImages />
<MetadataImages defaultTab="movies"/>
2 changes: 1 addition & 1 deletion docs/general/server/media/music.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Line 5

import MetadataImages from './\_metadata-images.md';

<MetadataImages />
<MetadataImages defaultTab="music"/>

## File Extensions / Containers

Expand Down
10 changes: 5 additions & 5 deletions docs/general/server/media/shows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ import VideoMetadataProviders from './\_video-metadata-providers.md';

import ExternalStreams from './\_video-external-streams.md';

<ExternalStreams />
<ExternalStreams defaultTab="shows"/>

import ExternalExtras from './\_video-external-extras.md';

<ExternalExtras />
<ExternalExtras defaultTab="shows"/>

### Show Specials

Expand All @@ -91,12 +91,12 @@ Note that this will show them in both the `Specials` season, as well as the seas

import Video3D from './\_video-3d.md';

<Video3D />
<Video3D defaultTab="shows"/>

import Multipart from './\_video-multipart.md';

<Multipart />
<Multipart defaultTab="shows"/>

import MetadataImages from './\_metadata-images.md';

<MetadataImages />
<MetadataImages defaultTab="shows"/>