Perl6::Pod::FormattingCode::D - Definition


Perl6-Pod documentation  | view source Contained in the Perl6-Pod distribution.

Index


NAME

Top

Perl6::Pod::FormattingCode::D - Definition

SYNOPSIS

Top

    A D<formatting code|formatting codes;formatters> provides a way
    to add inline mark-up to a piece of text.

DESCRIPTION

Top

The D<> formatting code indicates that the contained text is a definition, introducing a term that the adjacent text elucidates. It is the inline equivalent of a =defn block. For example:

    There ensued a terrible moment of D<coyotus interruptus>: a brief
    suspension of the effects of gravity, accompanied by a sudden
    to-the-camera realisation of imminent downwards acceleration.

A definition may be given synonyms, which are specified after a vertical bar and separated by semicolons:

    A D<formatting code|formatting codes;formatters> provides a way
    to add inline mark-up to a piece of text.

A definition would typically be rendered in italics or <dfn>...</dfn> tags and will often be used as a link target for subsequent instances of the term (or any of its specified synonyms) within a hypertext.

to_xhtml

    D<photo|picture>

Render xhtml:

    <dfn>photo</dfn>

to_docbook

    D<photo|picture>

Render xml:

    photo

SEE ALSO

Top

http://zag.ru/perl6-pod/S26.html, Perldoc Pod to HTML converter: http://zag.ru/perl6-pod/, Perl6::Pod::Lib

AUTHOR

Top

Zahatski Aliaksandr, <zag@cpan.org>

COPYRIGHT AND LICENSE

Top


Perl6-Pod documentation  | view source Contained in the Perl6-Pod distribution.