From 8185bfe821b15836bd175fb8e9241f94d57026e6 Mon Sep 17 00:00:00 2001 From: Marius Gavrilescu Date: Sat, 15 Oct 2016 17:40:16 +0100 Subject: [PATCH] Document the new functionality --- lib/Lyrics/Fetcher/LyricsTranslate.pm | 34 ++++++++++++++++++++------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/lib/Lyrics/Fetcher/LyricsTranslate.pm b/lib/Lyrics/Fetcher/LyricsTranslate.pm index 55f3761..f1ee778 100644 --- a/lib/Lyrics/Fetcher/LyricsTranslate.pm +++ b/lib/Lyrics/Fetcher/LyricsTranslate.pm @@ -401,28 +401,44 @@ Lyrics::Fetcher::LyricsTranslate - Get lyrics from lyricstranslate.com # This module should be used directly use Lyrics::Fetcher::LyricsTranslate; print Lyrics::Fetcher::LyricsTranslate->fetch('Lyube', 'Kombat'); + # Equivalent to + print Lyrics::Fetcher::LyricsTranslate->fetch('Lyube', 'Kombat', 'English'); + # Equivalent to + print Lyrics::Fetcher::LyricsTranslate->fetch('Lyube', 'Kombat', 328); - # Can also be used via Lyrics::Fetcher but produces ugly output + + print $Lyrics::Fetcher::LyricsTranslate::LANGUAGES{English}; # prints 328 + + + # Can also be used via Lyrics::Fetcher but produces ugly output and + # does not support a custom target language use Lyrics::Fetcher; print Lyrics::Fetcher->fetch('Lyube', 'Kombat', 'LyricsTranslate'); =head1 DESCRIPTION This module tries to get translated lyrics from -L. It does a search for a translation of -the given artist and song title from any language to English, and -returns the contents of the first result found. - -This is a very basic implementation of the concept and it should be -improved in future versions (for example supporting multiple -destination languages). +L. It searches for a translation of the +given artist and song title from any language to a requested language +(which defaults to English), and returns the contents of the first +result found. It is recommended to use the module directly, as using it via L loses empty lines between parahraphs. +The target language can be specified as either a number or a string. +If a string is given, it is looked up in the hash +C<%Lyrics::Fetcher::LyricsTranslate::LANGUAGES> which maps language +names to their numerical identifiers. The hash was generated from the +website, and it might be outdated. + +The target language is passed as the third argument to the B +method. If using the module via L, the target +language cannot be set and defaults to English. + =head1 SEE ALSO -L +L, L =head1 AUTHOR -- 2.39.2