Skip to content

Commit

Permalink
[S26] Attempts at clarifying language
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.pugscode.org/pugs@31883 c213334d-75ef-0310-aa23-eaa082d1ae64
  • Loading branch information
jani committed Jul 31, 2010
1 parent 09e13a6 commit 412b4c3
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions S26-documentation.pod
Expand Up @@ -13,7 +13,7 @@ Damian Conway <L<C<damian@conway.org>|mailto:damian@conway.org>>
=table
Maintainer: Damian Conway
Date: 9 Apr 2005
Last Modified: 30 Jul 2009
Last Modified: 31 Jul 2010
=end VERSION
=head1
Expand All @@ -39,28 +39,31 @@ textual content. All Pod directives are considered to be special types
of comments in Perl 6.
Every directive starts either with an equals sign (C<=>) followed
immediately by an identifier N<as specified in Synopsis 2>, or with a
immediately by an identifier N<as specified in Synopsis 2>, or with
C<#=> followed immediately by whitespace or an opening bracket.
Directives that start with C<=> can be indented like the code they
interleave, but their initial C<=> must still be the first non-whitespace
character on their line. Directives that start with C<#=> can be placed
anywhere that a Perl 6 comment can appear (though they are meaningful
only in a subset of those places; see L<#Declarator blocks>).
anywhere that a Perl 6 comment can appear, though they are meaningful
only in a subset of those places; see L<#Declarator blocks>.
If a directive is indented from the left margin, the column at which the
first character of its opening delimiter appears is thereafter
considered the first column of the entire block's contents. That is, an
indented Pod block is considered to have a I<virtual left margin>,
determined by the indentation of its opening delimiter. As with Perl 6
heredocs, the virtual margin treats leading tabs as aligning to tabstops
spaced every C<($?TABSTOP // 8)> characters.
An indented Pod block is considered to have a I<virtual left margin>,
determined by the indentation of its opening delimiter.
In other words, if a directive is indented from the left margin, the
column at which the first character of its opening delimiter appears is
thereafter considered the first column of the entire block's contents.
As with Perl 6 heredocs, the virtual margin treats leading tabs as
aligning to tabstops spaced every C<($?TABSTOP // 8)> characters.
=head2
Pod blocks
The content of a document is specified within one or more D<blocks|block>.
Every Pod block may be declared in any of four forms:
L<I<delimited style>|#Delimited blocks>, L<I<paragraph style>|#Paragraph
blocks>, L<I<abbreviated style>|#Abbreviated blocks>, or L<I<declarator
style>|#Declarator blocks>. The first three forms are all equivalent; the
Expand All @@ -70,8 +73,8 @@ Anything in a document that is neither a Pod directive nor contained
within a Pod block is treated as "ambient" material. Typically this
would be the source code of the program that the Pod is documenting. Pod
parsers still parse this text into the internal representation of the
file (representing it as a C<Pod6::Block::Ambient> block), but renderers
will I<usually> ignore such blocks (but see L<#Aliases>).
file, representing it as a C<Pod6::Block::Ambient> block. Renderers
will I<usually> ignore such blocks, but see L<#Aliases>.
In Perl 5's POD format, once a POD directive is encountered, the parser
considers everything that follows to be POD, until an explicit C<=cut>
Expand Down

0 comments on commit 412b4c3

Please sign in to comment.