PHPDocumentor 模板

Question

有人能告诉我 :

1. 在哪里下载新模板
2. 如何安装一个模板来覆盖默认值。
3. 默认的模板文件夹在哪里？

谢谢。

- Michel Lecomte

Answer 1

我下载了phpDocumentor.phar，对可用的模板也有些困惑。这是来自github上2.8.3版本的源代码。

可用的模板有：

- abstract - clean - new-black - old-ocean - responsive-twig - responsive - xml - zend

对于phpDocumentor 3，可用的模板在github上列出如下：

- clean - default - responsive-twig - xml

- Toby Allen

---

我给这个点赞是因为它提示了我如何生成structure.xml文件：在/phpdoc/transformations的phpdoc.xml中包含<template name="xml" />。 - Jay Bienvenu

Answer 2

--在phpdoc命令行中使用模板或编辑/usr/share/pear/phpDocumentor/data/templates/phpdoc.tpl.xml并更改“使用作为默认值的模板名称”行。

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

- Michel Lecomte

---

你找到下载它们的地方了吗？ - M H

Answer 3

如何下载新模板

目前还没有官方页面提供下载，您需要在互联网上搜索。

不过，如果您想尝试 VuePress，您可以使用我创建的兼容模板nelson6e65/phpdoc-vuepress（查看演示）。

---

如何安装模板以覆盖默认设置

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

重要的是要知道“新”模板安装在哪里，然后像文档中所述，您可以通过传递---template和您的模板位置（即template.xml所在的目录）来使用外部模板：

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

例如，对于我之前链接的模板，您可以通过运行以下命令来实现此目标：

# 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。

---

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

- nelson6e65