サイドバーをメタ情報として抜き出す #28

saki7 · 2017-10-31T10:42:05Z

ファイルの仕様については特に深く考えず json で良いと思う（階層構造を表現できていればどんな形式でもいい）

json を XHR で読みに行って動的に生成するフロントエンド側は１５分くらいあれば書けるので、問題はバックエンド

saki7 · 2017-10-31T10:43:02Z

refs #26, #27

saki7 · 2017-10-31T11:01:35Z

せっかく crsearch の機能追加で綺麗な json を吐いているので、site_generator の crsearch.json 生成処理で

現段階で省かれているページを Index オブジェクトとして追加。 type は "meta"
Namespace オブジェクトにサイドバー上の名前を表す name 属性を追加
crsearch.js のクイックジャンプの検索結果で除外して欲しい Index にだけ "nojump": true を追加

この仕様変更でいけそう

saki7 · 2017-10-31T11:04:30Z

現行のhtmlについている active が消えるという問題があるけど、 js 側で breadcrumb を見に行って頑張ればどうにかなりそう

saki7 · 2017-10-31T11:07:37Z

boostjpでまだcrsearch.jsonを吐いていないのを忘れてた……

とりあえず cpprefjp の時だけ true になるフラグを立てますかね……

melpon · 2017-10-31T11:35:28Z

crsearch とサイドバーは全く別の機能なので、混ぜるよりも別々に置いた方が綺麗そうではありますね。容量的にはダメかもしれないですけど。

saki7 · 2017-10-31T11:39:29Z

そうなんですよね。容量の問題があるのでとりあえず一本化した方がいいかなと。

melpon · 2017-10-31T11:57:42Z

boostjp の場合はサイドバーを静的に出力して、cpprefjp はサイドバーを出力せず動的に組み立てるようにする感じですかね？

saki7 · 2017-10-31T12:03:42Z

はい。boostjpのメタ情報を正しく吐くようにするのはやり始めると手間がかかるので、まずcpprefjpだけ動的に作ってみたいと思います。 boostjp / cpprefjp かどうかのフラグはフロントエンドでも持てるので、 <body> に class="boostjp" と追加していただけると

melpon · 2017-10-31T12:12:09Z

了解です。

あとメタ情報ですが、

現段階で省かれているページを Index オブジェクトとして追加。 type は "meta"
Namespace オブジェクトにサイドバー上の名前を表す name 属性を追加
crsearch.js のクイックジャンプの検索結果で除外して欲しい Index にだけ "nojump": true を追加

並び順のルールがあるので、順序の情報が必要そうです。 get_order_priority 関数が返す値だけ入れておけば何とかなりますかね？

saki7 · 2017-10-31T12:24:52Z

それでお願いします。なんとかします。

saki7 · 2017-10-31T12:44:57Z

と思ったのですが、 page_id があるので並び順は一切入れなくてもこちらで対応できると思います。 ORDER_PRIORITY_LIST にハードコードされているものを生 json の配列か何かに抜き出した上で、 cpprefjp/meta のようなまっさらなリポジトリの中に置いておいて頂ければ、フロントエンド側でそれだけ submodule で取りに行けます。

melpon · 2017-10-31T12:57:13Z

確かにフロントエンドと site_generator が共有して使う設定を置いたリポジトリはあっても良いかもしれないですね。

melpon · 2017-10-31T13:21:23Z

とりあえず以下の２つを実装しました fdcef2b 。

現段階で省かれているページを Index オブジェクトとして追加。 type は "meta"
crsearch.js のクイックジャンプの検索結果で除外して欲しい Index にだけ "nojump": true を追加

feature/sidebar ブランチをチェックアウトして、./crsearch.json/docker.sh run を実行すれば新しい形式の crsearch.json が出てくると思います。

Namespace オブジェクトにサイドバー上の名前を表す name 属性を追加

これは何を追加すればいいでしょうか？ cpp11[meta cpp] とかのメタ情報？

saki7 · 2017-10-31T13:41:06Z

