Merge pull request #690 from felix920506/fallback-fonts

document fonts
jellyfin · Oct 9, 2023 · fafa8ad · fafa8ad
2 parents f0b5d3c + 0223aea
commit fafa8ad
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/docs/general/administration/configuration.md b/docs/general/administration/configuration.md
@@ -106,3 +106,23 @@ This section lists all the configuration options available and explains their fu
 | `FFmpeg:analyzeduration`                | `"200M"`                                                                                          | The value to set for the FFmpeg `analyzeduration` format option. See the FFmpg [documentation](https://ffmpeg.org/ffmpeg-formats.html#Format-Options) for more details. |
 | `playlists:allowDuplicates`             | `True`                                                                                            | Whether playlists should allow duplicate items or automatically filter out duplicates.                                                                                  |
 | `PublishedServerUrl`                    | Server Url based on primary IP address                                                            | The Server URL to publish in udp Auto Discovery response.                                                                                                               |
+
+## Fonts
+
+Jellyfin uses fonts to render text in many places.
+
+### Server Side System Fonts
+
+The system fonts installed on the server are used for burning in subtitles and rendering cover images. How to install them depends on the operating system.
+
+### Client Side System Fonts
+
+The system fonts installed on the client devices are used to display the text in the client interface as well as render subtitles for some clients. How to install them depends on the operating system.
+
+### Fallback Fonts
+
+The `Fallback Fonts` option is currently used by the web client to render subtitles only. This can be set to a folder containing fonts for this purpose. Lightweight formats optimized for web like woff2 are recommended. A tool to convert normal TrueType (`.ttf`) and OpenType (`.otf`) fonts to woff2 can be found [in their repo](https://github.com/google/woff2).
+
+### Downloading Fonts
+
+There are many fonts available online. [Google Fonts](https://fonts.google.com/) is a good place to download fonts for most languages.
diff --git a/docs/general/administration/troubleshooting.md b/docs/general/administration/troubleshooting.md
@@ -178,3 +178,7 @@ UPDATE Permissions SET Value = 1 WHERE (Kind = 0 OR Kind = 3 OR Kind = 4 OR Kind
 
 .exit
 ```
+
+## Text Not Rendering Properly
+
+Text may show up as boxes ☐☐☐☐☐☐ if fonts for the characters are not available. Installing fonts for the affected languages can solve the problem. For library cover images, please install system fonts on the server system. For subtitles, the source of fonts depends on the client. Please refer to [Fonts](/docs/general/administration/configuration#fonts) on where to install them.
diff --git a/docs/general/clients/codec-support.md b/docs/general/clients/codec-support.md
@@ -150,6 +150,10 @@ Content recorded OTA will typically have subtitles [embedded](https://aberdeen.i
 ffmpeg -f lavfi -i "movie=Ronin (1998).ts[out+subcc]" -map 0:1  "Ronin (1998).srt"
 ```
 
+### Fonts
+
+Text-based subtitle formats require fonts to render properly. Please refer to [Fonts](/docs/general/administration/configuration#fonts) for how to install them.
+
 ## [Container Compatibility](https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Containers)
 
 If the container is unsupported, this will result in remuxing. The video and audio codec will remain intact but wrapped in a supported container. This is the least intensive process. Most video containers will be remuxed to use the HLS streaming protocol and TS containers. Remuxing shouldn't be a concern even for an RPi3.
-Original file line number
+Diff line change
@@ Expand Up @@
     .exit
     ```
+    ## Text Not Rendering Properly
+    Text may show up as boxes ☐☐☐☐☐☐ if fonts for the characters are not available. Installing fonts for the affected languages can solve the problem. For library cover images, please install system fonts on the server system. For subtitles, the source of fonts depends on the client. Please refer to [Fonts](/docs/general/administration/configuration#fonts) on where to install them.