Skip to content
This repository was archived by the owner on Jul 28, 2025. It is now read-only.

Commit eb8bc3d

Browse files
committed
Update documentation
1 parent aac8591 commit eb8bc3d

File tree

8 files changed

+103
-34
lines changed

8 files changed

+103
-34
lines changed

docs/docs/features/Columns.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,52 +4,70 @@
44

55
You can add a new column with the `+` button of the database, or by using the `insert right/left` in the column menu.
66

7-
![[blank column.mov]]
7+
<video width="670" controls>
8+
<source src="https://user-images.githubusercontent.com/38974541/197634987-e455f617-322a-4337-b2cc-9a46b691bfe8.mov" type="video/mp4">
9+
</video>
810

911
### Add From Existing Metadata
1012

1113
The plugin searches all the files included in the source selected for metadata that is not included in the database. Choose from the list provided when clicking on the `+` button.
1214

13-
#video
15+
<video width="670" controls>
16+
<source src="https://user-images.githubusercontent.com/38974541/197634844-b985d0dc-eb88-47d2-8102-17d347935195.mov" type="video/mp4">
17+
</video>
1418

1519
### Add From All Available Metadata at Once
1620

1721
The plugin can grab all the metadata from all the files included in the selected source and add them all at once. Be aware that this will override any previously created columns, you'll have to configure the columns again.
1822

19-
#video
23+
<video width="670" controls>
24+
<source src="https://user-images.githubusercontent.com/38974541/197634946-51ac7f08-176f-40d0-816e-174019ed6f1f.mov" type="video/mp4">
25+
</video>
2026

2127
### Add From Template
2228

2329
The plugin can look at only one file (as a template), and grab only this file's metadata as columns. The list of files to choose from is provided from the used source and can be found in the database settings under `select file as column template`.
2430

25-
#video
31+
<video width="670" controls>
32+
<source src="https://user-images.githubusercontent.com/38974541/197634895-0c7d3029-4517-4d83-8098-4aad9a9f1707.mov" type="video/mp4">
33+
</video>
2634

2735
## Hiding
2836

2937
You can hide the columns while keeping the underlying metadata by using the column menu or by pressing the `+` button, where you'll see a list of all the columns (hidden or not).
3038

31-
#video
39+
<video width="670" controls>
40+
<source src="https://user-images.githubusercontent.com/38974541/197635036-5f44aa91-975f-40fb-85fa-132d0760f565.mov" type="video/mp4">
41+
</video>
3242

3343
## Removing
3444

3545
You can remove the column and remove its underlying metadata by using the column menu. Make sure to enable `configuration about columns > remove fields` in the plugin global settings or in the database settings.
3646

37-
#video
47+
<video width="670" controls>
48+
<source src="https://user-images.githubusercontent.com/38974541/197635125-be132cb0-acfd-4e88-b8c3-8a9305ac314c.mov" type="video/mp4">
49+
</video>
3850

3951
## Resizing
4052

4153
You can resize columns by dragging the handle at the right of the column header.
4254

43-
#video
55+
<video width="670" controls>
56+
<source src="https://user-images.githubusercontent.com/38974541/197635232-3bb6dfe9-cf87-4622-a7e4-2c00670a0ac9.mov" type="video/mp4">
57+
</video>
4458

4559
## Reordering
4660

4761
To reorder a column, you have to drag and drop it to the specific location you want it to be moved.
4862

49-
#video
63+
<video width="670" controls>
64+
<source src="https://user-images.githubusercontent.com/38974541/197635075-1bc59f70-96c4-4726-80d2-0da53e5e17e4.mov" type="video/mp4">
65+
</video>
5066

5167
## Renaming
5268

5369
You can rename columns by clicking on the column header and changing the selected text.
5470

55-
#video
71+
<video width="670" controls>
72+
<source src="https://user-images.githubusercontent.com/38974541/197635177-6a7992e4-69df-42f2-b011-941b347122f1.mov" type="video/mp4">
73+
</video>

docs/docs/features/Formulas.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ The formula is a javascript code that will be executed when the row is loaded.
88

99
The code can be written in the column settings. The generated values can be added to the notes' metadata by enabling `persist formula output` in the column settings.
1010

11-
#video
11+
<video width="670" controls>
12+
<source src="https://user-images.githubusercontent.com/38974541/197597294-aaf809e6-bb28-4e30-9e26-4281f6030236.mov" type="video/mp4">
13+
</video>
1214

1315
### Exposed Variables
1416

@@ -26,7 +28,7 @@ The root object `db` has the following functions:
2628

2729
## Examples
2830

29-
If you have a column ID (not always the name of the column) named "Date" you can add time:
31+
If you have a column ID named "Date" you can add time:
3032

3133
- `${row.Date.plus({years: 1}).toFormat("DD")}` adds 1 year
3234
- `${row.Date.plus({months: 1}).toFormat("DD")}` adds 1 month

docs/docs/features/Notes.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,31 @@
22

33
You can create blank notes by typing the name in the bottom bar while leaving the template field empty.
44

