## What needs to be done?
Most articles are stubs, with a couple links to pages to be used as a reference when writing the page. The idea is to use the information on those links to help write the new ones. Some of the old userguide pages can probably be mostly copied, with a few improvements, others will be better to be completely rewritten. If you ever have questions, please feel free to jump in the kohana irc channel.
## Guidelines
Documentation should use complete sentences, good grammar, and be as clear as possible. Use lots of example code, but make sure the examples follow the Kohana conventions and style.
Try to commit often, with each commit only changing a file or two, rather than changing a ton of files and commiting it all at once. This will make it easier to offer feedback and merge your changes. Make sure your commit messages are clear and descriptive. Good: "Added initial draft of hello world tutorial." Bad: "working on docs".
If you feel a menu needs to be rearranged or a module needs new pages, please open a [bug report](http://dev.kohanaframework.org/projects/userguide3/issues/new) to discuss it.
## A brief explanation of how the userguide works:
The userguide uses [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](http://michelf.com/projects/php-markdown/extra/) for the documentation. Here is a short intro to [Markdown syntax](http://kohanut.com/docs/using.markdown), as well as the [complete guide](http://daringfireball.net/projects/markdown/syntax), and the things [Markdown Extra adds](http://michelf.com/projects/php-markdown/extra/). Also read what the userguide adds to markdown at the end of this readme.
### Userguide pages
Userguide pages are in the module they apply to, in `guide/<module>`. Documentation for Kohana is in `system/guide/kohana` and documentation for orm is in `modules/orm/guide/orm`, etc.
Each module has an index page at `guide/<module>/index.md`.
Each module's menu is in `guide/<module>/menu.md`.
### Images
Any images used in the userguide pages must be in `media/guide/<module>/`. For example, if a userguide page has `![Image Title](hello-world.jpg)` the image would be located at `media/guide/<module>/hello-world.jpg`. Images for the ORM module are in `modules/orm/media/guide/orm`, and images for the Kohana docs are in `system/media/guide/kohana`.
### API browser
The API browser is generated from the actual source code. The descriptions for classes, constants, properties, and methods is extracted from the comments and parsed in Markdown. For example if you look in the comment for [Kohana_Core::init](http://github.com/kohana/core/blob/c443c44922ef13421f4a/classes/kohana/core.php#L5) you can see a markdown list and table. These are parsed and show correctly in the API browser. `@param`, `@uses`, `@throws`, `@returns` and other tags are parsed as well.
# What the userguide adds to markdown:
In addition to the features and syntax of [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](http://michelf.com/projects/php-markdown/extra/) the following apply to userguide pages and api documentation:
### Namespacing
The first thing to note is that all urls are "namespaced". The name of the module is automatically added to links and image urls, you do not need to include it. For example, to link to the hello world tutorial page from another page in the Kohana userguide, you should use `[Hello World Tutorial](tutorials/hello-world)` rather than `(kohana/tutorials/hello-world)`. To link to pages in a different section of the guide, you can use `../`, for example `[Cache](../cache/usage)`.
### Notes
If you put [!!] in front of line it will be a note, put in a box with a lightbulb.
[!!] This is a note.
### Headers automatically get IDs
Headers are automatically assigned an id, based on the content of the header, so each header can be linked to. You can manually assign a different id using the syntax as defined in Markdown Extra. If multiple headers have the same content, like if more than one header is "Examples", only the first will get be automatically assigned an id, so you should manually assign more descriptive ids. For example:
### Examples {#header-id-examples}
### API links
You can make links to the api browser by wrapping any class name in brackets. You may also include a function and it will link to that function. All of the following will link to the API browser:
[Request]
[Request::factory]
[Request::factory()]
If you want to have parameters, only put the brackets around the class and function (not the params), and put a backslash in front of the opening parenthesis.
[Kohana::$config]\('foobar','baz')
### Including Views
You may include a view by putting the name of the view in double curly brackets. **If the view is not found, no exception or error will be shown!** The curly brackets and view will simply be shown an the page as is.
{{some/view}}
没有合适的资源?快使用搜索试试~ 我知道了~
PHP实例开发源码-Kohana PHP5框架.zip
共653个文件
php:468个
md:115个
png:24个
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 47 浏览量
2022-11-21
09:55:22
上传
评论
收藏 1.25MB ZIP 举报
温馨提示
PHP实例开发源码—Kohana PHP5框架.zip PHP实例开发源码—Kohana PHP5框架.zip PHP实例开发源码—Kohana PHP5框架.zip
资源推荐
资源详情
资源评论
收起资源包目录
PHP实例开发源码-Kohana PHP5框架.zip (653个子文件)
screen.css 11KB
shCore.css 6KB
kodoc.css 4KB
shThemeKodoc.css 3KB
shThemeDefault.css 3KB
style.css 2KB
api.css 1KB
print.css 991B
example.htaccess 517B
dynamic-600.jpg 44KB
crop_orig.jpg 31KB
dynamic-400.jpg 27KB
upload_result.jpg 18KB
crop_result.jpg 15KB
crop_form.jpg 15KB
upload_form.jpg 12KB
jquery.min.js 77KB
sizzle.js 26KB
shCore.js 16KB
shBrushPhp.js 5KB
jquery.cookie.js 4KB
kodoc.js 2KB
composer.json 992B
composer.json 924B
composer.json 916B
composer.json 902B
composer.json 886B
composer.json 884B
composer.json 880B
composer.json 873B
composer.json 869B
composer.json 849B
composer.json 82B
README.markdown 943B
README.markdown 0B
builder.md 13KB
routing.md 12KB
validation.md 11KB
mockobjects.md 11KB
conventions.md 9KB
cache.usage.md 8KB
usage.md 8KB
about.conventions.md 8KB
requests.md 8KB
controllers.md 8KB
CONTRIBUTING.md 8KB
markdown.md 7KB
config.md 7KB
sessions.md 7KB
library-kohana.md 7KB
files.md 6KB
config.md 6KB
relationships.md 6KB
views.md 6KB
developers.md 6KB
git.md 5KB
results.md 5KB
index.md 5KB
README.md 5KB
extension.md 5KB
config.md 5KB
encryption.md 5KB
validation.md 5KB
validation.md 5KB
fragments.md 5KB
hello-world.md 4KB
cookies.md 4KB
testing.md 4KB
bootstrap.md 4KB
upload.md 4KB
upgrading.md 4KB
contributing.md 4KB
index.md 4KB
using.md 4KB
crop.md 4KB
parameterized.md 3KB
dynamic.md 3KB
autoloading.md 3KB
install.md 3KB
simple.md 3KB
modules.md 3KB
clean-urls.md 3KB
config.md 3KB
error-pages.md 3KB
tips.md 3KB
testing_workflows.md 3KB
adding.md 2KB
errors.md 2KB
tasks.md 2KB
helpers.md 2KB
sharing-kohana.md 2KB
README.md 2KB
index.md 2KB
develop.md 2KB
using.md 2KB
about.kohana.md 2KB
profiling.md 2KB
examples.md 2KB
README.md 2KB
works.md 2KB
共 653 条
- 1
- 2
- 3
- 4
- 5
- 6
- 7
资源评论
毕业_设计
- 粉丝: 1921
- 资源: 1万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功