Front page | perl.perl5.porters |
Postings from August 2009
2009/8/30 <albie@alfarrabio.di.uminho.pt>:
>
>> I think this wishlist item implies adding a footnote syntax to POD.
>> how about "=foot" to identify a paragraph that will be a footnote, and
>> f<> to indicate where the footnote asterisk goes. Multiple paragraph
>> footnotes are acomodated by =foot text always continuing to the next
>> =cut., with labels, as an optional =foot LABEL, when provided getting
>> associated with text inside f<LABEL> and unlabeled footnotes lining up
>> sequencewise.
>
> Footnotes are relevant in lots of situations.
> Not sure this is the right syntax, but +1 on defining one.
Footnotes make sense for printed, paged text. Synopsis 26 proposes a
broader alternative, inline notes, noted N<> :
=head3 Annotations
Anything enclosed in an C<N<>> code is an inline B<note>.
For example:
=begin code :allow<B>
Use a C<for> loop instead.B<N<The Perl 6 C<for> loop is far more
powerful than its Perl 5 predecessor.>> Preferably with an explicit
iterator variable.
=end code
Renderers may render such annotations in a variety of ways: as
footnotes, as endnotes, as sidebars, as pop-ups, as tooltips, as
expandable tags, etc. They are never, however, rendered as unmarked
inline text. So the previous example might be rendered as:
=nested
Use a C<for> loop instead.E<dagger> Preferably with an explicit iterator
variable.
and later:
=begin nested
B<Footnotes>
=para
E<dagger> The Perl 6 C<for> loop is far more powerful than its Perl 5
predecessor.
=end nested
Thread Previous
|
Thread Next