Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CollinHeist committed Oct 24, 2023
1 parent 1a60fac commit fa0bdba
Show file tree
Hide file tree
Showing 14 changed files with 119 additions and 84 deletions.
51 changes: 0 additions & 51 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -36,57 +36,6 @@ ENV TCM_PREFERENCES=/config/preferences.yml \
TCM_IS_DOCKER=TRUE \
TZ=UTC

# These are from the dpokidov/imagemagick Docker container
# https://hub.docker.com/r/dpokidov/imagemagick/dockerfile
# ARG IM_VERSION=7.1.1-8
# ARG LIB_HEIF_VERSION=1.12.0
# ARG LIB_AOM_VERSION=3.1.0
# ARG LIB_WEBP_VERSION=1.2.0

# RUN apt-get -y update && \
# apt-get -y upgrade && \
# apt-get install -y git make gcc pkg-config autoconf curl g++ \
# # libaom
# yasm cmake \
# # libheif
# libde265-0 libde265-dev libjpeg62-turbo libjpeg62-turbo-dev x265 libx265-dev libtool \
# # IM
# libpng16-16 libpng-dev libjpeg62-turbo libjpeg62-turbo-dev libgomp1 ghostscript libxml2-dev libxml2-utils libtiff-dev libfontconfig1-dev libfreetype6-dev && \
# # Building libwebp
# cd / && \
# git clone https://chromium.googlesource.com/webm/libwebp && \
# cd libwebp && git checkout v${LIB_WEBP_VERSION} && \
# ./autogen.sh && ./configure --enable-shared --enable-libwebpdecoder --enable-libwebpdemux --enable-libwebpmux --enable-static=no && \
# make && make install && \
# ldconfig /usr/local/lib && \
# cd ../ && rm -rf libwebp && \
# # Building libaom
# git clone https://aomedia.googlesource.com/aom && \
# cd aom && git checkout v${LIB_AOM_VERSION} && cd .. && \
# mkdir build_aom && \
# cd build_aom && \
# cmake ../aom/ -DENABLE_TESTS=0 -DBUILD_SHARED_LIBS=1 && make && make install && \
# ldconfig /usr/local/lib && \
# cd .. && \
# rm -rf aom && \
# rm -rf build_aom && \
# # Building libheif
# curl -L https://github.com/strukturag/libheif/releases/download/v${LIB_HEIF_VERSION}/libheif-${LIB_HEIF_VERSION}.tar.gz -o libheif.tar.gz && \
# tar -xzvf libheif.tar.gz && cd libheif-${LIB_HEIF_VERSION}/ && ./autogen.sh && ./configure && make && make install && cd .. && \
# ldconfig /usr/local/lib && \
# rm -rf libheif-${LIB_HEIF_VERSION} && rm libheif.tar.gz && \
# # Building ImageMagick
# git clone https://github.com/ImageMagick/ImageMagick.git && \
# cd ImageMagick && git checkout ${IM_VERSION} && \
# ./configure --without-magick-plus-plus --disable-docs --disable-static --with-libtiff && \
# make && make install && \
# ldconfig /usr/local/lib && \
# apt-get remove --autoremove --purge -y gcc make cmake curl g++ yasm git autoconf pkg-config libpng-dev libjpeg62-turbo-dev libde265-dev libx265-dev libxml2-dev libtiff-dev libfontconfig1-dev libfreetype6-dev && \
# rm -rf /var/lib/apt/lists/* && \
# rm -rf ImageMagick && \
# # Override default ImageMagick policy
# cp /maker/modules/ref/policy.xml /usr/local/etc/ImageMagick-7/policy.xml

# Delete setup files
# Create user and group to run the container
# Clean up apt cache
Expand Down
Binary file added docs/assets/add_series_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/add_series_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/blueprint_all_dark.webp
Binary file not shown.
Binary file added docs/assets/blueprint_all_light.webp
Binary file not shown.
Binary file added docs/assets/blueprint_series_dark.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/blueprint_series_light.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 20 additions & 15 deletions docs/blueprints.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,24 @@ description: >

