文档与帮助模块

有些模块实际上不需要你执行任何操作，它们只是默默地在后台运行。然而，这些模块通常没有可配置的参数，或仅作为其他模块的依赖项存在。

多数情况下，你感兴趣的模块是可以配置权限和参数的模块。一些项目非常易用，也就是说，它们的使用是“直观的”，你可以很容易理解哪些选项可配置，以及如何实现你的目标。

如果你想要了解所有细节，以便更聪明地使用刚安装的模块，我能想到一些你可能需要知道的事情，或一些你可以查阅的地方。

以下建议按使用的简易程度排列。

对于像我们这样的新手终端用户来说，不幸的是，Drupal 仍在不断发展中。尽管我们很幸运能自由地受益于开发者的辛勤工作，但他们的时间有限，而且我敢说，最优秀的开发者往往不是最勤奋的文档编写者，否则你和我现在也不会在这里。

我建议你在学习使用 Drupal 的过程中记录并发布你的经验与困难，这将帮助未来几天、几个月、几年里成千上万与你处境相同的人。

我将此视为撰写这份文档的最终使命，尽管（或者说正因为）这意味着无尽的挫折与挑战——使用 Drupal 的新文档系统，并在一定程度上缓解学习和使用 Drupal 时的困难。如果早期有像你我这样的新手写下清晰的指导文档，我们就不会走这么多弯路。不过我很高兴，我的朋友，你将从中受益。

和我一样，你无需懂得“开发”或编程，也能分享你所“知道”和所学到的内容。

通过试错法

你可以直接开始使用模块，或尝试调整其设置。

如果在探索之后仍然不确定某个选项的作用，或无法预料其所有可能的影响，你可以大胆尝试各种可能的设置。

每当你需要做出猜测时，不必担心尝试不同的选项，因为你的网站备份始终可以让你恢复到之前的版本。你确实有备份你的网站，对吧？

请注意，模块或其选项的所有效果可能不会立即在网站上显现，因此我建议一次只尝试一个模块，并彻底测试你的网站——访问每个角落，创建新页面，尝试不同配置——在添加另一个 contrib 模块之前完成测试。

否则，如果你一次启用了多个新模块，随后遇到奇怪的问题，你将无法确定是哪一个模块引起的。

项目页面内容

每个模块的项目页面都是它在 drupal.org 上的主页。通常我会先查看项目页面，以决定是否值得尝试该模块，或在遇到问题或有疑问时查阅它。

如果你完整阅读项目页面，你通常能获得最重要的信息。例如，在考虑是否安装模块时，如果该模块依赖其他模块，这些依赖模块都会在项目页面中列出。

项目页面还可能包含与模块相关的其他有用链接。

项目页面的内容可能面向 Drupal 新用户，也可能更适合高级用户或开发者。

“阅读文档”链接（如果有）

在右侧栏（在移动设备或窄窗口中会显示在页面底部），通常可以看到“资源”标题，在其下方你可能会看到“阅读文档”的链接。

不过，并非所有项目页面都有“阅读文档”链接。在这种情况下，希望你能在项目页面的主要内容区域中找到有用的文档链接。

当存在“阅读文档”链接时，它通常是开发者推荐的最合适的学习资源。

每个项目页面的内容由项目创建者及其授权的少数维护者管理。

其他 drupal.org 贡献者即使无法修改项目页面，也经常会创建其他包含优秀信息的页面。不幸的是，这些页面通常不会在项目页面上被链接。

如何查找这些未在项目页面中链接的页面，将在后文的 Google 限定 drupal.org 搜索 ⤵ 部分中讨论。

模块的 “README.txt” 文件

“README.txt” 文件历来是模块（或主题）的官方文档位置，其中包含重要且必要的信息，包括如何将模块（或主题）升级到新版本。

提取后，README.txt 文件位于 contrib 模块（或主题）的顶级目录中（如果存在）。

要在不下载任何文件的情况下查看模块（或主题）的 README.txt 文件，请访问以下链接：

http://cgit.drupalcode.org/project/PROJECT_MACHINE_NAME.git/blob/HEAD:/README.txt

将上面 URL 中的 PROJECT_MACHINE_NAME 替换为项目的“机器名称”。

“机器名称” 是你在访问 drupal.org 上的项目页面时浏览器地址栏中 URL 的最后一部分，如以下示例：

https://www.drupal.org/project/PROJECT_MACHINE_NAME

如果模块没有 README.txt 文件，则可能说明该模块没有可配置参数，仅作为后台运行的依赖模块存在。

如果没有 README.txt 文件，或你想查看项目的其他文件，请使用以下链接（同样替换“PROJECT_MACHINE_NAME”）：

http://cgit.drupalcode.org/PROJECT_MACHINE_NAME/tree/?id=HEAD

在此 “drupalcode.org” 页面右上角，你可能需要“切换”到你正在使用的 Drupal 核心版本。

Google 限定 drupal.org 搜索

如果你希望将搜索范围限定在整个 drupal.org 网站，这是我经常使用的方法。我常用这种方式搜索 drupal.org 或其他指定域名的内容。

访问 google.com ⎘，然后输入：

site:drupal.org

注意，在冒号 (:) 与域名之间不要有空格，也不要在域名前加 “www.”。

在域名后添加一个空格，然后输入关键字，例如模块名称。

有时我会在搜索中添加 “Drupal 8”，以限制结果仅针对 Drupal 8，而不是混入 D6、D7 的结果。若使用双引号括起 “Drupal 8”，Google 会返回完全匹配该短语的页面。

如果你希望查看关于某个模块的全球信息（包括非 drupal.org 的内容），可以去掉 “site:drupal.org”。

在 Google 搜索结果页面显示 100 条结果而不是 10 条： 在任意 Google 搜索结果页面的右上角点击齿轮图标，选择“搜索设置”。在“即时预测”部分选择“从不显示即时结果”。然后在“每页结果数”部分将滑块拖到最右端。搜索可能会多花几毫秒时间。

附带意见：你可能会想到使用 drupal.org 页面顶部自带的搜索框。我试过几次，如果你喜欢做无用功，也可以试试。

站点“扩展”页面上的“帮助”按钮 / 链接（如果有）

在你网站的“扩展”页面上，每个模块名称的右侧通常会显示该模块描述的第一行（前提是浏览器窗口足够宽）。

点击描述的第一行后，它会展开，显示完整的描述，并在可用时显示“帮助”、“权限”和“配置”等按钮/链接。

如果你看不到模块名称右侧的描述行，可参阅 模块配置页面 上的说明。

遗憾的是，要访问模块的帮助页面，你不仅需要将模块导入网站，还必须启用该模块，才能看到“帮助”按钮/链接。此外，并非所有 contrib 或核心模块都有“帮助”按钮或链接。除非启用模块，否则你无法知道它是否存在。

由于这些不便的原因，我过去从未依赖“帮助”按钮。尽管如此，现在我发现它们往往能链接到包含实用信息的页面。