編集に役立つ情報
目次 |
[編集] 概要
このウィキのコンテンツのほとんどはウィキテンプレートで囲まれています。中には簡単なものもあれば、そうでないものもあります。これらはフォーマットの大部分を担当し、繰り返し発生するものを一箇所に集約するのに役立ちます。そのため、何かを変更する必要がある場合、同じ変更を何度も行う必要はありません。
Wikipediaのチートシートにあるテキストフォーマットマークアップ構文を使用できます(Help:Editingも参照)。ただし、一般的に推奨されるテンプレートも利用可能で、Help:Templatesページにリストされています。
一般的に、既存のページを選択し、「編集」モードに切り替えることで、テンプレートやマークアップがどのように使用されているかを確認し、どのように作成されたかを見ることができます。
[編集] その他のヘルプ
追加のヘルプが必要な場合は、以下のいずれかの方法で行うことができます。
- Cppreference talk:FAQのディスカッションページにテキストを追加して質問する。
- cpplangのSlackに参加し、cppreferenceチャンネルに参加して質問する。
[編集] テキストフォーマット
Formattingに関するテンプレートヘルプを参照してください。
例えば、最も一般的な等幅フォント(テレタイプ)テンプレートは {{tlc|tt| {{tt|text}} です。
[編集] リンク
外部リンクについては、Wikipediaの構文を使用してください。
内部リンクについては、Linksに関するテンプレートヘルプを参照してください。
一般的に使用される自動リンクテンプレートの1つにlcがあり、これは既知の識別子に使用されます。例えば、{{lc|std::vector}}とすると、ページへのリンクが作成され、テレタイプフォントで表示されます。例: std::vector。
[編集] コード
Syntax-Highlightingに関するテンプレートヘルプを参照してください。
インラインコードには{{c|1=code}}が一般的に使用されます。もしcodeに「=」が含まれていない場合、「1=」は省略できます。例えば、戻り値の{{c|true}}と{{c|false}}は、trueおよびfalseとして頻繁に使用されます。
[編集] 注意点と癖
- ウィキテンプレートのブレースセクション内では、ウィキエンジンが「
=」記号で混乱することがあります。「{{=}}」を使用してこの問題を回避してください。 {{!=}}テンプレートは「!=」ではなく「|=」を表示し、同様に{{!}}は「|」を表示します。「!{{=}}」を使用してください。
[編集] 繰り返しコンテンツ
一部のクラス/型は、APIが同じ(またはほぼ同じ)であるため、共通のサブページセットを持っています。例えば、std::condition_variableとstd::condition_variable_anyは、ほとんどの関数の説明と解説がほぼ同一のAPIを持っています。
同じテキストを繰り返し記述し、複数の場所で修正することを避けるために、サブページにはカスタムテンプレートが使用されています。例えば、condition_variable::notify_one()のページにアクセスすると、情報の全ページが表示されますが、「編集」をクリックすると、`include`テンプレートのみが表示されます。実際のコンテンツは、そのテンプレートによって生成されています。
サブページにおけるこのようなテンプレートの使用はトリッキーであり、ここでは説明するには複雑すぎます。現在の使用例から理解できない場合は、ヘルプを求めてください。「その他のヘルプ」セクションを参照してください。