# Blueprints

!!! warning "Under Construction"

This documentation is actively being developed.

_Blueprints_ can be viewed as amped-up Templates. These are ready-made
collections of cards configurations that apply to a single Series. Blueprints
allow for importing a pre-made customization for a Series, including any
associated Named Fonts, Templates, Series options, Episode-specific overrides,
and custom source files.
allow for importing a pre-made customization for a Series, and can include any
of the following:

??? example "Example"
- Named Fonts - _i.e. Fonts with files_
- Templates
- Series customizations
- Episode customizations
- Source files - _i.e. logos, masks, source images, etc._

!!! example "Example"

Don't want to spend an hour of your life combing through the Pokémon
Wikipedia in order to determine which specific Episodes apply to which
specific seasons? Blueprints allow you to just take the hour of my work and
apply everything with the click of a button.

![](./assets/example_blueprints.png)

All Blueprints are hosted on the
[companion repository](https://github.com/CollinHeist/TitleCardMaker-Blueprints/)
and anyone can (and is encouraged to!) submit a Blueprint for availability
Expand All @@ -42,6 +41,10 @@ going to the _Blueprints_ tab on a Series' page.
2. Viewing _all_ available Blueprints for _all_ Series. These are accessed by
going to the new/add Series page.

Some Blueprints will also have multiple preview images. This will be indicated
by a slight animation when the preview is hovered over. Clicking on the image
will then cycle through the available previews.

## Importing Blueprints

??? note "Note about Font Files"
Expand Down Expand Up @@ -73,17 +76,19 @@ Series, Templates, or Fonts as you see fit. TitleCardMaker will not override
your changes with the Blueprint settings unless you prompt it to do so by
re-importing the Blueprint.

![](./assets/blueprint_series_light.jpg#only-light){loading=lazy}
![](./assets/blueprint_series_dark.jpg#only-dark){loading=lazy}

### Browsing

If you'd like to browse all available Blueprints, go to the new Series page
(the `/add` URL) and scroll down to the Blueprints section. After clicking
`Browse Blueprints`, preview cards for each Blueprint will be shown.

These can be sorted by release date and Series name. Each Blueprint can be
imported (along with the associated Series _if_ it is not already in TCM), or
hidden from this display. Once hidden, that Blueprint will no longer appear in
the list (even after page reloads) - however it will still be present if you
browse for Blueprints [by Series](#by-series).
This is covered in greater detail [here](./user_guide/new_series.md).

![](./assets/blueprint_all_light.webp#only-light){loading=lazy}
![](./assets/blueprint_all_dark.webp#only-dark){loading=lazy}

## Sharing your own Blueprint

Expand Down
14 changes: 0 additions & 14 deletions docs/card_types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,6 @@ styling, and font, TitleCardMaker is designed to support multiple different
types of Title Cards. These different types vary in more fundamental ways such
as layout, text placement, and additional features.

??? example "Example Card Types"

Below are two different card types created for the same Episode.

<figure markdown>
![Star Wars](../assets/cardtype_example_starwars.jpg)
<figcaption>Star Wars</figcaption>
</figure>

<figure markdown>
![Tinted Glass](../assets/cardtype_example_tintedglass.jpg)
<figcaption>Tinted Glass</figcaption>
</figure>

There are three different categories of card types:

Built-in
Expand Down
7 changes: 7 additions & 0 deletions docs/getting_started/add_series.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ Saul_ in the top search bar and click `Search`.
don't have Better Call Saul in your server, you can choose a different
connection, or just search TMDb.

??? warning "Sonarr Posters Not Loading"

If the posters in your search results are not loading (all black), this
is a result of Sonarr rejecting TCM's API request to view the poster.
You can either disable authentication for local addresses within Sonarr
(if using TCM locally), or just ignore this.

4. TCM will now query your selected connection for all Series that match that
name. _Better Call Saul_ should be the first result. There are now two ways to
add this to TCM:
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Welcome to TitleCardMaker
description: >
A program that automates the creation and customization of Title Cards for
use in personal media server services like Plex, Jellyfin, or Emby.
Automate the creation and customization of Title Cards in Plex, Jellyfin, or
Emby.
---

# Welcome to TitleCardMaker
Expand Down
87 changes: 87 additions & 0 deletions docs/user_guide/new_series.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: Series and Blueprint Browser
description: >
Manually add a Series or Blueprint to create Title Cards for.
---

# Series and Blueprint Browser

!!! warning "Under Construction"

This documentation is actively being developed.

## Background
From the left-hand navigation menu, new Series and Blueprints can be manually
added and imported to TitleCardMaker. When on the home page, the
:material-magnify-plus-outline: `Add New` sub-menu will appear. This can also
be accessed from the search bar (top-left corner, or hitting the ++s++ key) and
clicking the bottom `Search for ...` result.

This page is separated into two sections, the Series browser - where new Series
can be search for and added; and the Blueprints browser - where all Blueprint
submissions can be viewed, filtered, and imported.

## Adding Multiple Series

If you are adding multiple Series (especially with the same Title Card
configuration, or first a first-time setup) it is recommended to set up a
[Sync](./syncs.md), as this automates the process.

## Browse Series

After typing the name of the Series you're looking to add, select the applicable
Connection to search. The default is to search your global
[Episode data source](./settings.md#episode-data-source), but it is largely
irrelevant which Connection you browse (as TCM uses them all). Click `Search`.

![Browsing Series](../assets/add_series_light.png#only-light){loading=lazy}
![Browsing Series](../assets/add_series_dark.png#only-dark){loading=lazy}

!!! note "Unclickable Results"

Results which have already been imported will not be clickable, and will
appear greyed out. See the first result above.

The top results will appear below. Clicking a result will launch a separate
dialog in which any libraries or [Templates](./templates.md) can be applied. Of
course these can also be changed later by going to the Series page itself.

In addition to the above Series options, you may also browse any existing
[Blueprints](../blueprints.md) that are available for this Series. Clicking the
`Import Series and Blueprint` button will start the Series import process - so
be sure to have entered any libraries or Templates beforehand.

If not utilizing a Blueprint, then click the `Add` :material-plus: button to add
the Series to TitleCardMaker.

## Quick-Adding Series

On the right-hand side of the result is a `Quick-Add` button. This can be
pressed to bypass the customization dialog and add the Series to TCM using
__the last-selected library and Template options__. This can be useful if you
are adding multiple related Series, but do not want to create a
[Sync](./syncs.md).

## Browse Blueprints

!!! tip "Blueprints"

Blueprints are described in much greater detail [here](../blueprints.md).

Below the Series browser is the Blueprints browser. From here, you can view the
Blueprint submissions for _all_ Series. These can be sorted by (Blueprint)
release date and Series name. There are also two filter options which adjust
_which_ Blueprints are displayed:

- Only show Blueprints for Series which you have already added to TCM
- Display Blueprints which you have already imported

![](../assets/blueprint_all_light.webp#only-light){loading=lazy}
![](../assets/blueprint_all_dark.webp#only-dark){loading=lazy}

There are two actions for each Blueprint:

- __Import__ - add the selected Blueprint (along with the associated Series
_if_ it is not already in TCM).
- __Hide__ - Remove the selected Blueprint from this list. However it will still
be present if you browse for Blueprints [by Series](../blueprints.md#by-series).
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,9 @@ nav:
- User Guide:
# - user_guide/index.md
# - Series: user_guide/series.md
- Adding Series: user_guide/new_series.md
# - Templates: user_guide/templates.md
- Fonts: user_guide/fonts.md
# - Fonts: user_guide/fonts.md
# - Sync: user_guide/sync.md
- Connections: user_guide/connections.md
- Settings: user_guide/settings.md
Expand Down
2 changes: 1 addition & 1 deletion modules/ref/version_webui
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v2.0-alpha.6.0-webui97
v2.0-alpha.6.0-webui98

0 comments on commit fa0bdba

Please sign in to comment.