OSDN Docs (English)
edit[[PageNavi(NavigationList)]]
= List of Wiki Syntax rules =
[[PageOutline]]
You can use syntax similar to Trac, !MoinMoin. Also read [WikiLinks Link formats], [WikiBlockProcessor Block processor], and [WikiPlugins Extension/Plugin].
== Font Style ==
You can embed font style by adding marks around both ends of the text string.
* !'''Bold!'''
* !''Italic!''
* !'''''Bold+italic!'''''
* !__under-line!__
* !~~line through!~~
* !^superscript!^
* !,,subscript!,,
* !`fixed pitch!`
* !{{{inline ''formatted text''}}}
Each will be expressed as below.
* '''Bold'''
* ''Italic''
* '''''Bold+italic'''''
* __under-line__
* ~~line through~~
* ^superscript^
* ,,subscript,,
* `fixed pitch`
* {{{inline ''formatted text''}}}
All font styles (except inline formatted text) can extend over lines.
{{{
'''bold.
Here as well.''' Revert back to original.
}}}
-> '''bold.
Here as well.''' Revert back to original.
Within an inline formatted text using !{{{string text}}}, Wiki grammar rules will be invalidated and expressed in fixed pitch. When using !`string text!`, all the link notations within the string text will be interpreted.
== Header ==
You can create a heading by typing "=" at the beginning of a line, then hit the space bar before you type in your heading. You can place the same number of "=" at the end of the line, but that will be simply ignored.
Also, at the end, if you write a string text right after "#", corresponding ID will be generated.
{{{
== Header Level 2
=== Header Level 3
=== Alternate 3 ===
==== Header 4 #header4-sample
==== Alternate 4 === #header4-sample2
}}}
== Paragraph ==
By inserting a blank line, you can divide a paragraph. (For HTML, use '''p''' element. )
Example:
{{{
Paragraph 1
Paragraph 2
}}}
Expressed as:
Paragraph 1
Paragraph 2
== Force Line Break ==
By writing ![[BR]], you can force line break.
Example:
{{{
It's more commonly recommended to divide paragraphs properly rather than to force line breaks. [[BR]]
You can also write in the midst of [[BR]] a line.
}}}
Expressed as:
It's more commonly recommended to divide paragraphs properly rather than to force line breaks. [[BR]]
You can also write in the midst of [[BR]] a line.
== List ==
空白でインデントしたマーカーを置くとリストになります。
マーカーには * i. a. 1. 等が使用可能です。
Example:
{{{
* 箇条書きリスト
* インデント幅は 2 です。
インデントをあわせれば改行しても
アイテムが継続します。
* 次のアイテム
1. 数値付きリストも書けます
1. マーカーとして書いた数値は単に無視されます
9999. 現在の所開始の数字を変更することは出来ません
*マーカーと文字列の間にはスペースが必要です
}}}
Expressed as:
* 箇条書きリスト
* インデント幅は 2 です。
インデントをあわせれば改行しても
アイテムが継続します。
* 次のアイテム
1. 数値付きリストも書けます
1. マーカーとして書いた数値は単に無視されます
9999. 現在の所開始の数字を変更することは出来ません
*マーカーと文字列の間にはスペースが必要です
{{{ comment
== Def List ==
'''TODO:未実装です'''
"::" を使うと定義リストになります。
Example:
{{{
項目1::
内容はインデントする必要があります
項目2::
しかしまだ未実装です。
}}}
Expressed as:
項目1::
内容はインデントする必要があります
項目2::
しかしまだ未実装です。
}}}
== フォーマット済みテキストブロック ==
行頭を "!{{{" で始めると、そこから "}}}" までの行を整形済みテキストとして表示します。
全ての Wiki 文法の解釈は停止され、ブロック内は標準で HTML の pre として出力されます。
Example:
{{{
{{{
この間の文字は'''全て'''そのまま
* 出力されます。
}}}
}}}
Expressed as:
{{{
この間の文字は'''全て'''そのまま
* 出力されます。
}}}
"{{{" の後ろに名前を指定した場合、適切にフォーマットされます。
省略した場合は適当に自動判別します。
詳しくは[WikiBlockProcessor ブロックプロセッサ]を参照してください。
Example:
{{{
{{{ code ruby
class OSDN
def hello
puts "world :)"
end
end
}}}
}}}
Expressed as:
{{{ code ruby
class OSDN
def hello
puts "world :)"
end
end
}}}
== 引用 ==
行頭を ">" から始め、スペースを開けて文字列を書くと引用になります。
">" の数によって引用のネストレベルが表現できます。
Example:
{{{
>> 元の内容
> 誰かのコメント
自分のテキスト
}}}
Expressed as:
>> 元の内容
> 誰かのコメント
自分のテキスト
== 表 ==
行頭を "||" で始めるとテーブルになります。
セルの区切りも同じく "||" で、行の最後にも "||" が必要です。
Example:
{{{
||セル1||セル2||セル3||
||セル4||セル5||セル6||
||セル数が||違う||物が||
||あっても||分割||されなく||なりました||
}}}
Expressed as:
||セル1||セル2||セル3||
||セル4||セル5||セル6||
||セル数が||違う||物が||
||あっても||分割||されなく||なりました||
== 水平線 ==
行頭から始まる4つ以上のハイフン "----" で水平線になります。
Example:
{{{
----
}}}
Expressed as:
----
== リンク ==
!WikiPageNames や URL は自動的にハイパーリンクされます。
Example:
{{{
* FrontPage
* http://osdn.jp/
}}}
Expressed as:
* FrontPage
* http://osdn.jp/
これ以外に、様々な形式でリンクを生成することができます。
詳しい文法は[WikiLinks リンク文法]を参照してください。
== Wiki文法のエスケープ ==
手前に "!" を置くとエスケープされます。
Example:
{{{
!'''太字にならない。!WikiName のリンクを止める。
}}}
Expressed as:
!'''太字にならない。!WikiName のリンクを止める。
== 拡張記法 ==
インライン画像表示などはプラグインで行うことができます。
[WikiPlugins 拡張文法]を参照してください。
[[PageNavi(NavigationList)]]