RTM Wikiを編集する上での、統一する文法や表記の規則です。
できる限りこれを遵守するようにしてください。
初心者向けカテゴリーなど、一部のページにおいてはこれらの例外となる場合があります。
エディタはMarkdownを使用し、他のエディタは使用しないでください。
見出しレベルは適切に使い分けてください。
最上位の見出しには#
を使用してください。
これは<h1>
に変換され、1つのページに複数のh1要素が存在することになりますが、Wiki.jsの仕様上これが必要なので、HTML Living Standardの仕様は一旦忘れてください。
**...**
を使用してください。<strong>
に変換されます。*...*
を使用してください。<em>
に変換されます。*
,-
,+
が順序なしリスト<ul>
に変換されますが、-
のみを使用してください。
1.
,2.
などが順序付きリスト<ol>
に変換されますが、プレビューのレンダリング結果と同様になるように1から順に数字を指定してください。
ただし、執筆途中など、リストの内容が確定していない場合には、全て1.
を使用してください。
内部リンク、外部リンクは適切に使用してください。
外部リンクは信頼できる公式ドキュメントやメディアなどのページに限定し、特に難しい専門用語などにのみ使用してください。
追加の補足と、出典の明記に使用してください。
専門用語は解説サイト/ページへのハイパーリンク、略語の説明などには使用しないでください。
よく知られた略語がある語句を使用する場合には、文末で以下のような定義を行ってください。
*[RTM]: RealTrainMod
*[MCTE]: MC Terrain Editor
基本的に、文の終わりごとに改行を行ってください。
改行する際に、1行間隔をあけると別の段落(段落要素<p>
)になります。
別の段落にするのが適当な場合は、間隔を1行あけるようにしてください
段落を分けない改行前のテキストの最後には、半角スペース
(U+0020
)を2つ入力してください。
これは標準的なMarkdownの文法で、改行要素<br>
に変換されます。
このWikiにおいては、半角スペースを入れなくても改行されて表示されますが、他の環境で編集する場合には改行されて表示されません。
他の編集環境でも改行されるようにするために、必ず半角スペースを入力してください。
ですます調を基本としてください。
可能な限り推定や婉曲の表現は用いず、断定してください。
方法を示す場合には、「まず、~します。次に~です。」のように、中立な表現をしてください。
「まず、~してください。次に~てください。」のような中立でない表現は使用しないでください。
「RTM」「MCTE」など、よく知られた略語がある語句は、冒頭または最初の言及時にのみ正式名称を使用し、それ以降は略語を使用してください。
.webp
)を使用し、PNG形式やJPEG形式は使用しないでください。英単語や固有名詞の前後のスペースは使用しないでください。