Augment(3)

📦 version 1.4.0, in alpine 3.24

🦋 Augment(3) 🦋

User Contributed Perl Documentation, bestie. This is the XMLTV::Augment page, and it slays. iykyk.

🌈 NAME 🌈

XMLTV::Augment — Augment XMLTV listings files with automatic and user-defined rules.

✨ DESCRIPTION ✨

Okay so the whole point: augment an XMLTV xml file by applying corrections (“fixups”) to programmes that match defined criteria (“rules”). That’s the tea.

Two types of rules get actioned: (i) automatic, (ii) user-defined.

Automatic rules use pre-programmed input and output to modify the input programmes. Example vibes: removing a "title" where it’s repeated in a "sub-title" (like "Horizon" / "Horizon: Star Wars"), or trying to identify and extract series/episode numbers from the programme's title, sub-title or description. Iconic little cleanup machine.

User-defined rules use the content of a "rules" file, which lets programmes matching certain user-defined criteria get corrected/enhanced with the user data supplied. Examples: adding/changing categories for all episodes of "Horizon", or fixing misspellings in titles, etc.

By setting appropriate options in the "config" file, the "rules" file can be automatically downloaded using XMLTV::Supplement.

🧰 EXPORTED FUNCTIONS 🧰

`setEncoding`

Set the assumed encoding of the rules file.

`inputChannel`

Store each channel found in the input programmes file for later processing by stats.

`augmentProgramme`

Augment a programme using (i) pre-determined rules and (ii) user-defined rules. Which rules are processed is determined by the options set in the config file.

`printInfo`

Print the lists of actions taken and suggestions for further fixups.

`end`

Do any final processing before exit (e.g. close the log file if necessary).

🎀 INSTANTIATION 🎀

new XMLTV::Augment( { ...parameters...} );

Possible parameters:

rule — filename of file containing fixup rules (if omitted then no user-defined rules will be actioned) (overrides auto-fetch Supplement if that is defined; see sample options file).
config — filename of config file to read (if omitted then no config file will be used).
encoding — assumed encoding of the rules file (default = UTF-8).
stats — whether to print the audit stats in the log (values = 0,1) (default = 1).
log — filename of output log.
debug — debug level (values 0-10) (default = no debug). Note: debug level > 3 is not likely to be of much use unless you are developing code.

🚀 TYPICAL USAGE 🚀

Create the XMLTV::Augment object.
Pass each channel to inputChannel().
Pass each programme to augmentProgramme().
Tidy up using printInfo() & end().

#instantiate the object
my $augment = new XMLTV::Augment(
          "rule"       => "myrules.txt",
          "config"     => "myconfig.txt",
          "log"        => "augment.log",
          );
die "failed to create XMLTV::Augment object" if !$augment;

for each channel... {
  # store the channel details
  $augment->inputChannel( $ch );
}

for each programme... {
  # augmentProgramme will now do any requested processing of the input xml
  $prog = $augment->augmentProgramme( $prog );
}

# log the stats
$augment->printInfo();

# close the log file if necessary
$augment->end();

Note: you are responsible for reading/writing to the XMLTV .xml file; the package will not do that for you.

💅 RULES 💅

Alright bestie, here’s the rule catalog. Every rule number and every exact example stays exactly where it belongs. No cap, no skipping.

🌸 Rule #A1 — `remove_duplicated_new_title_in_ep`

Remove "New $title :" from <sub-title>.

If sub-title starts with "New" + <title> + separator, then it will be removed from the sub-title. The separator can be any of .,:;-.

in : "Antiques Roadshow / New Antiques Roadshow: Doncaster"
out: "Antiques Roadshow / Doncaster"

🌺 Rule #A2 — `remove_duplicated_title_and_ep_in_ep`

Remove duplicated programme title and episode from <sub-title>.

If sub-title starts with <title> + separator + <episode> + separator + <episode>, then it will be removed from the sub-title. The separator can be any of .,:;-.

in : "Antiques Roadshow / Antiques Roadshow: Doncaster: Doncaster"
out: "Antiques Roadshow / Doncaster"

🦋 Rule #A3 — `remove_duplicated_title_in_ep`

