Skip to content

Commit 4b26d51

Browse files
authored
Replace Pod6 with Rakudoc
1 parent 3cd771a commit 4b26d51

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

doc/Language/pod.rakudoc

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
=begin pod :kind("Language") :subkind("Language") :category("reference")
22

3-
=TITLE Pod6
3+
=TITLE Rakudoc (aka Pod6)
44

55
=SUBTITLE An easy-to-use markup language for documenting Raku modules and programs
66

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
88
writing language documentation, for documenting programs and modules, as
99
well as for other types of document composition.
1010

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>.
1212
Everything between these two delimiters will be processed and used to generate
1313
documentation.
1414

1515
=begin code :lang<rakudoc>
1616
=begin pod
1717

18-
A very simple Pod6 document
18+
A very simple Rakudoc document
1919

2020
=end pod
2121
=end code
2222

2323
=head1 Block structure
2424

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
2626
define a block: delimited, paragraph, abbreviated, and declarator; the first three
2727
yield the same result but the fourth differs. You can use whichever form is most
2828
convenient for your particular documentation task.
@@ -75,7 +75,7 @@ outside of strings. Hash keys need not be quote-delimited unless they contain
7575
significant whitespace. Strings entered inside angle brackets become lists if
7676
any whitespace is used inside the angle brackets.
7777

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
7979
specification language, not a programming language. Specifically, option
8080
values cannot be closures. See L<Synopsis 2|https://design.raku.org/S02.html>
8181
for details of the various
@@ -85,7 +85,7 @@ The configuration section may be extended over subsequent
8585
lines.
8686
Each subsequent line must start
8787
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,
8989
and it must be followed
9090
by at least one horizontal whitespace character.
9191

@@ -138,7 +138,7 @@ Top Level Heading
138138
Abbreviated blocks begin with an C<=> sign, which is followed immediately by the
139139
C<typename> of the block. All following data are part of the contents of the
140140
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.
142142

143143
=begin code :lang<rakudoc>
144144
=head1 Top level heading
@@ -215,7 +215,7 @@ L<S26-documentation/block-leading-user-format.t|https://github.com/Raku/roast/bl
215215

216216
=head1 Block types
217217

218-
Pod6 offers a wide range of standard block types.
218+
Rakudoc offers a wide range of standard block types.
219219

220220
=head2 Headings
221221

@@ -326,7 +326,7 @@ and C<=end code>
326326

327327
=head2 I/O blocks
328328

329-
Pod6 provides blocks for specifying the input and output of programs.
329+
Rakudoc provides blocks for specifying the input and output of programs.
330330

331331
The C<=input> block is used to specify pre-formatted keyboard input,
332332
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.
338338

339339
=head3 Unordered lists
340340

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.
342342

343343
For example:
344344

@@ -459,9 +459,9 @@ As you can see, folk wisdom is often of dubious value.
459459
Check out this page for documentation related to L<Tables|/language/tables>
460460
Z<Eventually copy everything from tables.rakudoc and put it here>
461461

462-
=head2 Pod6 comments
462+
=head2 Rakudoc comments
463463

464-
Pod6 comments are comments that Pod6 renderers ignore.
464+
Rakudoc comments are comments that Rakudoc renderers ignore.
465465

466466
Comments are useful for I<meta>documentation (documenting the documentation).
467467
Single-line comments use the C<=comment> marker:
@@ -507,7 +507,7 @@ documentation, publishing, source components, or meta-information.
507507

508508
Formatting codes provide a way to add inline mark-up to a piece of text.
509509

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
511511
by a set of single or double angle brackets; Unicode double angle brackets may
512512
be used.
513513

@@ -704,7 +704,7 @@ Z<If used will bust Pod::To::BigPage>
704704

705705
=head2 Unicode
706706

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,
708708
enclose them in C<E< >>
709709

710710
C<E< >> can enclose a number, which is treated as the decimal Unicode
@@ -857,7 +857,7 @@ You can omit the C<=Text> portion:
857857
raku --doc input.rakudoc > output.txt
858858
=end code
859859

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
861861
traditional Unix command line "--man" option to your program with a
862862
multi MAIN subroutine like this:
863863

@@ -867,20 +867,20 @@ multi MAIN(Bool :$man) {
867867
}
868868
=end code
869869

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.
871871

872872
=head1 Accessing Pod
873873

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
875875
special C<=> twigil, as documented
876876
in the L<variables section|/language/variables#The_=_twigil>, must be used.
877877

878-
The C<=> twigil provides the introspection over the Pod6 structure,
878+
The C<=> twigil provides the introspection over the Rakudoc structure,
879879
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.
881881

882882
As an example, the following piece of code introspects
883-
its own Pod6 documentation:
883+
its own Rakudoc documentation:
884884

885885
=begin code
886886
=begin pod

0 commit comments

Comments
 (0)