5-
#video
5+
<video width="670" controls>
6+
<source src="https://user-images.githubusercontent.com/38974541/197633841-2e54a360-ce90-4b95-8032-34409fe4a1bc.mov" type="video/mp4">
7+
</video>
68

79
## Creating Notes with a Template
810

911
You have to choose a template in the bottom bar before creating the note. You can filter the files suggested in the bottom bar by adding a folder in the settings under `rows template file folder location`.
1012

11-
#video
13+
<video width="670" controls>
14+
<source src="https://user-images.githubusercontent.com/38974541/197634718-98463157-f7d7-4323-87ab-e280211eeed7.mov" type="video/mp4">
15+
</video>
1216

1317
> It works with the core template plugin. But with the templater plugin, you have to activate the option `Trigger templater on new file creation` in templater settings.
1418
15-
#video
19+
<video width="670" controls>
20+
<source src="https://user-images.githubusercontent.com/38974541/197634584-7420f211-bec2-4e0e-a031-dab809cbc1ab.mov" type="video/mp4">
21+
</video>
1622

1723
## Deleting & Renaming Notes
1824

1925
You can click on the numbers to the right of every row, to bring up a menu where you can delete and rename the note associated with the row.
2026

21-
#video
27+
<video width="670" controls>
28+
<source src="https://user-images.githubusercontent.com/38974541/197634302-a1081f6b-12da-40a5-a476-b222d4686b98.mov" type="video/mp4">
29+
</video>
2230

2331
## Moving Notes Based on Metadata
2432

