1
1
=begin pod :kind("Language") :subkind("Language") :category("reference")
2
2
3
- =TITLE Pod6
3
+ =TITLE Rakudoc (aka Pod6)
4
4
5
5
=SUBTITLE An easy-to-use markup language for documenting Raku modules and programs
6
6
7
- Pod6 is an easy-to-use markup language. It can be used for
7
+ Rakudoc is an easy-to-use markup language. It can be used for
8
8
writing language documentation, for documenting programs and modules, as
9
9
well as for other types of document composition.
10
10
11
- Every Pod6 document has to begin with C<=begin pod> and end with C<=end pod>.
11
+ Every Rakudoc document has to begin with C<=begin pod> and end with C<=end pod>.
12
12
Everything between these two delimiters will be processed and used to generate
13
13
documentation.
14
14
15
15
=begin code :lang<rakudoc>
16
16
=begin pod
17
17
18
- A very simple Pod6 document
18
+ A very simple Rakudoc document
19
19
20
20
=end pod
21
21
=end code
22
22
23
23
=head1 Block structure
24
24
25
- A Pod6 document may consist of multiple Pod6 blocks. There are four ways to
25
+ A Rakudoc document may consist of multiple Rakudoc blocks. There are four ways to
26
26
define a block: delimited, paragraph, abbreviated, and declarator; the first three
27
27
yield the same result but the fourth differs. You can use whichever form is most
28
28
convenient for your particular documentation task.
@@ -75,7 +75,7 @@ outside of strings. Hash keys need not be quote-delimited unless they contain
75
75
significant whitespace. Strings entered inside angle brackets become lists if
76
76
any whitespace is used inside the angle brackets.
77
77
78
- All option keys and values must be constants since Pod6 is a
78
+ All option keys and values must be constants since Rakudoc is a
79
79
specification language, not a programming language. Specifically, option
80
80
values cannot be closures. See L<Synopsis 2|https://design.raku.org/S02.html>
81
81
for details of the various
@@ -85,7 +85,7 @@ The configuration section may be extended over subsequent
85
85
lines.
86
86
Each subsequent line must start
87
87
with an C<=> in the first virtual column, meaning that it must vertically
88
- align with the C<=> of the Pod6 Block declaration,
88
+ align with the C<=> of the Rakudoc Block declaration,
89
89
and it must be followed
90
90
by at least one horizontal whitespace character.
91
91
@@ -138,7 +138,7 @@ Top Level Heading
138
138
Abbreviated blocks begin with an C<=> sign, which is followed immediately by the
139
139
C<typename> of the block. All following data are part of the contents of the
140
140
block, thus configuration data B<cannot> be specified for an I<abbreviated>
141
- block. The block ends at the next Pod6 directive or the first blank line.
141
+ block. The block ends at the next Rakudoc directive or the first blank line.
142
142
143
143
=begin code :lang<rakudoc>
144
144
=head1 Top level heading
@@ -215,7 +215,7 @@ L<S26-documentation/block-leading-user-format.t|https://github.com/Raku/roast/bl
215
215
216
216
=head1 Block types
217
217
218
- Pod6 offers a wide range of standard block types.
218
+ Rakudoc offers a wide range of standard block types.
219
219
220
220
=head2 Headings
221
221
@@ -326,7 +326,7 @@ and C<=end code>
326
326
327
327
=head2 I/O blocks
328
328
329
- Pod6 provides blocks for specifying the input and output of programs.
329
+ Rakudoc provides blocks for specifying the input and output of programs.
330
330
331
331
The C<=input> block is used to specify pre-formatted keyboard input,
332
332
which should be rendered without re-justification or squeezing of whitespace.
@@ -338,7 +338,7 @@ which should also be rendered without re-justification or whitespace-squeezing.
338
338
339
339
=head3 Unordered lists
340
340
341
- Lists in Pod6 are specified as a series of C<=item> blocks.
341
+ Lists in Rakudoc are specified as a series of C<=item> blocks.
342
342
343
343
For example:
344
344
@@ -459,9 +459,9 @@ As you can see, folk wisdom is often of dubious value.
459
459
Check out this page for documentation related to L<Tables|/language/tables>
460
460
Z<Eventually copy everything from tables.rakudoc and put it here>
461
461
462
- =head2 Pod6 comments
462
+ =head2 Rakudoc comments
463
463
464
- Pod6 comments are comments that Pod6 renderers ignore.
464
+ Rakudoc comments are comments that Rakudoc renderers ignore.
465
465
466
466
Comments are useful for I<meta>documentation (documenting the documentation).
467
467
Single-line comments use the C<=comment> marker:
@@ -507,7 +507,7 @@ documentation, publishing, source components, or meta-information.
507
507
508
508
Formatting codes provide a way to add inline mark-up to a piece of text.
509
509
510
- All Pod6 formatting codes consist of a single capital letter followed immediately
510
+ All Rakudoc formatting codes consist of a single capital letter followed immediately
511
511
by a set of single or double angle brackets; Unicode double angle brackets may
512
512
be used.
513
513
@@ -704,7 +704,7 @@ Z<If used will bust Pod::To::BigPage>
704
704
705
705
=head2 Unicode
706
706
707
- To include Unicode code points or HTML5 character references in a Pod6 document,
707
+ To include Unicode code points or HTML5 character references in a Rakudoc document,
708
708
enclose them in C<E< >>
709
709
710
710
C<E< >> can enclose a number, which is treated as the decimal Unicode
@@ -857,7 +857,7 @@ You can omit the C<=Text> portion:
857
857
raku --doc input.rakudoc > output.txt
858
858
=end code
859
859
860
- You can even embed Pod6 directly in your program and add the
860
+ You can even embed Rakudoc directly in your program and add the
861
861
traditional Unix command line "--man" option to your program with a
862
862
multi MAIN subroutine like this:
863
863
@@ -867,20 +867,20 @@ multi MAIN(Bool :$man) {
867
867
}
868
868
=end code
869
869
870
- Now C<myprogram --man> will output your Pod6 rendered as a man page.
870
+ Now C<myprogram --man> will output your Rakudoc rendered as a man page.
871
871
872
872
=head1 Accessing Pod
873
873
874
- In order to access Pod6 documentation from within a Raku program the
874
+ In order to access Rakudoc documentation from within a Raku program the
875
875
special C<=> twigil, as documented
876
876
in the L<variables section|/language/variables#The_=_twigil>, must be used.
877
877
878
- The C<=> twigil provides the introspection over the Pod6 structure,
878
+ The C<=> twigil provides the introspection over the Rakudoc structure,
879
879
providing a L<C<Pod::Block>|/type/Pod::Block> tree root from which it is possible
880
- to access the whole structure of the Pod6 document.
880
+ to access the whole structure of the Rakudoc document.
881
881
882
882
As an example, the following piece of code introspects
883
- its own Pod6 documentation:
883
+ its own Rakudoc documentation:
884
884
885
885
=begin code
886
886
=begin pod
0 commit comments