Symfony中文文档

官方：https://github.com/symfony/symfony-docs

参考：http://www.symfonychina.com

同步记录

• master
  • 1310e0dc917f676f75662d6fe1053b3adaa695b6（2018-12-04）
    • components/dom_crawler.rst
• 4.2
  • 78123c8c25a67e8aa8e53ff5bb33252c79bdabae（2018-12-23）
  • 2086b162ba7b8e310a38fb108468cab6dd0d18fa（2018-12-04）
  • 2ebb3d5057c8024355ce173f6d0e0ea215053c71（2018-11-17）
  • 3edbcad1e97744bc86cdcb58df63916985775bc8（2018-11-01）
  • 28bd6e337977ff0e6908316f0749429a9dbaf392（2018-10-31）
  • e350b3efcfadbb26ab51768e5f6a2bcb07d9dc14（2018-10-26）
  • df318b284e22352b7678daeaa32ab06eb0fbcc0c（2018-10-25）
  • b43a26fc1c8408de31e79f1abf91e0201e92e487（2018-10-19）
• SensioFrameworkExtraBundle
  • 1032c7077fd1a6f24f98b5a8377938000859f35d（2018-12-03）

汉化进度

未汉化

• 常用Bundle
• introduction
• compoments
  • serializer (翻译小半)
• reference
• bundle/ (5)
• http_cache (7)
• service_container/service_subscribers_locators.rst
• configuration/environments.rst
• routing/custom_route_loader.rst
• templating/PHP.rst
• setup/bundles.rst
• security/custom_authentication_provider.rst
• security/ldap.rst

术语约定

• Application：应用
• Route：路由
• Controller：控制器
• Services：服务
• Service Container：服务容器
• Dependency Injection：依赖注入
• Type-Hint：类型约束
• Fully-Qualified：完全限定
• Centralize：集中化
• Recipes：指令
• Meatdata：元数据
• Schema：模式
• Repository：仓库
• Entity：实体
• Entity Manger：实体管理器
• Query Builder ：查询生成器
• Wire：装配
• Autowire：自动装配
• Override：重写，覆盖
• Public：公有
• Private：私有
• Auto-Tag：自动标记
• Tag：标签
• Tagged：标记
• Resource：资源
• Asset：资源，特指CSS，JS等Web资源
• Guesser：猜测器
• Transformer：转换器、变压器
• Authentication：认证
• Authenticator：认证器
• Authorization：授权
• Role：角色
• Firewall：防火墙
• Provider：提供器
• User Provider：用户提供器
• Authentication Provider：认证提供器
• Guard Authenticator：安保认证器
• Remember Me：保持登录
• Impersonation：模拟
• Dummy：虚拟
• Profiler：调试器
• Voter：表决器
• Hierarchy：层级
• Logger：日志器
• Handler：处理器
• Channel：通道
• Helper：辅助函数，辅助程序
• Section：切片
• Migration：迁移
• Event：事件
• Subscriber：订阅器
• Listener：监听器
• Dispatch：调度、派遣
• Exception：异常
• Workflow：工作流
• Serializer：序列化器
• Normalizer：规范化器
• Locale：语言环境，表示语言和国家/地区
• Translator：翻译器
• Filter：过滤器
• Flash Message：闪存消息
• Loader：加载器
• Constraint：约束
• Assert：断言
• Validator：验证器
• Messenger：信使
• Middleware：中间件
• Broker：代理
• Header：标头
• UpperCamelCase：大驼峰拼写法
• CamelCase：驼峰拼写法
• snake_case：蛇形拼写法
• Skeleton：骨架
• Decorator：装饰器
• Verbosity：冗余度
• Compiler passes：编译器传递
• Bridge：桥接
• Type Guesser：类型猜测器
• Guesser：猜测器
• Fragment：片段
• Block：区块
• Data Transformer：数据转换器
• Transformer：转换器
• Widget：部件
• Prototype：原型
• Formatter：格式化器
• Channel：通道
• Collector：收集器
• Insulate：隔离，绝缘
• Owning Side：拥有方
• Inverse Side：从属方
• Data Mapper 数据映射器
• Cache Pool 缓存池
• Cache Item 缓存项
• Cache Adapter 缓存适配器
• Cache Hit 缓存命中
• Cache Misse 缓存未命中

导航调整

为了让文档的导航更清晰，所以对几个 .. toctree:: 进行了一些调整。

configuration.rst

.. index::
   single: Configuration

- 配置 Symfony (以及环境)
+ 配置

======================================

index.rst

    bundles
+    configuration
    console
+    controller
    doctrine

....

    service_container
+    templating
    testing

controller.rst

扩展阅读
----------------------------

- .. toctree::
-     :hidden:
-
-     templating

page_creation.rst

深入了解HTTP和框架基础知识
----------------------------

- .. toctree::
-     :hidden:
-
-     routing

routing.rst

扩展阅读
----------------------------

- .. toctree::
-     :hidden:
-
-     controller

templating.rst

.. index::
   single: Templating

- 创建和使用模板
+ 模板

......

扩展阅读
----------------------------

- .. toctree::
-     :hidden:
-
-     configuration

这些调整不会影响正文内容，只是生成的导航位置不一样

生成文档

1. 按照pip安装文档中的说明安装 pip；

2. 安装 Sphinx 和 PHP和Symfony的Sphinx扩展 （根据你的系统，你可能需要以root用户身份执行此命令）：

$ pip install sphinx~=1.3.0 git+https://github.com/fabpot/sphinx-php.git

3. 运行以下命令以HTML格式构建文档：

$ cd _build/
$ make html

生成的文档可在 _build/html 目录中找到。

SymfonyCloud

SymfonyCloud会自动构建新的拉取请求。

Docker

你可以使用一下命令在本地生成文档:

# build the image...
$ docker build . -t symfony-docs

# ...and serve it locally on http//:127.0.0.1:8080
# (if it's already in use, change the '8080' port by any other port)
$ docker run --rm -p 8080:80 symfony-docs

中文搜索

Sphinx官方已经支持中文搜索。

• 安装结巴中文分词

  $ pip install jieba

• 接下来修改sphinx的 conf.py 文件，为项目设置为中文的搜索配置。

  html_search_language = 'zh'
  

  sphinx的位置可以使用pip -V来获取。

• 可选配置

  # 根据需要设置jieba的词典路径
  html_search_options = {'dict': '/usr/lib/jieba.txt'}

文档主题

推荐使用 Doctrine 项目文档的主题进行修改配置

• https://github.com/doctrine/doctrine-sphinx-theme