Skip to content

本页来源

核查在线手册引用的素材是否齐全的结论:素材齐全,但有 423 处引用路径错误导致在线破图

内容同步自知识库:10-软件知识\知识沉淀\概念\Tagetik 官方用户手册-素材完整性核查.md


Tagetik 官方用户手册 · 素材完整性核查

任务:核查在线帮助文档(/tagetikcpm/static/man/en/...)引用的参考资料、附件与素材是否在 EAR 应用包中齐全。

结论素材齐全,但引用路径有 423 处错误 —— 即"文件都在包里"(423/423 实际路径可访问),但"文档里写的路径是错的"(423/423 引用路径 404 → 在线破图)。 这不是素材缺失问题,是文档打包的路径一致性缺陷


一、文档源定位

1.1 在线 URL ↔ 包内路径(完全对应)

在线地址 EAR 包内位置
/tagetikcpm/static/man/en/Content/_comm/LP.htm gsw_ef.war → WEB-INF/lib/tgk-user-manual-5.3.36-6.jar → META-INF/resources/static/man/en/Content/_comm/LP.htm

判定依据gsw_ef/ 展开目录里没有 static/man;war 里也没有。 真正的源在 tgk-user-manual-5.3.36-6.jar(113.4 MB / 13842 条目), 被 war 以 META-INF/resources/ 形式打包(Servlet 3.0 静态资源约定),运行时映射到 /static/

1.2 包内结构

手册 jar tgk-user-manual-5.3.36-6.jar(113.4 MB,13842 条目)
语言 en / fr / it / jp(4 套)
en 文件数 2796(其中 .htm/.html 2162.css 30)
文件类型 htm 6588 · png 3282 · js 2415 · css 116 · html 283 · jpg 24 · svg 23 · gif 12 · 字体 24
生成工具 MadCap Flare(存在 .mcwebhelp / .flpgl
另一套帮助 gsd_efhelp-5.3.36.549.tgk.jar(8.4 MB,help/EN|FR|IT 共 3957 个 .html)——产品内嵌帮助,与在线手册是两套

二、比对结果(三类)

2.1 方法

  1. 解析 jar 内 en 全部 2162 个 .htm + 30 个 .css,提取 src/href/poster/url() 等引用;
  2. 引用解析规则覆盖三种形态:① /tagetikcpm/... 站点绝对 ② static/man/en/... 根相对../../ 真相对; HTML 实体(&)与 URL 编码先解码;
  3. 逐条检查目标是否在包内存在(大小写不敏感索引);
  4. 对"不一致"项再按文件名全局模糊匹配区分"真缺失"与"路径差异";
  5. 用 Playwright(登录态)在线实测引用路径与实际路径的 HTTP 可达性。

2.2 ⬛ 已存在(正常)

数量
引用总数(按属性计) 100,371
唯一引用目标 3,694
包内命中 3,261
在线首页 LP.htm 图片加载 19/19 成功

主体素材(文档页 2162 个、样式脚本、皮肤、导航、术语表、目录树、搜索索引)全部齐备

2.3 ⬛ 缺失(真缺失)

真缺失 7 项,其中仅 1 项是真资源

# 路径 性质 影响
1 static/man/en/Resources/Scripts/PIE-no-motw.htc IE 专用(CSS3 PIE 兼容库) 无影响(IE 已淘汰,现代浏览器不加载)
2 .../Concept/Sales 正文文本被误判
3 .../Concept/SalesData 正文文本被误判
4 .../Primitives/Sales 正文文本被误判
5 .../Primitives/SalesData 正文文本被误判
6 static/man/en/document.location.href JS 代码字符串被误判
7 .../MasterPages/Masterpage_index.flmsp MadCap 源工程文件(不随发布包分发)

结论无功能性缺失

2.4 ⬛ 存疑 → 实测定性为「引用路径错误」

423 处:引用的文件在包内存在(实际路径 200),但引用写错了路径(引用路径 404)。

在线实测(决定性证据)

检查 结果
423 个引用路径 在线 HTTP 全部 404(0 个 200)
423 个实际路径 在线 HTTP 全部 200(423/423)

⇒ 定性:不是素材缺失,是文档引用路径错误,导致在线破图。

破图按目录聚合(TOP)

数量 目录 说明
349 Content/Resources/Images/SCP/ 最大头:供应链模块图片;实际位于共享目录 static/man/Resources/Images/SCP/(不带语言段)
28 Skins/Default/Stylesheets/Components/Skins/Default/Stylesheets/Components/Images/ 路径段重复叠加Skins/.../Components/ 出现两次)→ MadCap 相对路径解析 bug
11 Skins/Fluid/Stylesheets/Skins/Fluid/Stylesheets/Images/ 同上
8 Skins/Default/Stylesheets/Images/ 皮肤图标,实际在 .../Default/Stylesheets/Components/Images/
8 Content/Resources/Images/LP/ 首页图标
8 Content/Resources/Images/__std/css/ 样式图片
4 Content/Resources/Images/Modernization/
2 Content/Resources/Images/LP_Topicons/ 主题图标
1 Content/Diagnostico/Esecuz/DIA_FinEseProcMD_r.htm 仅 en 缺,it 语言有

