Perl6::Pod::FormattingCode::N - inline note
=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
Anything enclosed in an N<> code is an inline note. For example:
N<>
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.
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:
Use a for loop instead. [*] Preferably with an explicit iterator variable.
and later:
Footnotes [*] The Perl 6 for loop is far more powerful than its Perl 5 predecessor.
A footnote reference and footnote text are output to HTML as follows:
Footnote reference:
<sup>[<a name="id394062" href="#ftn.id394062">1</a>]</sup>
Footnote:
<div class="footnotes"><p>NOTES</p> <p><a name="ftn.id394062" href="#id394062"><sup>1</sup></a> Text of footnote ... </p> <div>
You can change the formatting of the footnote paragraph using CSS. Use the div.footnote CSS selector, and apply whatever styles you want with it, as shown in the following example.
div.footnote { font-size: 8pt; }
This element is a wrapper around the contents of a footnote.
<footnote><para> Some text </para></footnote>
http://www.docbook.org/tdg/en/html/footnote.html
http://zag.ru/perl6-pod/S26.html, Perldoc Pod to HTML converter: http://zag.ru/perl6-pod/, Perl6::Pod::Lib
Zahatski Aliaksandr, <zag@cpan.org>
Copyright (C) 2009-2012 by Zahatski Aliaksandr
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.
To install Perl6::Pod, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perl6::Pod
CPAN shell
perl -MCPAN -e shell install Perl6::Pod
For more information on module installation, please visit the detailed CPAN module installation guide.