@@ -92,14 +92,36 @@ used as the completion UI for type completion when editing.
92
92
93
93
![ Completion] ( ./images/emacs-completion.png )
94
94
95
+ Command ` sdml-mode-ctags-generate ` has the default binding ` C-c C-s T ` . It uses the
96
+ variables ` sdml-mode-ctags-command ` and ` sdml-mode-ctags-output-file-name ` to
97
+ generate the tag file.
98
+
95
99
## Tool Commands
96
100
97
101
A number of the tools provided by the SDML command-line tool are exposed as
98
102
Emacs commands. The following image shows two tools in use, the module
99
- dependency tree and the validation tool. The tree view can be refreshed using
100
- the common binding of ` g ` and quit with ` q ` .
103
+ dependency tree and the validation tool.
104
+
105
+ ![ Tool Commands] ( ./images/emacs-tools.png )
106
+
107
+ ### Dependency Tree
108
+
109
+ * Command ` sdml-mode-current-buffer-dependency-tree ` has the default binding `C-c
110
+ C-s t`.
111
+ * The command will prompt for the maximum depth of the tree where 0 means
112
+ unbounded. This is a command prefix and can therefore be specified with the
113
+ usual ` C-u ` binding.
114
+ * The resulting tree view can be refreshed using the common binding of ` g ` and quit
115
+ with ` q ` .
116
+
117
+ ### Full Validation
101
118
102
- [ Tool Commands] ( ./images/emacs-tools.png )
119
+ * Command ` sdml-mode-validate-current-buffer ` has the default binding ` C-c C-s v ` .
120
+ * Command ` sdml-mode-validate ` has the default binding ` C-c C-s V ` .
121
+ * The variable ` sdml-mode-validation-level ` denotes the level of messages produced
122
+ by the validator, with a default of ` warnings ` .
123
+ * The output uses the standard ` compilation-mode ` with all the common bindings are
124
+ available.
103
125
104
126
### Abbreviations and Skeletons
105
127
@@ -130,9 +152,12 @@ will add the value of the Emacs variable `locale-language` as the language tag.
130
152
131
153
* ` C-c C-s d ` -- open the tree-sitter debug view
132
154
* ` C-c C-s q ` -- open the tree-sitter query builder
133
- * ` C-c C-s t ` -- open a dependency tree view
134
- * ` C-c C-s v ` -- run the validator in a compilation window
135
- * ` C-c C-s g ` -- run u-ctags for the current project
155
+ * ` C-c C-s t ` -- open a dependency tree view for the current buffer
156
+ * ` C-c C-s v ` -- run the validator, on the current buffer, and show the results in
157
+ a compilation window
158
+ * ` C-c C-s V ` -- run the validator, on a specified file, and show the results in
159
+ a compilation window
160
+ * ` C-c C-s T ` -- run u-ctags for the current project
136
161
137
162
## Add-Ons
138
163
0 commit comments