欧宝官网下载app文档格式

编辑该页面

警告:你浏览的文档欧宝官网下载appob娱乐下载Symfony 2.4,不再维护。

这个页面的更新版本Symfob娱乐下载ony 6.2(当前的稳定版本)。

欧宝官网下载app文档格式

Symfob娱乐下载ony的文档使用欧宝官网下载appreStructuredText作为标记语言斯芬克斯生成的文档的格式读取到最终用户,如HT欧宝官网下载appML和PDF。

reStructuredText

恰好是一个明文标记语法类似于减价,但是严格的语法。如果你恰好,花些时间来熟悉这个格式通过阅读现有的ob娱乐下载Symfony的欧宝官网下载app文档

如果你想了解更多关于这种格式,请查看reStructuredText底漆教程和reStructuredText参考

谨慎

如果您熟悉减价,小心有时非常相似但不同的东西:

  • 列出从一行的开始(不允许缩进);
  • 内联代码块使用double-ticks (这样的' ' ' ')。

斯芬克斯

斯芬克斯是一个构建系统,从reStructuredText文档提供了工具来创建文档。欧宝官网下载app因此,它增加了新的指令和解释文本角色标准标记。阅读更多关于斯芬克斯标记构造

语法高亮显示

PHP是默认语法高亮显示应用到所有的代码块。你可以改变它的代码块指令:

1 2 3
. .代码块:yaml{foo:酒吧,酒吧:{foo:酒吧,酒吧:baz}}

请注意

除了所有主要的编程语言,语法高亮显示支持各种各样的标记和配置语言。查看列表支持的语言语法高亮显示的网站。

配置块

每当你包括配置示例中,使用配置块指令显示配置在所有支持的配置格式(PHP,YAMLXML)。例子:

1 2 3 4 5 6 7 8 9 10 11 12 13
. .配置块::. .代码块:yaml#配置在YAML. .xml代码:< !——在XML配置- - >. .php代码:/ /配置PHP

前面的其他片段显示为:

  • YAML
  • XML
  • PHP
1
#配置在YAML

当前支持的格式列表如下:

标记格式 用它来显示
html HTML
xml XML
php PHP
yaml YAML
金贾的 纯粹的树枝标记
html +金贾的 树枝混合了HTML标记
html + php PHP代码和HTML混合
ini INI
php-annotations PHP的注释

最常见的类型的链接内部链接其他文档页面,使用欧宝官网下载app下面的语法:

1
医生:“绝对路径/ /页面”

页面名称不应该包括文件扩展名(首要)。例如:

1 2 3 4 5
医生:“/ book /控制器”医生:/组件/ event_dispatch /介绍的医生:“/食谱/配置/环境”

链接页面的标题将自动作为链接的文本。如果您想修改标题,使用这个替代语法:

1
医生:“假脱机邮件< /菜谱/电子邮件/ spool > '

请注意

尽管他们在技术上是正确的,避免使用相对内部链接如以下,因为他们打破了引用生成的PDF文档:欧宝官网下载app

1 2 3 4 5
医生:“控制器”医生:“event_dispatch /介绍”医生:“环境”

链接到API遵循不同的语法,你必须指定的类型与资源(名称空间,方法):

1 2 3 4 5
名称空间:“ob娱乐下载Symfony \ \ \ \ BrowserKit组件”类:“ob娱乐下载Symfony组件\ \ \ \ \ \匹配器\ \ ApacheUrlMatcher路由的方法:的ob娱乐下载Symfony \ \ HttpKernel \ \ \ \组件包\ \包::构建的

PHP文档的链接欧宝官网下载app遵循一个非常相似的语法:

1 2 3 4 5
:phpclass:“SimpleXMLElement”:phpmethod:DateTime:: createFromFormat”:phpfunction:“iterator_to_array”

新特性或行为变化

如果你记录一个全新的特性或在Symfony的改变,你应该先于你描述的变化ob娱乐下载. .versionadded:: 2. x指令和一个简短的描述:

1 2 3 4
. .versionadded:: 2.3的“askHiddenResponse“方法是在Symfony 2.3中引入的。ob娱乐下载你也可以问一个问题和隐藏的响应。这是特别[…]

如果你记录一个行为改变,它可能是有用的短暂的描述的行为已经发生了改变。

1 2 3
. .versionadded:: 2.3“包括()的函数是一个新的树枝中可用的特性ob娱乐下载Symfony 2.3。之前,“{%包括%}“使用标签。

Symfony的,每当一个新小版本发布(如2.4、2.5等),一ob娱乐下载个新的分支的创建文档欧宝官网下载app分支。在这一点上,所有的versionaddedSymfony版本ob娱乐下载标签,已经走到尽头将被删除。例如,如果Symfony 2.5ob娱乐下载是今天发布,和2.2最近达到临终,2.2versionadded从新的标签将被删除2.5分支。

测试文档欧宝官网下载app

当提交一个新的文档存储库的内容或更改任何现有的资源,一个自动的过程将检查如欧宝官网下载app果你的文档没有语法错误和准备。

然而,如果你喜欢去做这个检查在您自己的机器上本地提交您的文档之前,遵循这些步骤:欧宝官网下载app

  • 安装斯芬克斯;
  • 使用git安装狮身人面像扩展子:美元git子模块更新——init;
  • (可选)安装包文档和CMF文档:bash install.sh美元;
  • 运行使html并查看生成的HTML构建/目录中。
这项工作,包括代码示例,许可下Creative Commons冲锋队3.0许可证。