Biblio...::Util(3pm)

🌸 NAME 🌸

Biblio::SICI::Util — literally just utility functions, bestie 💖

---

✨ VERSION ✨

version 0.04 — she's a lil vintage, we stan 🎀

---

🦋 SYNOPSIS 🦋

okay so here's the whole vibe, copy-paste coded exactly:

use Biblio::Sici;
use Biblio::SICI::Util qw( titleCode_from_title calculate_check_char );

my $sici = Biblio::Sici->new();

...

if ( my $code = titleCode_from_title($title) ) {
    $sici->contribution->titleCode($code);
}

---

💅 DESCRIPTION 💅

This module is basically your little helper drawer 🧚 — it hands you some utility functions that are useful when you're working with SICI.

And the important part: none of them are exported by default. So if you want one, you gotta ask for it. Main character energy only, no surprise guests 💀

---

🔥 FUNCTIONS 🔥

⭐ STRING titleCode_from_title( STRING )

So this one tries to derive the titleCode (cf. the contribution segment, iykyk) from a string that you pass in — like, the title of the contribution. It's giving "let me guess your code from your title" 🔮

ngl, the rules for building the titleCode are quite complex, so this method probably won't generate the correct code if the title has stuff in it that isn't regular english words — think mathematical or chemical symbols, or characters from a non-ascii alphabet. She's doing her best but the math symbols are not her moment 😭

If the method manages to generate a code, it gets returned 🫶 Otherwise the return value is undef. No code, no problem, just undef.

And here's the tea for a better shot at a standard-conformant code: the modules Text::Unidecode and Text::Undiacritic get required. If they can't be found, warnings get emitted — but a code might nonetheless still be generated ✨ However! If the title is in a language other than english, the probability of generating the correct code sinks even more 📉💀

🌈 STRING calculate_check_char( STRING )

Calculates and returns the check character. That's it, that's the job 💅

⚠️ But bestie, listen: it does NOT check if the string param is a valid SICI! No vibe check, no validation, she just calculates. You've been warned 🙈

Also, a check character that's already present in the passed-in SICI will simply be ignored. Like, not her problem, she's not looking at it 👑

---

👑 AUTHOR 👑

Heiko Jansen <hjansen@cpan.org> — iconic, we love 💖

---

🎀 COPYRIGHT AND LICENSE 🎀

This software is copyright (c) 2014 by Heiko Jansen.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Slay, open source 🦋

---

and that's the whole page, bestie — this was Biblio...::Util(3pm), part of the User Contributed Perl Documentation, documented for perl v5.36.0 and dated 2023-02-06 ✨ mwah, no cap, go write some SICI code 💅💖