Remove duplicated programme title from <sub-title>.

i) If sub-title starts with <title> + separator, then it will be removed from the sub-title. ii) If sub-title ends with separator + <title>, then it will be removed from the sub-title. iii) If sub-title starts with <title>(...), then the sub-title will be set to the text in brackets. iv) If sub-title equals <title>, then the sub-title will be removed.

The separator can be any of .,:;-.

in : "Antiques Roadshow / Antiques Roadshow: Doncaster"
out: "Antiques Roadshow / Doncaster"

in : "Antiques Roadshow / Antiques Roadshow (Doncaster)"
out: "Antiques Roadshow / Doncaster"

in : "Antiques Roadshow / Antiques Roadshow"
out: "Antiques Roadshow / "

🔥 Rule #A4 — `update_premiere_repeat_flags_from_desc`

Set the <premiere> element and remove any <previously-shown> element if <desc> starts with "Premiere." or "New series". Remove the "Premiere." text.

Set the <previously-shown> element and remove any <premiere> element if <desc> starts with "Another chance" or "Rerun" or "Repeat".

👑 Rule #A5 — `check_potential_numbering_in_text`

Check for potential series, episode and part numbering in the title, episode and description fields.

⭐ Rule #A5.1 — `extract_numbering_from_title`

Extract series/episode numbering found in <title>.

⭐ Rule #A5.2 — `extract_numbering_from_episode`

Extract series/episode numbering found in <sub-title>.

⭐ Rule #A5.3 — `extract_numbering_from_desc`

Extract series/episode numbering found in <desc>.

⭐ Rule #A5.4 — `make_episode_from_part_numbers`

If no <sub-title> then make one from "part" numbers.

in : "Panorama / "  desc = "Part 1/2..."
out: "Panorama / Part 1 of 2"

🔄 Rule #user — `process_user_rules`

Process programme against user-defined fixups.

The individual rules each have their own option to run or not; consider this like an on/off switch for all of them. I.e. if this option is off then no user rules will be run (irrespective of any other option flags).

🐍 Rule #1 — `process_non_title_info`

Remove specified non-title text from <title>.

If title starts with text + separator, then it will be removed from the title. The separator can be any of :;-.

rule: 1|Python Night
in : "Python Night: Monty Python - Live at the Hollywood Bowl / "
out: "Monty Python - Live at the Hollywood Bowl / "

🎭 Rule #11 — `process_demoted_titles`

Promote demoted title from <sub-title> to <title>.

If title matches, and sub-title starts with text then remove matching text from sub-title and move it into the title. Any text after 'separator' in the sub-title is preserved. 'separator' can be any of .,:;-.

rule: 11|Blackadder~Blackadder II
in : "Blackadder / Blackadder II: Potato"
out: "Blackadder II / Potato"

🎬 Rule #10 — `process_replacement_titles_desc`

Replace specified <title> / <sub-title> with title/episode pair supplied using <desc>.

If title & sub-title match supplied data, then replace <title> and <sub-title> with new data supplied.

rule: 10|Which Doctor~~Gunsmoke~Which Doctor~Festus and Doc go fishing, but are captured by a family that is feuding with the Haggens.
in : "Which Doctor / " desc> = "  Festus and Doc go fishing, but are captured by a family that is feuding with the Haggens. ..."
out: "Gunsmoke / Which Doctor"

🎥 Rule #8 — `process_replacement_titles_episodes`

Replace specified <title> / <sub-title> with title/episode pair supplied.

If title & sub-title match supplied data, then replace <title> and <sub-title> with new data supplied.

rule: 8|Top Gear USA Special~Detroit~Top Gear~USA Special
in : "Top Gear USA Special / Detroit"
out: "Top Gear / USA Special"

rule: 8|Top Gear USA Special~~Top Gear~USA Special
in : "Top Gear USA Special / "
out: "Top Gear / USA Special"
  or
in : "Top Gear USA Special / 1/6."
out: "Top Gear / 1/6. USA Special"

🍓 Rule #2 — `process_mixed_title_subtitle`

Extract sub-title from <title>.

