README

此包仍在积极开发中。虽然可以使用，但请注意此包将会进行大量更新。它最初旨在与opifer/cms一起使用，但也可以在您的自己的CMS系统中独立使用，例如。

安装

首先，将包添加到composer.json

composer require opifer/manual-bundle dev-master

在app/AppKernel.php中注册必要的包

public function registerBundles()
{    
    $bundles = array(
        ...
        new \Opifer\ManualBundle\OpiferManualBundle(),
        new \Symfony\Cmf\Bundle\RoutingBundle\CmfRoutingBundle(),        
        new \Knp\Bundle\MarkdownBundle\KnpMarkdownBundle(),
        ...
    );
    
    // This bundle will only be loaded on the test envoirement.
    if (in_array($this->getEnvironment(), array('test'))) 
    {
        $bundles[] = new \Liip\FunctionalTestBundle\LiipFunctionalTestBundle();
    }
}

注意
如果您使用opifer/cms，则无需执行此操作！但是，您需要执行以下操作，并请确保您已安装bower。对于以下步骤，我们假设您已经设置了数据库，并让symfony创建它。

最后，您需要使用命令行进入manual-bundle并执行bower install。首先，进入manual-bundle

    cd vendor/opifer/manual-bundle

然后，执行

    bower install

这将安装运行所需的所有东西！

您需要做的最后一件事是

    app/console opifer:refresh

此最后一个命令将安装包附带的所有必要的帮助markdown文件以及具有上述结构的所有其他包。如果您还没有为自己的包设置帮助结构，并且想这样做，您需要重新运行app/console opifer:refresh或app/console opifer:manual:index。我建议您使用第一个，因为它还会重新安装资产文件并清除缓存！

使用此包

有关使用此包的说明，请参阅Resources/doc文件夹中的入门。

注意：此包依赖于一个模板文件。此包使用位于`Resources/views/Help`中的2个视图文件。请进入这些文件并根据您的模板文件位置更改模板文件。我们已经将其设置为合理的默认值。

测试

此包使用了Behat、Mink、Selenium（用于GUI JavaScript）或PhantomJS（如果无GUI可用，用于CLI JavaScript测试）

我们将在稍后提供如何使测试通过的详细说明。

opifer / manual-bundle

维护者

详细信息

README

安装

使用此包

测试