TOC in webpub should be converted to <nav epub:type="toc"> in EPUB output

[MurakamiShinyu]

文書内に <nav role="doc-toc"> などのマークアップで目次を入れることで、Vivliostyle Viewer の目次メニューや出力したPDFの「しおり」には目次ができるのに、EPUB出力ではそれがEPUBの目次にならないという問題があります。

例：
https://github.com/MurakamiShinyu/shokubutsu_ichinichi/blob/main/shokubutsu_ichinichi.html

これを Vivliostyle CLI で EPUB に変換します。

vivliostyle build shokubutsu_ichinichi.html -o shokubutsu_ichinichi.epub

このEPUBをEPUB閲覧アプリ（Apple Books、Kindle Previewerなど）で開くと、目次メニューにタイトル「植物一日一題」以外に目次項目が表示されません。

EPUBの中のXHTMLファイル shokubutsu_ichinichi.xhtml を見てみると、元のHTMLファイルにあった <nav class="toc" role="doc-toc"> とは別に、次のようにEPUB用の目次がbody要素の終わりに追加されています：

  <nav epub:type="landmarks" id="landmarks" hidden="">
    <ol>
      <li><a epub:type="toc" href="shokubutsu_ichinichi.xhtml#toc">Table of Contents</a></li>
    </ol>
  </nav>
  <nav id="toc" role="doc-toc" epub:type="toc" hidden="">
    <ol>
      <li><a href="shokubutsu_ichinichi.xhtml">植物一日一題</a></li>
    </ol>
  </nav>
</body>
</html>

このように、本のタイトルだけがEPUBでの目次項目になっています。また、次の問題もあります：

• landmarks項目での目次へのリンク先は文書内の目次ページであるべきなのに、hidden 属性で非表示になっているEPUB用の nav 要素になっている。これでは目次ページにジャンプしようとしても文書の最後のページにジャンプするだけとなる。

修正の提案

以下ように修正するとよいと思います：

• 元の文書内にEPUB用の目次 <nav epub:type="…"> がある場合はそれをそのまま活かし、別のnav要素を追加しない。
  • epub:type属性の値は "toc", "landmarks", "page-list" に限らず何でも有効とする (See: https://www.w3.org/TR/epub-33/#sec-nav-def-types-other)
• EPUB用ではない目次（<nav role="doc-toc"> など）が元の文書内にあれば、その内容を使ってEPUB用の目次 <nav epub:type="toc"> を作る。
  • サポートする必要がある目次の形式については、Publication Manifest仕様のMachine-Processable Table of Contentsを参照。
  • 目次要素の検出については Vivliostyle.jsの findTocElements() の処理（最近 Improve TOC handling vivliostyle.js#1259 と fix: All <nav epub:type="…"> elements in EPUB navigation doc should be shown in TOC box vivliostyle.js#1271 で修正したもの）を参考に。その要約：
    • EPUB用の目次（<nav epub:type="…">）があれば、それを使う。それがなくて、webpub用の目次（属性 role="doc-toc" 付きの要素）があれば、それを使う。どちらもない場合には、セレクタ nav,.toc,#toc,#table-of-contents,#contents,[role=directory] で見つかる要素を使う。
  • EPUB用の目次の仕様ではリストの要素として <ol> しか認められていないが、webpub用の目次では <ol>, <ul> とも有効なので、EPUB用の目次に変換するには <ul> を <ol> に変える必要がある。
    • このような要素の変更が必要なため、元の HTML の <nav role="doc-toc"> に epub:type="toc" を追加するのではなく、<nav epub:type="toc"> を別の要素として作る必要がある。本の内容として表示する文書（EPUBのspine項目）にそれを入れる場合には、hidden 属性が必要。（EPUB用目次を別のXHTMLファイルに生成して、spine項目にはしない場合には hidden 属性はなくてよい）
• <nav epub:type="landmarks"> で目次へのリンクを出力する場合、そのリンク先は文書内に元からある目次の要素（hidden 属性なし）とする。
• <nav epub:type="landmarks"> は <nav epub:type="toc"> のあとに出力したほうがよい。Vivliostyle ViewerでTOC Boxで出現順に表示される。Landmarksよりも目次が最初にあるほうが便利。
• 各 <nav epub:type="…"> 要素内に見出しがあったほうがよい。例： <h2>Table of Contents</h2>、<h2>Landmarks</h2>。

参考：Vivliostyle.jsで最近行った目次の扱いの修正について

• Vivliostyle.jsの最新版 v2.27.0 でつぎのように目次の扱いを修正しました：
  • pub-manifest の resources にある目次文書（"rel": "contents"）が readingOrder の最後にあるかのように組版結果に入ってしまうバグを修正しました。これで、EPUBでのspine項目にはしない目次文書と同じ扱いになりました。(See: HTML documents listed in "resources" in pub-manifest should not be rendered as if in "readingOrder" vivliostyle.js#1257)
  • HTML文書内で目次がbody要素の直接の子でなく深いところにあるとき、目次以外の要素の内容がVivliostyle Viewerの目次ボックス内に表示されてしまうバグを修正した。(See: TOC box should contain only the TOC element content vivliostyle.js#1258)
    • 同時に、目次要素の検出の処理を修正
• 次の修正版リリース v2.27.1 に入れる予定の修正：
  • 目次要素の検出の処理を再修正 (See: fix: All <nav epub:type="…"> elements in EPUB navigation doc should be shown in TOC box vivliostyle.js#1271)
    • 文書内にEPUB用目次 <nav epub:type="…"> とwebpub用目次（属性 role="doc-toc"）が両方ある場合には、EPUB用目次だけ使うようにした。
      • これによりwebpubから変換したEPUBで、ひとつの文書内に両方の形式の目次がある場合に、Vivliostyle Viewerの目次ボックス内にそれらが重複して表示される問題がなくなります。
    • XHTMLではないHTMLファイルであっても <nav epub:type="…"> があればそれを使うようにした。
      • XHTMLの場合 epub: は名前空間プレフィックスだがHTMLの場合はそうではないので doc.querySelectorAll("nav[*|type],nav[epub\\:type]") で両方を検出するようにした。
      • これにより、MD原稿でEPUB用目次を自分で書く場合に、<nav epub:type="toc"> と書くことができるようになります。