iPentec.com  /  Document  /  カテゴリ: Manual  /  タグ:  整形ルール

目次

iPentec Document 整形ルール

目次

iPentec Document の整形ルールを紹介します。

見出し

行頭に"*"を入れると見出しになります。
"**"を行頭に入力すると子見出しに、"***"を入力すると孫見出し、"****"を入力するとひ孫見出しになります。

形式指定符号意味対応するタグ
*見出しLv1 (見出し)h2
**見出しLv2 (小見出し)h3
***見出しLv3 (孫見出し)h4
****見出しLv4 (ひ孫見出し)h5
*****見出しLv5 (ひひ孫見出し)h6
******見出しLv6 (ひひひ孫見出し)h7

表示例

*見出しの例 / Title Caption
テキスト文です。
**子見出しの例 / Sub Title Caption
テキスト文です。
***孫見出しの例 / Sub Sub Title Caption
テキスト文です。
****ひ孫見出しの例 / Sub Sub Sub Title Caption
テキスト文です。
*****ひひ孫見出しの例 / Sub Sub Sub Sub Title Caption
テキスト文です。
******ひひひ孫見出しの例 / Sub Sub Sub Sub Sub Title Caption
テキスト文です。

見出しの例 / Title Caption

テキスト文です。

子見出しの例 / Sub Title Caption

テキスト文です。

孫見出しの例 / Sub Sub Title Caption

テキスト文です。

ひ孫見出しの例 / Sub Sub Sub Title Caption

テキスト文です。

ひひ孫見出しの例 / Sub Sub Sub Sub Title Caption

テキスト文です。

ひひひ孫見出しの例 / Sub Sub Sub Sub Sub Title Caption

テキスト文です。

表示例(見出しが続く場合)

*見出しの例 / Title Caption
aaabbbccc
*見出しの例 / Title Caption
**子見出しの例 / Sub Title Caption
aaabbbccc
**子見出しの例 / Sub Title Caption
***孫見出しの例 / Sub Sub Title Caption
aaabbbccc
***孫見出しの例 / Sub Sub Title Caption
****ひ孫見出しの例 / Sub Sub Sub Title Caption
aaabbbccc
****ひ孫見出しの例 / Sub Sub Sub Title Caption
*****ひひ孫見出しの例 / Sub Sub Sub Sub Title Caption
aaabbbccc
*****ひひ孫見出しの例 / Sub Sub Sub Sub Title Caption
******ひひひ孫見出しの例 / Sub Sub Sub Sub Sub Title Caption
aaabbbccc
******ひひひ孫見出しの例 / Sub Sub Sub Sub Sub Title Caption
aaabbbccc
*****ひひ孫見出しの例 / Sub Sub Sub Sub Title Caption
aaabbbccc
****ひ孫見出しの例 / Sub Sub Sub Title Caption
aaabbbccc
***孫見出しの例 / Sub Sub Title Caption
aaabbbccc
**子見出しの例 / Sub Title Caption
aaabbbccc
*見出しの例 / Title Caption
aaabbbccc

見出しの例 / Title Caption

aaabbbccc

見出しの例 / Title Caption

子見出しの例 / Sub Title Caption

aaabbbccc

子見出しの例 / Sub Title Caption

孫見出しの例 / Sub Sub Title Caption

aaabbbccc

孫見出しの例 / Sub Sub Title Caption

ひ孫見出しの例 / Sub Sub Sub Title Caption

aaabbbccc

ひ孫見出しの例 / Sub Sub Sub Title Caption
ひひ孫見出しの例 / Sub Sub Sub Sub Title Caption

aaabbbccc

ひひ孫見出しの例 / Sub Sub Sub Sub Title Caption
ひひひ孫見出しの例 / Sub Sub Sub Sub Sub Title Caption

aaabbbccc

ひひひ孫見出しの例 / Sub Sub Sub Sub Sub Title Caption

aaabbbccc

ひひ孫見出しの例 / Sub Sub Sub Sub Title Caption

aaabbbccc

ひ孫見出しの例 / Sub Sub Sub Title Caption

aaabbbccc

孫見出しの例 / Sub Sub Title Caption

aaabbbccc

子見出しの例 / Sub Title Caption

