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

Commit aaaf147

Browse files
imed-ghomariimed-ghomari
committed
Update documentation
1 parent fdbfc9b commit aaaf147

File tree

17 files changed

+268
-36
lines changed

17 files changed

+268
-36
lines changed

‎docs/.obsidian/app.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"promptDelete": false
3+
}

‎docs/.obsidian/appearance.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"theme": "obsidian"
3+
}

‎docs/.obsidian/core-plugins.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[
2+
"file-explorer",
3+
"global-search",
4+
"switcher",
5+
"graph",
6+
"backlink",
7+
"outgoing-link",
8+
"tag-pane",
9+
"page-preview",
10+
"daily-notes",
11+
"templates",
12+
"note-composer",
13+
"command-palette",
14+
"editor-status",
15+
"starred",
16+
"outline",
17+
"word-count",
18+
"file-recovery"
19+
]

‎docs/.obsidian/hotkeys.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"command-palette:open": [
3+
{
4+
"modifiers": [
5+
"Mod"
6+
],
7+
"key": "T"
8+
}
9+
]
10+
}

‎docs/.obsidian/workspace‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
{
2+
"main": {
3+
"id": "60d0d101d34a2ff9",
4+
"type": "split",
5+
"children": [
6+
{
7+
"id": "1388ebae61465da7",
8+
"type": "leaf",
9+
"state": {
10+
"type": "markdown",
11+
"state": {
12+
"file": "docs/Imed/6_Viewing data.md",
13+
"mode": "source",
14+
"source": false
15+
}
16+
}
17+
}
18+
],
19+
"direction": "vertical"
20+
},
21+
"left": {
22+
"id": "f595d9310d39a1ed",
23+
"type": "split",
24+
"children": [
25+
{
26+
"id": "00bd36e9d9822747",
27+
"type": "tabs",
28+
"children": [
29+
{
30+
"id": "3a02bf8e6b8a26a9",
31+
"type": "leaf",
32+
"state": {
33+
"type": "file-explorer",
34+
"state": {}
35+
}
36+
},
37+
{
38+
"id": "9f96aadaff7d1d3d",
39+
"type": "leaf",
40+
"state": {
41+
"type": "search",
42+
"state": {
43+
"query": "header",
44+
"matchingCase": false,
45+
"explainSearch": false,
46+
"collapseAll": false,
47+
"extraContext": false,
48+
"sortOrder": "alphabetical"
49+
}
50+
}
51+
},
52+
{
53+
"id": "7202a51f3eee53b0",
54+
"type": "leaf",
55+
"state": {
56+
"type": "starred",
57+
"state": {}
58+
}
59+
}
60+
]
61+
}
62+
],
63+
"direction": "horizontal",
64+
"width": 300
65+
},
66+
"right": {
67+
"id": "f90ec7f8de4e0a24",
68+
"type": "split",
69+
"children": [
70+
{
71+
"id": "201b017301510b3b",
72+
"type": "tabs",
73+
"children": [
74+
{
75+
"id": "6f3bd3da61e0ab5a",
76+
"type": "leaf",
77+
"state": {
78+
"type": "backlink",
79+
"state": {
80+
"file": "docs/Imed/6_Viewing data.md",
81+
"collapseAll": false,
82+
"extraContext": false,
83+
"sortOrder": "alphabetical",
84+
"showSearch": false,
85+
"searchQuery": "",
86+
"backlinkCollapsed": false,
87+
"unlinkedCollapsed": true
88+
}
89+
}
90+
},
91+
{
92+
"id": "472341dc0d63ec39",
93+
"type": "leaf",
94+
"state": {
95+
"type": "outgoing-link",
96+
"state": {
97+
"file": "docs/Imed/6_Viewing data.md",
98+
"linksCollapsed": false,
99+
"unlinkedCollapsed": true
100+
}
101+
}
102+
},
103+
{
104+
"id": "509e30d4813ee14c",
105+
"type": "leaf",
106+
"state": {
107+
"type": "tag",
108+
"state": {
109+
"sortOrder": "frequency",
110+
"useHierarchy": true
111+
}
112+
}
113+
},
114+
{
115+
"id": "75e551ecfe61359a",
116+
"type": "leaf",
117+
"state": {
118+
"type": "outline",
119+
"state": {
120+
"file": "docs/Imed/6_Viewing data.md"
121+
}
122+
}
123+
}
124+
]
125+
}
126+
],
127+
"direction": "horizontal",
128+
"width": 300,
129+
"collapsed": true
130+
},
131+
"active": "3a02bf8e6b8a26a9",
132+
"lastOpenFiles": [
133+
"docs/Imed/5_Notes.md",
134+
"docs/Imed/4_Properties.md",
135+
"docs/Imed/3_Columns.md",
136+
"docs/Imed/2_Sources.md",
137+
"docs/Imed/1_index.md",
138+
"docs/Imed/6_Viewing data.md",
139+
"docs/Imed/sommaire.md",
140+
"docs/faq.md",
141+
"docs/Imed/6_Yaml & inline fields.md"
142+
]
143+
}

docs/docs/index.md renamed to docs/docs/Imed/1_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ You **need** to have Dataview installed to use this plugin.
77

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.
10-
![AddDatabase.gif](assets/AddDatabase.gif)
10+
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.

‎docs/docs/Imed/2_Sources.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Just like dataview, you can use multiple sources for your data :
2+
3+
1. **Current folder**: this will match all files within the selected folder when creating the database;
4+
2. **Tag**: this will match all files with the given tag ;
5+
3. **Incoming_link**: this will match all files that have links to the select file ;
6+
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.
8+
9+
> If you want to combine multiple tags or links or folders, you'll have to use the **Dataview source**.

‎docs/docs/Imed/3_Columns.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Creating
2+
### 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.
6+
### 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.
9+
### 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`.
11+
## Hiding
12+
You can hide the columns while keeping the underlying metadata.
13+
## Removing
14+
You can remove the column and remove its underlying metadata. Make sure to enable `configuration about columns > remove fields` in the plugin setting or in the database settings.
15+
## Resizing
16+
You can resize columns by draging the handle at the right of the column header.
17+
## 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`.
19+
## Renaming
20+
You can rename columns by clicking on the column header and changing the selected text.

‎docs/docs/Imed/4_Properties.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## 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 many 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.
13+
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.
15+
16+
## 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+
If there is no metadata in your notes, it will be created when you fill the corresponding cell in the database.

‎docs/docs/Imed/5_Notes.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Creating blank notes
2+
You can create blank notes by typing the name in the bottom bar while leaving the template field empty.
3+
## 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.
8+
## Moving notes based on property
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`.

0 commit comments

Comments
 (0)