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

Commit 1bc9be3

Browse files
authored
Merge pull request #428 from RafaelGB/imed-docu-branch
Imed docu branch
2 parents 916983a + 67a757f commit 1bc9be3

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

docs/docs/features/Formulas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ To use an exposed variable, use the `${}` syntax. For example, to get the value
2020

2121
The root object `db` has the following functions:
2222

23-
- `js` : execute a javascript function that you previously defined in the `js` folder of your table. (I.E.: `db.js.myFunction( arg1, arg2)`)
23+
- `js` : execute a javascript function that you previously defined in the `js` folder of your table in the database or plugin settings. (I.E.: `db.js.myFunction( arg1, arg2)`)
2424

docs/docs/features/Properties.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## Types
22

3-
- **Text**: this property support markdown, links, and tags. If you're using links you can enable alias in the column settings ;
3+
- **Text**: this property support markdown, links, and tags. If you're using links you can enable alias in the column settings or in the plugin settings ;
44
- **Number**: this property only accepts numbers ;
55
- **Checkbox**: this property is represented by `true/false` in the underlying markdown ;
6-
- **Date**: this property accepts dates. The default format is `yyyy-MM-dd`, but it can be changed in the plugin settings under `editing engine section > Date format` ;
7-
- **Time**: this property accepts time. The default format is `yyyy-MM-dd HH:mm:ss`, but it can be changed in the plugin settings under `editing engine section > Datetime format` ;
6+
- **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` ;
7+
- **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` ;
88
- **Select**: this property accepts from a list of options you define. Colors are attributed automatically, though you can change them in the column setting. Furthermore, when removing the select option in the setting, it is also removed from the note's 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.
@@ -14,6 +14,7 @@
1414
- **Tasks**: this column can be added only once from the database settings and will display the task of the given file. You can also choose to hide the completed tasks in the column settings ;
1515
- **Inlinks**: this column can be added only once from the database settings and will display the files that have links to the select file ;
1616
- **Outlinks**: this column can be added only once from the database settings and will display the files that have links from the select file.
17+
1718
> You can change from one property type to another, and if the format is right, it will be recognized by the plugin.
1819
1920
## YAML & Dataview Inline Fields

docs/docs/features/Sources.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1+
## Types
2+
13
Just like dataview, you can use multiple sources for your data :
24

3-
1. **Current_folder**: this will match all files within the selected folder when creating the database;
5+
1. **Current_folder**: this will match all files within the selected folder when creating the database. If you want to change the folder, just move the database to another folder ;
46
2. **Tag**: this will match all files with the given tag ;
57
3. **Incoming_link**: this will match all files that have links to the select file ;
68
4. **Outgoing_link**: this will match all files that have links from the select file ;
7-
5. **Dataview**: you can put your dataview query (DQL) without the first line `TABLE columns` as the plugin will autocomplete this part. For example : `FROM "folder" WHERE column = "something" SORT column ASC`.
9+
5. **Dataview**: you can put your dataview query (DQL) without the first line `TABLE columns` as the plugin will autocomplete this part. For example : `FROM "folder" WHERE column = "something" SORT column ASC`. Use this source if you want to combine multiple tags, links, or folders.
10+
11+
## Destination Folders
12+
13+
There are two types of destinations :
814

9-
If you right-clicked a folder or selected **current folder** as the source, the folder is used for storing the database and the new notes. But if you select any other source, you'll have to select where to store the new notes and where to store the database.
15+
1. Where you will store the database file ;
16+
2. Where you will store the notes of the database.
1017

11-
> If you want to combine multiple tags or links or folders, you'll have to use the **Dataview source**.
18+
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.

0 commit comments

Comments
 (0)