aaabbbccc

見出しの例 / Title Caption

aaabbbccc

表示例(長い文章)

テキスト文です。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。

見出しの例 / Title Caption

テキスト文です。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。

子見出しの例 / Sub Title Caption

テキスト文です。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。

孫見出しの例 / Sub Sub Title Caption

テキスト文です。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。

ひ孫見出しの例 / Sub Sub Sub Title Caption

テキスト文です。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。

ひひ孫見出しの例 / Sub Sub Sub Sub Title Caption

テキスト文です。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。

ひひひ孫見出しの例 / Sub Sub Sub Sub Sub Title Caption

テキスト文です。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。 あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへのまみむめもやゆよらりるれろん。 いろはにほへと ちりぬるを わかよたれそ つねならむ うゐのおくやま けふこえて あさきゆめみし ゑひもせす。

目次

目次機能はデフォルトで有効になり、#TOC 記述は廃止になりました。

ページリンク

ドキュメント内のリンクについては下記の記述を利用します。

[[caption>PageID]]


MediaWiki形式の下記の書式の記述も利用できます。

[[PageID|caption]]


外部サイトへのリンクについては以下の書式です。

[[caption:url]]

外部へのURLをリンクする場合にはと以下の記述もサポートしています。（ただしURLの先頭はhttp://またはhttps://となることが必須です）

