README

Symfony2 的帮助/文档组件

与 Symfony 2.1.x 不兼容

此组件提供了查看 Web 应用程序文档或帮助浏览器的接口。管理后端允许用户管理文档内容。包含的前端模板使用两栏布局来显示帮助主题和内容。

依赖

1. symfony/framework-bundle
2. doctrine/common
3. symfony/doctrine-bundle
4. TrsteelCkeditorBundle（可选）

安装

使用 deps 文件

1. 将组件添加到 deps

[DezullHelpBundle]
    git=git://github.com/dezull/HelpBundle.git
    target=/bundles/Dezull/Bundle/HelpBundle

2. 安装供应商

$ php bin/vendors install

3. 将组件添加到 app/AppKernel.php

$bundles = array(
    ...
    new Dezull\Bundle\HelpBundle\DezullHelpBundle(),
    ...
);

4. 将命名空间添加到 app/autoload.php

$loader->registerNamespaces(array(
    ...
    'Dezull' => __DIR__.'/../vendor/bundles',
    ...
));

5. 添加路由。根据您的应用程序进行自定义。

# This is the only required route need
DezullHelpBundle:
    prefix: /prefix
    resource: "@DezullHelpBundle/Resources/config/routing/main.yml"

_help_topic:
    type:     annotation
    pattern: /help/!{title}
    defaults: { _controller: DezullHelpBundle:Browser:index }

6. 将所需表安装到数据库中，例如

CREATE TABLE help_category (id INT AUTO_INCREMENT NOT NULL, name VARCHAR(120) NOT NULL, PRIMARY KEY(id)) ENGINE = InnoDB;
CREATE TABLE help_topic (id INT AUTO_INCREMENT NOT NULL, category_id INT DEFAULT NULL, title VARCHAR(120) NOT NULL, content LONGTEXT NOT NULL, INDEX IDX_FAD81EE212469DE2 (category_id), PRIMARY KEY(id)) ENGINE = InnoDB;
ALTER TABLE help_topic ADD CONSTRAINT FK_FAD81EE212469DE2 FOREIGN KEY (category_id) REFERENCES help_category(id);

使用 composer.json

1. 将组件添加到 composer.json

"require": {
    ...,
    "dezull/help-bundle": "1.0.1"
},

2. 更新依赖

$ composer.phar update

使用

1. 使用管理界面添加新的分类和主题。例如，通过 http://example.com/admin/help/category 访问
2. 要链接到帮助页面，使用路由 DezullHelpBundle:Browser:Index，并将主题标题作为其唯一参数。例如，http://example.com/help/!How+to+use+this+web+app