Skip to content

Commit

Permalink
Merge pull request #1239 from hankache/master
Browse files Browse the repository at this point in the history
pod.pod6 pass xtest
  • Loading branch information
coke committed Mar 6, 2017
2 parents 4ee2630 + 7b1598c commit 2321be8
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 30 deletions.
60 changes: 30 additions & 30 deletions doc/Language/pod.pod6
@@ -1,6 +1,6 @@
=begin pod
=TITLE Perl 6 Pod
=TITLE Perl 6 Pod
=SUBTITLE An easy-to-use markup language
Expand All @@ -14,7 +14,7 @@ Everything between these 2 delimiters will be processed and used to generate doc
=begin code
=begin pod
A very simple Perl 6 Pod document
A very simple Perl 6 Pod document
=end pod
=end code
Expand Down Expand Up @@ -132,11 +132,11 @@ which continues until an...
=end para
=end code
As demonstarted by the previous example, within a delimited C<=begin para> and C<=end para> block, any blank lines are preserved.
As demonstrated by the previous example, within a delimited C<=begin para> and C<=end para> block, any blank lines are preserved.
=head2 Code blocks
Code blocks are used to specify source code, which should be rendered without rejustification,
Code blocks are used to specify source code, which should be rendered without re-justification,
without whitespace-squeezing, and without recognizing any inline formatting codes.
Typically these blocks are used to show examples of code, mark-up,
or other textual specifications, and are rendered using a fixed-width font.
Expand Down Expand Up @@ -169,10 +169,10 @@ Code blocks can also be explicitly defined by enclosing them in C<=begin code> a
Pod provides blocks for specifying the input and output of programs.
The C<=input> block is used to specify pre-formatted keyboard input,
which should be rendered without rejustification or squeezing of whitespace.
which should be rendered without re-justification or squeezing of whitespace.
The C<=output> block is used to specify pre-formatted terminal or file output,
which should also be rendered without rejustification or whitespace-squeezing.
which should also be rendered without re-justification or whitespace-squeezing.
=head2 Lists
Expand Down Expand Up @@ -310,23 +310,23 @@ Formatting codes may nest other formatting codes.
=head2 Bold
To format a text in bold enclose it in C<B< >>
=code Perl 6 is B<awesome>
=code Perl 6 is B<awesome>
Perl 6 is B<awesome>
Perl 6 is B<awesome>
=head2 Italic
To format a text in italic enclose it in C<I< >>
=code Perl 6 is I<awesome>
=code Perl 6 is I<awesome>
Perl 6 is I<awesome>
Perl 6 is I<awesome>
=head2 Underlined
To underline a text enclose it in C<U< >>
=code Perl 6 is U<awesome>
=code Perl 6 is U<awesome>
Z<If used will bust pod2onepage>
Z<If used will bust Pod::To::BigPage>
=head2 Code
Expand All @@ -338,64 +338,64 @@ C<my $var = 1; say $var;>
=head2 Links
To create a link enclose it in C<L< >>
=code Perl 6 homepage L<https://perl6.org>
=code Perl 6 homepage L<https://perl6.org>
Perl 6 homepage L<https://perl6.org>
Perl 6 homepage L<https://perl6.org>
=head2 Comments
A comment is text that is never rendered.
To create a comment enclose it in C<Z< >>
=code Perl 6 is awesome Z<Of course it is!>
=code Perl 6 is awesome Z<Of course it is!>
Perl 6 is awesome Z<Of course it is!>
Perl 6 is awesome Z<Of course it is!>
=head2 Notes
Notes are rendered as footnotes.
To create a note enclose it in C<N< >>
=code Perl 6 is multi-paradigmatic N<Supporting Procedural, Object Oriented, and Functional programming>
=code Perl 6 is multi-paradigmatic N<Supporting Procedural, Object Oriented, and Functional programming>
Z<Perl 6 is multi-paradigmatic N<Supporting Procedural, Object Oriented, and Functional programming> >
Z<Perl 6 is multi-paradigmatic N<Supporting Procedural, Object Oriented, and Functional programming> >
=head2 Keyboard input
To flag text as keyboard input enclose it in C<K< >>
=code Enter your name K<John Doe>
Z<If used will bust pod2onepage>
Z<If used will bust Pod::To::BigPage>
=head2 Terminal Output
To flag text as terminal output enclose it in C<T< >>
=code Hello T<John Doe>
Z<If used will bust pod2onepage>
Z<If used will bust Pod::To::BigPage>
=head2 Unicode
To include Unicode code points or HTML5 character references in a Pod document, enclose them in C<E< >>
C<E< >> can enclose a number, that number is treated as the decimal Unicode value for the desired code point.
It can also enclose explicit binary, octal, decimal, or hexadecimal numbers using the Perl 6 notations for explicitly based numbers.
It can also enclose explicit binary, octal, decimal, or hexadecimal numbers using the Perl 6 notations for explicitly based numbers.
=begin code
Perl 6 makes considerable use of the E<171> and E<187> characters.
Perl 6 makes considerable use of the E<171> and E<187> characters.
Perl 6 makes considerable use of the E<laquo> and E<raquo> characters.
Perl 6 makes considerable use of the E<laquo> and E<raquo> characters.
Perl 6 makes considerable use of the E<0b10101011> and E<0b10111011> characters.
Perl 6 makes considerable use of the E<0b10101011> and E<0b10111011> characters.
Perl 6 makes considerable use of the E<0o253> and E<0o273> characters.
Perl 6 makes considerable use of the E<0o253> and E<0o273> characters.
Perl 6 makes considerable use of the E<0d171> and E<0d187> characters.
Perl 6 makes considerable use of the E<0d171> and E<0d187> characters.
Perl 6 makes considerable use of the E<0xAB> and E<0xBB> characters.
Perl 6 makes considerable use of the E<0xAB> and E<0xBB> characters.
=end code
Perl 6 makes considerable use of the E<171> and E<187> characters.
Perl 6 makes considerable use of the E<171> and E<187> characters.
=head1 Rendering Pod
Expand All @@ -408,7 +408,7 @@ C<zef install Pod::To::HTML>
Using the terminal run the following command:
=begin code
perl6 --doc=HTML filecontaining.pod6 > outputfilename.html
perl6 --doc=HTML input.pod6 > output.html
=end code
=head2 Markdown
Expand All @@ -420,7 +420,7 @@ C<zef install Pod::To::Markdown>
Using the terminal run the following command:
=begin code
perl6 --doc=Markdown filecontaining.pod6 > outputfilename.md
perl6 --doc=Markdown input.pod6 > output.md
=end code
=end pod
4 changes: 4 additions & 0 deletions xt/code.pws
Expand Up @@ -165,6 +165,7 @@ kbar
keyvaluepairs
keyvaluepairsactions
lastname
laquo
lenticular
libfoo
libmysql
Expand Down Expand Up @@ -238,6 +239,7 @@ pwstruct
pêrl
quietlevel
quux
raquo
rawheader
rectanglewithcachedarea
regexname
Expand Down Expand Up @@ -311,7 +313,9 @@ withoutlinenumber
wraphandler
wrappee
xa
xab
xaf
xbb
xbeef
xc
xff
Expand Down
1 change: 1 addition & 0 deletions xt/examples-compilation.t
Expand Up @@ -22,6 +22,7 @@ if @*ARGS {
doc/Language/nativecall.pod6
doc/Language/packages.pod6
doc/Language/phasers.pod6
doc/Language/pod.pod6
doc/Language/rb-nutshell.pod6
doc/Language/tables.pod6
doc/Language/testing.pod6
Expand Down
2 changes: 2 additions & 0 deletions xt/words.pws
Expand Up @@ -843,6 +843,7 @@ reification
reified
reifier
reifying
renderers
repl
repo
repositoryregistry
Expand Down Expand Up @@ -1081,6 +1082,7 @@ typeclasses
typediag
typeglobs
typename
typenames
typeobject
typesystem
tz
Expand Down

0 comments on commit 2321be8

Please sign in to comment.