注釈(脚注)を貼るときの書き方の統一

[yumetodo]

cpprefjp/site_generator#52
にてQiitaにあるような注釈の記法導入は見送られ、各自aタグを駆使して実現することとなったが、見た目の統一はした方がいいのではないか。

• 注釈番号の記法(^1か[^1]か)
• 注釈に飛んだ後戻れるようにする必要はあるか(注釈を貼った場所にもidattributeを貼る必要があるか
• idattributeの命名規則
• 数字じゃない注釈はどうするか
• 注釈元はsupタグで囲い上付き文字にするべきか

このへん。

すでに注釈が利用された例としては、 #485 がある。これは

• [^1]
• 戻れない
• cite-N
• 使っていない
• していない

のようになっている。

[faithandbrave]

私は注釈についてこだわりは持っていないので、いまあるものと意見が衝突したら、もしくはそれでカバーできない状況がでてきたら議論でいいように思います。

[yumetodo]

あ、いや #493 と衝突しています。

#493 では

• ^1
• 戻れる
• noteNに飛んでnoteN-srcに戻る
• 使っていない
• supタグ使用

となっていて、主に @akinomyoga 氏とのすり合わせが必要と思っています。

[akinomyoga]

これはどのような形で解決されるのでしょう。ルールを制定して何処かに明記し、それに合わせるということになりますか。

• すみません。実は、さらに international-standard.md で表の註として † を使ってしまいました (さきの "時間計算量" で出ていた † の案に倣ったものです)
• また、参考文献の引用 cite と註釈 note は微妙に性格が異なるので、必ずしも統一するべきかどうか分かりません (むしろ引用と註は区別した方が良い気がします)
• 参考文献の引用といえば、各ページの 参照 で挙げられているリンクについても文中から参照する場合には同様にリンクを張る可能性も考えられます (今のところそのような使い方はないようですが)。

表の註釈・脚註・参考文献の引用をそれぞれ統合するかどうかも含めて考えた方が良い気がしました

[yumetodo]

こういうときはWikipediaに立ち返ってみるべきかと思って見てきたら

• [1]
• 戻れる
• cite_note-Nに飛んでcite_ref-Nに戻る
• ないが、named refというのがある。その場合cite_note-NAME-Nに飛んでcite_ref-NAME_N-Mに飛ぶ
• sup使用

となっていた。

---

すみません。実は、さらに international-standard.md で表の註として † を使ってしまいました (さきの "時間計算量" で出ていた † の案に倣ったものです)

こうしてみると†は使わないほうがいいんじゃないかと思えてきました・・・

---

また、参考文献の引用 cite と註釈 note は微妙に性格が異なるので、必ずしも統一するべきかどうか分かりません (むしろ引用と註は区別した方が良い気がします)

WIkipediaでは<ref group="注">のように書いたものを{{Reflist|group=注}}のように列挙できるようで、[注 2]みたいに表示されます。内部的な通し番号Nはグループによって区別されません。
ex.) 魔法科高校の劣等生 - Wikipedia

というように分けているので、やはり分けて考えるべきでしょうね・・・。Wikipediaのような拡張文法が無い以上、id的にも分けてあげるべきですね。

[akinomyoga]

@yumetodo あ、丁度いろいろ嗅ぎ回って似たようなものを表にまとめていたのでした。

	註釈元	←(リンク)→	註釈	註釈元id / 註釈id
implementation.md 表の註	[^N]	一方向	[^N]:	-- / #cite-N
implementation-compliance.md 脚註 (現状)	N	両方向	^N	#noteN-src / #noteN
Qiita脚註	N	一方向	N.	-- / #fnN
C++規格PDF脚註	N	一方向	N)	-- / --
Wikipedia脚注	[N]	両方向	N. ^	#cite_ref-N / #cite_note-N
Wikipediaテンプレート {{ref}} {{note}}	[N]	両方向	a	#ref_名前 / #endnote_名前

[yumetodo]

そういえば注釈/出典を書く場所もありますね、多いのはページ最下部に書くケースですのでそれに合わせてしまいたい(つまり修正案件)

---

リンクは双方向できたほうがやっぱり良いですよね。いかがでしょう？

---

註釈元なのに^があるのはおかしいな、なんでつけたんや、過去の私。

あとは[]をつけるかどうかですかね？

---

idについては、註釈元id / 註釈idをnote_ref-N/note-N, 出典元id / 出典idをcite_ref-N/cite-Nを提案します。

[akinomyoga]

そういえば注釈/出典を書く場所もありますね、多いのはページ最下部に書くケースですのでそれに合わせてしまいたい(つまり修正案件)

