README

需要做什么？

大多数文章都是框架，包含一些链接到页面，用作编写页面的参考。想法是使用那些链接上的信息来帮助编写新的文章。一些旧的用户指南页面可以基本上复制，进行一些改进，其他则最好是完全重写。如果您有任何问题，请随时加入 kohana irc 频道。

指南

文档应使用完整的句子、良好的语法，并尽可能清晰。使用大量的示例代码，但确保示例遵循 Kohana 规范和样式。

尽量频繁地提交，每次提交只更改一个或两个文件，而不是更改大量文件然后一次性提交。这将使提供反馈和合并您的更改变得更容易。确保您的提交信息清晰且描述性。好的：“添加了 hello world 教程的初始草稿。” 不好：“正在处理文档”。

如果您觉得菜单需要重新排列或模块需要新页面，请打开 错误报告 来讨论。

用户指南的工作原理简要说明

用户指南使用 Markdown 和 Markdown Extra 来编写文档。以下是 Markdown 语法 的简要介绍，以及 完整指南 和 Markdown Extra 添加的内容。同时阅读此说明书中关于用户指南如何扩展 markdown 的部分。

用户指南页面

用户指南页面位于它们应用的模块中，在 guide/<module>。Kohana 的文档位于 system/guide/kohana，orm 的文档位于 modules/orm/guide/orm 等。

每个模块都有一个索引页面在 guide/<module>/index.md。

每个模块的菜单在 guide/<module>/menu.md。

图片

用户指南页面中使用的任何图片都必须位于 media/guide/<module>/。例如，如果用户指南页面有 ![Image Title](hello-world.jpg)，则图片位于 media/guide/<module>/hello-world.jpg。ORM 模块的图片位于 modules/orm/media/guide/orm，而 Kohana 文档的图片位于 system/media/guide/kohana。

API 浏览器

API 浏览器是从实际源代码生成的。类、常量、属性和方法描述是从注释中提取并解析为 Markdown。例如，如果您查看 Kohana_Core::init 的注释，您将看到一个 Markdown 列表和表格。这些被解析并在 API 浏览器中正确显示。 @param、@uses、@throws、@returns 和其他标签也被解析。

用户指南为 markdown 添加了什么

除了 Markdown 和 Markdown Extra 的特性和语法外，以下也适用于用户指南页面和 API 文档

命名空间

首先需要注意的是，所有URL都是“命名空间化的”。模块名称会自动添加到链接和图片URL中，您不需要包含它。例如，要从Kohana用户指南中的另一页链接到“Hello World”教程页面，您应该使用[Hello World教程](tutorials/hello-world)而不是(kohana/tutorials/hello-world)。要链接到指南中不同部分的页面，您可以使用../，例如[缓存](../cache/usage)。

注意事项

如果您在行前放置[!!]，它将变成一个备注，放在带灯泡的框中。

[!!] This is a note.

标题自动获取ID

标题会自动分配一个ID，基于标题内容，因此每个标题都可以被链接到。您可以使用Markdown Extra中定义的语法手动分配不同的ID。如果有多个标题内容相同，例如多个标题都是“示例”，则只有第一个会自动分配ID，因此您应该手动分配更描述性的ID。例如

### Examples     {#header-id-examples}

API链接

您可以通过将任何类名用中括号包裹来创建对API浏览器的链接。您还可以包括一个函数，它将链接到该函数。以下所有内容都会链接到API浏览器

[Request]
[Request::factory]
[Request::factory()]

如果您想要有参数，只需将中括号放在类和函数周围（不是参数），并在开括号前放置一个反斜杠。

[Kohana::$config]\('foobar','baz')

包含视图

您可以通过在双大括号中放置视图的名称来包含一个视图。**如果找不到视图，不会显示异常或错误！** 大括号和视图将简单地显示在页面上。

{{some/view}}