Jerrad Pierce > Text-FIGlet-2.19.3 > Text::FIGlet::Illuminated

Download:
Text-FIGlet-2.19.3.tgz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 2.19   Source  

NAME ^

Text::FIGlet::Illuminated - s/// 1st char of each/1st para. with ASCII art

SYNOPSIS ^

  use Text::FIGlet::Illuminated;

  my $illuminated = Text::FIGlet::Illuminated->new(-f=>'doh');

  my $ipsum =<<LOREM;
  Lorem ipsum dolor sit amet, consectetur adipisicing elit,
  Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
  Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris
  nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in
  reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
  pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
  culpa qui officia deserunt mollit anim id est laborum.

  Sed ut perspiciatis unde omnis iste natus error sit voluptatem
  accusantium doloremque laudantium, totam rem aperiam, eaque ipsa
  quae ab illo inventore veritatis et quasi architecto beatae vitae
  dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas
  sit aspernatur aut odit aut fugit, sed quia consequuntur magni
  dolores eos qui ratione voluptatem sequi nesciunt. Neque porro
  quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur,
  adipisci velit, sed quia non numquam eius modi tempora incidunt ut
  labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima
  veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam,
  nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure
  reprehenderit qui in ea voluptate velit esse quam nihil molestiae
  consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla
  pariatur?
  LOREM

  print $illuminated->illuminate(-A=>$ipsum, -w=>-72);
  __DATA__
  LLLLLLLLLLL               orem ipsum dolor sit amet, consectetur      
  L:::::::::L               adipisicing elit, sed do eiusmod tempor
  L:::::::::L               incididunt ut labore et dolore magna aliqua.
  LL:::::::LL               Ut enim ad minim veniam, quis nostrud
    L:::::L                 exercitation ullamco laboris nisi ut aliquip
    L:::::L                 ex ea commodo consequat. Duis aute irure
    L:::::L                 dolor in reprehenderit in voluptate velit
    L:::::L                 esse cillum dolore eu fugiat nulla pariatur.
    L:::::L                 Excepteur sint occaecat cupidatat non
    L:::::L                 proident, sunt in culpa qui officia deserunt
    L:::::L                 mollit anim id est laborum.
    L:::::L         LLLLLL      
  LL:::::::LLLLLLLLL:::::L  Sed ut perspiciatis unde omnis iste natus
  L::::::::::::::::::::::L  error sit voluptatem accusantium doloremque
  L::::::::::::::::::::::L  laudantium, totam rem aperiam, eaque ipsa
  LLLLLLLLLLLLLLLLLLLLLLLL  quae ab illo inventore veritatis et quasi
                            architecto beatae vitae dicta sunt explicabo.
  Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut
  fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem
  sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor
  sit amet, consectetur, adipisci velit, sed quia non numquam eius modi
  tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
  Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis
  suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis
  autem vel eum iure reprehenderit qui in ea voluptate velit esse quam
  nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo
  voluptas nulla pariatur?

DESCRIPTION ^

Illumination replaces the first character a paragraph with the corresponding figchar from the specified font. The remaining text is then wrapped around the figchar, reminiscent of illuminated texts, some magazines, or the CSS :first-letter pseudo-element.

OPTIONS ^

new

Loads the specified font.

Default options are inherited from Text::FIGlet.

illuminate

Default options are inherited from Text::FIGlet::Font.

Pass a negative width if you would like only the first paragraph of the input to be illuminated, otherwise each paragraph will be illuminated.

ENVIRONMENT ^

Text::FIGlet::Illuminated will make use of these environment variables if present

FIGFONT

The default font to load. If undefined the default is standard.flf. It should reside in the directory specified by FIGLIB.

FIGLIB

The default location of fonts. If undefined the default is /usr/games/lib/figlet

CAVEATS & RESTRICTIONS ^

Kerning and smushing modes make little sense with Illuminated.

$/ is used to separate the input

Consequently, make sure it is set appropriately i.e; Don't mess with it, perl sets it correctly for you.

SEE ALSO ^

Text::FIGlet::Font, Text::FIGlet::Ransom, Text::FIGlet, figlet(6)

AUTHOR ^

Jerrad Pierce

                **                                    />>
     _         //                         _  _  _    / >>>
    (_)         **  ,adPPYba,  >< ><<<  _(_)(_)(_)  /   >>>
    | |        /** a8P_____88   ><<    (_)         >>    >>>
    | |  |~~\  /** 8PP"""""""   ><<    (_)         >>>>>>>>
   _/ |  |__/  /** "8b,   ,aa   ><<    (_)_  _  _  >>>>>>> @cpan.org
  |__/   |     /**  `"Ybbd8"'  ><<<      (_)(_)(_) >>
               //                                  >>>>    /
                                                    >>>>>>/
                                                     >>>>>
syntax highlighting: