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

Commit 4ddea8b

Browse files
committed
Update documentation
1 parent 802b7de commit 4ddea8b

File tree

5 files changed

+83
-39
lines changed

5 files changed

+83
-39
lines changed

docs/docs/features/Columns.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,35 @@
1-
## Creating
21
### Blank column
3-
You can add a new column with the `+` button of the database, or by using the `insert right/left` in the column menu.
4-
### Add from extisting metadata
5-
The plugin searches all the file included in the source selected for metadata that is not included in the database. Choose from the list provided when clicking in the `+` button.
2+
3+
You can add a new column with the `+` button of the database, or by using the `insert right/left` in the column menu.
4+
5+
### Add from existing metadata
6+
7+
The plugin searches all the file included in the source selected for metadata that is not included in the database. Choose from the list provided when clicking in the `+` button.
8+
69
### Add from all available metadata at once
7-
The plugin can grab all the metadata from all the files included in the selected source and add them all at once.
8-
Be aware that this will overide any previously created columns, you'll have to configure the columns again.
10+
11+
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.
12+
913
### Add from template
10-
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`.
14+
15+
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`.
16+
1117
## Hiding
12-
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).
18+
19+
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).
20+
1321
## Removing
14-
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.
22+
23+
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.
24+
1525
## Resizing
16-
You can resize columns by draging the handle at the right of the column header.
26+
27+
You can resize columns by dragging the handle at the right of the column header.
28+
1729
## Reordering
18-
For now, by default, resizing columns is disabled because of a related bug. You can however enable it in the plugin settings under `Developer section > Enable drag and drop columns`.
30+
31+
For now, by default, reordering columns is disabled because of a related bug. You can, however, enable it in the plugin settings under `Developer section > Enable drag and drop columns`.
32+
1933
## Renaming
34+
2035
You can rename columns by clicking on the column header and changing the selected text.

docs/docs/features/Notes.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
## Creating blank notes
2+
23
You can create blank notes by typing the name in the bottom bar while leaving the template field empty.
4+
35
## Creating notes with template
4-
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`.
5-
> It works with the core template plugin. But with templater plugin, you have to activate the option `Trigger templater on new file creation` in templater settings.
6-
## Deleting notes
7-
You can use the dots menu to the right of every row to delete the row and the note associated with it.
6+
7+
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`.
8+
9+
> It works with the core template plugin. But with templater plugin, you have to activate the option `Trigger templater on new file creation` in templater settings.
10+
11+
## Deleting notes
12+
13+
You can use the dots to the right of every row to delete the row and the note associated with it.
14+
815
## Moving notes based on metadata
9-
You can move the notes between folders based on the change of a **select** property option. You have to choose the **select** property option in the database setting under `choose column for group folder`.
16+
17+
You can move the notes between folders based on the change of a **select** property option. You have to choose the **select** property option in the database setting under `choose column for group folder`.

docs/docs/features/Properties.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
## Types
2-
- **Text**: this property support markdown, links and tags ;
3-
- **Number**: this property only accepts numbers ;
4-
- **Checkbox**: this property is represented by `1/0` in the underlying markdown ;
5-
- **Date**: this property accepts dates with the format `YYYY-MM-DD` ;
6-
- **Time**: this property accepts time with the format `YYYY-MM-DD hh:mm AM/PM` ;
7-
- **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-
- **Tags**: similar to the previous property but instead of only selecting one option, you can select multiples options per cell ;
9-
- **Image**: you can embed images in the `text` property in this format `![[image]]`. Make sure to enable `media links` in the column setting and ajust the dimensions too ;
10-
- **Created time**: this column can be added only once from the database settings and will display the created time of the row ;
11-
- **Modified time**: this column can be added only once from the database settings and will display the last modified time of the row ;
12-
- **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.
132

14-
> You can change the column property types, and if the format is right, it will be recognized by the plugin. Sometimes though, after converting, you won't see the changes until you refresh the database.
3+
- **Text**: this property support markdown, links and tags ;
4+
- **Number**: this property only accepts numbers ;
5+
- **Checkbox**: this property is represented by `1/0` in the underlying markdown ;
6+
- **Date**: this property accepts dates with the format `YYYY-MM-DD` ;
7+
- **Time**: this property accepts time with the format `YYYY-MM-DD hh:mm AM/PM` ;
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 ;
9+
- **Tags**: similar to the previous property, but instead of only selecting one option, you can select multiples options per cell ;
10+
- **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+
- **Created time**: this column can be added only once from the database settings and will display the created time of the row ;
12+
- **Modified time**: this column can be added only once from the database settings and will display the last modified time of the row ;
13+
- **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.
14+
15+
> You can change the column property types, and if the format is right, it will be recognized by the plugin. Sometimes, though, after converting, you won't see the changes until you refresh the database.
1516
1617
## YAML & dataview inline fields
17-
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'll have to change it in the column's settings. Keep in mind that this change will not convert the underlying yaml to inline format.
18+
19+
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'll have to change it in the column's settings. Keep in mind that this change will not convert the underlying YAML to inline format.
1820

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

docs/docs/features/Viewing data.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,41 @@
11
## Database information
2+
23
You can change the database name and description in the database settings.
4+
35
## Sticky first column
6+
47
You can make the first column sticky in the database settings to make it always visible even when scroll horizontally.
8+
59
## Pagination
10+
611
To help with displaying a lot of data, by default the database displaying 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.
12+
713
## Row height
8-
In the database setings under `cell size`, you can change the row height between 3 options (compact, normal, wide).
14+
15+
In the database settings under `cell size`, you can change the row height between 3 options (compact, normal, wide).
16+
917
## Filtering
10-
You can either search for any metadata dispalyed in the database or you can create a filter using the top bar.
11-
You can use multiple filters at the same time. The button on the left activates and deactivates the filter.
12-
> the database filter holds priority over the dataview query source filter.
18+
19+
You can either search for any metadata displayed in the database, or you can create a filter using the top bar. You can use multiple filters at the same time. The button on the left activates and deactivates the filter.
20+
21+
> The database filter holds priority over the dataview query source filter.
22+
1323
## Refresh database
14-
There is no actual refresh button, but you can use the `activate/desactive filter` button to refresh the database.
24+
25+
There is no actual refresh button, but you can use the `activate/desactive filter` button to refresh the database.
26+
1527
## Sorting
28+
1629
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 header menu.
30+
1731
## Database markdown
18-
You can view the database markdown note by using the command `open as markdown` in obsidian menu.
19-
## Embeding database
20-
You can embed a database by using this format `![[database file name.md]]`, it'll show a dataview query of the database.
32+
33+
You can view the database markdown note by using the command `open as markdown` in obsidian menu.
34+
35+
## Embedding database
36+
37+
You can embed a database by using this format `![[database file name.md]]`, it'll show a dataview query of the database.
38+
2139
## Exporting data
22-
You can export the database into **CSV** format using the database menu.
40+
41+
You can export the database into **CSV** format using the database menu.

docs/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ You **need** to have Dataview installed to use this plugin.
88
## How can I add a database?
99
You can add a database by right clicking on the folder where you want to store your table.
1010

11-
## How do I access settings?
11+
## How do I access settings?
1212
There is two types of settings (plugin setting and database setting). You can access the database settings from the obsidian menu. The database settings takes priority over the plugin setting.

0 commit comments

Comments
 (0)