Skip to content

Commit 5289033

Browse files
akoclaude
andcommitted
docs: add image collection reference pages
Fill in reference pages for the new image collection feature: CREATE/DROP IMAGE COLLECTION, SHOW/DESCRIBE IMAGE COLLECTION. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 0b1e9a8 commit 5289033

File tree

5 files changed

+196
-0
lines changed

5 files changed

+196
-0
lines changed
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Image Collection Statements
2+
3+
Statements for creating, inspecting, and dropping image collections within modules.
4+
5+
| Statement | Description |
6+
|-----------|-------------|
7+
| [CREATE IMAGE COLLECTION](create-image-collection.md) | Create a new image collection with optional images |
8+
| [DROP IMAGE COLLECTION](drop-image-collection.md) | Remove an image collection |
9+
| [SHOW / DESCRIBE IMAGE COLLECTION](show-describe-image-collection.md) | List or inspect image collections |
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# CREATE IMAGE COLLECTION
2+
3+
## Synopsis
4+
5+
CREATE IMAGE COLLECTION module.name
6+
[EXPORT LEVEL 'Hidden' | 'Public']
7+
[COMMENT 'description']
8+
[(
9+
IMAGE 'image_name' FROM FILE 'path',
10+
...
11+
)];
12+
13+
## Description
14+
15+
Creates a new image collection in the specified module. Image collections bundle images (icons, logos, graphics) within a module. Images can be loaded from the filesystem during creation, with the format detected automatically from the file extension.
16+
17+
## Parameters
18+
19+
**module.name**
20+
: The qualified name of the collection (e.g., `MyModule.AppIcons`).
21+
22+
**EXPORT LEVEL**
23+
: Controls visibility from other modules. `'Hidden'` (default) restricts access to the owning module. `'Public'` makes images available to other modules.
24+
25+
**COMMENT**
26+
: Documentation text for the collection.
27+
28+
**IMAGE 'name' FROM FILE 'path'**
29+
: Loads an image from a file on disk. The path is relative to the current working directory. Supported formats: PNG, SVG, GIF, JPEG, BMP, WebP.
30+
31+
## Examples
32+
33+
### Empty collection
34+
35+
```sql
36+
CREATE IMAGE COLLECTION MyModule.AppIcons;
37+
```
38+
39+
### Public collection with description
40+
41+
```sql
42+
CREATE IMAGE COLLECTION MyModule.SharedIcons
43+
EXPORT LEVEL 'Public'
44+
COMMENT 'Shared icons for all modules';
45+
```
46+
47+
### Collection with images
48+
49+
```sql
50+
CREATE IMAGE COLLECTION MyModule.NavigationIcons (
51+
IMAGE 'home' FROM FILE 'assets/home.png',
52+
IMAGE 'settings' FROM FILE 'assets/settings.svg',
53+
IMAGE 'profile' FROM FILE 'assets/profile.png'
54+
);
55+
```
56+
57+
### All options combined
58+
59+
```sql
60+
CREATE IMAGE COLLECTION MyModule.BrandAssets
61+
EXPORT LEVEL 'Public'
62+
COMMENT 'Company branding assets' (
63+
IMAGE 'logo-dark' FROM FILE 'assets/logo-dark.png',
64+
IMAGE 'logo-light' FROM FILE 'assets/logo-light.png'
65+
);
66+
```
67+
68+
## See Also
69+
70+
[DROP IMAGE COLLECTION](drop-image-collection.md), [SHOW / DESCRIBE IMAGE COLLECTION](show-describe-image-collection.md)
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# DROP IMAGE COLLECTION
2+
3+
## Synopsis
4+
5+
DROP IMAGE COLLECTION module.name;
6+
7+
## Description
8+
9+
Removes an image collection and all its embedded images from the module.
10+
11+
## Parameters
12+
13+
**module.name**
14+
: The qualified name of the collection to drop (e.g., `MyModule.AppIcons`).
15+
16+
## Examples
17+
18+
```sql
19+
DROP IMAGE COLLECTION MyModule.StatusIcons;
20+
```
21+
22+
### Check references before dropping
23+
24+
```sql
25+
SHOW REFERENCES TO MyModule.AppIcons;
26+
DROP IMAGE COLLECTION MyModule.AppIcons;
27+
```
28+
29+
## See Also
30+
31+
[CREATE IMAGE COLLECTION](create-image-collection.md), [SHOW / DESCRIBE IMAGE COLLECTION](show-describe-image-collection.md)
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# SHOW / DESCRIBE IMAGE COLLECTION
2+
3+
## Synopsis
4+
5+
SHOW IMAGE COLLECTION;
6+
SHOW IMAGE COLLECTION IN module;
7+
DESCRIBE IMAGE COLLECTION module.name;
8+
9+
## Description
10+
11+
`SHOW IMAGE COLLECTION` lists all image collections in the project, optionally filtered by module. `DESCRIBE IMAGE COLLECTION` shows the full definition of a specific collection, including its images as a re-executable `CREATE` statement.
12+
13+
In the TUI, images are rendered inline when the terminal supports it (Kitty, iTerm2, Sixel).
14+
15+
## Parameters
16+
17+
**IN module**
18+
: Filters the listing to a single module.
19+
20+
**module.name**
21+
: The qualified name of the collection to describe (e.g., `MyModule.AppIcons`).
22+
23+
## Examples
24+
25+
### List all image collections
26+
27+
```sql
28+
SHOW IMAGE COLLECTION;
29+
```
30+
31+
### Filter by module
32+
33+
```sql
34+
SHOW IMAGE COLLECTION IN MyModule;
35+
```
36+
37+
### View full definition
38+
39+
```sql
40+
DESCRIBE IMAGE COLLECTION MyModule.AppIcons;
41+
```
42+
43+
The output includes the complete `CREATE` statement with all `IMAGE ... FROM FILE` entries, which can be copied and re-executed.
44+
45+
## See Also
46+
47+
[CREATE IMAGE COLLECTION](create-image-collection.md), [DROP IMAGE COLLECTION](drop-image-collection.md)
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# SHOW IMAGE COLLECTION
2+
3+
## Synopsis
4+
5+
SHOW IMAGE COLLECTION;
6+
SHOW IMAGE COLLECTION IN module;
7+
8+
## Description
9+
10+
Lists all image collections in the project. Use `IN module` to filter to a specific module. For full details including embedded images, use `DESCRIBE IMAGE COLLECTION`.
11+
12+
## Parameters
13+
14+
**IN module**
15+
: Optional. Restricts the listing to collections in the specified module.
16+
17+
## Examples
18+
19+
### List all collections
20+
21+
```sql
22+
SHOW IMAGE COLLECTION;
23+
```
24+
25+
### Filter by module
26+
27+
```sql
28+
SHOW IMAGE COLLECTION IN MyModule;
29+
```
30+
31+
### Describe a specific collection
32+
33+
```sql
34+
DESCRIBE IMAGE COLLECTION MyModule.AppIcons;
35+
```
36+
37+
## See Also
38+
39+
[DESCRIBE IMAGE COLLECTION](../image-collection/show-describe-image-collection.md), [CREATE IMAGE COLLECTION](../image-collection/create-image-collection.md), [SHOW MODULES](show-modules.md)

0 commit comments

Comments
 (0)