crsearch.jsonフォーマット (v1)

[saki7]

Wiki: crsearch.jsonフォーマット

イメージとしてはこんな感じ…… @melpon

[saki7]

書いてて思ったんですが、 Index::target, もしかするとこれ要らないですね。cpprefjpの中身が「ものすごくきれい」で、全部の相対パスが完全に統一されているなら、ですが（頑張れば自動化できそうな気がするけど、つらい）。

[melpon]

Index::type ですが、既存のメタ情報のドキュメントを見ると、

[meta id-type]: 識別子の種別を表すメタ情報。class, class template, function, function template, enum, variable, type-alias, macro, namespace

とあるので、enum, variable, type-alias あたりも必要そうです。

あと match_string というのは、例えばそのページの概要とか検索用単語とかを入れておくと、それで引っ掛けてくれる的な感じでしょうか。

[saki7]

enum, variable, type-alias あたりも必要そうです

この辺を踏まえて、全体的に書き直しました（もっかいレビューお願いします）。
必要最小限のjsonで「思った通り」にインデックスされるような設計にしようと思って頑張ったのですが、こんな感じでどうでしょうか。

match_string

これはあまりにも雑すぎたので article という type に変更しました。
そのかわり、Index::related_to というメンバを追加したので、これでいい感じになるような気がします。

[saki7]

列挙すべき物をStringで扱っている関係で、多少jsonのサイズが大きくなるような気がしますが、現実的には問題にならないと思います。

それより、今回の僕の編集で Index が再帰するようになったせいで、jsの実装の方で遅延評価する必要性が出てきて頭が痛いです

[saki7]

それより、今回の僕の編集で Index が再帰するようになったせいで、jsの実装の方で遅延評価する必要性が出てきて頭が痛いです

この問題があったので Index を IndexID と Index に分けました。

分ける前

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/2321d17ed2fc57ff4fc212df722b681ea20a6561

分けた後（現行）

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

[faithandbrave]

バージョンについてです。

version と C++XX の対応

ISO/IEC 規格が発効する前は "1z" のような文字列
その後は "17" のような文字列

C++17からは3年周期のバージョンアップで、仕様が固まったものから順次リリースという体制になったので、仮名称を使う必要はなくなりました。
ですので、最初からC++20とかを使って大丈夫です。

• cpprefjpサイトでの次期C++バージョンの取り扱い方針

[saki7]

おお、そうなんですね。知りませんでした。該当箇所を変更しておきます。

[saki7]

• Namespace::version -> Namespace::cpp_version
• 説明を削除（テーブルに移動）

[melpon]

Index::page_id は、多分常に設定すると思うので必須でも大丈夫です。

とりあえず related_to を考慮しない状態でインデックスを作っていこうと思います。

[saki7]

Index::page_id は、多分常に設定すると思うので必須でも大丈夫です。

メンバ関数の名前とそれに対応するファイル名は全て統一されているようなので、自動生成できると思います。

• begin -> begin.html
• operator[] -> op_at.html
• ...

これを全て手動で指定してしまうと、jsonのファイルサイズが膨れ上がると思うんですよね。
article などは常に指定する必要があると思います。

とりあえず related_to を考慮しない状態でインデックスを作っていこうと思います。

おっけーです。

[melpon]

なるほど、サイズ対策ですか…。
では、ひとまずは全部入れて作りますが、自動で解決できそうな場所は後で削っていくことにします。

[saki7]

一応：自動生成はjs側でやるので、site_generatorの方では何もしなくて大丈夫ですよ。
「これ自動でいけそうだな」という感じの項目は直感でスキップしてよいかと。

（補足）
js で crsearch.json を読んだあとに、 <li><a>... を生成するときの href に突っ込む段階で自動生成する感じです。

（追記）
じつは operator[] は本来は "at operator" ではなく "subscript operator" なんですよね（すごい蛇足）。