Parcourir la source

修正文档中的过时配置说明

zhangyan il y a 6 jours
Parent
commit
5236719035

+ 3 - 2
doc/config/全局规则与配置维度清单.md

@@ -203,9 +203,9 @@
 | 自动弹窗开关 | `playfield.controlOverrides.<key>.autoPopup` | 完成点位后是否自动弹内容 | `true` `false` | 最小模板默认 `false` |
 | 自动内容仅一次 | `playfield.controlOverrides.<key>.once` | 本局是否只自动展示一次 | `true` `false` | `false` |
 | 内容承载方式 | `playfield.controlOverrides.<key>.contentExperience.type` | 自动内容使用原生还是 H5 | `native` `h5` | 当前按点位配置 |
-| 内容展示形态 | `playfield.controlOverrides.<key>.contentExperience.presentation` | H5 内容如何呈现 | `sheet` `dialog` `fullscreen` | `sheet` |
+| 内容展示形态 | `playfield.controlOverrides.<key>.contentExperience.presentation` | H5 内容如何呈现 | 运行建议 `fullscreen`;兼容历史值 `sheet` `dialog` | `fullscreen` |
 | 点击承载方式 | `playfield.controlOverrides.<key>.clickExperience.type` | 点击点位时使用原生还是 H5 | `native` `h5` | 当前按点位配置 |
-| 点击展示形态 | `playfield.controlOverrides.<key>.clickExperience.presentation` | 点击 H5 如何呈现 | `sheet` `dialog` `fullscreen` | `sheet` |
+| 点击展示形态 | `playfield.controlOverrides.<key>.clickExperience.presentation` | 点击 H5 如何呈现 | 运行建议 `fullscreen`;兼容历史值 `sheet` `dialog` | `fullscreen` |
 
 说明:
 
@@ -214,6 +214,7 @@
 - 点击内容能力改为显式配置能力;只有配置了 `clickTitle` / `clickBody` / `clickExperience` 之一时,点击点位才会产生内容反馈。
 - 完成后自动弹白卡也改为显式配置能力;只有明确开启 `autoPopup = true` 时,完成点位后才会弹出白色内容卡。
 - 点击详情卡片当前默认不展示 H5 详情按钮,但 `clickExperience` 和 CTA 能力保留。
+- 当前真机约束下,`web-view` 不再承担局部弹窗职责;原生内容卡负责即时弹出,H5 详情统一按整页承载。
 - 连续点击不同检查点时,新的点击卡片会直接替换当前卡片,不进入手动关闭队列。
 - 黑色顶部提示条只承担操作引导,不承载点位内容或结果信息。
 - 当白色内容卡、答题卡或结果页出现时,黑色顶部提示条默认让位,不与内容层抢注意力。

+ 10 - 7
doc/config/当前最全配置模板.md

@@ -85,13 +85,13 @@
           "type": "h5",
           "url": "https://example.com/content/start-1",
           "bridge": "content-v1",
-          "presentation": "dialog"
+          "presentation": "fullscreen"
         },
         "clickExperience": {
           "type": "h5",
           "url": "https://example.com/content/start-1-click",
           "bridge": "content-v1",
-          "presentation": "dialog"
+          "presentation": "fullscreen"
         }
       },
       "control-1": {
@@ -108,13 +108,13 @@
           "type": "h5",
           "url": "https://example.com/content/control-1",
           "bridge": "content-v1",
-          "presentation": "dialog"
+          "presentation": "fullscreen"
         },
         "clickExperience": {
           "type": "h5",
           "url": "https://example.com/content/control-1-click",
           "bridge": "content-v1",
-          "presentation": "dialog"
+          "presentation": "fullscreen"
         }
       },
       "control-2": {
@@ -140,7 +140,7 @@
           "type": "h5",
           "url": "https://example.com/content/finish-1-click",
           "bridge": "content-v1",
-          "presentation": "dialog"
+          "presentation": "fullscreen"
         }
       }
     },
@@ -487,9 +487,12 @@
 
 - 类型:`string`
 - 说明:H5 内容页展示形态
