ここにHTML版があります https://docs.perl6.org/。これを読むのがおすすめです。
また、"p6doc"と呼ばれるコマンドラインツールがあります。
あなたがこのリポジトリをGitHubで閲覧しているのなら、ほとんどのファイルは正しく表示されないかもしれません。 GitHubはPerl 6 PodをPerl 5 Podとみなすからです。
- README in Chinese
- README in Italian
- README in English
- README in German
- README in Spanish
- README in French
PATHにRakudo perl6が入った状態で、
$ ./bin/p6doc Str
と打つとStrクラスの文書を閲覧することができます。また、
$ ./bin/p6doc Str.split
と打つと、Strクラスのsplitメソッドの文書を閲覧することができます。zefでインストールした場合は、./binを抜いて
$ p6doc -f slurp
と打つと標準的な関数の文書を閲覧することができます。これは時間がかかることがあります。
チェックアウトしたディレクトリで依存関係をインストールしてください:
$ zef --deps-only install .
rakudobrewを使用している場合は、次のコマンドも実行してください:
$ rakudobrew rehash
Perl 6の依存関係に加えて、 graphiviz がインストールしてある必要があります。
Debian環境なら下記のコマンドでインストールすることができます:
$ sudo apt-get install graphviz
公式文書のウェブページを構築するには、下記のコマンドを実行するだけで大丈夫です:
$ make html
上記のコマンドでHTMLのコンテンツを生成するためにはnodejsが必要になるかもしれないことに注意してください。
また、 node の実行ファイルが PATH 以下にある必要があります。
加えて、nodejsの依存モジュールをビルドするために g++ もインストールされている必要があります。
nodejsはコードにシンタックスハイライトをかけたい場合にのみ必要になります。
もしもその必要がない場合は、次のコマンドを実行してください
$ make html-nohighlight
ページの生成後は、同梱の app.pl プログラムを実行させることで、ローカル環境でこれらのページを見ることができます:
$ make run
次のアドレスをブラウザに入力して閲覧してください: http://localhost:3000.
少なくとも Mojolicious がインストールされている必要があります。 またシンタックスハイライトを行いたい場合は nodejs が必要になります。 その他の必要なモジュールについては、次のコマンドで全部インストールすることができます:
$ cpanm --installdeps .
Perl 6は小さな言語ではありません。したがって、この言語の仕様を文書化するには多大な努力が必要です。 どんな些細なことでも私たちの助けになります。
例えばこんな方法があります:
- クラス、ロール、メソッド、演算子について抜けていた文書を追加する
- 使用例を追加する
- 推敲し文書を修正する
- GithubでISSUEを開いて抜けている文書についてメンテナーに報告する
git grep TODOコマンドをこのリポジトリで実行し、TODOになっている事項を実際の文書に置き換える
Issues page には現在のissueと足りない文書が掲載されています。 また、 the CONTRIBUTING document にはどうやって文書作成に貢献したらよいのか簡潔に述べられています。
Q: どうしてコアのソースコードに文書を埋め込んでいないのですか?
A: いくつか理由があります:
- この文書はあるバージョンの仕様に対して共通な内容が掲載されるようになっています。 特定のPerl 6の実装に対するものではありません。
- 埋め込まれたPodに対する扱い方にはまだまだばらつきがあります。 実行時間に対する影響を避けています。
- コアのソースコードとはまた別のリポジトリに対してコントリビューターや編集者を招待しています。
Q: スーパークラスやロールのメソッドを含めるべきですか?
A: 含めるべきではありません。HTML版の文書にはすでにスーパークラスとロールのメソッドが含まれています。
また p6doc スクリプトが先ほど述べたことと同じことを教えてくれるでしょう。