On this page |
|
Tip
ヘルプサーバー内の任意のページのそのままのマークアップを確認したいのであれば、URLの最後に.txt
を付けて(例えば、/nodes/sop/copy.txt
)アクセスしてください。
クィックスタート
ページの構造
= Title = #name: value """要約。""" == 最初の見出し == これは段落です。 空白行で段落を分けます。 == 2つ目の見出し == * Bullet one. * Bullet two Bullet twoのサブ段落。
スタイル
これは *太字*, これは _イタリック体_, これは`コード`,
コメント
// 一行コメント <!-- HTML形式のフリーフォームコメント -->
タイトル
タイトル
= タイトル =
前のタイトルとサブタイトル
タイトルには、"前のタイトル"や"サブタイトル"の部分を持つことができ、HTML内で視覚的な強調を抑えることができます。
前のタイトル付きのタイトル
= What's new |> Rendering =
サブタイトル付きのタイトル
= Saturday the 14th <| the sequel =
前のタイトルとサブタイトルの両方
= Pre-title |> Main title <| Sub-title =
プロパティ
マークアップ
プロパティは、ブロックのレンダリングを修正をするために広く使われています。基本的なプロパティの形式は以下の通りです:
#name: value
ページプロパティ
ブロックプロパティ
ブロック下でインデントされているプロパティは、そのブロックに適用されます。
* これは箇条書きです。 #name: value
利用可能なプロパティのリストは、以下の個々のブロックタイプを参照してください。
マルチライン
値をインデントすることで、マルチラインの値を持つことができます。
#name: これはマルチラインの プロパティ値です。
ページプロパティのリスト
名前 |
値 |
---|---|
|
このページを表現する小さい画像までのパス。 |
|
そのページに適用されるディスプレイクラスをスペースで区切ったリスト。
ページのタイトルを表示しません。 詳細は、ディスプレイプロパティを参照してください。この機能は、実験段階であり変更予定です。 |
|
ヘルプシステムがこのページをロードしようとすると、そのページを、指定したパスにリダイレクトします。 |
|
親とサブトピックを参照してください。 |
見出し
マークアップ
== 見出しのレベル 2 == === 見出しのレベル 3 === ==== 見出しのレベル 4 ===
ID
標準プロパティを使うことで、見出しにIDを振ることができます:
== How to == #id: howto
これは、見出しにリンクすることができます(以下のリンクを参照)。また、IDと見出しの関連付けに利用可能な若干コンパクトなマークアップもあります:
== How to == (howto)
インデント(字下げ)
通常、このwikiマークアップでは、インデントとは、字下げしたブロックがブロックの"内部"にあることを意味します。 しかし、 見出しの後に必ずしもインデントする必要はありません 。 パーサーは自動的に"正しい処理を行なって"、ブロックを追加し — 付随する見出しを追加 — その後に見出しを追加します。
例:
== Foo == この段落は、インデントしなくても"Foo"セクションの一部と見なされます。 === Bar === このブロックは、"Bar"の見出しの下にあり、そして"Foo"の見出しの下でもあります。
以下の段落を見出しの下に置きたいけれども、すべての下に置きたくない場合は、見出しの下でインデントを追加すればいいだけです。これは内容を他のページに含ませる時に役立つことがあります:
== 包含する見出し == (includeme) この段落を他のページに含ませる時に、それを見出しと一緒に含ませたい。 この段落を含ませたくない。
ディスプレイプロパティ
pull left
内容を字下げし、左側の余白に見出しを表示します。
notitle
見出しを表示しません。
リスト
箇条書きリスト
* 箇条書き * 箇条書き
番号リスト
# 1番目 # 2番目
定義
Cat: 動物のタイプ。 Cinq: フランス語の5。
タスク
:task: レンダーを起動する: # Render Viewタブに進みます。 # __Render__ をクリックします。 :task: Houdiniを使うことを辞める: 人生の選択を考えなおしてください。
テキスト
スタイル
マークアップ |
レンダリング |
---|---|
|
太字 |
|
イタリック体 |
|
|
|
UI |
|
File ▸ Open |
|
variable |
キー
マークアップ |
レンダリング |
---|---|
|
K |
|
⇧ Shift |
|
⇧ Shift + K |
|
Alt ⌥ Option |
|
⌃ Ctrl ⌘ |
|
up down left right |
|
⇥ Tab |
|
⌦ Del |
|
|
|
|
|
|
タイポグラフィ
マークアップ |
置換 |
---|---|
シングルクォートやダブルクォート |
曲線形のダブルクォート |
|
← と → |
|
4×4 |
|
≤ と ≥ |
|
© ™ ® |
|
… |
通知
ヒントとメモ
TIP: これはヒントです。 これはヒントの2番目の段落です。 NOTE: これはメモです。 WARNING: これは警告です。
Tip
これはヒントです。
これはヒントの2番目の段落です。
Note
これはメモです。
Warning
これは警告です。
大文字のTIP:
構文は、マークアップのページで筆者に視覚的に目立つように意図しています。これは、以下の標準のマークアップと等価です:
標準の項目形式
:tip: これはヒントです。 :note: これはメモです。 :warning: これは警告です。
他の通知
Houdiniには他にもいくつかのタイプの通知があります。それらのタイプには標準の項目マークアップだけを使用することができ、大文字にして使用することはできません。
:new: 新しい事。 :improved: 高速化された事。 :changed: 変更された事。 :dev: 開発者向けの事。 :fixed: 修正された事。 :bug: まだ修正されていない事。
New
新しい事。
Improved
高速化された事。
Changed
変更された事。
Developer
開発者向けの事。
Fixed
修正された事。
Unresolved
まだ修正されていない事。
プラットフォーム
Mac OS X, Windows, Linuxによって異なる事を指定するための特別な通知があります。
:platform:Mac これはMacでの話です。 :platform:Windows これはWindowsでは411です。 :platform:Linux これはLinuxでの話です。
Mac
これはMacでの話です。
Windows
これはWindowsでは411です。
Linux
これはLinuxでの話です。
アイコン
アイコン
マークアップ |
レンダリング |
---|---|
|
|
|
|
|
Font Awesome
あなたのページ内にFont Awesomeアイコンフォントをアイコンにすることもできます。
見出し, 箇条書き, 定義, 通知, テーブルセル, タブには、#glyph:
プロパティによって独自の絵文字を使用することができます。
* こうもり傘を忘れずに。 #glyph: fa-umbrella * オフィスに行きます。 #glyph: fa-building * 空き箱を拾ってください。 #glyph: fa-cube TIP: #glyph: fa-certificate これは新機能です。
-
こうもり傘を忘れずに。
-
オフィスに行きます。
-
空き箱を拾ってください。
Tip
これは新機能です。
テキスト内にFont Awesome絵文字を埋め込むことができます:
マークアップ |
レンダリング |
---|---|
|
|
#glyph
プロパティにfa-spin
などの他のFont Awesome CSSクラスを使用することができます。
* これは数秒かかります。 #glyph: fa-spinner fa-spin
-
これは数秒かかります。
メディアとリンク
リンク
リンク先 |
マークアップ |
---|---|
Wiki |
|
Web page |
|
ページ内のリンク
ページ内をリンクするには、最初に見出しや他のブロックにIDを振ってください:
== リンク先の見出し == (linktome)
そして、同じページ上でそこにリンクします:
[そこに行く|#linktome]
または他のページから:
[そこに行く|/path/to/page#linktome]
ショートカット
リンク先 |
マークアップ |
---|---|
ノード |
|
エクスプレッション関数 |
|
VEX関数 |
|
Mantraプロパティ |
|
HOMモジュール/クラス |
|
HOMメソッド/関数 |
|
Wikipedia |
|
HScriptコマンド |
|
画像
[Image:/path/to/image]
画像の比較
:compare_images: #image1: /images/buildings.jpg #image2: /images/commute.jpg
ビデオ
:video: #src: /path/to/video.mp4
Vimeoビデオ
:vimeo: Video title #id: 84058031
チャートとグラフ
FLOTライブラリを使用することで、ページ上にチャートとグラフを生成することができます。 オプションとデータ形式に関する情報は、そのページを参照してください。
:chart: #left: truth #bottom: height #options: { "xaxis": {"ticks": [0, 50, 100, 150, 180, 200, 250]}, "yaxis": {"ticks": [0, 0.5, 1]} } #data: [ {"data": [ [0, 0], [179, 0], [180, 1], [250, 1] ]} ]
left |
チャートの左側(垂直)の軸のラベル。 |
bottom |
チャートの下側(水平)の軸のラベル。 |
options |
ライブラリに渡されるJSONオブジェクト。 |
data |
ライブラリに渡されるJSONリスト。 |
テーブル
単純なテーブル
単純なテーブルのマークアップは、ほとんどの場合に使用します。
二重の垂直線で終わるライン(||
)は、 見出し セルです。
単一の垂直線で終わるライン(|
)は、通常のセルです。
インデントされたセルは、その親の 隣 に現れます。
コラム 1 || コラム 2 || 1番目のセル | 2番目のセル 2番目のセル内に2番目の段落。
コラム 1 |
コラム 2 |
---|---|
1番目のセル |
2番目のセル 2番目のセル内に2番目の段落。 |
単純なマークアップの主な欠点は、行内の最後のセルしか複数の段落を持てないことです。
フルテーブル
単純なマークアップが作成できる事よりも複雑なテーブル(例えば、行や列の間隔)が必要であれば、HTMLテーブルを使用することができます。 以下のHTMLを参照してください。
HTML
HTMLの埋め込み
wikiマークアップにHTMLを埋め込むことができます。HTMLタグを使用すると、テキストがwikiテキストとして解釈されます。
You need to <strike>burn</strike> deprecate that node.
擬似HTML
複雑なHTMLに関しては、インデントに基づいて"擬似HTML"マークアップを使用したほうが綺麗です。
>>
で終わる行は、HTMLエレメントタグとして扱われ、その下にインデントした内容は、HTMLエレメントコンテンツとして扱われます。
table width="100%">> tr>> td colspan="2">> Alpha td>> Bravo tr>> td>> Charlie td>> Delta td>> Echo
整理
分割線
3つ以上のチルダ文字(~
)の行は、水平線を作成します。そのチルダの後にテキストを配置すると、ラベル付きの分割線が作成されます。
ライン分割線 ~~~ テキスト付きライン分割線 ~~~ Or ~~~ ディスプレイスタイル付きのライン ~~~~ #display: red 簡単!
ライン分割線
テキスト付きライン分割線
ディスプレイスタイル付きのライン
簡単!
ボックス
:box: #display: raised これは、ボックス内の内容です。
これは、ボックス内の内容です。
丸み付け
影付き
境界付き
反転
説明文
box
ブロックにテキストを追加すると、その内容の内側に小さなラベルが配置されます。
:box: Decoratorのサンプル {{{ #!python @decorator def foo(): return "bar" }}}
Decoratorのサンプル
@decorator def foo(): return "bar"
Columns
コラムは、ブラウザの幅に順応します。ブラウザの幅が狭ければ、それらのコラムは単一のコラムに折り畳まれます。
:col: コラム 1 段落 1 コラム 2 段落 2 :col: コラム 2 段落 1 コラム 2 段落 2
コラム 1 段落 1
コラム 2 段落 2
コラム 2 段落 1
コラム 2 段落 2
(上記のコラムが見えない場合は、あなたのブラウザウィンドウを広げてみてください。)
タブ
:tab: Reality これが現実の世界です。 :tab: Fantasy これが虚像の世界です。
これが現実の世界です。
これが虚像の世界です。
#selected: true
ページを読み込んだ時にタブを選択状態にするには、そのタブにこのプロパティを追加します。
#glyph: font-awesome-name
タブにFont Awesome絵文字を表示させるには、このプロパティを追加します。
ブロックの分割
2個のチルダ文字(~~
)だけを使用すると、"不可視の"分割線が作成されます。
これはラインとしてレンダリングしませんが、同じタイプのブロックのグループを分けます。
これは、一連の:tab:
や:col:
のブロックがある時に、それらを別々のグループに分けたい時に役に立ちます。
バブル !!(beta)
バブルとは、チャットバブルのような見た目の特別なボックスです。
:bubble: 彼が _なんだと_!? と言ったよ。 #dir: left #display: yellow :bubble: #dir: right #display: teal そうだよな!? 彼はどこでイライラしてるんだ?
彼が なんだと!? と言ったよ。
そうだよな!?
彼はどこでイライラしてるんだ?
#dir: direction
right
down
left
up
#display: look
バブルのカラーの設定に使用します。ディスプレイプロパティを参照してください。
ディスクロージャ
:disclosure:
ブロックは、折り畳まれたヘッダに追加情報をさり気なく隠すことができます。
:disclosure:Technical discussion Overly technical explanation which most users won't be interested in.
Technical discussion
Overly technical explanation which most users won’t be interested in.
脚注
fold(折り畳み) と呼ばれる"脚注"内の余計なテキストを隠すことができます。[Fold:name]
ショートカットはボタンを作成します。
同じ名前の#fold: name
を持った:box:
があれば、ボタンをクリックすることで、そのボックスの内容が表示されます。
Houdiniに関してあなたが知りたかったすべての事[Fold:1]. :box: #fold: 1 ...を聞くのが怖くてできなかった。
Houdiniに関してあなたが知りたかったすべての事.
…を聞くのが怖くてできなかった。
複数のショートカットが折り畳みボックスの#fold:
プロパティと同じ名前である限り、それらを使用して、そのボックスを参照することができます。
ビルボード !!(beta)
上にテキストが乗った"カバー"画像。これは、前置きや目次のページ向けに"斑点"を作成するのに使用します。
:billboard:Houdini 15.0 #image: /images/billboards/zombie_flame_poster.jpg プロシージャルなアニメーションとエフェクト
コード
インライン
バッククォート(`
)でテキストを囲むと、それをコードとしてレンダリングします。
シェルで`echo $HFS`とタイプしてください。
コードブロック
{{{
と}}}
の間の行がコードのブロックとして扱われます。
1行目を#!
で始めると、使用する構文のカラーを指定することができます。
Pygmentsライブラリから任意の構文名を使用することができ、さらに、Houdini固有の言語のhscript
とvex
を使用することができます。
{{{ #!python def double(n): return n * 2 }}}
ディスプレイプロパティ
#display: !!(beta)
ページ上や色々なブロックタイプに対して#display:
プロパティを使用することで、ブロックのHTMLでの表示方法を修正することができます。
この値は、スペース区切りのクラスのリストです。
== ヘッダー == #display: notitle collapsible inverted :tab: タブ 1 #display: red タブの内容。
Note
使用可能な値のほとんどが、すべてのブロックタイプで動作するわけではなく、また完全に実装されていなかったり、すべての組み合わせで動作しないことがあります。
以下のブロックタイプは、色々な形式でディスプレイプロパティを受け入れます:
-
Page
-
Headings
-
Columns
-
Table cells
-
Tabs
-
Dividing lines
-
Boxes
-
Bubbles
値
notitle
ページや見出しに対して、そのタイトルを隠します。
collapsible
見出しに対して、ユーザーがその内容を折り畳んだり展開することができます。
collapsed
見出しに対して、折り畳まれた状態で始めます。
pull left|right
見出しに対して、タイトルをボディの横に移動させます。
inverted
内容を反転して表示します。
colorname
カラー名を使ってブロックに色を付けることができます。異なったブロックタイプを異なった方法でカラーを適用することができます。
:box: #display: raised yellow これは、影付きの黄色いボックスです。 TIP: #display: orange これは、オレンジ色のヒントです。
これは、影付きの黄色いボックスです。
Tip
これは、オレンジ色のヒントです。
gray
blue
pink
red
green
yellow
purple
magenta
teal
orange
seafoam
white
@マークのセクション
概要
@マークは、トップレベルの見出しのような挙動をします。これは、ページ内の特定のセクションでマークします。そのセクション内の項目を特別な扱いにすることができます。
サンプルに関しては、ノードヘルプに"parameters"セクションがあります:
@parameters
このセクション内では、無名の項目が特定のパラメータのドキュメントとして扱われます:
@parameters ::Group: このノードの適用先となるエレメントを指定します。
@parameters
セクション外で無名の項目のブロックを使用した場合と異なり、これはインデックス化されてレンダリングされます。
マークアップ
@セクションは、このように見えます:
@name タイトル
タイトルを与えなかった場合、その見出しは、そのセクションを大文字にした名前(例えば、@parameters
→ Parameters)を使ってレンダリングされます。
プロパティ
#status: code
-
nd
– not documented -
ni
– not implemented.
まさに見出しのようにセクションに対して#display:
プロパティを使用することができます。
インクルード
マークアップ
他のファイルの内容を含ませるには(パスは現行ページまでの絶対パスまたは相対パスを指定することができます):
[Include:path/to/file]
他のファイルから1ブロックのみを含ませるには、#
とブロックのIDを追加します:
[Include:/path/to/file#blockid]
他のファイルから1ブロックの 内容 だけを含ませるには、IDの後にスラッシュを追加します:
[Include:/path/to/file#blockid/]
検索
基本
:list:
ブロックは、ページ上に検索クエリの結果を表示させることができます。
:list: #query: title:cap
プロパティ
#query: search query
検索クエリ。
#filtered: yes|no
no
の場合は、検索結果の上にフィルタリングのインターフェースを表示しません。
#filters: field names
検索フィールドをスペースで区切ったリストで、これによって、ユーザーが検索結果をフィルタリングすることができます。
#sortedby: field name
検索結果のソートで使用するフィールドの名前。フィールド名の頭にマイナス記号(-
)を付けると、ソート順が逆になります。
#groupedby: field name
指定したフィールドの値で検索結果をグループ化します。
#groupedby:
フィールドを指定した場合、オプションで#labels: path
プロパティを指定することもできます。
これには、フィールド値をグループラベルにマッピングした[Labels]
セクションを持ったサーバー上の.ini
ファイルを指定します。
#includecontent: true|false
true
の場合は、リンク先の合致した各ドキュメントの内容を含めます。これにより、あなたのページが 非常に 大きくなってしまうことがあるので気を付けてください。
#limit: num
検索結果を、このヒット数に制限します。
#display:
show-icons
検索結果に対して、それらが持っているアイコンを表示します。
narrow-columns
/ columns
/ wide-columns
検索結果をコラムに分割します。
親とサブトピック
Index page
wikiファイルのディレクトリでは、index.txt
という名前のファイルが、そのディレクトリでの"目次"ページとして扱われます。
ユーザーがそのディレクトリをブラウジングすると、サーバーは、そのindex
のページを表示します。
サブトピック
現行の"親"ページの"子"トピックにリンクを付けるには、@subtopics
セクションを作成します。
@subtopics ::[レンダリングの紹介|intro] ::[高度なレンダリング|advanced]
"子"リンクは、親と同じディレクトリにある必要はありません。
subtopicsセクション内に見出しを使用することで、それらのリンクを整理することができます:
@subtopics == はじめよう == ::[レンダリングの紹介|intro] ::[基本的なレンダリングの開始|basic] == 次のステップ == ::[パフォーマンスのチューニング|tuning]
親プロパティ
各ページには、階層内での現行ページの親を意味する"パンくずリスト"を表示します。
ページが存在しているディレクトリに_index
ページがあれば、それが自動的に親ページとして扱われます。
そのディレクトリに_index
ページがない場合や、別の親を使用したい場合は、親ページのパスを持つトップレベルの#parent:
プロパティを含ませます:
= Title = #parent: /examples/