9 Star 16 Fork 3

桔子 / perl6doc

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Artistic-2.0

p6doc -- Perl6的'perldoc'

该文档的html版本链接为: https://docs.perl6.org/.

(如果你通过 github浏览本仓库, 显示可能会部分不协调的,因为使用Perl 6 Pod格式, github用的 Perl 5 POD).

文档中文化进度

Perl6常见问题

感谢araraloren的翻译

从Perl5到Perl6初步

从Perl5到Perl6指南——语法

从Perl5到Perl6指南——函数

从Perl5到Perl6指南——变量

从Perl5到Perl6指南——操作符

从Ruby到Perl6初步

安装

本模块可以用过 Perl6 模块生态体系安装,命令为:

zef install p6doc

通过以上命令安装二进制版本,并且确保安装了正确的执行路径下

下载安装正常后, 运行

p6doc-index build

创建索引。

使用

通过Rakudo安装目录perl6可以运行

./bin/p6doc Str

查看类Str的文档,或者通过

./bin/p6doc Str.split

查看类Str的方法split的文档。你可以跳过./bin部分,如果你通过panda或者zef安装了此模块的话 你也可执行

p6doc -f slurp

来浏览标准函数的文档的,根据你硬盘的速度和Rakudo版本,这个命令可能要慢一点

生成HTML文档

在你的项目目录通过以下命令安装依赖包

zef --deps-only install .

panda installdeps .       # panda
zef --depsonly install .  # zef

如果你用的是rakudobrew, 你也可以通过执行下面的命令能够 升级各个模块。

rakudobrew rehash

同时你也必须安装graphviz依赖,用来生成各种图形,在Debian系统你可以通过以下命令安装

sudo apt-get install graphviz

通过以下命令生成文档的web页面:

$ make html

页面生成以后,你就可以在本地浏览。你通过以下命名启动app.pl的程序(Mojo程序)

$ make run

这样你就可以通过浏览器输入网址http://localhost:3000浏览文档

注意:你必须安装了 Mojolicious 你还的需要nodejs来实现高亮。

给予帮助!

Perl6工程 并非一个小项目,项目文档需要投入大量的人力精力,我们感谢你给予任何的帮助。 您可以通过各种方式帮助我们:

  • 给类,角色,方法或者操作符等补充缺失的文档
  • 给已有的文档补充使用实例
  • 校对所有文档
  • 通过github提交问题报告缺失的文档
  • 通过本仓库的 git grep TODO ,找出TODO项并将其文档化
  • 将本项目国际化(翻译成各国语言)

项目问题 项目问题页面列出了当前的问题和已知缺失的文档 和 CONTRIBUTING 简要说明如何开始提供文档。


答疑解惑:

Q: 为什么本文当没有嵌入到Perl6语言中?
A: 有几个原因:

  1. 本文档的意在独立于给定版本,不与任何给定的perl6版本挂钩。
  2. POD的解析和嵌如工程还不是很稳定,为了避免对运行时造成影响。
  3. 独立于perl6的Github仓库可以让更多的人参与编辑做出贡献。

Q: 我需要从superclasses或者roles中引入方法不
A: 不需要. HTML版本已经引入了所有的superclasses和roles方法,我们可以通过p6doc脚本学习之。

Q: 项目的许可协议是?
A: 所有的代码和文档都基于the Artistic License 2.0 发行,查看LICENSE全文。


版本

I want p6doc and doc.perl6.org to become the No. 1 resource to consult when you want to know something about a Perl 6 feature, be it from the language, or built-in types and routines. I want it to be useful to every Perl 6 programmer.

-- moritz

我希望p6doc和doc.perl6.org成为人们了解perl6特性的首要资源,不管是语言,内建类型和例程。我希望 对每位perl6程序员和需要了解perl6的人都给予最大的帮助 -- moritz


想要的格式:

  • Perl6实现通过在源代码中嵌入P<...>,作为相应的p6doc入口,这将使诸如 &say.WHY的文档条目成动态获取! 而,而不需要在 CORE.setting资源中复制这些文档或者将其编码到二进制文件中。

    例如:

    # In Rakudo's src/core/IO.pm:
    
    #= P<p6doc/&print>
    sub print(|$) { ... }
    
    #= P<p6doc/&say>
    sub say(|$) { ... }
    
    #= P<p6doc/&note>
    sub note(|$) { ... }

LICENSE

See LICENSE file for the details of the license of the code in this repository.

This repository also contains code authored by third parties that may be licensed under a different license. Such files indicate the copyright and license terms at the top of the file. Currently these include:

