Skip to content
This repository was archived by the owner on May 11, 2022. It is now read-only.

Commit 6293aa0

Browse files
pwrightpwright
authored
make the documentation render in github (#443)
as a tutorial writer I want to be able to read the documentation reference without a scroll bar on the bottom of the page as per https://github.com/redhat-developer/vscode-didact/blob/master/examples/commands.reference.md I've kept all params on separate lines, just not separate columns
1 parent 267d275 commit 6293aa0

File tree

2 files changed

+188
-30
lines changed

2 files changed

+188
-30
lines changed

‎examples/commands.reference.adoc‎

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
= Didact Commands Reference
2+
3+
4+
|===
5+
|vscode.didact.<ID> | Description | Parameters | Return
6+
7+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactclicommandsuccessful[cliCommandSuccessful]
8+
| Even simpler command-line check for system capabilities. Takes two parameters - the id of the HTML element to update with the results and the test command (such as mvn --version. If command executes with no errors (return code 0), it returns true. If not, false.
9+
| requirement: string / required
10+
testCommand: string / required
11+
12+
| true on success, false on failure; result posted as message to update requirement element
13+
14+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactclosenamedterminal[closeNamedTerminal]
15+
| Terminate a named terminal and dispose of it.
16+
| name : string / required
17+
18+
19+
| Check Didact output channel
20+
21+
| https://github.com/redhat-developer/vscode-didact/blob/master/examples/clipboard.example.didact.md[copyClipboardToActiveTextEditor]
22+
| Copies contents of the system clipboard to the currently open (or previously used) editor.
23+
|
24+
25+
26+
| Check Didact output channel
27+
28+
| https://github.com/redhat-developer/vscode-didact/blob/master/examples/clipboard.example.didact.md[copyClipboardToEditorForFile]
29+
| Copies contents of the system clipboard to a file path for an existing file (opened if not already open).
30+
| filepath:vscode.Uri / required
31+
32+
33+
| Check Didact output channel
34+
35+
| https://github.com/redhat-developer/vscode-didact/blob/master/examples/clipboard.example.didact.md[copyClipboardToNewFile]
36+
| Copies contents of the system clipboard to a new file (opened after creation).
37+
|
38+
39+
40+
| Check Didact output channel
41+
42+
| https://github.com/redhat-developer/vscode-didact/wiki/[copyFileTextToClipboardCommand]
43+
| Copies text from a file to the system clipboard.
44+
| text : string / required
45+
46+
47+
| Check Didact output channel
48+
49+
| https://github.com/redhat-developer/vscode-didact/wiki/[copyToClipboardCommand]
50+
| Copies text to the system clipboard.
51+
| text : string / required
52+
53+
54+
| Check Didact output channel
55+
56+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactcreateworkspacefolder[createWorkspaceFolder]
57+
| Creating temporary folder as workspace root. Update named 'requirement' label field with success or failure.
58+
| requirement: string / optional
59+
60+
61+
| Check Didact output channel
62+
63+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactextensionrequirementcheck[extensionRequirementCheck]
64+
| Simple check to see if the extension Id is installed in the user workspace.
65+
| requirement: string / required
66+
extensionId : string / required
67+
68+
| true on success, false on failure; result posted as message to update requirement element
69+
70+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactgatherallcommands[gatherAllCommands]
71+
| Gathers a list of all commands used in the Didact file. Used for testing purposes only.
72+
|
73+
74+
75+
| array any[]
76+
77+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactgatherallrequirements[gatherAllRequirements]
78+
| Gathers a list of all requirements in the Didact file. Used internally as part of the validateAllRequirements execution.
79+
|
80+
81+
82+
| array any[]
83+
84+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactopentutorial[openTutorial]
85+
| Opens the Didact editor with the default didact URI set in the user settings.
86+
|
87+
88+
89+
| Check Didact output channel
90+
91+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactregister[register]
92+
| Command used to register a new Didact tutorial so that it appears in the Didact Tutorials view. This command is invoked by VS Code Extension code to register tutorials they provide.
93+
| name : string / required
94+
sourceUri : string / required
95+
category : string / optional
96+
| Check Didact output channel
97+
98+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactreload[reload]
99+
| Forces the Didact window to reload with the default Didact file specified in VS Code settings.
100+
|
101+
102+
103+
| Check Didact output channel
104+
105+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactrequirementcheck[requirementCheck]
106+
| Simple command-line check for system capabilities. Takes three parameters - the id of the HTML element to update with the results, the test command (such as mvn --version, and a string to search for in the resulting text, such as Apache Maven if the mvn command works successfully).
107+
| requirement: string / required
108+
testCommand: string / required
109+
testResult: string / required
110+
| true on success, false on failure; result posted as message to update requirement element
111+
112+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactscaffoldproject[scaffoldProject]
113+
| Create new project in user workspace from json file provided by P1.
114+
| jsonpath:vscode.Uri / required
115+
116+
117+
| Check Didact output channel
118+
119+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactsendnamedterminalastring[sendNamedTerminalAString]
120+
| Send a text string to a named terminal. If the terminal doesn't exist, create it. Pass text as is. Does not automatically add a NL/CR at the end.
121+
| name : string / required
122+
text: string / required
123+
124+
| Check Didact output channel
125+
126+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactsendnamedterminalctrlc[sendNamedTerminalCtrlC]
127+
| Send a Ctrl+C key combination to a named terminal to stop a long-running process.
128+
| name : string / required
129+
130+
131+
| Check Didact output channel
132+
133+
| https://github.com/redhat-developer/vscode-didact/wiki/Constructing-Didact-Links#didact-link-formatting-for-opening-didact-files-inside-vs-code[startDidact]
134+
| Opens the Didact editor using the markdown or asciidoc file URI passed in. Can be
135+
| uri:vscode.Uri / optional
136+
137+
138+
| Check Didact output channel
139+
140+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactstartterminalwithname[startTerminalWithName]
141+
| Start a named terminal so we have a handle to it. If passed a string, use that as the name for the terminal that can be referenced later. If passed a file URI, pass that as the current working directory.
142+
| name : string / optional
143+
filePath : vscode.Uri / optional
144+
145+
| Check Didact output channel
146+
147+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactvalidateallrequirements[validateAllRequirements]
148+
| Gathers all requirements in the Didact file and invokes the requirement checks one at a time. Useful if you have a long list of requirements to check.
149+
|
150+
151+
152+
| Check Didact output channel
153+
154+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactviewrefresh[view.refresh]
155+
| Refresh the Didact Tutorials view. Called automatically each time register is called.
156+
|
157+
158+
159+
| No output
160+
161+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactviewtutorialopen[view.tutorial.open]
162+
| Menu command used when the user right-clicks on a tutorial in the Didact Tutorials view to Start Didact Tutorial.
163+
| node: TreeNode / required
164+
165+
166+
| Check Didact output channel
167+
168+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactworkspacefolderexistscheck[workspaceFolderExistsCheck]
169+
| Simple check to see if the workspace has at least one root folder.
170+
| requirement: string / required
171+
172+
173+
| true on success, false on failure; result posted as message to update requirement element
174+
175+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactopennamedoutputchannel[openNamedOutputChannel]
176+
| Creates and opens an output channel with the given name.
177+
| channelName: string / optional
178+
179+
180+
| Check the named output channel
181+
182+
| https://github.com/redhat-developer/vscode-didact/wiki/Available-Commands-in-Didact-and-Elsewhere#vscodedidactsendtexttonamedoutputchannel[sendTextToNamedOutputChannel]
183+
| Sends a text to the output channel with the given name. If no name is provided it will use the Didact Activity channel.
184+
| message: string
185+
channelName: string / optional
186+
187+
| Check the named output channel
188+
|===

‎examples/commands.reference.md‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)