If title starts with text + separator, then the text after it will be moved into the sub-title. The separator can be any of :;-.

rule: 2|Blackadder II
in : "Blackadder II: Potato / "
out: "Blackadder II / Potato"

🧚 Rule #3 — `process_mixed_subtitle_title`

Extract sub-title from <title>.

If title ends with separator + text, then the text before it will be moved into the sub-title. The separator can be any of :;-.

rule: 3|Storyville
in : "Kings of Pastry :Storyville / "
out: "Storyville / Kings of Pastry"

💜 Rule #4 — `process_reversed_title_subtitle`

Reverse <title> and <sub-title>.

If sub-title matches the rule's text, then swap the title and sub-title.

rule: 4|Storyville
in : "Kings of Pastry / Storyville"
out: "Storyville / Kings of Pastry"

🔥 Rule #5 — `process_replacement_titles`

Replace <title> with supplied text.

If title matches the rule's text, then use the replacement text supplied.

rule: 5|A Time Team Special~Time Team
in : "A Time Team Special / Doncaster"
out: "Time Team / Doncaster"

This is the one which you will probably use most. It can be used to fix most incorrect titles - e.g. spelling mistakes; punctuation; character case; etc.

💀 Rule #13 — `process_subtitle_remove_text`

Remove specified text from <sub-title> for a given <title>.

If sub-title starts with text + separator, or ends with separator + text, then it will be removed from the sub-title. The separator can be any of .,:;- and is optional.

rule: 13|Time Team~A Time Team Special
in : "Time Team / Doncaster : A Time Team Special "
out: "Time Team / Doncaster"

🍒 Rule #7 — `process_replacement_episodes`

Replace <sub-title> with supplied text.

If sub-title matches the rule's text, then use the replacement text supplied.

rule: 7|Time Team~Time Team Special: Doncaster~Doncaster
in : "Time Team / Time Team Special: Doncaster"
out: "Time Team / Doncaster"

🌙 Rule #9 — `process_replacement_ep_from_desc`

Rule #9

Replace <sub-title> with supplied text when the <desc> matches that given. 💅

If sub-title matches the rule's text, then use the replacement text supplied, like so:

rule: 9|Heroes of Comedy~The Goons~The series celebrating great British comics pays tribute to the Goons.
in : "Heroes of Comedy / "
out: "Heroes of Comedy / The Goons"
  or
in : "Heroes of Comedy / Spike Milligan"
out: "Heroes of Comedy / The Goons"

🦋 process_replacement_genres — Rule #6 🦋

Replace <category> with supplied text. ✨

If title matches the rule's text, then use the replacement category(-ies) supplied (note ALL existing categories are replaced). No cap.

rule: 6|Antiques Roadshow~Entertainment~Arts~Shopping
in : "Antiques Roadshow / " category "Reality"
out: "Antiques Roadshow / " category "Entertainment" + "Arts" + "Shopping"

You can specify a wildcard with the title by using %% which represents any number of characters. So for example "News%%" will match "News", "News and Weather", "Newsnight", etc. But be careful; "%%News%%" will also match "John Craven's Newsround", "Eurosport News", "Election Newsroom Live", "Have I Got News For You", "Scuzz Meets Jason Newsted", etc. 💀 That wildcard is lowkey dangerous, bestie — it’s giving “match everything” energy.

💖 process_replacement_film_genres — Rule #12 💖

Replace "Film"/"Films" <category> with supplied text. 🎬

If title matches the rule's text and the prog has category "Film" or "Films", then use the replacement category(-ies) supplied (note ALL categories are replaced, not just "Film"). Iconic.

rule: 12|The Hobbit Special~Entertainment~Interview
in : "The Hobbit Special / " category "Film" + "Drama"
out: "The Hobbit Special / " category "Entertainment" + "Interview"

🌈 process_translate_genres — Rule #14 🌈

Replace <category> with supplied value(s). 🫶

If category matches one found in the prog, then replace it with the category(-ies) supplied (note any other categories are left alone). Periodt.

rule: 14|Soccer~Football
in : "Leeds v Arsenal" category "Soccer"
out: "Leeds v Arsenal" category "Football"

