使用 Altium 文档
Altium 提供的各类设计解决方案配套了内容丰富的技术文档。本文档汇总了一组实用的“技巧与窍门”,帮助您在使用文档时更快找到所需内容,同时也会更深入地介绍文档中许多您可能尚未了解的丰富功能与不同组成部分。
访问技术文档
进入技术文档的主要入口——也就是所谓的“前门”——为:https://www.altium.com/documentation/。
页面的核心位置提供了以下两套文档:
-
Altium Designer – 桌面设计软件,品牌如下:-
Altium Designer Develop – 作为 Altium Develop 解决方案的一部分时。 -
Altium Designer Agile – 作为 Altium Agile 解决方案的一部分时。 -
Altium Designer – 在仍继续使用(有效期限内)且不属于平台解决方案时。
-
-
Altium 365 – 云平台,其核心 Workspace 的品牌如下:-
Altium Develop Workspace - 在作为 Altium Develop 解决方案的一部分创建时。 -
Altium Agile Workspace - 在作为 Altium Agile 解决方案的一部分创建时。 -
Altium 365 Workspace – 在仍与 Altium Designer 一起使用(有效期限内)且不属于平台解决方案时。
-
请注意,这两种情况下均使用同一套文档来支持所有解决方案。在 Altium Designer documentation 中,提及该软件时通常使用简称“Altium Designer”。在 Altium 365 documentation 中,提及平台时使用 “Altium Platform”(或 “Altium 365”),提及托管在该平台上的 Workspace 时使用 “Altium Workspace”(或 “Altium 365 Workspace”,或简称 “Workspace”)。
页面使用方法:
-
点击磁贴的主标题,可进入对应设计解决方案文档的主页。
-
点击 Altium Designer 或 Altium 365 磁贴中的链接,可访问该特定区域的信息。
-
使用可用的
QuickLinks 菜单访问其他关键页面,如下方 Altium Designer 和 Altium 365 文档磁贴所示。
-
使用页面顶部的
Search 字段,可快速搜索所有设计解决方案(以及适用时的各版本)的全部文档,以及知识库。有关搜索功能的更多详情,请参见 Documentation Search Facility。 -
点击
Other Products 条目可展开页面,以访问其他解决方案/领域的文档:Renesas 365、Altium On-Prem Enterprise Server、Company Dashboard、Altium CircuitMaker、Altium CircuitStudio 以及 Altium Infrastructure Server。 -
点击
See Also 条目可展开页面,以访问 Altium 提供的其他实用资源,例如 Knowledge Base、Learning Hub(其中包含大量有趣且聚焦的文章,许多由行业专家撰写)、Altium Professional Training,以及 Altium Forums(这是极具价值的学习资源,可直接获取来自同行的信息)。
使用“F1”直接访问
对于包括 Altium Designer 在内的设计软件,F1F1*.HelpID\Program Files\Altium\AD<Solution>\Help
下图展示了该功能的实际使用方式。这里使用 F1
F1 更新
对于受支持的设计软件,安装主目录中 \HelpF1
只要检查间隔已到,下次使用 F1\ProgramData\Altium\Altium Designer <Solution> <GUID>\Help\Help
其他访问方式
技术文档还可以通过多种其他方式访问,包括:
-
通过 Web 浏览器搜索引擎进行外部搜索,例如 Google。若要将搜索范围聚焦到 Altium 文档,请以前缀形式输入站点,格式为
(例如site:altium.com/documentation <Search String> )。site:altium.com/documentation PCB Layout Replication -
通过 Altium 官方论坛帖子中提供的链接访问。
-
通过主 altium.com 网站其他区域中的链接访问(例如 Learning Hub 区域,或专门的“新增功能”和功能级页面)。
-
通过软件中的专用链接访问。例如从某个
Help 菜单,或使用“Learn More ”(或类似措辞)的链接。
文档界面
文档界面通常最多由 14 个不同区域组成,如下图所示,后文将逐一详细说明。
-
Product Documentation Selector – 使用此控件可在可用的各套专用文档之间切换。 -
Theme Selector – 使用此控件可在浅色(
)和深色(
)显示模式之间切换,如下例所示。
-
Search – 使用此字段输入搜索字符串,以在当前查看的产品文档中查找信息。相关搜索筛选器可帮助您随后调整搜索范围。更多详情请参见 Documentation Search Facility。 -
Nav Tree Pane – 显示当前所查看产品文档的所有组成页面。页面按逻辑分组,点击某个条目即可查看对应页面。窗格右上角的控件可用于调整其大小和/或控制其可见性。 -
QuickLinks – 这是Nav Tree 窗格中一个专用且固定的组成部分,无论当前查看的是哪种产品文档,它都会始终显示。它可快速访问本页、版权信息和主文档入口,同时也可快速访问知识库。 -
Breadcrumbs – 提供基于当前正在阅读页面的辅助导航方式,可导航到层级结构中更上层的父页面。当面包屑路径涉及很多页面时,会使用省略号控件以保持显示简洁。点击该控件可打开一个弹出窗口,其中包含路径中的所有其他中间页面,每个页面都是指向相应页面的活动链接。 -
Main Page Content – 这是界面的主要区域,用于显示在Nav Tree 窗格中选择的页面。有关页面内容各方面的更多详情,以及组成特性和功能的使用技巧,请参见 Viewing a Technical Document。 -
Feature Availability Note —— 这会显示在某些文档集中的每一页上。技术文档涵盖某个产品或整体解决方案中某个组成部分的全部特性与功能。对于 Altium Designer 和 Altium 365,您是否能够访问页面中介绍的某项功能,取决于您所使用的 Altium 解决方案——Altium Develop、Altium Agile 的某个版本(Agile Teams 或 Agile Enterprise),或 Altium Designer(在有效订阅期内)。如果您在实际软件中没有看到所讨论的功能,请联系 Altium 销售团队了解更多信息。 -
Legacy Documentation Note —— 这会显示在 Altium Designer 文档中的每一页上。它可快速访问 Legacy Documentation 部分,该部分位于 Other Installers 页面中,用于查阅与旧版本软件相关的文档。 -
Table of Contents —— 右侧窗格中的Content 区域会在适用时显示当前页面的结构,即其标题层级(2 到 4 级,因为 1 级为页面标题)。单击某个条目即可跳转到页面中的相应位置。反过来,当您滚动页面时,Content 区域也会更新,以跟踪您当前在文档中的位置。 -
Like/Dislike —— 常见的“赞/踩”功能,可让您快速评价某个页面是否有帮助;如果没有帮助,还可让您告知原因(登录 Altium 账户后可用)。更多详情,请参见 Like/Dislike Functionality。 -
Language Selector —— 提供一种快速方式,可切换为使用多种官方支持语言之一来查看文档。 -
Documentation Feedback (登录 Altium 账户后显示)—— 此功能为您提供了一种快捷方式,可向技术文档团队提交您对某个页面的反馈,更适合用于指出拼写错误、不正确/过时的信息或缺失的信息。只需在页面上选择文本和/或图像,然后使用 键盘快捷键即可访问该功能。更多详情,请参见 Documentation Feedback Mechanism。Ctrl+Enter -
Printer-friendly version —— 提供一种即时生成页面版本的方式,该版本的内容经过专门处理,更便于打印(例如保存为 PDF)。
结构分页
在界面的
查看技术文档
以下各节介绍了与页面内容本身相关的各个方面。
文档约定
用于突出显示正文中提到的菜单命令、对话框控件、按钮或工具栏。 示例:
|
|
用于突出显示正文中提到的面板或对话框。 示例:
在需要时,也会使用斜体来强调重要内容。 |
|
Monospace |
用于突出显示正文中提到的硬盘位置、文件名、文件扩展名、查询语言表达式或语言关键字。 示例:
|
Bold + Monospace |
用于突出显示正文中提到的键盘快捷键。 示例:
|
Altium Designer 文档中的主菜单引用使用 » 字符作为分隔符。第一项表示菜单本身,后面跟随该菜单中的命令。如果某个命令是从子菜单访问的,则会额外使用一个 » 字符来表示。 示例:
|
|
Altium CircuitStudio 和 Altium CircuitMaker 文档中的主菜单引用使用 | 字符作为分隔符。第一项表示功能区菜单中的特定选项卡,接着是该选项卡中的组(或区域),最后是该组中的按钮。如果某个命令是从与按钮关联的菜单中访问的,则使用 » 字符表示。 示例:
|
|
Key1+Key2 |
在引用快捷键时,使用加号 (+) 表示按照所示顺序同时按住键盘上的多个按键。 示例:
|
Key1, Key2 |
在引用加速键序列时,使用逗号 (,) 表示依次连续按下序列中的各个按键。 示例:
|
| 链接 | 指向目标的普通超链接,目标可以是:
|
用于突出显示与页面中正在讨论的特定主题相关的一些重要补充信息。 示例: |
|
用于突出显示某项值得注意的特性或功能,或相关使用技巧。 示例: |
|
用于突出显示需要特别注意或应当执行的事项。 示例: |
增强视觉效果
在整个文档中,您会看到使用了多种可视化元素 ,以更生动的方式传达信息。以下各节说明了这些元素在页面上的显示方式及其用途。
静态图像
朴素的静态图像是文档中的基础元素,通常结合周围文本使用,以准确提供有关软件某个关键方面的详细信息。
为了使文档的呈现效果(以及可读性)保持在可控范围内,页面采用了固定宽度。因此,图像通常默认无法以完整尺寸显示。当您将光标悬停在图像上时,光标会从指针图标(
)变为放大镜图标(
)。这表示当您单击图像时,将会在浮动窗口中显示其完整尺寸版本(如适用,并取决于当前浏览器窗口的大小)。下图展示了文档中静态图像的这种行为(有点讽刺的是,您需要单击该图像才能查看其完整尺寸)。
幻灯片
幻灯片元素可以包含多张图像(以及视频),并配有说明文字,以更清晰地展示更多可视信息。在说明软件某项功能的操作过程或分步顺序时,这种元素尤其有用。
下图展示了文档中幻灯片的一个示例,并突出显示了一些关键区域,后文将对此进行说明。
-
使用这些控件可分别向前和向后切换幻灯片。当您将鼠标悬停在某个区域上时,该区域会变暗。您可以单击整个“箭头框”区域中的任意位置,而不仅仅是箭头图标本身。
-
这些“气泡”表示幻灯片中包含多少张,以及您当前位于哪一张(较深色的气泡)。您可以单击某个气泡快速跳转到对应幻灯片。
-
幻灯片可以包含说明文字——每张幻灯片对应一条说明。随着您单击切换不同幻灯片,这些说明也会随之更新。
动画 Gif
当需要以类似视频的方式展示软件中的某个过程或方面,但展示内容较短、使用视频又显得过于繁琐时,就会使用动画 Gif。文档中的动画 gif 的特征是在中央有一个明显的“播放”按钮,如下图所示。单击该按钮后,gif 会播放到结束并停止,然后再次显示播放按钮。
视频 (MP4)
视频与 gif 类似,也用于在视觉上展示软件中某个过程或方面的“执行”过程,但其内容长度比适合 gif 的情况更长。文档中的视频可通过底部的控制面板加以识别,如下图所示。单击视频中的任意位置即可开始播放(不必单击左下角的播放箭头)。再次单击视频中的任意位置即可暂停。您还可以使用可用的视频控件,例如切换全尺寸与普通视图、沿时间轴前后跳转,以及更改播放速度。
悬停图像
悬停图像用于展示“前后对比”场景,或针对软件某项特性或功能进行某种比较。它仅由两张图像组成。在页面上,它看起来与普通静态图像相同,默认显示第一张图像。当光标悬停其上时,会显示第二张图像。
以下是文档中使用悬停图像的一个真实示例。在此示例中,它用于说明屏蔽过孔(默认/第一张图像)和缝合过孔(第二张图像,悬停时显示)。
弹出图像
弹出图像用于在周围文本的上下文中展示某些内容,而无需将该图像直接加入正文内容流。从这个角度看,它更像是一种“旁注”或示例,用于强化文本中的某条评论或陈述。此类元素会显示以下两种图标之一:
(弹出图像)或
(弹出动画 Gif 或视频)。下图展示了单击弹出元素后的效果,此处为“图像”类型的弹出,显示的是全尺寸图像。
悬停文本(工具提示)
悬停文本(或工具提示)用于针对页面上的特定条目提供额外的有用说明。例如,它可以是某个条目的解释性注释,或者是对所用术语的类似术语表说明。工具提示可以通过以下两种方式之一出现:
可折叠章节
为了使页面内容保持整洁且不过于繁杂,文档使用了可折叠章节。这类章节通常用于包含更深入的信息,但这些信息并非理解页面常规内容流程所必需(因此无需默认展开显示)。例如,这类内容可以是对话框或面板中的可用选项,或与正文中讨论的某项功能相关的特定注意事项。单击章节标题区域中的任意位置即可展开/折叠该章节。
获取页面或特定章节的链接
当您想与他人共享某个页面时,需要能够快速获取其 URL。可以通过以下几种方式获取(复制到 Windows 剪贴板):
-
首次访问该页面时,从浏览器的地址栏获取。
-
右键单击左侧导航树中的页面条目,然后使用上下文菜单中的
Copy link address 命令。
进一步来说,您还可以获取当前正在阅读页面中某个特定章节的 URL,方法如下:
-
使用右侧窗格访问页面内容结构中的目标章节,然后从浏览器地址栏复制 URL。
-
向下滚动页面至目标章节。滚动时,浏览器地址栏会更新,以反映您当前到达的章节。
-
右键单击页面内容结构(右侧窗格)中目标章节的条目,然后使用上下文菜单中的
Copy link address 命令。
您还可以从以下位置快速“获取链接”:
版本化文档
对于 Altium On-Prem Enterprise Server,其相关文档采用版本化管理。这使您能够为所使用的软件版本选择正确的文档版本。您可以在主文档入口中(通过产品磁贴的
如果您正在阅读的页面不是该页面的最新版本,版本系统会提醒您。提醒方式有两种:
- 下拉版本选择器中的版本号会以不同颜色显示,并带有警告符号。
- 页面顶部会显示一条警告信息,并附带指向最新版本的链接。单击该链接后,版本选择器中的条目将自动切换为最新可用版本。
适用版本
虽然软件会随着版本迭代不断演进,增加新功能并增强其功能性,但 Altium On-Prem Enterprise Server 的对应版本化文档通常只会在某些部分受到影响。许多页面不会因软件的下一个版本而发生变化,因此,之前适用的相同内容,同样也适用于后续版本。因此,每个页面都会提供版本适用性说明,用于显示该页面内容适用于哪些软件版本。
下图展示了这种说明方式。这里打开的是介绍 Project History 功能的页面 8.0 版本。该内容同样适用于软件的 7.0、7.1 和 7.2 版本。换句话说,如果你将文档的版本选择器设置为 7.0、7.1、7.2 或 8.0,该页面内容都没有区别。
文档搜索功能
为了帮助你在 Altium 设计解决方案的技术文档中查找信息,系统提供了强大的
-
从网站顶部横幅访问——如下方幻灯演示所示进行访问和使用。搜索会在整个网站范围内执行,结果显示在单独的浏览器标签页中。
-
从技术文档的“入口页”(altium.com/documentation) 访问——如下方幻灯演示所示进行访问和使用。搜索会在适用于各种 Altium 设计解决方案的全部文档集以及知识库中执行。结果显示在同一个浏览器标签页中。
-
从技术文档中的某个页面访问——如下方幻灯演示所示进行访问和使用。搜索仅在当前正在查看的活动文档集中执行。结果显示在同一个浏览器标签页中。
QuickNav 页面导航(Altium Designer 文档)
对于 Altium Designer 中的设计对象和面板,这些元素的信息分散在 Altium Designer 文档集中的大量页面里。为了便于快速导航到这些信息,文档采用了
在大多数情况下,QuickNav 页面会以三个不同的部分呈现信息:
-
Graphical Overview - 常用对象的汇总可视图,例如。 -
Slideshow - 提供关于某些你会更频繁使用元素的概览信息。 -
A-Z Listing - 方便的按字母顺序排列的列表。没有花哨内容,没有多余步骤,只有指向特定元素详细信息的直接链接。
QuickNav 页面导航适用于以下内容:
QuickStart 页面导航(Altium Designer 文档)
在 Altium Designer 文档集中(该文档集为 Altium 提供的平台解决方案提供基础和支持),有一些关键的顶层页面,综合来看,它们构成了一组非常有价值的“QuickStart”信息。这类页面会带你了解某个特定设计领域,提供恰到好处的细节,帮助你快速建立对该领域的理解并开始上手,而无需过度深入。这些页面包括:
Like/Dislike 功能
为了帮助我们获取技术文档页面的粗粒度分析数据,文档中采用了常见的“点赞/点踩”功能。这样我们就能了解某个页面是否有用;如果没有用,就可以安排进行相应修订。你可以在页面右侧窗格中、
文档反馈机制
有时你可能会遇到或发现文档中的问题,例如拼写错误、访问问题、信息不正确/不清晰,或信息已过时。人非圣贤,孰能无过,我们也希望读者能够帮助我们纠正这些问题。为此,技术文档集成了一个可从任意页面访问的反馈机制,可将报告直接发送给技术文档团队。
该反馈机制可通过使用 Ctrl+EnterCtrl+Enter
访问该功能后,会显示
支持在任意设备上查看
每位设计人员都坐在配有单个 1280x1024 显示器的台式电脑前工作的时代已经过去了。如今,我们的台式电脑通常配有多个不同尺寸和分辨率的显示器。我们还需要能够在外出现场或客户办公室时通过笔记本电脑工作。此外,既然我们都是热爱知识的人,我们也希望在候机或乘公交去办公室时,能通过平板电脑或手机继续获取更多信息。
为了让内容能够在所有这些不同设备上良好显示,技术文档(作为上级 altium.com 网站的一部分)采用了
便于打印的文档
想要打印一些技术文档吗?由于我们采用了“在线”功能,并且使用了大量炫目的视觉效果来传达信息,因此您首先需要确保页面已准备就绪,可以发送到您忠实的打印设备(或另存为 PDF)。在底部横幅区域的右侧,您会找到一个可执行此操作的控件,用于获取页面的打印友好版本。
本地化文档
我们的部分内容提供英语以外的其他语言版本。请使用位于底部横幅区域左侧的语言选择器,从当前支持的语言中选择所需语言。
如果某个页面版本提供了对应的其他语言内容,系统将自动显示该语言版本;否则将显示英文内容。下面的幻灯片演示了页面本地化的实际效果,该页面提供英语、日语、中文、韩语和波兰语版本。
浏览器翻译(非官方)
根据您偏好的 Web 浏览器,您可能可以对当前正在阅读的页面进行临时的即时翻译。下面的幻灯片演示了如何使用 Google Chrome 的翻译功能,快速以众多支持语言中的一种查看页面,此处以德语为例。请注意,这种翻译是临时的——点击进入其他页面再返回,或刷新页面,都会恢复为原始查看语言。
知识库
人们经常会进入 Altium 的 Knowledge Base,并认为它就是我们技术文档的全部。实际上,它本身就是一个独立的资源。事实上,两者形成了一种共生关系:Knowledge Base 与技术文档相互链接、彼此补充,帮助您获得所需的信息。
Knowledge Base 是一个“首选”的自助服务入口,其内容由 Altium 支持团队成员精心整理——这些人对 Altium 解决方案拥有专业知识。这些内容直接来源于其他用户遇到的问题。最终形成了一个自然增长的文章库,为各种主题和边缘情况提供有针对性的答案/解决方案。精准、易读的短文,帮助您快速恢复工作。
Knowledge Base 的界面极其简洁。您可以选择搜索所有文章,也可以将范围限定在某个受支持的设计解决方案类别中的文章。然后只需开始输入搜索字符串——系统会在您输入时进行筛选。当您找到感兴趣的文章时,点击其条目即可打开该文章。
文档版权
技术文档的版权信息已方便地显示在下图中,并且可通过导航树窗格的 QuickLinks 部分(文档版权信息)访问;在查看技术文档中的任何页面时,都可以使用该窗格。该页面包含指向主 altium.com 网站上的 版权与商标 页面链接。
结束语……
这正是技术文档团队始终遵循并努力践行的理念。展望未来,技术文档将继续不断演进,尤其会从可用性的角度持续改进。毕竟,只有当用户能够找到信息时,海量信息才真正有价值。随着新的开发、增强功能和特性的推出,本页面也将持续更新,以反映并重点说明这些新增内容,以及如何最佳地利用它们来获取您所需的信息。






















































