`docindex`: no way to create a collapsible-only (no target) TOC node; empty links open a directory listing in the web-based Help Browser

未关闭
#38 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
59/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
活跃
技术栈
matlab, xml

调研方向

Start by reading resources/helptoc.xsl and trace how docindex turns an empty Markdown link into a tocitem target. Check how the web-based Help Browser handles targetless nodes; the issue notes the Java-based behavior is unverified. Done when a section with children can expand and collapse without opening a directory listing or duplicating the child page’s selection and dropdown indicators.

由索引模型根据 Issue 内容生成。

描述

In helptoc.md, a section header that should only group child pages is usually written with an empty link:

* [Overview](Overview.md)
  * [Getting Started]()
    * [Setup](Setup.md)

docindex transforms this with resources/helptoc.xsl, which always emits target="{a/@href}":

<tocitem target="Overview.html">Overview
    <tocitem target="">Getting Started
        <tocitem target="Setup.html">Setup</tocitem>

The web-based Help Browser (default from 24b) handle target="" badly: clicking the node navigates to the doc folder itself and shows a directory listing. I think Java-based Help Browser rendered the same node as a collapsible folder, which is the desired behavior, but I haven't been able to verify this.

Current workaround: link each section header to its first child page, e.g.:

* [Overview](Overview.md)
  * [Getting Started](Setup.md)
    * [Setup](Setup.md)

This works by stopping the directory listing, but it has visible side effects in the web-based Help Browser:

  • Double selection highlight: when the page is open, the section header (Getting Started) and its first child (Setup) are both highlighted in blue, because they point to the same target.
  • Extra dropdown on the child: the first child (Setup) now shows an expand/collapse dropdown arrow, as though it had children of its own. It's a leaf page.
  • The header is no longer a pure folder: clicking it opens a page instead of just expanding or collapsing.

See the screenshot below showing this result after the workaround:
Screenshot_AfterWorkaround

主要语言
MATLAB
星标
10
派生
3
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

mathworks/docmaker 的其他 Issue

查看 mathworks/docmaker 的全部 Issue

相似的 Issue

更多 MATLAB Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。