シビライザーカスタムマークアップコマンド - suewonjp/civilizer-jpdoc GitHub Wiki

シビライザーカスタムマークアップコマンドはマークダウンが支援しない機能を支援する為考案されている．

✔️ 基本シンタックス

基本シンタックスは次の何かである．

  • {{[ コマンド名 ] 対象テキスト ... }}
  • {{{[ コマンド名 ] 対象テキスト ... }}}

✔️ テキスト色コマンド

テキスト色コマンド
Figure 1. Text テキスト色コマンド

  • このコマンドはテキストの色を指定する為に使用される.
  • フラグメントエディターのテキスト色メニューでも使用可能.
  • 現在，次のコマンドが使用可能:
    • {{[clr-c] ... }} シアン
    • {{[clr-b] ... }} 青
    • {{[clr-r] ... }} 赤
    • {{[clr-g] ... }} 緑
    • {{[clr-y] ... }} 黄
    • {{[clr-m] ... }} 紅紫色
    • {{[clr-v] ... }} 紫
    • {{[clr-br] ... }} ブラウン

✔️ ラインスタイリングコマンド

  • 取り消し線
    • {{[st] ... }}
  • 下線と太字
    • {{[usb] ... }}

✔️ リンクコマンド

  • フラグメントへのリンク
  • タグリンク
    • {{[tag] Tag-ID ... }}
    • 手動でこのコマンドを打つよりは専用のドラッグアンドドロップを利用すること.
  • Link to a File
    • {{[file] File-ID ... }}
    • 手動でこのコマンドを打つよりは専用のドラッグアンドドロップを利用すること．

✔️ はめ込みコマンド

  • {{[frgm-embed]フラグメントID ... }}
    • 指定したIDが指すフラグメントをはめ込む.
    • 現在，このコマンドの為のメニューは用意していない.
      • 例) {{[frgm-embed]1234}}
    • フラグメントに同じフラグメントをはめ込むと(つまり，再帰的に)危険!!!
      • ブラウザーがハングアップしたりする！.

✔️ インラインHTMLコマンド

  • マークダウンは基本HTMLタグを受け入れる仕様であるが,シビライザーは（主にセキュリティの理由で）この仕様にわざと対応していない.
  • その代わりにインラインHTMLコマンドを提供し限定的にHTMLコードを受け入れている．（まだ実験中の機能）
    • インラインタグ(<span>のような) を入れるにはダブル波括弧を使用 : {{[html] ... HTML ... }}
    • ブロックタグ(<div>のような) を入れるには３つ波括弧を使用 : {{{[html] ... HTML ... }}}
  • あるいは, 対象のHTMLコードを選択した後，フラグメントエディターツールバーの HTML メニューを使用.

注意
時には変なHTML(ちゃんと閉じられていないタグなど)によりライアウトが崩れたり何も表示されなかったりするのでこのコマンドにはかなりの注意が必要.
外部由来のHTMLコードをコピーペーストでインラインHTMLコマンドの中に取り入れる時には慎重にHTMLコードをレビューし特にJavaScriptコードは全て排除するべきである.
シビライザーは特に次の何かのタグがインラインHTMLコマンドで使用された場合，警告無しで取り除く.

  • <html>, <head>, <body>, <link>, <script>

✔️ 文字通りの波括弧を入力するには？ (バージョン0.9.0.RC5から)

  • カスタムマークアップコマンドにおいて２つ，３つの波括弧は大事な意味を持つ為，（２つ以上の）波括弧を文字通りに書きたい場合問題になる.
  • 例えば, 文字通りの {{ hello }} をフラグメントの中身に書きたい場合，
    • １つのオプションは { hello } のように１つ波括弧で我慢する. :-)
    • どうしても２つ以上書きたい場合，HTMLエンティティの&#125;&#125;（ }} ）や&#125;&#125;&#125;( }}} )を右括弧の代わりに使用．
    • 左括弧はそのまま使用して良い
    • 例えば，{{ hello }} を文字通りに表現したい場合, {{ hello &#125;&#125; のように書けば良い．
⚠️ **GitHub.com Fallback** ⚠️