@ggboy123/dsh-paper-reader 0.1.1 → 0.2.0

package/README.md

@@ -4,9 +4,15 @@
 
 功能迁移自本地独立产品 pdfqa（Go 实现的论文伴读工具）。原则：agent 循环 / 模型层 / 会话持久化全部交给 dsh 框架，插件只做「转录 + 检索 + 阅读器 UI」的薄壳组合。
 
+**安装后不改动官方界面** —— 侧栏底部多一行「📚 论文伴读」开关，点击才进入伴读模式（左侧变为文献库树），再点即还原官方工作区列表：
+
+![默认安装：官方侧栏原样，只多一行开关](https://raw.githubusercontent.com/GGboya/dsh-paper-reader/main/docs/screenshot-default.png)
+
+![伴读模式：文献库 + PDF 阅读器 + 原生对话](https://raw.githubusercontent.com/GGboya/dsh-paper-reader/main/docs/screenshot-reading.png)
+
 ## 功能
 
-- 📚 **侧栏文献库树**：接管工作区侧栏，专题 → 论文两级；支持新建专题、上传 PDF
+- 📚 **侧栏文献库树**：「论文伴读」模式开启时接管工作区侧栏，专题 → 论文两级；支持新建专题、上传 PDF（默认关闭，不覆盖官方界面）
 - 💬 **原生对话伴读**：点击论文即在右侧打开它的 dsh 原生会话（流式 / 工具卡 / 用量条全是官方 UI）；默认只呈现当前对话，对话列头部的 🕐 下拉回看**历史对话**（真实标题+日期，点哪条进哪条），＋ 新建对话
 - 🔗 **会话绑定论文**：会话 id 编码文献身份，工具调用自动定位当前论文——直接在输入框提问无需点名论文，回答必带页码
 - 🤖 **专用 agent preset「论文伴读」**：paper 会话自动使用专用 preset —— 像老师一样带读：制定分步阅读计划（每步带页码和思考题）→ 逐节指导、点评 → 出题检验、逐题批改 → 成绩与薄弱点记入 `<文献>.study.json` 学习档案，跨会话累积；快速问答（选中即问）则直接回答，不上课
@@ -50,7 +56,7 @@ dsh --profile web                                  # 侧栏变为文献库树
 > 上面的 `translate` 配置退为**部署方默认值**，仅当 UI 未配置时生效。babeldoc 只支持 OpenAI 协议端点，
 > Anthropic 协议的端点（如 `api.kimi.com/coding/`）不能直连。
 
-⚠️ 本插件按「论文伴读专用 profile」设计：侧栏的 `sidebar.workspaces` 被文献库树接管，官方工作区/会话列表在该 profile 侧栏不可见（从 `cordis.patch.yml` 删掉本插件即恢复）。
+> 伴读模式是**按需开启**的：默认不注册 `sidebar.workspaces`（官方工作区/会话列表原样），侧栏底部「📚 论文伴读」开关点击才接管，再点还原；模式选择记在 localStorage。退出模式时已打开的 PDF 页签和伴读会话不受影响。
 
 ## 架构
 

package/lib/client.js

@@ -7,9 +7,9 @@
 //     列钉到 grid 第 2 轨（宽轨=阅读器），center 列自动流入第 3 轨（窄轨=对话）。
 //     纯 CSS grid 放置技巧：JS 只维护 grid-template-columns 的列宽（宽轨给 PDF、
 //     窄轨给对话，正是想要的比例），内容换列不影响拖拽手柄/全屏/折叠逻辑。
-//   - sidebar.workspaces single slot 按 priority -1000 接管（lowest renders）——
-//     ⚠️ 官方工作区/会话列表在本 profile 侧栏不可见；本插件面向论文伴读专用 profile，
-//     从 cordis.patch.yml 删掉本插件即恢复官方工作区。
+//   - sidebar.workspaces single slot 按 priority -1000 接管（lowest renders）——但**按需**：
+//     「论文伴读模式」默认关闭，侧栏底部 footer.action 开关行点击才注册（再点注销，
+//     还原官方工作区列表），localStorage 记忆。安装后官方侧栏原样，只多一行开关。
 //   - 选中即问：阅读器内选中 → /api/ask 注入当前会话 → 原生对话区实时流出。
 //
 // 加载机制：package.json 声明 dsh.client.inject + exports["./client"]；require 解析
@@ -32,6 +32,7 @@ window.__ModuleLoader__.load({
       upload: '上传 PDF 到此专题', newChat: '新建对话', session: '会话', pdfTab: '论文 PDF',
       history: '历史对话',
       sync: '对话还停在另一篇文献的会话里，点击切到当前文献',
+      mode: '论文伴读', modeEnterTip: '进入论文伴读：左侧变为文献库树', modeExitTip: '退出论文伴读：恢复官方工作区列表',
     }
     const en = {
       library: 'Library',
@@ -39,6 +40,7 @@ window.__ModuleLoader__.load({
       upload: 'Upload PDF into this topic', newChat: 'New chat', session: 'Session', pdfTab: 'Paper PDF',
       history: 'Chat history',
       sync: 'Chat is still on another paper — click to switch to the current one',
+      mode: 'Paper Reading', modeEnterTip: 'Enter paper-reading mode: sidebar becomes the library tree', modeExitTip: 'Exit paper-reading mode: restore the official workspace list',
     }
 
     let t = (k) => k
@@ -654,16 +656,65 @@ window.__ModuleLoader__.load({
           )
 
       return h('div', { style: S.root, 'data-dsh-plugin': 'dsh-paper-reader', 'data-dsh-surface': 'sidebar' },
-        // 常驻阅读器 iframe（覆盖在 PDF 页签的锚点上；不随会话重建）
-        h(ReaderOverlay, null),
-        // 对话列头部的历史/新建浮动按钮组（自渲染，不占树）
-        h(SessionActions, { uiWorkspace }),
         h('input', { ref: fileInput, type: 'file', accept: '.pdf', style: { display: 'none' }, onChange: onFile }),
-        // 阅读器和浮动按钮都不属于侧栏，收起侧栏时照常挂载；只换掉树本身
+        // 阅读器 iframe 与对话头部按钮组已迁往 shell.overlay 常驻注册（见 applyPaperMode 下方）——
+        // 它们不属于侧栏，更不能跟着「退出伴读模式」被卸载（已打开的 PDF 页签要继续活着）
         tree,
       )
     }
 
+    /* ---------- 论文伴读模式：默认不接管侧栏 ----------
+       sidebar.workspaces 是 single slot，注册即遮蔽官方工作区列表——「一装就覆盖」
+       对用户不礼貌。改为按需注册：默认不注册（官方侧栏原样），sidebar.footer.action
+       （list slot，侧栏底部常驻）放一个开关行，点击注册/注销文献库树，localStorage 记忆。
+       阅读器悬浮层/会话按钮组走 shell.overlay 常驻注册，与本开关无关——退出模式时
+       已打开的 PDF 页签和伴读会话照常工作，随时可切回。 */
+    let paperMode = localStorage.getItem('dpr.mode') === 'paper'
+    let disposeLibrarySlot = null
+    let clientApi = null // apply() 里注入 { slots, layout, uiWorkspace, sidebarRight }
+
+    function applyPaperMode(on) {
+      paperMode = on
+      try { localStorage.setItem('dpr.mode', on ? 'paper' : '') } catch { /* 隐私模式写不了就算了 */ }
+      if (!clientApi) return
+      if (on && !disposeLibrarySlot) {
+        clientApi.slots.inject('sidebar.workspaces', () => {
+          disposeLibrarySlot = clientApi.slots.register({
+            name: 'sidebar.workspaces', priority: -1000, locale: NS,
+          }, function LibrarySection(slot) {
+            return h(LibraryTree, {
+              layout: clientApi.layout, uiWorkspace: clientApi.uiWorkspace,
+              sidebarRight: clientApi.sidebarRight,
+              wide: slot?.wide, expandSidebar: slot?.expandSidebar,
+            })
+          })
+        })
+      } else if (!on && disposeLibrarySlot) {
+        disposeLibrarySlot()
+        disposeLibrarySlot = null
+      }
+    }
+
+    const MODE = {
+      // 展开态：对齐官方 panelRow（36px 高、radius 8、hover 官方交互色）
+      wide: { display: 'flex', alignItems: 'center', gap: '8px', width: '100%', minHeight: '36px', padding: '7px 8px', borderRadius: '8px', border: 'none', background: 'none', cursor: 'pointer', font: 'inherit', textAlign: 'left', color: 'var(--dsw-alias-label-secondary, #656d76)' },
+      wideOn: { background: 'var(--dsw-alias-interactive-bg-active, rgba(9,105,218,.12))', color: 'var(--dsw-alias-label-primary, #24292f)', fontWeight: 600 },
+      // 收起态（rail）：36×36 圆形图标钮，对齐官方 rail 控件
+      rail: { width: '36px', height: '36px', display: 'inline-flex', alignItems: 'center', justifyContent: 'center', borderRadius: '50%', border: 'none', background: 'none', cursor: 'pointer', font: 'inherit', color: 'var(--dsw-alias-label-primary, #24292f)' },
+    }
+
+    function PaperModeToggle(props) {
+      const wide = props?.wide !== false
+      const [on, setOn] = useState(paperMode)
+      return h('button', {
+        type: 'button', 'data-dsh-plugin': 'dsh-paper-reader', 'data-dsh-surface': 'paper-mode', 'data-dpr-mode': '',
+        title: on ? t('modeExitTip') : t('modeEnterTip'),
+        'aria-pressed': on ? 'true' : 'false',
+        style: { ...(wide ? MODE.wide : MODE.rail), ...(on && wide ? MODE.wideOn : {}) },
+        onClick: () => { applyPaperMode(!paperMode); setOn(paperMode) },
+      }, wide ? h(React.Fragment, null, '📚', h('span', null, t('mode'))) : '📚')
+    }
+
     return {
       inject: ['slots', 'locale', 'layout', 'uiWorkspace', 'sidebarRight', 'sidebarRightTabs'],
       apply(ctx) {
@@ -687,7 +738,7 @@ window.__ModuleLoader__.load({
           if (!document.getElementById('dpr-surface-css')) {
             const styleEl = document.createElement('style')
             styleEl.id = 'dpr-surface-css'
-            styleEl.textContent = '[data-dpr-rail]:hover{background:var(--dsw-alias-interactive-bg-hover)!important}'
+            styleEl.textContent = '[data-dpr-rail]:hover,[data-dpr-mode]:hover{background:var(--dsw-alias-interactive-bg-hover)!important}'
             document.head.appendChild(styleEl)
           }
 
@@ -699,20 +750,28 @@ window.__ModuleLoader__.load({
             name: 'sidebar.right.pane.tab', key: 'dpr-reader', locale: NS,
           }, PdfTab))
 
-          // （对话头部的历史/新建按钮不走 slot —— session 作用域 slot 不渲染动态包条目；
-          //   SessionActions 由 LibraryTree 挂载，见下）
-
-          // 侧栏中部：专题→论文→会话 树。
-          // 槽传 { wide, expandSidebar }：收起成 rail 时 wide=false，注册方必须自己给一个
-          // 图标入口（官方 WorkspaceBrowser 同款契约）——否则整棵树被塞进 56px 挤成竖排文字。
-          ctx.slots.inject('sidebar.workspaces', () => ctx.slots.register({
-            name: 'sidebar.workspaces', priority: -1000, locale: NS,
-          }, function LibrarySection(slot) {
-            return h(LibraryTree, {
-              layout: ctx.layout, uiWorkspace: ctx.uiWorkspace, sidebarRight: ctx.sidebarRight,
-              wide: slot?.wide, expandSidebar: slot?.expandSidebar,
-            })
+          clientApi = { slots: ctx.slots, layout: ctx.layout, uiWorkspace: ctx.uiWorkspace, sidebarRight: ctx.sidebarRight }
+
+          // 常驻浮层（与模式开关无关）：阅读器 iframe + 对话头部历史/新建按钮组。
+          // shell.overlay 是官方钦定的整页浮层自留地（list slot，additive，不遮蔽任何人）。
+          // （对话头部按钮不走 slot —— session 作用域 slot 不渲染动态包条目，只能自渲染。）
+          ctx.slots.inject('shell.overlay', () => ctx.slots.register({
+            name: 'shell.overlay', id: 'dpr-paper-overlays', locale: NS,
+          }, function PaperOverlays() {
+            return h(React.Fragment, null,
+              h(ReaderOverlay, null),
+              h(SessionActions, { uiWorkspace: clientApi?.uiWorkspace }),
+            )
           }))
+
+          // 侧栏底部常驻的模式开关行（list slot）——安装后官方侧栏原样，只是底部多一行
+          // 「论文伴读」；点它才接管 workspaces 区，再点还原。
+          ctx.slots.inject('sidebar.footer.action', () => ctx.slots.register({
+            name: 'sidebar.footer.action', id: 'dpr-paper-mode', locale: NS,
+          }, PaperModeToggle))
+
+          // 上次会话开过伴读模式的话恢复（默认/首次安装 = 关 = 官方侧栏）
+          if (paperMode) applyPaperMode(true)
         } catch (e) {
           console.error('[dsh-paper-reader] client apply failed:', e)
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ggboy123/dsh-paper-reader",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "DeepSeek Harness 插件：论文伴读工作台 — PDF 转录 / 检索 / 原生对话伴读 + 内置阅读器页面。",
   "license": "MIT",
   "type": "module",