| 1 |
This directory is for perl 6 end-user docs, the equivalent of the |
|---|
| 2 |
perldoc distributed with perl 5. |
|---|
| 3 |
|
|---|
| 4 |
The contents of this directory are hierarchical rather than having a |
|---|
| 5 |
flat space. |
|---|
| 6 |
|
|---|
| 7 |
Perl6::Doc::Intro intro to perl 6 (equiv to perlintro) |
|---|
| 8 |
Perl6::Doc::Reference::* language reference |
|---|
| 9 |
Perl6::Doc::Tutorial::* tutorials |
|---|
| 10 |
Perl6::Doc::FAQ::* FAQs |
|---|
| 11 |
|
|---|
| 12 |
All this is subject to change depending on what seems necessary, but for |
|---|
| 13 |
the moment, the general scheme is that the top level of the namespace is |
|---|
| 14 |
"type of documentation" and then under that is "topic of documentation". |
|---|
| 15 |
So you might have Perl6::Doc::Reference::Objects and |
|---|
| 16 |
Perl6::Doc::Tutorial::Objects |
|---|
| 17 |
|
|---|
| 18 |
There will be a p6doc command, equivalent to the perldoc command, such |
|---|
| 19 |
that 'p6doc Foo::Bar' is equivalent to 'perldoc Perl6::Doc::Foo::Bar'. |
|---|
| 20 |
|
|---|
| 21 |
The files in this directory here in the pugs code tree skip the |
|---|
| 22 |
Perl6::Doc prefix because it's unnecessary for our current purposes. |
|---|
| 23 |
We'll need a tool to bundle up the contents of this dir under Perl6::Doc |
|---|
| 24 |
and push them out to CPAN. |
|---|
| 25 |
|
|---|
| 26 |
THE PLAN |
|---|
| 27 |
|
|---|
| 28 |
Here's my plan of attack. |
|---|
| 29 |
|
|---|
| 30 |
1. Go through perlintro (from perl 5) and rewrite it for Perl 6 |
|---|
| 31 |
|
|---|
| 32 |
2. As I go along, take notes for perl5-to-6 transition docs |
|---|
| 33 |
|
|---|
| 34 |
3. Go through the general language reference perl 5 docs (eg perlsyn, |
|---|
| 35 |
perlop, perlfunc, perldata), rewriting for perl 6. |
|---|
| 36 |
|
|---|
| 37 |
4. Deal with stuff like tutorials and FAQs last, unless they happen to |
|---|
| 38 |
come up as I go along. |
|---|
