引导教程

创建组织或扩展程序教程的最简单方法是使用Joomla提供的工具创建这些教程。

转到系统（管理部分） -> 引导教程。

创建新的教程

从Joomla 5开始，为每个教程提供了一个标识符。这不是必填字段，但始终存在值。此标识符旨在

• 允许从任何地方启动教程，
• 区分教程，并提供其来源的提示，
• 如果教程需要任何语言文件，则提供语言文件的文件名结构，
• 允许对现有教程进行可能的更新，并在数据库中轻松跟踪。

Joomla 5中的另一个新功能是创建了2个独立的语言文件。一个用于教程，另一个用于教程的步骤。

标识符

这是一个唯一的字符串，非常类似于文章的别名。字符串应格式化为

authorname-tourname
companyname-tourname
domain-tourname

例如，Joomla创建的欢迎教程的标识符名称为joomla-welcome。作者姓名、公司名称、域名应为单个单词，教程名称可以包含连字符。

只要您创建的教程包含您的“签名”并且在您的教程池中是唯一的，用户就不会出现重复问题。

标识符对应于#__guidedtour表的uid列。在保存或复制时，会创建一个建议的标识符字符串。

语言文件

并非所有教程都需要语言文件，尤其是在您只针对单一语言受众时。但是，如果您确实需要它们，则文件需要遵循标识符规定的新约定。

例如，对于标识符为joomla-welcome的教程，语言文件将为

guidedtours.joomla_welcome.ini
guidedtours.joomla_welcome_steps.ini

其中第一个文件仅包含2个键，一个用于教程名称，一个用于其描述，第二个文件包含所有步骤键。

所有语言文件都需要以“extensionname”、“com_extensionname”、“mod_modulename”、“plg_[group]_pluginname”或“tpl_templatename”开头，以.ini或_steps.ini结尾。

提醒：语言键可以是任何内容，但键中必须包含GUIDEDTOUR。这是为了允许教程和步骤视图正确区分什么是语言键，什么只是普通内容。

语言文件不需要放在administrator/language/[language]/中。您可以将文件保留在扩展程序的文件结构内。

教程上下文

自Joomla中引入教程以来，一直提供“组件选择器”参数。Joomla 5中“组件选择器”的定义略有不同。现在，在显示“参加教程”模块的任何给定页面上，处于页面上下文的教程将优先显示。

选择一个组件将确保在组件的视图中，教程将被标记为“收藏”。“全部”将在所有页面中优先显示教程。不建议将选择保留为“全部”。作为第三方开发人员，您将选择教程绑定的扩展程序。

例如，“如何创建文章”教程在“文章”、“特色文章”或“类别”视图中将优先显示。为此，教程的组件选择器设置为“文章”和“类别”。

请注意，引导教程组件知道如何为特定组件区分类别教程。例如，如果您为com_contact创建类别教程，则文章的类别教程在“联系”上下文中不会显示为收藏教程。

在编辑特定模块、插件或模板时，没有可用的教程。这就是从任何地方启动教程可以派上用场的地方。

从任何位置启动教程

从引导教程模块以外的其他位置启动教程就像添加具有教程标识符的属性data-gt-uid一样简单。

例如，在cpanel仪表板中创建一个自定义模块，并将此HTML添加到其中

<button class="btn btn-primary button-start-guidedtour" type="button" data-gt-uid="joomla-articles">How to create articles?</button>
<button class="btn btn-secondary button-start-guidedtour" type="button" data-gt-uid="joomla-contacts">How to create contacts?</button>