表注は表の直下が良いです。それ以外はページ末尾で問題ありません。ただ、長めの記事の場合には章の末尾の方が良いという場合もあるかなと感じています (どちらが良いかは脚註をどのように読むかによりそう)。この辺りは (Wikipedia で {{Reflist}} で指定できるように) 執筆者に任せて良いのではないかという気がします。

リンクは双方向できたほうがやっぱり良いですよね。いかがでしょう？

そうですね。あった方が便利だなと感じます (僕だけかもしれないけれど、註釈を見てから本文の何処に対応するのか目で探すのをよくやる)

あとは[]をつけるかどうかですかね？

個人的には [] は付けたほうが良いかなという気がします。例えば Qiita は付けていないのですが、利用していて文字が小さくて脚註があることを見落としそうになるので。

idについては、註釈元id / 註釈idをnote_ref-N/note-N, 出典元id / 出典元をcite_ref-N/cite-Nを提案します。

賛成です。参照元の書式は ^{[注 N]} (註釈) / ^[N] (出典) ですかね (追記: 表の註は ^{[表 N]}?)。 註釈・出典の番号も Wikipedia に倣って N. ^ が無難な気がします。

[yumetodo]

Wikipedia の{{Reflist}}って記事中に全く同じグループ指定のものを複数置いた場合どうなるんでしたっけ・・・？なんとなく一つしか置けないイメージが有りました。

どこか一箇所にまとめないとナンバリングが面倒そう・・・。またWikipediaのように註釈・出典の番号を箇条書きで実装できなくなります

[akinomyoga]

別に同じグループ名にしなければならないということはないので、複数箇所に分けるのだとしたら例えば {{Reflist|group="章1"}}, {{Reflist|group="章2"}} などで良いのではないでしょうか。

どこか一箇所にまとめないとナンバリングが面倒そう・・・

寧ろ手動ナンバリングの場合には、一箇所にまとめると後から注を追加する時に番号を大量にシフトしなければならなくなるので、適当に分けた方が良い気がします… (或いは、注の番号と文中に現れる順番は shuffle されていて OK とするか…)

[akinomyoga]

あ、でも…複数に分けた場合には区別するためには [N] ではなくて [N.M] の様な形式にしなければならなくなりますね…。[N] の形式を保持 (続きの番号を使用) するとしたら、一箇所にまとめた方が番号の管理は幾らかマシですね…。

[akinomyoga]

Wikipedia の {{Reflist}}って記事中に全く同じグループ指定のものを複数置いた場合どうなるんでしたっけ・・・？なんとなく一つしか置けないイメージが有りました。

これは、実際に Wikipedia でプレビューで試してみたら

文章1: <ref>alpha</ref> <ref>beta</ref> <ref>gamma</ref>

{{Reflist}}

文章2: <ref>delta</ref> <ref>epsilon</ref> <ref>zeta</ref>

{{Reflist}}

のようなとき

文章1: ^{[1] [2] [3]}

• 1. ^ alpha
• 2. ^ beta
• 3. ^ gamma

文章2: ^{[1] [2] [3]}

• 1. ^ delta
• 2. ^ epsilon
• 3. ^ zeta

のような感じに数字が再利用されるみたいです。

[yumetodo]

一箇所にまとめた方が番号の管理は幾らかマシ

ええ、そうなんですよ。幸いにして双方向リンクにしようという方向で話が進んでいるので離れたところに書いてあっても良いかなと思っています。というかシステム面はさておきほとんどのWikipediaの記事で一箇所にまとめて運用しているので、それでいいかなと思っています。

数字が再利用

それidはどうなっていますか？

---

それはそうと例えば将来的にフロントエンド側で参照元にマウスをかざしたらツールチップに参照先を表示させるみたいなことをするために、classattributeをつけておきたいです(class="reference")

[akinomyoga]

数字が再利用

それidはどうなっていますか？

どうも表示の番号と id の番号は独立のようで、id の番号は group に関係なく <ref> に文章中での登場順で番号が付くみたいです (つまり、全て cite_ref-N の形式で <ref> に一意な番号がついている)。

class="reference"

そうですね…。でも、将来的に対応するということは確定なのでしょうか。class 属性の付加はツールチップの自動生成に対応してからでも良い気がします。

[yumetodo]

どうも表示の番号と id の番号は独立のようで

やっぱり。拡張構文なしにそういう複雑さを受け入れるのはちょっとやってられない思いがあるので、一箇所にまとめたいです・・・。

class 属性の付加はツールチップの自動生成に対応してからでも良い気がします。

そう言われればそうですね。