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

Commit be3cb4e

Browse files
authored
Merge pull request #331 from RafaelGB/imed-docu-branch
Imed docu branch
2 parents b3b121f + d7782b6 commit be3cb4e

File tree

5 files changed

+25
-18
lines changed

5 files changed

+25
-18
lines changed

docs/docs/features/Notes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
## Creating blank notes
1+
## Creating Blank Notes
22

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

5-
## Creating notes with a template
5+
## Creating Notes with a Template
66

77
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`.
88

99
> 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.
1010
11-
## Deleting notes
11+
## Deleting Notes
1212

1313
You can use the dots to the right of every row to delete the row and the note associated with it.
1414

15-
## Moving notes based on metadata
15+
## Moving Notes Based on Metadata
1616

1717
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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
> 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.
1616
17-
## YAML & dataview inline fields
17+
## YAML & Dataview Inline Fields
1818

1919
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 an inline format.
2020

docs/docs/features/Sources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ Just like dataview, you can use multiple sources for your data :
66
4. **Outgoing_link**: this will match all files that have links from the select file ;
77
5. **Dataview**: you can put your dataview query (DQL) without the first line `TABLE columns` as the plugin will autocomplete this part.
88

9-
When selecting **current folder** as the source, new notes will be added to the folder selected. But if you select any other source, you'll have to select a destination folder for the new notes.
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.
1010

1111
> If you want to combine multiple tags or links or folders, you'll have to use the **Dataview source**.

docs/docs/features/Viewing data.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
## Database information
1+
## Database Information
22

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

5-
## Sticky first column
5+
## Sticky First Column
66

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

99
## Pagination
1010

1111
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.
1212

13-
## Row height
13+
## Row Height
1414

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

@@ -20,22 +20,22 @@ You can either search for any metadata displayed in the database, or you can cre
2020

2121
> The database filter holds priority over the dataview query source filter.
2222
23-
## Refresh database
23+
## Refresh Database
2424

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

2727
## Sorting
2828

29-
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.
29+
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.
3030

31-
## Database markdown
31+
## Database Markdown
3232

3333
You can view the database markdown note by using the command `open as markdown` in obsidian menu.
3434

35-
## Embedding database
35+
## Embedding Database
3636

3737
You can embed a database by using this format `![[database file name.md]]`, it'll show a dataview query of the database.
3838

39-
## Exporting data
39+
## Exporting Data
4040

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

docs/docs/index.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# Welcome to Obsidian Database Folder!
2+
23
This plugin allows you to create [Notion](https://www.notion.so)'s like databases in your [Obsidian](https://obsidian.md) Vault.
34

45
Using the search engine of the popular [Dataview plugin](https://github.com/blacksmithgu/obsidian-dataview), you can view the content of your notes and edit the fields directly from the table without the need to open the note.
56

67
You **need** to have Dataview installed to use this plugin.
78

8-
## How can I add a database?
9-
You can add a database by right clicking on the folder where you want to store your table.
9+
## How Can I Add a Database?
10+
11+
There are 3 ways of creating a database:
12+
13+
1. By executing the command `DB folder: create a new database table` ;
14+
2. By clicking on the custom sidebar icon ;
15+
3. By right-clicking on a folder where you want to store your notes and your database.
16+
17+
## How Do I Access Settings?
1018

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

0 commit comments

Comments
 (0)