Skip to content

Commit 5ea0d2b

Browse files
add proper descriptions to Commands md table in docs (#101 & #110)
1 parent 49fc7f6 commit 5ea0d2b

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -119,24 +119,26 @@ Hit Reload ↺ button in an open Table View 🀄 after you toggle Tabular Data S
119119

120120
Tabular Data Viewer 中 provides a number of global and context specific commands to load and view tabular data files and [Data Packages](https://specs.frictionlessdata.io/data-package/#introduction) 📦.
121121

122-
You can access custom Tabular Data Commands from `View -> Command Palette...` menu (`ctrl+shift+p`) by typing `Tabular` in command the search box:
122+
You can access custom Tabular Data Commands from `View -> Command Palette...` menu (`ctrl+shift+p`) by typing `Tabular` in the command search box:
123123

124124
![Tabular Data 中 Commands](https://github.com/RandomFractals/tabular-data-viewer/blob/main/docs/images/tabular-data-commands.png?raw=true
125125
"Tabular Data 中 Commands")
126126

127-
All Tabular Data Commands start with `Tabular Data:` prefix and custom command Ids use `tabular.data.` prefix. Some of the Tabular Data Commands like `View Table` and `List Data Resources` are enabled in vscode file explorer and in code editors for the supported data file types and formats via the corresponding context menues in vscode IDE.
127+
All Tabular Data Commands start with `Tabular Data:` prefix, and exposed public Tabular Data Viewer 中 command Ids use `tabular.data.` prefix to enable other extensions to use Table View 🀄 and tabular data list commands.
128+
129+
Some of the Tabular Data Commands like `View Table` and `List Data Resources` are enabled in vscode file explorer and in code editors for the supported data file types and formats via the corresponding context menues in vscode IDE.
128130

129131
Currently supported Tabular Data 中 Commands include:
130132

131133
| Command `tabular.data.` | Name | Description |
132134
| --- | --- | --- |
133-
| `listDataPackages` | List Data Packages | |
134-
| `listDataResources` | List Data Resources | |
135-
| `openDataFile` | Open Data File | |
136-
| `openTextDocument` | Open Text Document | |
137-
| `viewTable` | View Table | |
138-
| `viewDataFileOnGitHub` | View Data File on GitHub | |
139-
| `viewSettings` | View Settings | View Tabular Data Viewer 中 Configuration Settings |
135+
| `listDataPackages` | List Data Packages | Lists over 750 public Data GitHub Repositories with [`datapackage.json`](https://specs.frictionlessdata.io/data-package/#introduction) configuration files that ship with Tabular Data Viewer 中 v1.8.0 and above for exploring public datasets and Tabular Data Resources. Curated list of those Data Packages 📦 is configured in our [`packages.json`](https://github.com/RandomFractals/tabular-data-viewer/blob/main/src/configuration/packages.json) configuration file. |
136+
| `listDataResources` | List Data Resources | Lists Tabular Data 中 Resources for an open `datapackage.json` file in an active vscode editor or a public dataset GitHub repository selected from the Data Package 📦 Quick Pick List above.|
137+
| `openDataFile` | Open Data File | Prompts for a local `file:///` or remote `https://` Tabular Data Resource or a Data Package 📦 Url to load and view the Data Resource List or a Table View 🀄 for data files. |
138+
| `openTextDocument` | Open Text Document | Opens local Tabular Data Resource in bilt-in vscode Text Editor, or opens it in a browser for GitHub hosted data sources and other data files loaded via remote `https://` urls. |
139+
| `viewTable` | View Table | Displays Table View 🀄 for an open Tabular Data file in vsode Editor or from context menus in built-in File Explorer. |
140+
| `viewDataFileOnGitHub` | View Data File on GitHub | Opens public GitHub Repository Data File or a Data Package in a browser. |
141+
| `viewSettings` | View Settings | Displays Tabular Data Viewer 中 Configuration Settings. |
140142

141143
# Observable JS Notebook
142144

0 commit comments

Comments
 (0)