#=============================================================================== # # DESCRIPTION: ordered and unordered lists # # AUTHOR: Aliaksandr P. Zahatski, #=============================================================================== #$Id$ package Perl6::Pod::Block::item; =pod =head1 NAME Perl6::Pod::Block::item - lists =head1 SYNOPSIS =item Happy =item Dopey =item Sleepy =item1 Animal =item2 Vertebrate =item2 Invertebrate =head1 DESCRIPTION Lists in Pod are specified as a series of contiguous C<=item> blocks. No special "container" directives or other delimiters are required to enclose the entire list. For example: The seven suspects are: =item Happy =item Dopey =item Sleepy =item Bashful =item Sneezy =item Grumpy =item Keyser Soze List items have one implicit level of nesting: Lists may be multi-level, with items at each level specified using the C<=item1>, C<=item2>, C<=item3>, etc. blocks. Note that C<=item> is just an abbreviation for C<=item1>. For example: =item1 Animal =item2 Vertebrate =item2 Invertebrate =item1 Phase =item2 Solid =item2 Liquid =item2 Gas =item2 Chocolate Note that item blocks within the same list are not physically nested. That is, lower-level items should I be specified inside higher-level items: =comment WRONG... =begin item1 -------------- The choices are: | =item2 Liberty ==< Level 2 |==< Level 1 =item2 Death ==< Level 2 | =item2 Beer ==< Level 2 | =end item1 -------------- =comment CORRECT... =begin item1 --------------- The choices are: |==< Level 1 =end item1 --------------- =item2 Liberty ==================< Level 2 =item2 Death ==================< Level 2 =item2 Beer ==================< Level 2 =head2 Ordered lists An item is part of an ordered list if the item has a C<:numbered> configuration option: =for item1 :numbered Visito =for item2 :numbered Veni =for item2 :numbered Vidi =for item2 :numbered Vici Alternatively, if the first word of the item consists of a single C<#> character, the item is treated as having a C<:numbered> option: =item1 # Visito =item2 # Veni =item2 # Vidi =item2 # Vici To specify an I list item that starts with a literal C<#>, either make the octothorpe verbatim: =item V<#> introduces a comment or explicitly mark the item itself as being unnumbered: =for item :!numbered # introduces a comment =head2 Unordered lists List items that are not C<:numbered> are treated as defining unordered lists. Typically, such lists are rendered with bullets. For example: =item1 Reading =item2 Writing =item3 'Rithmetic =head2 Multi-paragraph list items Use the delimited form of the C<=item> block to specify items that contain multiple paragraphs. For example: Let's consider two common proverbs: =begin item :numbered I This is a common myth and an unconscionable slur on the Spanish people, the majority of whom are extremely attractive. =end item =begin item :numbered I In deciding whether to become an early riser, it is worth considering whether you would actually enjoy annelids for breakfast. =end item As you can see, folk wisdom is often of dubious value. =head2 Definition lists =defn MAD Affected with a high degree of intellectual independence. =defn MEEKNESS Uncommon patience in planning a revenge that is worth while. =defn MORAL Conforming to a local and mutable standard of right. Having the quality of general expediency. =head1 METHODS =cut use strict; use warnings; use Data::Dumper; use Perl6::Pod::Block; use base 'Perl6::Pod::Block'; use Perl6::Pod::Utl; sub new { my $class = shift; my $self = $class->SUPER::new(@_); #check if item numbered # my $content = $self->{content}->[0]; if ( $self->{content}->[0] =~ s/^(\s*\#\s*)// ) { #set numbered attr #TODO $self->set_attr; push @{ $self->{attr} }, { '' => ':numbered', 'name' => 'numbered', 'type' => 'bool', 'items' => 1 }; } # for definition get TERM #The first non-blank line of content is treated as a term being defined, #and the remaining content is treated as the definition for the term if ( $self->item_type eq 'definition' ) { my $first_para = $self->{'content'}->[0]; if ( $first_para =~ s/^\s*(.*)[\r\n]// ) { $self->{term} = $1; } $self->{'content'}->[0] = $first_para; } return $self; } sub item_type { my $self = shift; #determine item type my $pod_attr = $self->get_attr; #for defn block name return 'definition' if $self->name eq 'defn'; my $type = 'unordered'; if ( $self->is_numbered ) { $type = 'ordered'; } $type; } sub is_numbered { my $self = shift; my $pod_attr = $self->get_attr; return $pod_attr->{numbered} || 0; } sub item_level { my $self = shift; $self->{level} || 1; #default 1 level for items } =head2 to_xhtml =over 1 =item Unordered lists =item Milk =item Toilet Paper =item Cereal =item Bread #

Milk
Toilet Paper
Cereal
Bread

Find a Job
Get Money
Move Out

- definition term *

- defining definition

Fromage: French word for cheese.
Voiture: French word for car.
'); $to->visit( Perl6::Pod::Utl::parse_para( $self->{term} ) ); $w->raw('