Namespace オブジェクトにサイドバー上の名前を表す name 属性を追加

これは何を追加すればいいでしょうか？ cpp11[meta cpp] とかのメタ情報？

今のツリーのトップレベルの要素に表示されている名前です。

処理系
コンパイラの実装状況
メーリングリスト
外部ライブラリ
スタイル
article
editors_doc
言語機能
リファレンス

このうち、上５つについては元々crsearchで扱いが無かったものだと思います。これは、同名の Index （type: meta なもの）を作って、それだけを含む同名のNamespaceを追加すれば良いのではないかなと。

saki7 · 2017-10-31T13:54:01Z

CRSearch オブジェクトに追加：

{
  "ids": [
    {
      "key" : ["コンパイラの実装状況"], // これが 12340001 相当
      "type": "meta"
    }
  ]
}

今まで省かれていたサイドバー上の要素について新しい Namespace オブジェクトを追加：

{
  "indexes": [
    {
      "id": 12340001, // このIDは適当
      "page_id": [
        "",
      ]
    },
  ],
  "name": "コンパイラの実装状況",
  "namespace": [
    "implementation-status"
  ],
  "path_prefixes": [
    "implementation-status"
  ]
},

というものを想像しています（もしかするとこれだと仕様的に欠陥があるかもしれない）

saki7 · 2017-10-31T14:01:24Z

meta な物は IndexID::key で名前を指定すれば良いのですが、サイドバーのツリーのトップレベルの要素の名前に相当する概念がcrsearch.jsonの仕様上今まで無かったのです。なので、専用のNamespaceを掘って、
Namespace::name を新設すれば良いのではないかなと。

これをやっておくと、例えば "コンパイラの実装状況" が将来的に

"コンパイラの実装状況" >> "Windows"
"コンパイラの実装状況" >> "Mac"

に細分化された場合にも同じ仕様で対応できるので、一石二鳥のような気がしています。

melpon · 2017-10-31T14:04:09Z

あーなるほど、今だと "namespace" を空にして、"page_id" にファイル名を入れるようにしてます。こんな感じです。

{
  "indexes": [
    {
      "id": 12340001, // このIDは適当
      "page_id": [
        "implementation-status",
      ],
      "nojump": true
    },
  ],
  "namespace": [],
  "path_prefixes": []
},

こうじゃなくて、特定の "namespace" で作ってしまえばいいってことですね。

saki7 · 2017-10-31T14:05:31Z

@melpon なるほど。これだとやはり僕の上記コメントのように入れ子になった時につらい思いをしそうなので、僕が書いたような構造の方が良いのかなと（あれで欠陥が無ければ、ですが……）

saki7 · 2017-10-31T14:12:12Z

上のjsonの例で肝心のnameを書き忘れていたので書いておきました……

melpon · 2017-10-31T14:30:35Z

対応しました（たぶん）。 41a34cc

saki7 · 2017-10-31T14:32:39Z

ありがとうございます！フロントエンドのブランチになるはやでとりこみます。

melpon · 2017-11-01T15:13:26Z

今デイリーで全 html に更新を掛けている理由は、追加したページの情報を全ページに反映させるためなので、もしこれが出来るようになったらデイリーで全 html を更新する必要も無くなりますね。結構メリット多い…。

faithandbrave · 2017-11-01T15:19:20Z

グローバル修飾リストの適用は、全変換じゃないといけなそうな気がします。

melpon · 2017-11-01T15:23:12Z

site_generator を更新すると全変換走るようにしたので、サイドバーを抜き出すことで十分に変換が早くなってればそれで問題ないはず…！

melpon · 2017-11-01T15:26:42Z

と思ったけど GLOBAL_QUALIFY_LIST.txt は site 側にあった…。
まあほんとに変換が十分早くなってれば、site の更新でも全変換すればいいですしですし

saki7 · 2017-11-03T21:12:03Z

@melpon 実装をお願いしておきながら大変申し訳無いのですが、 cpprefjp/kunai_config#1 に統合した方が良さそうという理由から Namespace::name は向こうに移動しました。現行のsite_generatorの対応箇所は僕が直しておきます。