-- 当前支持值:
-  - `dialog`
+- 当前运行建议:
   - `fullscreen`
+- 兼容历史值:
+  - `dialog`
+  - `sheet`
+- 备注:经过真机验证,`web-view` 不再承担局部弹窗职责;当前应按“原生内容卡 + H5 全屏详情页/任务页”理解。
 
 #### `clickExperience`
 

+ 8 - 3
doc/config/配置发布说明.md

@@ -1,10 +1,15 @@
 # 配置发布说明
 
-本文档说明当前项目如何把 `event/*.json` 配置同步到服务器。
+本文档说明当前项目如何把 `event/*.json` 样例配置同步到服务器。
+
+注意:
+
+- 这里描述的是样例配置发布链,用于本地开发、模拟器测试、样例玩法联调。
+- 正式前后端联调时,小程序应以 backend `launch` 返回的 `manifestUrl` 为准,而不是直接把根目录 `event/*.json` 当作正式配置入口。
 
 ## 1. 当前发布链路
 
-当前客户端直接读取 OSS 上的静态配置:
+当前样例配置会发布到 OSS,供样例玩法和调试链路使用
 
 - `classic-sequential`
   - 远端对象:`gotomars/event/classic-sequential.json`
@@ -13,7 +18,7 @@
   - 远端对象:`gotomars/event/score-o.json`
   - 访问地址:`https://oss-mbh5.colormaprun.com/gotomars/event/score-o.json`
 
-对应加载入口见:
+对应样例加载入口见:
 
 - [map.ts](D:/dev/cmr-mini/miniprogram/pages/map/map.ts)
 

+ 5 - 0
doc/config/配置文档索引.md

@@ -50,6 +50,11 @@
 5. 对应玩法目录下的最小配置模板、最大配置模板、全局配置项、游戏配置项
 6. 对应 `event/*.json` 样例
 
+补充约定:
+
+- `event/*.json` 主要用于样例配置、模拟器测试和手动发布链。
+- 正式前后端联调时,小程序应优先以 backend `launch` 返回的 `manifestUrl` 为准。
+
 ## 4. 维护约定
 
 后续每次新增玩法或新增字段时,建议至少同步这几处:

+ 14 - 10
doc/config/配置选项字典.md

@@ -359,11 +359,13 @@
 
 - 类型:`string`
 - 说明:H5 内容的展示形态
-- 当前支持:
+- 当前运行建议:
+  - `fullscreen`
+- 兼容历史值:
   - `sheet`
   - `dialog`
-  - `fullscreen`
-- 建议默认值:`sheet`
+- 建议默认值:`fullscreen`
+- 备注:经过真机验证,`web-view` 不再承担局部弹窗职责;当前应按“原生内容卡 + H5 全屏详情页/任务页”理解。
 
 #### `clickExperience`
 
@@ -396,6 +398,13 @@
 
 - 类型:`string`
 - 说明:点击内容的展示形态
+- 当前运行建议:
+  - `fullscreen`
+- 兼容历史值:
+  - `sheet`
+  - `dialog`
+- 建议默认值:`fullscreen`
+- 备注:点击详情页当前统一按整页 H5 处理,不再把 `web-view` 作为局部弹窗承载。
 
 #### `pointStyle`
 
@@ -451,11 +460,6 @@
 - 类型:`string`
 - 说明:单个控制点编号文字颜色覆盖,例如 `#ffffff`
 - 备注:未配置时回退到样式系统默认标签颜色逻辑
-- 当前支持:
-  - `sheet`
-  - `dialog`
-  - `fullscreen`
-- 建议默认值:`sheet`
 
 ### 6.3 示例
 
@@ -485,13 +489,13 @@
       "type": "h5",
       "url": "https://example.com/content/control-2",
       "bridge": "content-v1",
-      "presentation": "sheet"
+      "presentation": "fullscreen"
     },
     "clickExperience": {
       "type": "h5",
       "url": "https://example.com/content/control-2-click",
       "bridge": "content-v1",
-      "presentation": "dialog"
+      "presentation": "fullscreen"
     }
   },
   "finish-1": {