The Artistic License 2.0 Copyright (c) 2000-2006, The Perl Foundation. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble This license establishes the terms under which a given free software Package may be copied, modified, distributed, and/or redistributed. The intent is that the Copyright Holder maintains some artistic control over the development of that Package while still keeping the Package available as open source and free software. You are always permitted to make arrangements wholly outside of this license directly with the Copyright Holder of a given Package. If the terms of this license do not permit the full use that you propose to make of the Package, you should contact the Copyright Holder and seek a different licensing arrangement. Definitions "Copyright Holder" means the individual(s) or organization(s) named in the copyright notice for the entire Package. "Contributor" means any party that has contributed code or other material to the Package, in accordance with the Copyright Holder's procedures. "You" and "your" means any person who would like to copy, distribute, or modify the Package. "Package" means the collection of files distributed by the Copyright Holder, and derivatives of that collection and/or of those files. A given Package may consist of either the Standard Version, or a Modified Version. "Distribute" means providing a copy of the Package or making it accessible to anyone else, or in the case of a company or organization, to others outside of your company or organization. "Distributor Fee" means any fee that you charge for Distributing this Package or providing support for this Package to another party. It does not mean licensing fees. "Standard Version" refers to the Package if it has not been modified, or has been modified only in ways explicitly requested by the Copyright Holder. "Modified Version" means the Package, if it has been changed, and such changes were not explicitly requested by the Copyright Holder. "Original License" means this Artistic License as Distributed with the Standard Version of the Package, in its current version or as it may be modified by The Perl Foundation in the future. "Source" form means the source code, documentation source, and configuration files for the Package. "Compiled" form means the compiled bytecode, object code, binary, or any other form resulting from mechanical transformation or translation of the Source form. Permission for Use and Modification Without Distribution (1) You are permitted to use the Standard Version and create and use Modified Versions for any purpose without restriction, provided that you do not Distribute the Modified Version. Permissions for Redistribution of the Standard Version (2) You may Distribute verbatim copies of the Source form of the Standard Version of this Package in any medium without restriction, either gratis or for a Distributor Fee, provided that you duplicate all of the original copyright notices and associated disclaimers. At your discretion, such verbatim copies may or may not include a Compiled form of the Package. (3) You may apply any bug fixes, portability changes, and other modifications made available from the Copyright Holder. The resulting Package will still be considered the Standard Version, and as such will be subject to the Original License. Distribution of Modified Versions of the Package as Source (4) You may Distribute your Modified Version as Source (either gratis or for a Distributor Fee, and with or without a Compiled form of the Modified Version) provided that you clearly document how it differs from the Standard Version, including, but not limited to, documenting any non-standard features, executables, or modules, and provided that you do at least ONE of the following: (a) make the Modified Version available to the Copyright Holder of the Standard Version, under the Original License, so that the Copyright Holder may include your modifications in the Standard Version. (b) ensure that installation of your Modified Version does not prevent the user installing or running the Standard Version. In addition, the Modified Version must bear a name that is different from the name of the Standard Version. (c) allow anyone who receives a copy of the Modified Version to make the Source form of the Modified Version available to others under (i) the Original License or (ii) a license that permits the licensee to freely copy, modify and redistribute the Modified Version using the same licensing terms that apply to the copy that the licensee received, and requires that the Source form of the Modified Version, and of any works derived from it, be made freely available in that license fees are prohibited but Distributor Fees are allowed. Distribution of Compiled Forms of the Standard Version or Modified Versions without the Source (5) You may Distribute Compiled forms of the Standard Version without the Source, provided that you include complete instructions on how to get the Source of the Standard Version. Such instructions must be valid at the time of your distribution. If these instructions, at any time while you are carrying out such distribution, become invalid, you must provide new instructions on demand or cease further distribution. If you provide valid instructions or cease distribution within thirty days after you become aware that the instructions are invalid, then you do not forfeit any of your rights under this license. (6) You may Distribute a Modified Version in Compiled form without the Source, provided that you comply with Section 4 with respect to the Source of the Modified Version. Aggregating or Linking the Package (7) You may aggregate the Package (either the Standard Version or Modified Version) with other packages and Distribute the resulting aggregation provided that you do not charge a licensing fee for the Package. Distributor Fees are permitted, and licensing fees for other components in the aggregation are permitted. The terms of this license apply to the use and Distribution of the Standard or Modified Versions as included in the aggregation. (8) You are permitted to link Modified and Standard Versions with other works, to embed the Package in a larger work of your own, or to build stand-alone binary or bytecode versions of applications that include the Package, and Distribute the result without restriction, provided the result does not expose a direct interface to the Package. Items That are Not Considered Part of a Modified Version (9) Works (including, but not limited to, modules and scripts) that merely extend or make use of the Package, do not, by themselves, cause the Package to be a Modified Version. In addition, such works are not considered parts of the Package itself, and are not subject to the terms of this license. General Provisions (10) Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license. (11) If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license. (12) This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder. (13) This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed. (14) Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

简介

perl6官方文档,汉化工程 展开 收起
Perl
Artistic-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Perl
1
https://gitee.com/ijz/perl6doc.git
git@gitee.com:ijz/perl6doc.git
ijz
perl6doc
perl6doc
master

搜索帮助