另有全局性 404(每页均出现)

static/man/en/Content/Resources/Images/LP_Topicons/skin_searchIcon.png   → 404

(皮肤搜索图标,所有页面都引用,均 404 —— 属皮肤配置缺陷。)

2.5 根因判断

现象 根因
349 个 SCP 图片 404 MadCap 工程里图片放在「共享/公共资源」区,生成时引用写成语言目录相对路径en/Content/Resources/...),但打包后共享资源被归到 static/man/Resources/...无语言段
47 处 Skins/…/Components/ 路径段重复 CSS 内相对 url()二次解析,路径段叠加
皮肤图标指向 Images/ 而非 Components/Images/ 皮肤配置与产物目录结构不一致

性质文档打包/发布的路径一致性缺陷,非素材丢失,不影响 Tagetik 功能,仅影响帮助文档显示。


三、核查用工具(可复用)

脚本 作用
scan_war.py 列 war 清单,定位 static/manhelp/manual 相关 jar
scan_helpjar.py 列手册 jar 的语言/类型/目录分布,定位 LP.htm
check_man_refs.py 核心:解析全部 htm/css 的引用 → 存在性检查 → 真缺失/路径差异/文本误判三分 → 落盘 missing_list.txt
tk_web_man.js 在线打开指定页面,检查 img 加载状态与 HTTP 失败
tk_man_verify.js 批量验证引用路径 vs 实际路径的在线可达性 → broken_images.txt
man_export.py 导出 Glossary 405 条术语 → Markdown
man_toc_export.py 导出 FullToc 2566 条目 目录树 → Markdown

四、沉淀成果

4.1 已落位知识库

页面 内容
Tagetik 官方用户手册-术语表Glossary 405 条官方术语定义(跨项目通用,可用于口径对齐)
Tagetik 官方用户手册-目录总览 2566 条目 / 13 章节完整目录树(用于按主题定位官方文档)

手册 13 个顶层章节(条目数):

章节 条目
Platform Management 851
Extended Planning 401
Reporting & Data Visualization 379
Data Entry 252
Financial Close & Consolidation 227
Data Integration 204
Intelligent Disclosure 155
Getting Started 37
What's New / This manual / Using Search / Glossary 0(单页)

4.2 术语表校验价值示例

官方术语表可直接校验我们既有认知:

AIH (Analytic Information Hub): "One of two customizable workspaces of CCH Tagetik primarily utilized for analysis purposes. It provides access to an unlimited number of dimensions and custom data tables... It is structured into Analytical Workspaces (AWs), serving as containers to define customized data models."

tagetik-app-anatomy skill 的 FW/AW 机制完全一致("两种工作区"= FW + AIH;AW 是 AIH 下的容器)。

4.3 对 skill 的强化(已执行)

在各 skill 中新增「官方手册参照」定位区,把"在线文档 + 包内 jar + 术语表 + 目录树"变成可查的权威来源, 使机制类问题能先定位官方章节再取原文,而不是只靠实测推断。见 §4.4 清单。

4.4 手册按 skill 主题的映射(导航用)

skill 对应官方章节
tagetik-app-anatomy Platform Management(851)中的 Workspace / Dimension / Data Model 相关;Glossary 术语
tagetik-report-deepdive Reporting & Data Visualization(379)—— 报表定义/函数/表单
tagetik-web-report 同上 + Data Entry(252)—— 表单录入与运行
tagetik-migration-tools Platform Management 中的环境/迁移相关
epm-db-explorer Platform Management 中的数据模型与系统管理
(Report Bursting / 调度) 独立模块(9 页)+ Platform Management
(接口/ETL) Data Integration(204)

五、结论与建议

5.1 核查结论

类别 结果
已存在 3261 / 3694(88%) 引用目标命中;文档主体、样式、脚本、皮肤、术语表、目录、搜索索引齐全
缺失 7 项,其中仅 1 项为真资源(IE 专用 .htc无影响
存疑 423 项 → 实测定性为「引用路径错误」(文件在包内且可访问,是文档写错路径 → 在线破图)

总体判定:素材完整性 ✅ 通过;引用路径正确性 ⚠️ 有 423 处缺陷(不影响 Tagetik 功能,仅影响帮助显示)。

5.2 建议

  1. 不必补素材 —— 423 个文件都在包里、也能在线访问,无需从别处获取
  2. 若要修复破图,两个方向:
  3. 服务端重写:为 /static/man/en/Content/Resources/Images/** 增加 fallback 到 /static/man/Resources/Images/**(可一次性解决 349 个 SCP 破图);
  4. 或忽略 —— 破图集中在 SCP(供应链)与皮肤图标,海油项目用不到 SCP 模块。
  5. 向上游反馈:路径段重复叠加(47 处)属 MadCap 生成缺陷,可在升级到新 SP 时观察是否修复。
  6. 本核查可复用于其他 SP 版本 —— 换 jar 路径即可重跑 check_man_refs.py