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

Commit 8e7e956

Browse files
authored
Merge pull request #480 from RafaelGB/imed-docu-branch
Imed docu branch
2 parents 9f6c246 + 78f1725 commit 8e7e956

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

docs/docs/features/Columns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ The plugin can grab all the metadata from all the files included in the selected
1414

1515
### Add From Template
1616

17-
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 setting under `select file as column template`.
17+
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`.
1818

1919
## Hiding
2020

2121
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).
2222

2323
## Removing
2424

25-
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 setting or in the database settings.
25+
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.
2626

2727
## Resizing
2828

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 in the database or plugin settings. (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 global settings. (I.E.: `db.js.myFunction( arg1, arg2)`)
2424

docs/docs/features/Notes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ You have to choose a template in the bottom bar before creating the note. You ca
1010
1111
## Deleting & Renaming Notes
1212

13-
You can use the dots to the right of every row, to bring up a menu where you can delete and rename the note associated with the row.
13+
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.
1414

1515
## Moving Notes Based on Metadata
1616

1717
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.
1818

19-
You can choose one or many select properties by which this rule will run. If you choose more than one, the folders will be nested and the nesting order will follow the order by which the select properties are added in the database setting. For example *"select1/select2/select3"*. This setting can be found under `configuration about columns > Columns to group by`.
19+
You can choose one or many select properties by which this rule will run. If you choose more than one, the folders will be nested and the nesting order will follow the order by which the select properties are added in the database settings. For example *"select1/select2/select3"*. This setting can be found under `configuration about columns > Columns to group by`.
2020

2121
You have additional settings to customize this rule under `configuration about columns` in the database settings :
2222

docs/docs/features/Properties.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
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 or in the plugin 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 global settings ;
44
- **Number**: this property only accepts numbers ;
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 setting. 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, 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.
11-
- **Image**: you can embed images in the `text` property in this format `![[image]]`. Make sure to enable `media links` in the column setting and adjust the dimensions too ;
11+
- **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 ;
1212
- **Created time**: this column can be added only once from the database settings and will display the created time of the row ;
1313
- **Modified time**: this column can be added only once from the database settings and will display the last modified time of the row ;
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 ;
@@ -21,11 +21,11 @@
2121

2222
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 :
2323

24-
- You can toggle `enable inline field as default` in database or plugin setting, and you can choose between putting the inline fields at the top or at the bottom of the file ;
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 ;
2525
- 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.
2626

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

2929
## Appearance
3030

31-
You can enable text wrapping and you can change the text alignment between `right-aligned`, `centered`, `left-aligned`, and `justified` from the column setting of the **text**, **number**, and **formula** properties.
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.

docs/docs/features/Viewing data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ You can view the database markdown note by using the command `open as markdown`
4040

4141
## Embedding Database
4242

43-
You can embed a database by using this format `![[database file name.md]]`, it'll show a dataview query of the database.
43+
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.
4444

4545
## Exporting Data
4646

4747
You can export the database into **CSV** format using the database menu.
4848

4949
## Importing Data
5050

51-
You can upload a **CSV** file and turn it to a database using the database menu.
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`.

docs/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ There are 3 ways of creating a database:
1616

1717
## How Do I Access Settings?
1818

19-
There are two types of settings (plugin setting and database setting). You can access the database settings from the obsidian menu or from the database menu. The database settings take priority over the plugin settings.
19+
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.

0 commit comments

Comments
 (0)