&title:kukiki:整形ルール [[[index kukiki]]] [[Introduction](introduction.md)] [[Download](setup.md)] # Kukiki-整形ルール kukiki ver. 0.9の文法です. まだ微妙にドキュメント化されていないものもあります. |*機能|*表記| |[[#headline 見出し]]|{{\*~,**~,***~\}}| |[[#link リンク]]|{{\ [[URL ~]]\}}| |[[#list リスト]]|-~,+~,--~| |[[#font 文字色とサイズ]]|{{\{{color:red|~}},{{size:2.0|~}}\}}| |[[#dec 装飾]]|{{\''強調'',**斜体**,~~取り消し~~,__下線__\}}| |[[#quote 引用]]|>~| |[[#comment コメント]]|//~,//!~| |[[#esc エスケープ]]|\\~,{{\\{{\~\}}\\}}| |[[#table 表]]|{{\|~|~|~|\}} or ,~,~,~| |[[#p 改行と段落]]|~~| |[[#module 拡張モジュール]]|&module| ## 見出し {#headline} 行頭に「*」(アスタリスク)がある行は見出しになります. アスタリスクの数で見出しの大きさが調整できます. ``` # 見出し(*) ## 中見出し(**) ### 小見出し(***) #### 極小見出し(****) ``` :::block box # 見出し(*) ## 中見出し(**) ### 小見出し(***) #### 極小見出し(****) ::: ## リンク{#link} \\[[URL 表示するテキスト]] でリンクを張れます. 英数字のみのURLや,「:」から始まるリンク先は,サイト内のページへリンクします. 画像は勝手にIMGタグで埋め込まれます.埋め込みが嫌な場合はURLの頭に「!」を付けてください. \\URLを後に書きたい人は[[テキスト|URL]]という風に縦棒で区切ってください. ``` 例: \\[サンプルページ](サンプルページ.md) \\[Google](http://www.google.co.jp) \\[[ダウンロード|:../download/]] ``` :::block box - [サンプルページ](サンプルページ.md) - [Google](http://www.google.co.jp) - [[ダウンロード|:../download/]] ::: \\日記機能が有効になっていると,[[先月の13日]]というような, 日付に関係する言葉を解釈してリンクを生成してくれるおまけ機能があります. 画像の左右にテキストを回り込ませたい時は,ファイル名の後にカンマ(,)を入れて, rightもしくはleftと書いてください. 二重のチルダ「~~」を行末に入れると回り込みをクリアできます. ## リスト{#list} 「-」による番号無しリストと,「+」による番号つきリストをサポートしています. ネストにも対応しています. ``` - 新幹線 -+のぞみ -+つばさ -+あさま - 特急 -+あずさ -+しなの ``` と書くと, :::block box - 新幹線 -+のぞみ -+つばさ -+あさま - 特急 -+あずさ -+しなの ::: という風に表示されます. ## 文字色とサイズ {#font} \\{{COLOR:色|文字列}}で色を変えられます. ``` {{COLOR:red|赤文字}} {{COLOR:blue|青文字}} ``` {{COLOR:red|赤文字}} {{COLOR:blue|青文字}} \\{{SIZE:倍率|文字列}}でサイズを変えられます.1.0が標準の大きさです. ``` {{SIZE:1.5|大きい文字}} {{SIZE:0.5,COLOR:red|小さい文字(赤)}} ``` {{SIZE:1.5|大きい文字}} {{SIZE:0.5,COLOR:red|小さい文字(赤)}} fontモジュールを使って{{\&font(red,1.5){テキスト}\}}と 書くのもありです.お好きな書き方で. ## 注釈 \\{{NOTE:これは注釈です}}という風に書くとページの下に注釈が入れられます. 注釈~{{NOTE:これは注釈です}} ## 装飾{#dec} ``` \\-''強調'' \\-'''斜体ABC''' \\-==取り消し線== \\-__下線__ ``` :::block box - ''強調''~ - **斜体ABC**~ - ~~取り消し線~~~ - __下線__~ ::: ## 引用文{#quote} 「>」から始まる行は引用文になります. > これは引用文です. ## コメント{#comment} 「//」で始まる行はコメントとして扱われ,表示されません. HTMLのコメントとしても出力されたくない場合は「//!」としてください. ``` 下にコメントの例を書きます \\// この行は表示されません(HTMLのコメントになります) \\//! この行は完全に不可視です(HTMLのコメントにもなりません) ``` :::block box 下にコメントの例を書きます // この行は表示されません(HTMLのコメントになります) //! この行は完全に不可視です(HTMLのコメントにもなりません) ::: ## エスケープ{#esc} 「\\」から始まる行では,変換が無効になります. \\行の途中を無効にしたい場合は「{{\」~「\}}」で囲んでください. ## 表{#table} \\「|A|B|C|」という風に「|」(縦棒)で囲むと表が作れます. 左側にスペースを入れると,右寄せにもできます. 項目の頭に「*」が付いていると,表の見出しになります. ``` \\|*項目A|*項目B|*項目C| \\| 1| 2| 3| \\| い | ろ | は | ``` :::block box |*項目A|*項目B|*項目C| | 1| 2| 3| | い | ろ | は | ::: ## 段落と改行 {#p} 空行が段落の境界として扱われます. また,行頭に「~」がある場合も段落を変えます. 強制改行したい場合は行末に「~」を付けてください. 「~」のみの行は段落ではなくて改行として優先されます. ## 拡張 {#module} 拡張機能として「&」から始まるキーワードがあります. modulesフォルダ内のモジュールや内部モジュールを呼び出すときに使います. モジュールに渡すデータが単一行の場合,「&title:ページのタイトル」という風に一行に書きます. 複数行のデータを書きたい場合は,「&plain{」というように括弧を開いておくと, 「&}」という括弧を閉じるまでが有効になります.「{}」のほかにも「[]」でもOKです. 「{{~}}」のように二文字以上の場合,閉じるときに「&」は不要です. #### 内部モジュール - &CENTER - &block HTMLでいうDIV - &plain 書かれたテキストをそのまま表示します - &navi ナビゲーションバー - &html HTMLを書きます - &title 文書のタイトルを指定(ファイルの先頭に無いと有効になりません) ``` \\&CENTER:「&CENTER:~」による中寄せ ``` :::block box &CENTER:「&CENTER:~」による中寄せ ::: #### 外部モジュール 内部モジュールと同じように呼び出せます. 例えば,&sourceとすると,modules/filter_source.pmにテキストが渡されます. ``` \\&source{ /* filter_source.pmのテスト # / int main() { int test=123; // コメントテスト printf("Hello, World!\n"); return 0; } \\&} ``` ```cpp /* filter_source.pmのテスト # / int main() { int test=123; // コメントテスト printf("Hello, World!\n"); return 0; } ``` この文書自体のソースが読みたいなら[rule.md](rule.md?)を読んでください.