mark パラメーター

mark パラメーターを使用して、名前付きまたは名前なしマークを照会、設定、あるいは除去します。 マークとは、文書の隣接部分に割り当てられたラベルのことです。 文書が編集されても、マークの位置は維持されます。 つまり、マークは最初に配置されていたテキストに残されます。

マークには、エレメント・マークと文字マークという 2 つのタイプがあります。 エレメント・マークには桁位置がなく、完全なエレメントのみを参照します。 文字マークには桁位置があり、部分エレメントを参照することができます。 また、マークをスティッキー・マークにするかどうかを指定することもできます。 スティッキー・マークは、テキストがそのマークの直前または直後に追加されると展開します。

使用可能

query コマンド
set コマンド

有効範囲

現行ビュー。

構文

query mark.[name | #id]
set mark.[name | #id] { clear
                      | [ sticky ] element [ element1 [ element2 ] ]
                      | [ sticky ] [ element1 [ column1 [ element2 [ column2 ] ] ] ]
                      } 

パラメーター

name name パラメーターを使用して、新しい名前または既存のマークの名前を指定します。名前はスペース以外の文字を含むことができますが、# 文字で始まることはできません。
id id パラメーターを使用して、既存のマークの ID を指定します。  ID は、マークを一意に識別する正の整数値です。
clear clear パラメーターを使用して、指定したマークを除去します。
[ sticky ] element
[ element1 [ element2 ] ]
エレメントがマークの直後または直前に追加されるとこのマークが展開するようにしたい場合には、 sticky パラメーター (オプション) を指定します。 element パラメーターを使用して、そのマークをエレメント・マークとして作成 (または再作成) することを指示します。 エレメント・マークは完全なエレメントのみを参照します。オプション・パラメーター element1 および element2 を指定して、エレメント・マークの範囲を指示します。 element1element2 は正の整数で、エレメント序数を参照しなければなりません。 element2 を指定しないと、マークは、マークの開始と終了の両方で element1 として作成されます。 element1element2 も指定しないと、マークは、マークの開始と終了の両方で現行エレメントとして作成されます。
[ sticky ]
[ element1 [ column1
[ element2 [ column2 ] ] ] ]
テキストがマークの直前または直後に追加されるとこのマークが展開するようにしたい場合には、sticky パラメーター (オプション) を指定します。 パラメーターを指定しないと、文字マークが作成されます。 文字マークには、開始桁を含む開始エレメントと、終了桁を含む終了エレメントがあります。 デフォルトでは、文字マークは、現行カーソル位置にその開始点と終了点の両方があるように作成されます。
element1 のみを指定すると、マークは、指定されたエレメントの 1 桁目で開始および終了します。 element1column1 のみを指定すると、エレメントは指定された位置で開始および終了します。 element1column1、および element2 のみを指定すると、マークは element1column1 で開始し、element2 の 1 桁目で終了します。

説明

マーク名もマーク ID も指定せず、さらに clear オプションも指定しないと、名前なしマークが作成されます。この名前なしマークは、その ID によってのみ参照できます。マークの ID は、"query markId." (末尾のピリオドに注意) を出して調べることができます。"query markId." は、最後に作成されたマークの ID を戻します。マーク名もマーク ID も指定せず、clear オプションを指定すると、最後に作成されたマークが除去されます。

query mark.test
set mark.test element 5 10
set mark.test sticky 1 1 1 1
set mark.test clear 

関連
locate コマンド
query コマンド
set コマンド
headerMark パラメーター
markExcluded パラメーター
markExcludedHeader パラメーター
markHighlight パラメーター
markId パラメーター
markIncluded パラメーター
markProtect パラメーター
markStyle パラメーター
findMark アクション
findQuickMark アクション
nameMark アクション
setQuickMark アクション