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

Commit 0bd28eb

Browse files
authored
Merge pull request #554 from RafaelGB/imed-docu-branch
Imed docu branch
2 parents b50ce35 + eb8bc3d commit 0bd28eb

File tree

7 files changed

+161
-10
lines changed

7 files changed

+161
-10
lines changed

docs/docs/features/Columns.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,34 +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+
<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>
10+
711
### Add From Existing Metadata
812

913
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.
1014

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>
18+
1119
### Add From All Available Metadata at Once
1220

1321
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.
1422

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>
26+
1527
### Add From Template
1628

1729
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`.
1830

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>
34+
1935
## Hiding
2036

2137
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).
2238

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>
42+
2343
## Removing
2444

2545
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.
2646

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>
50+
2751
## Resizing
2852

2953
You can resize columns by dragging the handle at the right of the column header.
3054

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>
58+
3159
## Reordering
3260

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

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>
66+
3567
## Renaming
3668

37-
You can rename columns by clicking on the column header and changing the selected text.
69+
You can rename columns by clicking on the column header and changing the selected text.
70+
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: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ 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 width="670" controls>
12+
<source src="https://user-images.githubusercontent.com/38974541/197597294-aaf809e6-bb28-4e30-9e26-4281f6030236.mov" type="video/mp4">
13+
</video>
14+
1115
### Exposed Variables
1216

1317
- `row` : the row object
@@ -24,7 +28,7 @@ The root object `db` has the following functions:
2428

2529
## Examples
2630

27-
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:
2832

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

docs/docs/features/Notes.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,32 @@
22

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

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>
8+
59
## Creating Notes with a Template
610

711
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`.
812

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>
16+
917
> 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.
1018
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>
22+
1123
## Deleting & Renaming Notes
1224

1325
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.
1426

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>
30+
1531
## Moving Notes Based on Metadata
1632

1733
The database will watch for changes in the select property column and create folders for each option present. The notes will be placed under the corresponding folder based on the option chosen.
@@ -22,4 +38,10 @@ You have additional settings to customize this rule under `configuration about c
2238

2339
1. By default, the folder is not created until you choose the corresponding select option. You can enable automatic folder creation which will not wait for changes and create the folders directly after setting the rule.
2440
2. You can enable folder deletion if a folder is empty. Because, by default, if the select option is not chosen by any notes, in other words, the associated folder is empty, it is not deleted. Don't worry though, the folder will be created again if the appropriate select option is chosen.
25-
3. When you're grouping by more than one select property. Let's say you have one note that has 2 select properties `select1/select2` with `select1 = something` and `select2 = (nothing)`. By default, because this note is missing one select property, it will be stored at the root of the folder used for storing the database notes. You can disable the setting `hoist files with missing attributes to root folder` and the note will be stored in the last used folder, in the example that would be the folder called `something`.
41+
3. When you're grouping by more than one select property. Let's say you have one note that has 2 select properties `select1/select2` with `select1 = something` and `select2 = (nothing)`. By default, because this note is missing one select property, it will be stored at the root of the folder used for storing the database notes. You can disable the setting `hoist files with missing attributes to root folder` and the note will be stored in the last used folder, in the example that would be the folder called `something`.
42+
43+
> The `column name` and the `column id` have to be the same for this to work.
44+
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: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- **Checkbox**: this property is represented by `true/false` in the underlying markdown ;
66
- **Date**: this property accepts dates. The default format is `yyyy-MM-dd`, but it can be changed in the plugin or database settings under `editing engine section > Date format` ;
77
- **Time**: this property accepts time. The default format is `yyyy-MM-dd HH:mm:ss`, but it can be changed in the plugin or database settings under `editing engine section > Datetime format` ;
8-
- **Select**: this property accepts from a list of options you define. Colors are attributed automatically, though you can change them in the column settings. Furthermore, when removing the select option in the setting, it is also removed from the note's metadata ;
8+
- **Select**: this property accepts from a list of options you define. Colors are attributed automatically, though you can change them in the column settings. Furthermore, you can edit or remove the options from the column settings and the changes will be persisted on the notes' metadata ;
99
- **Tags**: similar to the previous property, but instead of only selecting one option, you can select multiples options per cell ;
1010
- **Formulas**: property that accepts js code to return dynamic values in function of your code. See the [Formulas](/obsidian-db-folder/features/Formulas/) section for more details.
1111
- **Image**: you can embed images in the `text` property in this format `![[image]]`. Make sure to enable `media links` in the column settings and adjust the dimensions too ;
@@ -17,15 +17,48 @@
1717

1818
> You can change from one property type to another, and if the format is right, it will be recognized by the plugin.
1919
20+
## Column ID
21+
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.
23+
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>
27+
2028
## YAML & Dataview Inline Fields
2129

22-
The plugin works with YAML and dataview inline fields, but by default, it looks for metadata in YAML. To make it work with inline fields, you have two options :
30+
The plugin works with YAML and dataview inline fields, but looks for metadata in YAML by default. To make it work with inline fields, you have two options :
2331

24-
- You can toggle `enable inline field as default` in database or plugin global settings, and you can choose between putting the inline fields at the top or at the bottom of the file ;
25-
- Or you can change it in the column's settings to use it with one property only. Keep in mind that this change will not convert the underlying YAML to an inline format, it was meant to work with metadata already formatted as inline.
32+
- You can toggle `enable inline field as default` in database or plugin global settings, and you can choose between putting the inline fields at the top or the bottom of the file ;
33+
- Or you can change it in the column's settings to use it with one property only. This change will not convert the underlying YAML to an inline format until you edit one of the cells in the column.
2634

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

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>
40+
41+
## Nested Metadata
42+
43+
You can add nested metadata by writing something like `metadata1.metadata2` in the column setting under `Behavior > column id`, which will render nested metadata separated by one space :
44+
45+
```
46+
---
47+
metadata1:
48+
metadata2: something
49+
---
50+
```
51+
52+
If you want to add existing nested metadata, you'll have to abide by the format described above.
53+
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>
57+
2958
## Appearance
3059

31-
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.
60+
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.
61+
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: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,7 @@ There are two types of destinations :
1616
2. Where you will store the notes of the database.
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.
19+
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: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,34 @@
22

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

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>
8+
59
## Sticky First Column
610

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

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>
16+
917
## Pagination
1018

1119
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.
1220

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>
24+
1325
## Row Height
1426

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

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>
32+
1733
## Filtering
1834

1935
Using the database top bar, you can create one or multiple filters or you can search (normally or with regex) for any metadata displayed in the database.
@@ -26,26 +42,54 @@ Each `group filter` will have a dedicated **named button** on the database top b
2642

2743
> The database filters hold priority over the dataview query source filters.
2844
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>
48+
2949
## Refresh Database
3050

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

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>
56+
3357
## Sorting
3458

3559
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.
3660

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>
64+
3765
## Database Markdown
3866

39-
You can view the database markdown note by using the command `open as markdown` in obsidian menu or in the database menu.
67+
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.
68+
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>
4072

4173
## Embedding Database
4274

4375
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.
4476

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>
80+
4581
## Exporting Data
4682

4783
You can export the database into **CSV** format using the database menu.
4884

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>
88+
4989
## Importing Data
5090

51-
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`.
91+
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`.
92+
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>

0 commit comments

Comments
 (0)