From b167a1a5f3dad6f24c3cfc35d9009d1a18144745 Mon Sep 17 00:00:00 2001
From: Yozora XCII <yozoraxcii@gmail.com>
Date: Thu, 25 Apr 2024 12:54:08 +0100
Subject: [PATCH] add `use_all` template variables to Defaults Collections

---
 CHANGELOG                             | 1 +
 defaults/templates.yml                | 7 +++++++
 docs/defaults/collection_variables.md | 1 +
 3 files changed, 9 insertions(+)

diff --git a/CHANGELOG b/CHANGELOG
index 7cb3f6a9..3a811623 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -13,6 +13,7 @@ Add Page Topics Options to `imdb_search`
 Add `lxml` Docker Version using an old lxml version that supports more cpus
 
 # Updates
+Add `use_all` template variable to default collections, which allows all collections to be disabled with one variable.
 Let conditional `.not` and `.exists` work with default variables
 
 # Defaults
diff --git a/defaults/templates.yml b/defaults/templates.yml
index 654ee1c2..5ab68cdd 100644
--- a/defaults/templates.yml
+++ b/defaults/templates.yml
@@ -64,6 +64,12 @@ templates:
           - file_poster_<<key>>.exists: false
             file_poster.exists: false
             value: <<url_poster>>
+      final_use:
+        conditions:
+          - use_<<key>>.exists: true
+            value: <<use_<<key>>>>
+          - use_all: false
+            value: false
     default:
       collection_section: "00"
       key: <<mapping_name>>
@@ -110,6 +116,7 @@ templates:
       - delete_collections_named
       - schedule
     run_definition:
+      - <<final_use>>
       - <<use_<<key>>>>
       - <<allowed_libraries>>
     name_mapping: <<name_mapping>>
diff --git a/docs/defaults/collection_variables.md b/docs/defaults/collection_variables.md
index daa57d80..5926314b 100644
--- a/docs/defaults/collection_variables.md
+++ b/docs/defaults/collection_variables.md
@@ -2,6 +2,7 @@
 | Variable                                      | Description & Values                                                                                                                                                                                                                                                                                                                                                                               |
 |:----------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `language`                                    | **Description:** Set the language of Collection Names and Summaries<br>**Default:** `default`<br>**Values:** `default` (English), `fr` (French), or `de` (German)                                                                                                                                                                                                                                  | 
+| `use_all`                                     | **Description:** Turns off all Collections in a Defaults file.<br>**Values:** `false` to turn off the collection                                                                                                                                                                                                                                                                                   |
 | `use_<<key>>`<sup>1</sup>                     | **Description:** Turns off individual Collections in a Defaults file.<br>**Values:** `false` to turn off the collection                                                                                                                                                                                                                                                                            |
 | `name_<<key>>`<sup>1</sup>                    | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name                                                                                                                                                                                                                                                                                            |
 | `summary_<<key>>`<sup>1</sup>                 | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary                                                                                                                                                                                                                                                                                      |