PHPDocumentor 模板答案

【问题标题】：PHPDocumentor templatePHPDocumentor 模板
【发布时间】：2013-11-20 11:29:07
【问题描述】：

谁能告诉我：

在哪里下载新模板
如何安装模板以覆盖默认值。
默认模板文件夹在哪里？

想。

【问题讨论】：

标签： templates phpdoc

【解决方案1】：

我下载了 phpDocumentor.phar 并且对可用的模板也有些困惑。这是来自source on github

摘要
检查样式
干净
新黑
古老的海洋
响应式树枝
响应式
xml
zend

【讨论】：

给了这个+1，因为它让我知道如何生成 structure.xml 文件：在 /phpdoc/transformations 的 phpdoc.xml 中包含

【解决方案2】：

--phpdoc cmd 行中的模板或编辑 /usr/share/pear/phpDocumentor/data/templates/phpdoc.tpl.xml 并将模板名称的行更改为默认使用。

默认模板目录是 usr/share/pear/phpDocumentor/data/templates

【讨论】：

你有没有找到下载它们的地方？

【解决方案3】：

在哪里下载新模板

这里没有“官方”页面；你必须在互联网上搜索。

但是，如果您想尝试VuePress，可以使用我创建的兼容模板nelson6e65/phpdoc-vuepress (see a demo)。

如何安装模板以覆盖默认值

安装模板的方式有很多种：手动下载、使用Composer等...

重要的是 在哪里 安装了“新”模板，然后，如 in documentation 所述，您可以通过将 ---template 传递给您的模板位置来使用外部模板（ template.xml 所在的目录）：

$ phpdoc -d "./src" -t "./docs/api" --template="data/templates/my_template"

例如，对于template I linked before，您可以通过运行来实现：

# Installing
$ composer require --dev nelson6e65/phpdoc-vuepress
# Using
$ phpdoc -d=src/ -t=docs/api/ --template="vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress"

在这种情况下，template.xml 文件安装在项目的相对路径中：vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress/template.xml

注意：如果我使用 *.phar，我在使用自定义模板时会出错。因此，您可能需要使用phpdoc 的另一种分发方法。

默认模板文件夹在哪里

取决于您的安装方法。

如果您使用 Composer 安装或下载源，则模板文件夹与安装位置 data/templates 相关。对于 Composer，位于：

vendor/phpdocumentor/phpdocumentor/data/templates/

对于通过 composer 进行全局安装，模板位于广告 ~/.config/composer/vendor/phpdocumentor/phpdocumentor/data/templates

我希望这对您和其他人有用。问候！ :)

【讨论】：