@@ -34,4 +42,6 @@ You have additional settings to customize this rule under `configuration about c
3442

3543
> The `column name` and the `column id` have to be the same for this to work.
3644
37-
#video
45+
<video width="670" controls>
46+
<source src="https://user-images.githubusercontent.com/38974541/197634397-54e28827-6629-492a-a529-89ecd49622cd.mov" type="video/mp4">
47+
</video>

docs/docs/features/Properties.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,11 @@
1919
2020
## Column ID
2121

22-
Where you create a column, the `column name` (name displayed in the database) is the same as the `column id` (the metadata persisted in your notes). You can change the column ID in the column settings. Keep in mind though, that the `column id` is used by the **filters**, so don't get confused when choosing what column to filter.
22+
Where you create a column, the `column name` (name displayed in the database) is the same as the `column id` (the metadata persisted in your notes). You can change the column ID in the column settings. This ID is used by the **filters**, so keep that in mind when choosing what column to filter.
2323

24-
#video
24+
<video width="670" controls>
25+
<source src="https://user-images.githubusercontent.com/38974541/197635378-256e2468-bb90-477f-8760-393f792777d6.mov" type="video/mp4">
26+
</video>
2527

2628
## YAML & Dataview Inline Fields
2729

@@ -32,7 +34,9 @@ The plugin works with YAML and dataview inline fields, but looks for metadata in
3234

3335
If there is no metadata in your notes, it will be created when you fill the corresponding cell in the database.
3436

35-
#video
37+
<video width="670" controls>
38+
<source src="https://user-images.githubusercontent.com/38974541/197635449-507ea33b-5213-4976-a7a2-bbb4e7b888b1.mov" type="video/mp4">
39+
</video>
3640

3741
## Nested Metadata
3842

@@ -47,10 +51,14 @@ metadata1:
4751

4852
If you want to add existing nested metadata, you'll have to abide by the format described above.
4953

50-
#video
54+
<video width="670" controls>
55+
<source src="https://user-images.githubusercontent.com/38974541/197635608-8c638ab0-1551-498f-b859-a9ab58eff34b.mov" type="video/mp4">
56+
</video>
5157

5258
## Appearance
5359

5460
You can enable text wrapping and you can change the text alignment between `right-aligned`, `centered`, `left-aligned`, and `justified` from the column settings of the **text**, **number**, and **formula** properties.
5561

56-
#video
62+
<video width="670" controls>
63+
<source src="https://user-images.githubusercontent.com/38974541/197635327-31c273a1-6cb5-4283-a9a5-dddbdcc6b831.mov" type="video/mp4">
64+
</video>

docs/docs/features/Sources.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,6 @@ There are two types of destinations :
1717

1818
If you chose `tag/incoming_link/outgoing_link/dataview` as the source, you'll have to choose both types of destinations. But if you right-clicked a folder or selected `current_folder` as the source, everything is stored under one folder, so you'll only choose once.
1919

20-
#video
21-
#video
20+
<video width="670" controls>
21+
<source src="https://user-images.githubusercontent.com/38974541/197635750-10d783f1-169a-4e6c-8c07-9c38dcf7938d.mov" type="video/mp4">
22+
</video>

docs/docs/features/Viewing data.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,33 @@
22

33
You can change the database name and description in the database settings.
44

5-
#image
5+
<video width="670" controls>
6+
<source src="https://user-images.githubusercontent.com/38974541/197635940-0b3c351d-9325-408e-8711-71cf8830bccc.mov" type="video/mp4">
7+
</video>
68

79
## Sticky First Column
810

911
You can make the first column sticky in the database settings to make it always visible even when scrolling horizontally.
1012

11-
#video
13+
<video width="670" controls>
14+
<source src="https://user-images.githubusercontent.com/38974541/197636568-e5a50f5e-0e31-42ce-8067-d810d9643129.mov" type="video/mp4">
15+
</video>
1216

1317
## Pagination
1418

1519
To help with displaying a lot of data, by default the database displays only 10 rows and allows changing the pages using the top bar. You can change the number of rows displayed per page in the database settings.
1620

17-
#video
21+
<video width="670" controls>
22+
<source src="https://user-images.githubusercontent.com/38974541/197636349-f473a874-4c6a-434e-8b90-56aa05f368f6.mov" type="video/mp4">
23+
</video>
1824

1925
## Row Height
2026

2127
In the database settings under `cell size`, you can change the row height between 3 options (compact, normal, wide).
2228

23-
#video
29+
<video width="670" controls>
30+
<source src="https://user-images.githubusercontent.com/38974541/197636446-9f17f8a7-baa5-4b7e-b910-557b0c5a478c.mov" type="video/mp4">
31+
</video>
2432

2533
## Filtering
2634

@@ -34,40 +42,54 @@ Each `group filter` will have a dedicated **named button** on the database top b
3442

3543
> The database filters hold priority over the dataview query source filters.
3644
37-
#video
45+
<video width="670" controls>
46+
<source src="https://user-images.githubusercontent.com/38974541/197636117-9268cbbe-fcb4-464e-9840-4c966e503589.mov" type="video/mp4">
47+
</video>
3848

3949
## Refresh Database
4050

4151
There is no actual refresh button, but you can use the `activate/desactive filter` button to refresh the database.
4252

43-
#video
53+
<video width="670" controls>
54+
<source src="https://user-images.githubusercontent.com/38974541/197636392-0c1c17fa-8f21-47dc-8c1f-887ca96d4bab.mov" type="video/mp4">
55+
</video>
4456

4557
## Sorting
4658

4759
You can sort one column or multiple columns from the column's menu in descending or ascending order. The sort priority is displayed as a number next the arrow in the column header. To remove the sort, just use the column menu.
4860

49-
#video
61+
<video width="670" controls>
62+
<source src="https://user-images.githubusercontent.com/38974541/197636458-e322e245-3efa-4261-9578-58ff2eee4ad8.mov" type="video/mp4">
63+
</video>
5064

5165
## Database Markdown
5266

5367
You can view the database markdown note by using the command `open as markdown` in obsidian menu or in the database menu. To re-enable the database view, just close the pane and re-open it again.
5468

55-
#video
69+
<video width="670" controls>
70+
<source src="https://user-images.githubusercontent.com/38974541/197636284-ad2d5772-e65e-4e7b-bffa-fce53b52b16e.mov" type="video/mp4">
71+
</video>
5672

5773
## Embedding Database
5874

5975
You can embed a database in another note by using this format `![[database file name.md]]`, it'll show a dataview query of the database.
6076

61-
#video
77+
<video width="670" controls>
78+
<source src="https://user-images.githubusercontent.com/38974541/197635963-e29dc482-09b0-4994-b861-ac57c85a583b.mov" type="video/mp4">
79+
</video>
6280

6381
## Exporting Data
6482

6583
You can export the database into **CSV** format using the database menu.
6684

67-
#video
85+
<video width="670" controls>
86+
<source src="https://user-images.githubusercontent.com/38974541/197636017-c4a1d9df-75c1-437e-924f-23d444658fb5.mov" type="video/mp4">
87+
</video>
6888

6989
## Importing Data
7090

7191
You can upload a **CSV** file and turn it into a database using the database menu. The **CSV** file has to have a header row and before importing you need to define the column used to create the files in the plugin global settings under `CSV section > mandatory header key`.
7292

73-
#video
93+
<video width="670" controls>
94+
<source src="https://user-images.githubusercontent.com/38974541/197636176-44eeaeb3-a753-4afc-b96b-4072b2e87fca.mov" type="video/mp4">
95+
</video>

docs/docs/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ There are 3 ways of creating a database:
1414
2. By clicking on the custom sidebar icon ;
1515
3. By right-clicking on a folder where you want to store your notes and your database.
1616

17+
<video width="670" controls>
18+
<source src="https://user-images.githubusercontent.com/38974541/197639196-b16cc8bf-81bc-4c19-be78-a596dcd7ee45.mov" type="video/mp4">
19+
</video>
20+
1721
## How Do I Access Settings?
1822

1923
There are two types of settings (plugin global settings and database settings). You can access the database settings from the obsidian menu or from the database menu. The database settings take priority over the plugin global settings.
24+
25+
<video width="670" controls>
26+
<source src="https://user-images.githubusercontent.com/38974541/197639146-d48fb28e-f14d-4f52-84b0-ee380cfd4db8.mov" type="video/mp4">
27+
</video>

docs/resources/blank column.mov

-987 KB
Binary file not shown.

0 commit comments

Comments
 (0)