saki7 · 2017-11-03T21:12:45Z

nojump はcrsearch.jsonの範囲なので、めっちゃ助かってます。

saki7 · 2017-11-03T21:37:58Z

仕様書を更新 https://github.com/cpprefjp/crsearch/wiki/crsearch.json%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%83%88

saki7 · 2017-11-03T21:44:17Z

「サイドバーをメタ情報として抜き出す」ために必要な site_generator の変更は、全て完了しました 🎉

このIssueはcloseします。今後の実装は kunai の実装になります

saki7 · 2017-11-06T04:46:33Z

Feature complete in tag v2.x.x

saki7 added the enhancement label Oct 31, 2017

This was referenced Oct 31, 2017

html の minify をやめる #27

Closed

site_generator 自身を push した時に cpprefjp/boostjp を再生成したい #26

Closed

saki7 mentioned this issue Nov 1, 2017

サイドバー：特別なページをまとめて上に持ってくる cpprefjp/kunai#4

Closed

saki7 mentioned this issue Nov 1, 2017

.parent_li .treespan ~ a をホバーしてもハイライトカーソルが出ない cpprefjp/kunai#21

Closed

saki7 added a commit to cpprefjp/crsearch that referenced this issue Nov 3, 2017

cpprefjp/site_generator#28 の対応版

b786f0c

This was referenced Nov 3, 2017

サイト全体のメタ情報を別リポジトリに分割して共有 #35

Closed

静的変換メタデータ共通化初回版 cpprefjp/kunai_config#1

Closed

saki7 closed this as completed Nov 3, 2017

saki7 mentioned this issue Nov 4, 2017

Feature/sidebar #38

Merged

saki7 mentioned this issue Nov 15, 2017

編集者向けページやスタブがクイックジャンプの検索結果に表示される cpprefjp/crsearch#28

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

サイドバーをメタ情報として抜き出す #28

サイドバーをメタ情報として抜き出す #28

saki7 commented Oct 31, 2017

saki7 commented Oct 31, 2017 •

edited

Loading

saki7 commented Oct 31, 2017 •

edited

Loading

saki7 commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Oct 31, 2017

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017 •

edited

Loading

saki7 commented Oct 31, 2017 •

edited

Loading

saki7 commented Oct 31, 2017 •

edited

Loading

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Nov 1, 2017 •

edited

Loading

faithandbrave commented Nov 1, 2017

melpon commented Nov 1, 2017

melpon commented Nov 1, 2017

saki7 commented Nov 3, 2017

saki7 commented Nov 3, 2017

saki7 commented Nov 3, 2017

saki7 commented Nov 3, 2017

saki7 commented Nov 6, 2017

サイドバーをメタ情報として抜き出す #28

サイドバーをメタ情報として抜き出す #28

Comments

saki7 commented Oct 31, 2017

saki7 commented Oct 31, 2017 • edited Loading

saki7 commented Oct 31, 2017 • edited Loading

saki7 commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Oct 31, 2017

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017 • edited Loading

saki7 commented Oct 31, 2017 • edited Loading

saki7 commented Oct 31, 2017 • edited Loading

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Oct 31, 2017

saki7 commented Oct 31, 2017

melpon commented Nov 1, 2017 • edited Loading

faithandbrave commented Nov 1, 2017

melpon commented Nov 1, 2017

melpon commented Nov 1, 2017

saki7 commented Nov 3, 2017

saki7 commented Nov 3, 2017

saki7 commented Nov 3, 2017

saki7 commented Nov 3, 2017

saki7 commented Nov 6, 2017

saki7 commented Oct 31, 2017 •

edited

Loading

saki7 commented Oct 31, 2017 •

edited

Loading

saki7 commented Oct 31, 2017 •

edited

Loading

saki7 commented Oct 31, 2017 •

edited

Loading

saki7 commented Oct 31, 2017 •

edited

Loading

melpon commented Nov 1, 2017 •

edited

Loading