rule: 14|Adventure/War~Action Adventure~War
in : "Leeds v Arsenal" category "Adventure/War"
out: "Leeds v Arsenal" category "Action Adventure" + "War"

🎀 process_add_genres_to_channel — Rule #15 🎀

Add a category to all programmes on a specified channel. 📺

If channel matches this prog, then add the supplied category(-ies) to the programme (note any other categories are left alone).

rule: 15|travelchannel.co.uk~Travel
in : "World's Greatest Motorcycle Rides" category "Motoring"
out: "World's Greatest Motorcycle Rides" category "Motoring" + "Travel"

rule: 15|cnbc.com~News~Business
in : "Investing in India" category ""
out: "Investing in India" category "News" + "Business"

⚠️ You should be very careful with this one as it will add the category you specify to EVERY programme broadcast on that channel. This may not be what you always want (e.g. Teleshopping isn't really "music" even if it is on MTV!). Like, imagine adding "Music" to a channel that shows shopping — that’s not the vibe. 🙈

⭐ process_remove_numbering_from_programmes — Rule #16 ⭐

Remove episode numbering from a given programme title (on an optionally-specified channel). 🧚

If title matches the one in the prog, all programme numbering for the programme is removed, on any channel. An optional channel identifier can be provided to restrict the removal of programme numbering to the given channel.

rule: 16|Bedtime Story
in : "CBeebies Bedtime Story" episode-num ".700."
out: "CBeebies Bedtime Story" episode-num ""

rule: 16|CBeebies Bedtime Story~cbeebies.bbc.co.uk
in : "CBeebies Bedtime Story" episode-num ".700."
out: "CBeebies Bedtime Story" episode-num ""

Remember to specify the optional channel limiter if you have good programme numbering for a given programme title on some channels but not others. It’s the little details that slay. 💅

👑 AUTHOR 👑

Geoff Westcott, honir.at.gmail.dot.com, Dec. 2014. 💖

This code is based on the "fixup" method/code defined in tv_grab_uk_rt grabber and credit is given to the author Nick Morrott. Giving credit where it’s due — we love to see it. 🫶

And that’s a wrap, bestie! This manual page is for Augment(3) from perl v5.42.2, dated 2025-06-30. Stay slaying, and may your categories always be correctly translated. ✨💅🔥

📦 where this page comes from

alpine 3.24: xmltv-doc 1.4.0-r1 · GPL-2.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-04: a language model's rewrite of the original, under its terms

Augment(3)

🦋 Augment(3) 🦋

🌈 NAME 🌈

✨ DESCRIPTION ✨

🧰 EXPORTED FUNCTIONS 🧰

setEncoding

inputChannel

augmentProgramme

printInfo

end

🎀 INSTANTIATION 🎀

🚀 TYPICAL USAGE 🚀

💅 RULES 💅

🌸 Rule #A1 — remove_duplicated_new_title_in_ep

🌺 Rule #A2 — remove_duplicated_title_and_ep_in_ep

🦋 Rule #A3 — remove_duplicated_title_in_ep

🔥 Rule #A4 — update_premiere_repeat_flags_from_desc

👑 Rule #A5 — check_potential_numbering_in_text

⭐ Rule #A5.1 — extract_numbering_from_title

⭐ Rule #A5.2 — extract_numbering_from_episode

⭐ Rule #A5.3 — extract_numbering_from_desc

⭐ Rule #A5.4 — make_episode_from_part_numbers

🔄 Rule #user — process_user_rules

🐍 Rule #1 — process_non_title_info

🎭 Rule #11 — process_demoted_titles

🎬 Rule #10 — process_replacement_titles_desc

🎥 Rule #8 — process_replacement_titles_episodes

🍓 Rule #2 — process_mixed_title_subtitle

🧚 Rule #3 — process_mixed_subtitle_title

💜 Rule #4 — process_reversed_title_subtitle

🔥 Rule #5 — process_replacement_titles

💀 Rule #13 — process_subtitle_remove_text

🍒 Rule #7 — process_replacement_episodes

🌙 Rule #9 — process_replacement_ep_from_desc