The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Lingua-Conjunction-2.6
River stage one • 2 direct dependents • 2 total dependents
++
/ Lingua::Conjunction

NAME

Lingua::Conjunction - Convert lists into simple linguistic conjunctions

VERSION

Version 2.6

SYNOPSIS

Language-specific definitions. These may not be correct, and certainly they are not complete. E-mail corrections and additions to <njh at bandsman.co.uk>, and an updated version will be released.

SUBROUTINES/METHODS

conjunction

Lingua::Conjunction exports a single subroutine, conjunction, that converts a list into a properly punctuated text string.

You can cause conjunction to use the connectives of other languages, by calling the appropriate subroutine:

    use Lingua::Conjunction;

    Lingua::Conjunction->lang('en');    # use 'and'
    Lingua::Conjunction->lang('es');    # use 'y'
    Lingua::Conjunction->lang();        # Tries to determine your language, otherwise falls back to 'en'

Supported languages in this version are Afrikaans, Danish, Dutch, English, French, German, Indonesian, Italian, Latin, Norwegian, Portuguese, Spanish, and Swahili.

You can also set connectives individually:

    Lingua::Conjunction->separator("...");
    Lingua::Conjunction->separator_phrase("--");
    Lingua::Conjunction->connector_type("or");

    # emits "Jack... Jill... or Spot"
    $name_list = conjunction('Jack', 'Jill', 'Spot');

separator

Sets the separator, usually ',' or ';'.

    Lingua::Conjunction->separator(',');

Returns the previous value.

separator_phrase

Sets the alternate (phrase) separator.

    Lingua::Conjunction->separator_phrase(';');

The separator_phrase is used whenever the separator already appears in an item of the list. For example:

    # emits "Doe, a deer; Ray; and Me"
    $name_list = conjunction('Doe, a deer', 'Ray', 'Me');

Returns the previous value;

penultimate

Enables/disables penultimate separator.

You may use the penultimate routine to disable the separator after the next to last item. In English, The Oxford Comma is a highly debated issue.

    # emits "Jack, Jill and Spot"
    Lingua::Conjunction->penultimate(0);
    $name_list = conjunction('Jack', 'Jill', 'Spot');

The original author was told that the penultimate comma is not standard for some languages, such as Norwegian. Hence the defaults set in the %languages.

    Lingua::Conjunction->penultimate(0);

Returns the previous value.

connector_type

Use "and" or "or", with appropriate translation for the current language

    Lingua::Conjunction->connector_type('and');

connector

Sets the for the current connector_type.

    Lingua::Conjunction->connector(SCALAR)

Returns the previous value.

lang

Sets the language to use. If no arguments are given, it tries its best to guess.

    Lingua::Conjunction->lang('de');    # Changes the language to German

AUTHORS

  • Robert Rothenberg <rrwo@cpan.org>

  • Damian Conway <damian@conway.org>

MAINTAINER

2021-present Maintained by Nigel Horne, <njh at bandsman.co.uk>

CONTRIBUTORS

  • Ade Ishs <adeishs@cpan.org>

  • Mohammad S Anwar <mohammad.anwar@yahoo.com>

  • Nigel Horne <njh at bandsman.co.uk>

SEE ALSO

Locale::Language, List::ToHumanString

The Perl Cookbook in Section 4.2 has a similar subroutine called commify_series. The differences are that 1. this routine handles multiple languages and 2. being a module, you do not have to add the subroutine to a script every time you need it.

SOURCE

The development version is on github at https://github.com/nigelhorne/Lingua-Conjunction and may be cloned from git://github.com/nigelhorne/Lingua-Conjunction.git

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Lingua::Conjunction

You can also look for information at:

BUGS AND LIMITATIONS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Dist/Display.html?Queue=Lingua-Conjunction

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

LICENSE AND COPYRIGHT

This software is Copyright (c) 1999-2020 by Robert Rothenberg.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

The current maintainer is Nigel Horne.