控制与评审
作为 Artifact 的 Word 和 PDF 文件
将 Word 文档和 PDF 作为 Artifact 添加到项目中,对其页面进行评审和评论,保留每个版本,并通过移除旧版本的文件释放存储空间。
本页内容
Word 文档或 PDF 可以作为 Artifact 保存在项目中。评审者在 Holarch 中阅读它、对其页面发表评论,并像审批其他条目一样审批它。同一文档的每次新上传都会成为一个新版本,早期版本仍可阅读。
在托管服务上,Word 文件在添加时会转换为 PDF,PDF 会被压缩。所有人阅读、下载和评论的都是 PDF。
概念
- 文件 Artifact:保存一个文件的 Artifact。其页面顶部有一个文件部分,包含查看器、版本和文件工具。
- 版本:文档的一次上传。每个版本保留其 PDF、上传者、日期和可选的备注。默认显示最新版本。
- 转换:将 Word 文件转换为 PDF 并压缩 PDF。所有人共用同一队列,每次转换一个文件;来自不同账户的文件轮流处理,因此一大批文件不会阻塞其他人。
- 固定评论:属于某个版本中某一位置的评论:选中的词语、一个点、一个框或整页(在 Word 视图中则是一个段落)。讨论会显示其位置,例如“在版本 2 第 3 页”。
如何使用
何时使用及原因
当交付物在 Holarch 之外编写时,请使用文件 Artifact:设计评审包、供应商的接口控制文档、测试报告。将其保存在项目中,可使它与所涵盖的需求和条目放在一起。评审者在同一处评论,基线会记录哪个版本获得了审批。
添加 Word 或 PDF 文件
- 打开 LML 项目的数据库。
- 点击+ 新建条目,然后点击名称字段下方的从 Word 或 PDF 文件创建 Artifact…。当数据库只显示 Artifact 时,按钮为+ 新建 Artifact,对话框中的按钮为从 Word 或 PDF 文件…。对话框关闭,文件选择器打开。
在新建条目对话框打开的每个位置都有同一个按钮,例如 ⌘K / Ctrl+K → 新建条目…。也可以将 .docx 和 .pdf 文件拖到数据库表上,或在项目的任意页面上按 ⌘K / Ctrl+K 并运行从文件创建 Artifact…。
- 选择一个或多个文件。
表格上方会显示正在添加的文件,以及每个文件的状态:“等待中(前面还有 2 个)”、正在转换…、正在压缩…或正在存储…。
- 等待,或继续工作。您可以关闭标签页。
文件处理完成后,Holarch 会通知您:“Design Review.docx 已作为 Artifact 就绪。”如果您没有打开任何 Holarch 标签页,该消息会通过电子邮件发送。
每个文件成为一个 Artifact,以不带扩展名的文件名命名。通知会说明存储大小,例如“存储为 2.1 MB,由 15 MB 压缩而来。”
上传新版本
- 打开该 Artifact。
- 在文件部分,点击上传新版本…并选择文件。
- 可以选择输入新版本的备注,例如“已处理设计评审中的评论”,然后点击作为新版本上传。
在新版本就绪之前,页面上会显示“新版本 Design Review.docx:正在转换…”。
当您添加的文件名称与已从同名文件创建的 Artifact 相同时,文件已在项目中会询问如何处理:
- 作为新版本上传(默认):该文件成为该 Artifact 的下一个版本。
- 保留两者:创建一个单独的 Artifact,其名称后加上“ (2)”。
- 取消:不添加任何内容。
评审和评论
- 打开该 Artifact。页面在文档查看器中显示 PDF:工具栏、页面以及旁边的评论面板。
- 使用工具栏浏览文档:第 3 页,共 12 页(输入页码并按 Enter)、上一页和下一页按钮、缩略图、缩放(适合宽度、适合页面或固定大小)以及查找(⌘F / Ctrl+F)。按键:← 和 → 翻页,Home 和 End 转到第一页和最后一页,+ 和 − 缩放。
- 可以用以下四种方式之一发表评论:
- 选择文字:在页面上选择词语(也可以复制它们),然后点击评论所选内容。这些词语会被突出显示。
- 点:点击页面上评论所属的位置。
- 框:拖动一个框圈住某个区域,例如一张图或一个表格。
- 评论页面:针对所显示页面整体的评论。
在面板中输入评论,然后点击添加评论(⌘Enter / Ctrl+Enter)。输入 @ 和姓名即可提及某人。
- 评论面板按页面顺序列出讨论串,编号与页面上的标记一致。点击讨论串可转到其位置;点击标记或突出显示可打开其讨论串。回复、解决和重新打开的用法与讨论中相同;显示已解决会显示已解决的讨论串。
- 如需更多空间,请点击审阅视图(版本占满整个窗口)或弹出(单独的窗口,例如在第二块屏幕上)。两者都会随他人评论而实时更新。
每条评论属于它所在的版本,讨论中也会显示,例如“在版本 2 第 3 页”。评论从不更改文件:已签名的 PDF 会保留其签名。
后续版本上的评论
添加新版本时,未解决的讨论串会移到新版本,因此评审可以跨版本继续:
- Holarch 会在新版本中查找每个讨论串的词语,即使它们移到了另一页或周围的文本重新排版。该讨论串会在那里显示,并标注来自版本 1(它所在的版本)。
- 当这些词语被编辑过时,讨论串还会标记文本此后已更改,并显示早期版本的内容,例如“版本 1 的内容:“reject 40 W””。
- 当这些词语已不存在时,讨论串会列在评论面板末尾的早期版本下,附有其引用的词语和在版本 1 上显示(包含这些词语的最后一个版本)。
- 点或框会跟随最近的一行文本。在没有文本的页面上(图纸或扫描件),如果该页面在新版本中看起来相同,它会停留在原处;否则会移到“早期版本”下。
- 已解决的讨论串保留在它们所在的版本上。重新打开一个讨论串,即可让它移到较新的版本。
- 添加于(在讨论串上方,当有来自多个版本的讨论串时显示)可只显示在某一版本上创建的讨论串,或显示全部。
- 来自 Word 的讨论串遵循相同的规则。
这在添加新版本时发生。包含此功能推出之前的评论的项目,会在首次显示较新版本时得到同样的处理。在讨论中,来自旧版本的评论会说明它现在的位置,例如“在版本 1 第 2 页,“radiator” · 已带到版本 3”或“· 不在版本 3 中”。
评论会保留其引用的词语,因此即使旧版本的文件被移除,仍然可以阅读。编辑过的评论会保留其早期文本:评论下方的早期文本列出每个早期措辞及其作者和时间。
基线会记录当时的文件版本及其评论讨论串。点击在基线中下的基线名称即可查看。
来自 Word 的评论和修订
在托管服务上,添加 Word 文件时会一并带入该文件自身的审阅标记:
- 其批注会成为 PDF 上的评论讨论串,位于批注所针对的词语上,并带有回复。每条都保留 Word 中的作者和日期,并标记为来自 Word。在 Word 中标记为已完成的批注会以已解决状态带入。
- 其修订会列为建议:“建议插入:…”或“建议删除:…”,署名为做出修订的人。
- PDF 在页边显示批注,并以红线显示修订。
上传后的通知会说明带入了哪些内容,例如“从 Word 带入了 3 条批注和 2 处修订。”导入的讨论串归您所有,因此您可以解决或删除它们。关注该条目的人不会因每条导入的评论而收到通知。
比较两个版本
- 打开该 Artifact。在文件部分,点击比较版本…(当 Artifact 有两个或更多版本时显示)。
- 选择较旧和较新的版本。默认将显示的版本与其前一个版本进行比较。
两个版本逐页并排显示:
- 已插入的词语在较新版本上显示为绿色。
- 已删除的词语在较旧版本上显示为红色。
- 已移动的句子和段落在两个位置均显示为紫色。移动后又被编辑的块还会显示其词语更改。更改列表会注明两个页面,例如“第 2 页 → 第 5 页”。
- 没有文本的页面(图纸、扫描件)按图片进行比较。有更改的页面会加上轮廓;在较新的页面上,差异以红色显示只有较旧版本有墨迹的地方,以绿色显示只有较新版本有墨迹的地方。
- 在列表中选择一项更改,或点击上一个和下一个(F7 和 Shift+F7),即可在两侧显示它。同步滚动会在您滚动时使相同的文本保持并排。
文本在整个文档范围内进行比较,因此移到另一页或重新排到其他行的文本仍能匹配。未经转换保存的 Word 文件按文本比较,不分页。长文档在读取时会显示进度条。
同样的比较也会在其他地方标记文本更改:变更请求评审、条目历史记录、文档更改和库差异都会将移动的句子显示为已移动,并在两个位置之间带有移至 / 移自链接。
实例:CubeSat EO-1 演示的设计评审
- 在 CubeSat EO-1 演示中,打开数据库,点击+ 新建条目,并用从 Word 或 PDF 文件创建 Artifact…添加“EO-1 CDR Package.docx”。
- 就绪后,打开 EO-1 CDR Package,并将其与它所涵盖的需求关联。
- 评审者打开它,并对第 12 页使用评论页面…:“Thermal margin table is missing the eclipse case.”
- 修复后,再次上传“EO-1 CDR Package.docx”并选择作为新版本上传,备注为“CDR comments addressed”。
- 创建基线。Artifact 页面会针对版本 2 显示在基线中及基线名称。
提示和良好做法
- 以相同的文件名上传每个新版本。这样一个 Artifact 就保存了完整的历史。
- 当版式必须与 Word 完全一致时,请上传 PDF 而不是 Word 文件:转换可能会移动换行位置。
- 已签名的 PDF、PDF 表单、PDF/A 文件和加密的 PDF 会完全按上传时的样子保存。压缩它们会破坏签名、表单或一致性。
常见错误
- 出现了第二个 Artifact:您选择了保留两者。删除它,然后再次上传该文件并选择作为新版本上传。
- 超过 100 MB 的 Word 文件被拒绝:在 Word 中选择“文件 → 另存为 → PDF”,然后上传该 PDF。
关联方式
- 评论和评审:固定评论是普通评论;回复、提及和审批的用法与任何条目相同。参见评论和评审。
- 基线:基线会记录每个文件 Artifact 当时的版本。参见变更请求。
- 存储:每个版本的 PDF 都计入项目和您的存储空间。参见附件、存储和限制。
文件部分
| 控件 | 功能 |
|---|---|
| 版本 | 显示一个版本:“版本 3(最新)· 日期 · 上传者”。文件已被移除的版本显示“文件已移除”。 |
| 下载(PDF) | 保存所显示版本的 PDF。未经转换显示的 Word 文件提供下载(.docx)。 |
| 恢复为最新 | 将所显示的版本作为新版本,使其重新成为最新版本。不会覆盖任何内容。仅限编辑者,不适用于最新版本。 |
| 上传新版本… | 添加下一个版本。仅限编辑者。 |
| 比较版本… | 两个版本并排显示,并标记插入、删除和移动的文本。参见“比较两个版本”。 |
| 移除旧版本的文件… | 删除所选旧版本的文件。见下文。 |
| 页面 / PDF 查看器 | 文档查看器(页面、查找、评论);或浏览器自带的 PDF 查看器(打印)。 |
| 审阅视图 / 弹出 | 文档查看器占满整个窗口,或在单独的窗口中显示。 |
| 评论页面… / 固定评论 | 在 Word 视图中(未经转换保存的 Word 文件):按页码对某页发表评论,或对您点击的段落发表评论。点击停止固定结束。PDF 使用查看器自身的工具(参见“评审和评论”)。 |
工具下方是该版本的信息:上传者(谁以及何时)、已上传的文件(其原始名称)、备注、已存储(大小和节省的空间)以及在基线中(点击基线名称可查看它记录的评论讨论串)。
移除旧版本的文件
旧版本的 PDF 会占用存储空间。移除不再需要的版本:
- 在该 Artifact 上,点击移除旧版本的文件…。
- 选择版本。
您会看到“永久移除版本 2 的文件。该版本仍保留在历史记录中。”
- 点击移除文件。
您会看到“已移除 1 个版本的文件(释放了 12.4 MB)。”
- 谁可以移除:个人方案上的账户持有人(项目所有者),Team 方案上的组织管理员。组织管理员无需拥有项目的编辑权限;移除操作会署上管理员的姓名。
- 最新版本不能以这种方式移除。要移除它,请删除该 Artifact。
- 该版本仍保留在列表中,标记为“文件已由 姓名 于 日期 移除”。其评论以文本形式保留在讨论中。
- 移除操作会记录在审计日志中,包括版本和释放的空间。
正在添加的文件
上传进行期间,数据库会显示正在添加的文件。
- 正在上传…:文件正在发送。取消会停止上传,不添加任何内容。
- 等待中(前面还有 n 个)或等待中(下一个):文件正在排队。取消会将其从队列中移除。
- 正在转换…、正在压缩…、正在存储…:文件正在处理中。
- 无法添加的文件会连同其消息留在列表中,直到您点击关闭。
如果服务器在转换过程中重启,文件会回到队列中并再尝试一次。
不进行转换
当服务器没有转换器时,文件按上传时的样子存储:
- PDF 存储时不压缩。
- Word 文件在浏览器中以只读方式显示:“在浏览器中以只读方式显示(此服务器不进行 PDF 转换)。版式可能与 Word 不同。”此时固定评论会将评论固定到段落。
消息
| 留言 | 应采取的行动 |
|---|---|
| “file 为 140 MB。超过 100 MB 的 Word 文件无法转换。在 Word 中选择“文件 → 另存为 → PDF”,然后上传该 PDF。” | 在 Word 中将文档另存为 PDF,然后上传该 PDF。 |
| “无法转换 file:该文件受密码保护。请移除密码后重新上传。” | 在 Word 中打开文件,移除打开密码,保存后重新上传。 |
| “无法转换 file:该文件已损坏或不是 Word 文档。” | 在 Word 中打开并保存该文件,或上传 PDF。 |
| “无法转换 file:耗时超过 5 分钟(文件非常大或非常复杂)。请将其拆分,或另存为 PDF 后上传该 PDF。” | 拆分文档,或在 Word 中将其另存为 PDF 后上传该 PDF。 |
| “无法转换 file:所需内存超过转换器的容量(大图片过多)。请减少图片或上传 PDF。” | 在 Word 中压缩图片(“图片格式 → 压缩图片”),或上传 PDF。 |
| “无法存储 file:该文件已损坏或不是 PDF。” | 从生成该 PDF 的程序中重新保存 PDF。 |
| “只有 Word 文档(.docx)和 PDF 可以成为 Artifact。未添加:files。” | 请先将其他格式另存为 .docx 或 PDF。 |
| 单文件限制消息 | 文件超过了您方案的单文件限制。对于 Word 文件,还会建议将其另存为 PDF。 |
文件无法添加时,不会保留任何内容:没有 Artifact、没有版本,且上传的内容会被删除。
限制
| 方案 | 每个文件 |
|---|---|
| Free / Academic | 10 MB |
| Individual | 25 MB |
| Team | 100 MB |
- 在任何方案上,超过 100 MB 的 Word 文件都无法转换。
- 单文件限制适用于您上传的文件。存储的 PDF 计入项目和您的存储空间。
- Word 和 PDF Artifact 可在 LML 项目中使用。