[[http://...url...]]


下記の書式を利用するとリンク先のドキュメントのタイトルをリンクのキャプションとして利用することができます。

[[$pageid$]]


また以下の記述の場合、リンク先がない場合は、文字列はaタグではなく、spanタグで囲まれます。

[[文字列]]

表示例

例1

[[https://www.ipentec.com]]

https://www.ipentec.com


例2

[[インデックスページ>index]]

インデックスページ


例3

[[index|インデックスページ]]

インデックスページ


例4

[[$format-rule$]]

iPentec Document 整形ルール

サーチページリンク

検索結果ページへのリンクについては廃止されました。

廃止フォーマット
検索結果ページへのリンクは下記の書式が利用できましたが、現在は廃止されています。
検索結果ページ
[[caption^keyword]]
タグ検索ページ
[[caption|keyword]]

表示例

[[C#記事の一覧です^C#]]

C#記事の一覧です


段落

従来スタイル

段落は行頭に"~"をつけます
段落は~をつけた行から、空行まで、もしくは行頭に"~"が存在する行を検出するまでをひとつの段落とします。

表示例1

~これは段落１です。
段落1の文章です。
これも、段落1の文章です。
これも、段落1の文章です。

~ここから、段落2です。
段落2の文章です。「そもそも段落とは、文章をわかりやすく区切るためのものであり（以下略…」
まだ、段落2の文章です。

ここは段落ではありません。~

これは段落１です。 段落1の文章です。 これも、段落1の文章です。 これも、段落1の文章です。

ここから、段落2です。 段落2の文章です。「そもそも段落とは、文章をわかりやすく区切るためのものであり（以下略…」 まだ、段落2の文章です。

ここは段落ではありません。

表示例2

~段落1
~段落2
~段落3

段落1

段落2

段落3

補足
"~"のみの行は改行とみなされます。

新しいスタイル

何も指定しないテキストは自動的に段落表示になります。空行で段落分けされます。

表示例1

これは段落１です。
段落1の文章です。
これも、段落1の文章です。

ここから、段落2です。
段落2の文章です。
まだ、段落2の文章です。

段落3の文章です。

これは段落１です。 段落1の文章です。 これも、段落1の文章です。

ここから、段落2です。 段落2の文章です。 まだ、段落2の文章です。

段落3の文章です。

改行

空行の改行

空行で改行をする場合は、行頭に"~"を記述、または行頭に"#br"を記述します。

表示例

ここで
~
改行
~
さらに
#br
改行

ここで
改行
さらに
改行

行末改行

改行は行末に"~"をつけます

文字文字~

表示例

ああ~
いい~
うう~

ああ
いい
うう

強調

'' で囲むことで強調表示となります。
強調表示は '' で囲んだ場合 em タグでの整形となり斜体表示になります。 ''' で囲んだ場合は strong タグでの整形となり太字の表示になります。

表示例1

''強調表示''します

強調表示します

表示例2

'''強調表示'''します

強調表示します

箇条書き (リスト)

行頭に"-"を入れると箇条書きとなります。
箇条書きは"-","--","---"が用意されており、-の数が多いものほどレベルが下がります。
箇条書きは空行までを一つの箇条書きとみなします。

表示例1

-項目1
-項目2
-項目3
  • 項目1
  • 項目2
  • 項目3

表示例2

-項目A
--A-1
---こまごま1
---こまごま2
---こまごま3
--A-2
-項目B
--B-1
---こまごま1
-項目C
  • 項目A
    • A-1
      • こまごま1
      • こまごま2
      • こまごま3
    • A-2
  • 項目B
    • B-1
      • こまごま1
  • 項目C

段落のリスト

行頭に"-~"を入力すると、段落のリストになります。
"-~","--~","---~"が用意されており、-の数が多いものほどレベルが下がります。

-~1項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん
-~2項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん
-~3項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん

  • 1項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん

  • 2項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん

  • 3項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん

項目リスト

行頭に"+"を入れると項目リストとなります。
項目リストは"+","++","+++"が用意されており、+の数が多いものほどレベルが下がります。
項目リストは空行までを一つの項目リストとみなします。

表示例

+リスト1
++子リスト1
++子リスト2
++子リスト3
++子リスト4
+リスト2
+リスト3
++子リスト1
+++孫リスト1
+++孫リスト2
+++孫リスト3
+++孫リスト4
++子リスト2
++子リスト3
  1. リスト1
    1. 子リスト1
    2. 子リスト2
    3. 子リスト3
    4. 子リスト4
  2. リスト2
  3. リスト3
    1. 子リスト1
      1. 孫リスト1
      2. 孫リスト2
      3. 孫リスト3
      4. 孫リスト4
    2. 子リスト2
    3. 子リスト3

段落の項目リスト

行頭に"+~"を入れると段落の項目リストとなります。
段落の項目リストは"+~","++~","+++~"が用意されており、+の数が多いものほどレベルが下がります。

+~段落の項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん
+~段落の項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん
+~段落の項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん

  1. 段落の項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん

    1. 段落の項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん

      1. 段落の項目リストです。あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをん

整形済みテキスト

行頭に" "(空白)を入れると整形済みテキストとなり、整形コマンドが無視されます
ただし、空白スペースのみの行は整形済みテキストとはみなされません。

表示例1

改行されない⇒~

表示例2

> cmd
> dir d:

表示例3

<title>タイトルだよ</title>
<p>本文です</p>
< > 記号の扱い
整形済みテキストブロックでは < > の記号はそのまま表示されます。

水平線 / 区切り線

区切り線(hrタグ)を挿入する場合は行頭で"#hr"を記述します。

表示例

#hr

テキストの配置

テキストのアライメントを変更するときは

LEFT:
RIGHT:
CENTER:
を用います。
上記指示は行の先頭に記述する必要があります。

中央揃えに変更する場合は

CENTER:中央表示

とします。

表示例

CENTER:中央表示
RIGHT:右寄せ
LEFT:左寄せ

中央表示
右寄せ
左寄せ

補足
iPentec Documentでは文字列のアライメントはDIVを用いて制御します。他の形式指定符号と合わせて使われた場合DIVの入れ子になる場合や競合を起こす場合があります。 テーブル等の複数行にわたる要素をアライメント制御する場合は#desigener指示を用いてください。

画像の貼り付け(外部URL参照)

外部の画像などURLで指定できる画像の場合は

#ref("URL")
と記述します。

ref指定画像にリンクを張る場合は

#ref("URL","linkURL")
と記述します。

表示例

#ref("https://localhost:44387/document/res/foot-logo-dark-4x.png")~



#ref("https://localhost:44387/document/res/foot-logo-dark-4x.png","http://www.ipentec.com")~



画像の貼り付け

画像を張り付けるには

#img("画像ID")
と記述します。

#img("画像ID",maxsize=100)

と記述すると100pixelを超えないよう縮小された画像が張り付けられます。(この場合は"の省略はできません。)
また、

#img("画像ID",maxwidth=100)
と記述すると幅が100pixelを超えないよう縮小された画像が張り付けられます。(この場合は"の省略はできません。)

#img("画像ID",maxheght=100)

と記述すると高さが100pixelを超えないよう縮小された画像が張り付けられます。(この場合は"の省略はできません。)

また、maxwidth, maxheight, maxsize の = の後の値は「"」で囲む書式も利用可能です。

#img("画像ID",maxwidth="100")

の書式も利用できます。

画像貼り付けの例

左から

#img("format-rule-spam")
#img("format-rule-spam",maxsize=80)
#img("format-rule-spam",maxwidth=120)
#img("format-rule-spam",maxheight=120)~

となります。

iPentec Document 整形ルール:画像1 iPentec Document 整形ルール:画像2 iPentec Document 整形ルール:画像3 iPentec Document 整形ルール:画像4


下記の書式は

#img("format-rule-spam",maxwidth="100")

下図の画像が表示されます。
iPentec Document 整形ルール:画像5

画像に枠をつける (画像のスタイルを変更する)

画像に独自のスタイルを適用する場合は

#img("(画像ID)", style="(スタイル記述)")

と記述します。

#("format-rule-spam",style="border:1px solid #303030;")

と記述した場合の結果が下記になります。

iPentec Document 整形ルール:画像6

maxwidth, maxheight, maxsize と組み合わせる場合

#img("format-rule-spam", maxwidth=96, style="border:2px dashed #303030;")
#img("format-rule-spam",style="border:2px dotted #2060A0;",maxwidth=96)

上記のどちらの書式でもサポートしています。以前はmaxwidth:nnn の旧フォーマットには対応していませんでしたが、最新版では利用可能です。ただし、非推奨の書式のため利用はお勧めできません。

表示例

#img("format-rule-spam", maxwidth=96, style="border:2px dashed #303030;")
#img("format-rule-spam",style="border:2px dotted #2060A0;",maxwidth=96)
#img("format-rule-spam",style="border:4px double #2060A0;",maxwidth:96)

iPentec Document 整形ルール:画像7 iPentec Document 整形ルール:画像8 iPentec Document 整形ルール:画像9

画像のキャプション

画像にキャプションを記載する場合は

#img("(画像ID)", caption="(キャプション)")

と記述します。
captionを指定した場合、キャプションはfigcaptionタグで表示されます。また、画像のimgタグ、キャプションのfigcaptionタグ全体が figure タグに囲まれます。

注意
figureタグはブロック要素のため、#img 末尾に "~" を記述すると1行余計に改行されますので注意してください。
注意
captionには ")" を記述できません。&amp;#x28;→"(" &amp;#x29;→")" の記述を利用してください。

表示例

#img("spam", maxwidth=96, caption="キャプション文字列")

キャプション文字列
キャプション文字列 - iPentec Document 整形ルール:画像10

仕様変更
以前は#img #ref ともに画像はDIVタグで囲まれる仕様でしたが、上記の仕様変更によりDIVタグで囲まれなくなりました。　

画像のフォーマット

画像にフォーマットを指定する場合は、以下の書式を利用します。フォーマットを指定しない場合は、webpでの出力になります。

#img("(画像ID)", format="(画像形式子)")

画像形式には以下が利用できます。

画像形式子画像形式
jpeg JPEG形式の画像で出力します。
png PNG形式の画像で出力します。
webp WEBP形式(非可逆圧縮)の画像で出力します。
webp-lossless WEBP形式(ロスレス)の画像で出力します。

画像のリンク

画像にリンクを張る場合には、

[[#img("(画像ID)"):(URL)]]
[[#img("(画像ID)")>(PageID)]]

と記述します。

表示例

[[#img("spam",maxsize=100):http://www.ipentec.com]]
[[#img("spam",maxsize=100)>index]]

iPentec Document 整形ルール:画像11 iPentec Document 整形ルール:画像12

カスタムスタイル(クラス指定)

divタグでスタイルを指定する場合

独自に定義したスタイルを指定する場合は

#designer(class="(CSS-class)"){[(スタイルを適用する文)]}

spanタグでスタイルを指定する場合

spanタグでカスタムスタイルを利用する場合は下記の書式を利用します。

#design(class="(CSS-class)"){[(スタイルを適用する文)]}

#designerとの違いはスタイル適用対象文が#designerではdivタグで囲まれるのに対し、#desinではspanタグで囲まれます。

※この仕様は現在流動的です、必要な場合を除いて他の書式で対応してください。

表示例

#designer(class="LaegeFont"){[スタイル指定！]}
スタイル指定！

カスタムスタイル(スタイル指定)の使用

divタグでスタイルを指定する場合

独自のスタイルを指定する場合は以下の記述となります。
スタイル記述を直接埋め込むため、スタイルシートの変更は必要ありません。

#designer(style="(CSSスタイル記述)"){[(スタイルを適用する文)]}

spanタグでスタイルを指定する場合

spanタグでカスタムスタイルを利用する場合は下記の書式を利用します。

#design(style="(CSSスタイル記述)"){[(スタイルを適用する文)]}

designerとの違いはスタイル適用対象文が#designerではdivタグで囲まれるのに対し、#desinではspanタグで囲まれます。

注意
この仕様は現在流動的です、必要な場合を除いて他の書式で対応してください。
スタイルを直接記述するカスタムスタイルはドキュメントのレイアウトの整合性を崩す要因となります。特殊な場合を除き、この書式を使うことは避け、designer(class=...)指示子を用いててください。

表示例

#designer(style="font-size:22px;"){[大きな文字ですぞ！]}
大きな文字ですぞ！


#designer(style="font-size:8px;"){[小さな文字ですぞ！]}
小さな文字ですぞ！

実体参照

実体参照の文字列を表現する場合はには次の表現を利用します。

10陣数コードの場合
&#(10進数コード);
10陣数コードの場合
&#x(16進数コード);

記述例

&#169;
&#x37;

実体参照の記述を文字列として表現したい場合

&#(10進数コード); &#x(16進数コード); のパターンにマッチすると実体表現として処理されるため、 実体参照の記述を文字列として表現したい場合には、末尾の";"を実体参照の表現として記述します。
(＆は半角文字の&に置換して利用)

実体参照の表現を文字列で表示する場合
＆#(10進数コード)＆#0059;
＆#x(16進数コード)＆#x003B;

または、先頭の"&"を実体参照の表現として記述します。

実体参照の表現を文字列で表示する場合
＆#x0026;#(10進数コード);
＆#x0026;#x(16進数コード);

ページ中での "<" ">" "&" 記号の扱い

"&"

ページ中の "&" 記号は &amp; に変換されます。 preタグ内も "&" は &amp; に変換されます。
ただし、先に紹介した &#(10進数); &#x(16進数); の表記は実体参照が優先され、&amp;の変換はされません。

"<"

ページ中の "<" 記号は &lt; に変換されます。 preタグ内も "<" は &lt; に変換されます。

">"

ページ中の ">" 記号は &gt; に変換されます。 preタグ内も ">" は &gt; に変換されます。

特殊な動作

<pre>～</pre>

タグ内は行頭にスペースが存在しても整形済みテキストとして処理されません。

<script>～</script>

タグ内は行頭にスペースが存在しても整形済みテキストとして処理されません。

タグの直接入力

タグは直接入力できません。タグを入力する場合はタグであることを示すキーワード(#tag#/tag)を入力してください。

注意
タグの直接入力はコード引用のpreタグ以外は、特殊な場合を除き利用しないことを推奨します。

例

#[[p]]段落です。#[[/p]]

表組み(従来版)

表組の整形ルールはこちらのページを参照してください。

表組み(MW版)

MediaWikiでの記述に沿った新しい整形ルールがサポートされました。整形ルールはこちらのページを参照してください。

コメント

文中にコメントを挿入できます。

複数行のコメントは

#/* ... */#

と記述します。
#/*　*/#で囲まれた内部がコメントになります。#//形式の場合は行末までがコメントとなります。コメントは本文のコンテンツには表示されません。コメントを用いると、文章作成中のメモを記述できたり、文章の一部を一時的に非公開にできます。

注釈・補足 フレームの記述

文中に注釈や補足を記述することができます。
従来は補足や注意事項はセクションとして記述しましたが、セクション内の補足や注意事項の記述がしにくく、 使い勝手があまり良くありませんでした。フレームの記述を利用することで、セクション内の補足や注意事項が見やすく記述できます。

書式

#{[
 注釈本文
]}
#(){[
 注釈本文
]}
#(caption="注釈枠のタイトル"){[
 注釈本文
]}
#(category="フレームのカテゴリ", caption="注釈枠のタイトル"){[
 注釈本文
]}

カテゴリに指定できる種別

カテゴリには下記の種別を指定できます。categoryを省略した場合は note となります。
通常の補足情報は"note"を利用してください。特殊な場合に限りカテゴリを指定してください。

Category値の一覧
category値意味補足
noteメモ、補足用のフレーム
important重要事項の説明用フレーム
messageシステムメッセージ、出力等の引用、説明用のフレーム
codeカラーリングが不要のコードを記述するためのフレーム
tipsTipsの説明用フレーム
caution注意用の説明用フレーム
warning警告用の説明用フレーム(cautionよりも危険度が高い表示になります。)
question質問コンテンツ用フレーム 2025/3追加
talkトークコンテンツ用フレーム 2025/3追加


表示結果についてはこちらのページを参照してください。

フレームの記述内でのコードの引用

フレームの記述内でコードを記述する場合は後述のコード引用を利用します。

記述例

#(category="code", caption="コード"){[
```
  //ピックアップ処理
  CsharpInsertPoint = new int[RunResultSectionLineIndex.Count];
  for (int k = 0; k < RunResultSectionLineIndex.Count; k++) {
    CsharpInsertPoint[k] = RunResultSectionLineIndex[k];
  }
```
]}

コードでない場合は #pre を利用します。

#(category="code", caption="コード"){[
``
  システムからのメッセージを掲載しています。
``
]}
#(category="code", caption="コード", option="pre"){[
  ``
  //ピックアップ処理
  CsharpInsertPoint = new int[RunResultSectionLineIndex.Count];
  for (int k = 0; k < RunResultSectionLineIndex.Count; k++) {
    CsharpInsertPoint[k] = RunResultSectionLineIndex[k];
  }
  ``
]}

または直接preタグを記述します。この記述方式は非推奨です。

#(category="code", caption="コード"){[
#[[pre]]
  //ピックアップ処理
  CsharpInsertPoint = new int[RunResultSectionLineIndex.Count];
  for (int k = 0; k < RunResultSectionLineIndex.Count; k++) {
    CsharpInsertPoint[k] = RunResultSectionLineIndex[k];
  }
#[[/pre]]
]}

user属性

userを記述するとユーザー情報をフレーム内に表示できます。

表示結果についてはこちらのページを参照してください。

フレームの入れ子

フレームを入れ子にすることもできますが、デザインの観点から3段以上の入れ子は非推奨です。

記述例

#(category="warning", caption="警告"){[
必ず終了処理を実行してください。メモリリークの原因になります。~
#(category="tips",caption="ワンポイント"){[終了処理は、Terminate() で呼び出せます。]}
]}

表示結果についてはこちらのページを参照してください。

廃止機能: あとがき (Afterwords)

廃止
この機能は廃止されました

あとがきを挿入できます。あとがきは本文の情報の外側に記載されます。余談や本文とは関係の薄い話題を挿入できます。

書式

#Afterwords(){[
 あとがき本文
]}

ページの説明 (Description)

ページの説明を挿入できます。meta descriptionに反映されます。

書式

#Description(){[
 ページの説明
]}

コードの掲載：文中用コードマークアップ

短文のコードやワード単位のコードを引用することができます。
従来はコード引用時には整形済みテキストのフォーマットを利用していましたが、整形済みフォーマットの場合、div枠で整形されるため、文中のコード引用には使いづらい書式でした。文中用マークアップを利用すると、spanタグで整形されるため文中での利用も容易になります。

書式

書式は下記です。

`引用コード`


コードのブロックは複数行での記述はできません。1行で記述する必要があります。

注意
コードマークアップよりも整形済みテキストの書式が優先されます。コードマークアップのブロックが複数行になる場合、先頭に空白を配置すると表示崩れの原因になります。
注意
"`", "``", "```" は入れ子にできません。

表示例

表示例はこちらのページです。

テキストの掲載 (複数行)

テキストを掲載する場合は以下の書式を利用します。

書式

``
  引用コード
``

表示例

表示例はこちらのページです。

コードの掲載 (複数行)

コードを掲載する場合は以下の書式を利用します。

書式

```
  引用コード
```

preタグ内にcodeタグが付加され、コードであることが表現されます。

補足
コードハイライターを利用する場合は、直接preタグを記述する方式が推奨です。

表示例

表示例はこちらのページです。

コードの掲載：ハイライトなし (タグ記述方式)

ハイライトなしのプログラムコードの掲載をする場合は、preタグを利用します。下記の書式を利用します。

#[[pre]]
  (...引用するコードを記述)
#[[/pre]]

表示例

表示例はこちらのページです。

補足
整形済みテキストよりpreタグが優先されるため、整形済みテキスト内に#preコード自体を記述する場合は#を"&amp;#35;"に置換する必要があります。
補足
iPentec Documentの編集ルールとして、コード引用の上部にコードの説明を記述することを基本方針として推奨しています。

コードの掲載：ハイライトあり (タグ記述方式)

キーワードをハイライトした、プログラムコードの掲載が可能です。preタグを直接記述する書式を利用します。
キーワードハイライトを利用する場合はこの書式を利用することが推奨されています。

#[[pre class="brush:(言語指定)"]]
  (...引用するコードを記述)
#[[/pre]]

表示例

表示例はこちらのページです。

コードヘッダの記述

コード引用枠のための専用のヘッダを記述できます。この機能はiPentec Documentの基本機能のため、下記の書式を利用します。

[|キャプション|]

マージンについて

コードヘッダとコード引用のpreタグには隣接タグCSSが定義されており、コードヘッダがある場合でも、コードヘッダが無い場合でもコード引用部分の上部にマージンは取られます。

表示例

[|C# での実装例|]
#[[pre class="brush:csharp"]]
public string GetolString(int olCount)
{
  string olStr = "";
  for (int i = 0; i < olCount; i++) {
    olStr += "</ol>";
  }
  return olStr;
}
#[[/pre]]

上記コードの実際の表示は下記になります。

C# での実装例
public string GetolString(int olCount)
{
  string olStr = "";
  for (int i = 0; i < olCount; i++) {
    olStr += "</ol>";
  }
  return olStr;
}

アコーディオンパネル

展開可能な枠を設置できます。書式は次の通り。

#accordion(){[
  (コンテンツ)
]}

#accordion(expand="[開くボタンの文字列]", collapse="閉じるボタンの文字列]"){[
  (コンテンツ)
]}

例

#accordion(){[
(コンテンツ1)~
(コンテンツ2)~
(コンテンツ3)~
(コンテンツ4)~
(コンテンツ5)~
(コンテンツ6)~
(コンテンツ7)~
(コンテンツ8)~
(コンテンツ9)~
]}
(コンテンツ1)
(コンテンツ2)
(コンテンツ3)
(コンテンツ4)
(コンテンツ5)
(コンテンツ6)
(コンテンツ7)
(コンテンツ8)
(コンテンツ9)
#accordion(expand="もっと見る - OPEN", collapse="閉じる - CLOSE"){[
(コンテンツ1)~
(コンテンツ2)~
(コンテンツ3)~
(コンテンツ4)~
(コンテンツ5)~
(コンテンツ6)~
(コンテンツ7)~
(コンテンツ8)~
(コンテンツ9)~
]}
(コンテンツ1)
(コンテンツ2)
(コンテンツ3)
(コンテンツ4)
(コンテンツ5)
(コンテンツ6)
(コンテンツ7)
(コンテンツ8)
(コンテンツ9)

以上

AuthorPortraitAlt
著者
iPentec Document 編集部
iPentec Document 編集部です。
快適な生活のための情報、価値のある体験やレビューを提供します。
作成日: 2009-02-24

関連するページ

ドキュメント
新着記事一覧
タグ一覧
ドキュメント トップ
SNSコンテンツ
YouTube
Instagram
Pinterest
X
iPentec
iPentecについて
プライバシー
お問い合わせ
Copyright © 1995–2025 iPentec all rights reserverd.