Merge pull request #640 from RafaelGB/imed-docu-branch

doc update 2.8 -> 3.0

Author: imed-ghomari

docs/docs/features/Columns.md

@@ -70,4 +70,12 @@ You can rename columns by clicking on the column header and changing the selecte
 
 <video  width="670" controls>
   <source src="https://user-images.githubusercontent.com/38974541/197635177-6a7992e4-69df-42f2-b011-941b347122f1.mov" type="video/mp4">
+</video>
+
+## Sticky First Column
+
+You can make the first column sticky in the database settings to make it always visible even when scrolling horizontally.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197636568-e5a50f5e-0e31-42ce-8067-d810d9643129.mov" type="video/mp4">
 </video>

docs/docs/features/Displaying data.md

@@ -0,0 +1,57 @@
+## Footer
+
+You can enable a footer from the database or plugin global setting under `Rows section`. For now, it only works with the number type column and only displays the sum of the values.
+
+## Filtering
+
+You have to use the database top bar, which can be toggled by the search icon in the page header, or simply by using `CMD/CTRL+F`. You can create one or multiple filters or you can search (normally or with regex) for any metadata displayed in the database.
+
+After opening the filter modal via the obsidian bar button or the command `DB Folder: OPen filters`, you can either create a `filter` or a `group filter`. The difference is that a `group filter` can include many `filters` with either an **AND** or an **OR** type of relationship, whereas `filters` can only have an **AND** type of relationship between them.
+
+You can create a `group filter` within a `group filter` for more granular filtering, and you can delete or rename them. Keep in mind that deleting a `parent group filter` will delete all the `children group filters` within it.
+
+Each `group filter` will have a dedicated **named button** on the database top bar to quickly enable/disable it. It's important to note that the state of all the filters is determined by another button. So in this case, you have to enable both the **named button** and the **filter button** for `group filters` to work. You can also toggle the filter state by using the command `DB Folder: Toggle filters`.
+
+You can also filter each column separately via the search filters which can be enabled by the icon on the top left.
+
+> The database filters hold priority over the dataview query source filters.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197636117-9268cbbe-fcb4-464e-9840-4c966e503589.mov" type="video/mp4">
+</video>
+
+## Refresh Database
+
+There is no actual refresh button, but you can use the `activate/desactive filter` button to refresh the database.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197636392-0c1c17fa-8f21-47dc-8c1f-887ca96d4bab.mov" type="video/mp4">
+</video>
+
+## Sorting
+
+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.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197636458-e322e245-3efa-4261-9578-58ff2eee4ad8.mov" type="video/mp4">
+</video>
+
+## Embedding Database
+
+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.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197635963-e29dc482-09b0-4994-b861-ac57c85a583b.mov" type="video/mp4">
+</video>
+
+## Exporting Data
+
+You can export the database into **CSV** format using the obsidian page header.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197636017-c4a1d9df-75c1-437e-924f-23d444658fb5.mov" type="video/mp4">
+</video>
+
+## Projects Plugin Integration
+
+You can add a custom DB Folder view in the [projects plugin](https://github.com/marcusolsson/obsidian-projects).

docs/docs/features/Notes.md

@@ -1,14 +1,14 @@
 ## Creating Blank Notes
 
-You can create blank notes by typing the name in the bottom bar while leaving the template field empty.
+You can create blank notes by clicking on the "+" icon the obsidian page header or by using the command `DB Folder: Add new row` which brings up the creation modal. Make sure you leave the template filed empty.
 
 <video  width="670" controls>
   <source src="https://user-images.githubusercontent.com/38974541/197633841-2e54a360-ce90-4b95-8032-34409fe4a1bc.mov" type="video/mp4">
 </video>
 
 ## Creating Notes with a Template
 
-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`.
+You have to choose a template in the creation modal. You can filter the files suggested by adding a folder in the database or global plugin settings under `Rows section`.
 
 <video  width="670" controls>
   <source src="https://user-images.githubusercontent.com/38974541/197634718-98463157-f7d7-4323-87ab-e280211eeed7.mov" type="video/mp4">
@@ -20,14 +20,26 @@ You have to choose a template in the bottom bar before creating the note. You ca
   <source src="https://user-images.githubusercontent.com/38974541/197634584-7420f211-bec2-4e0e-a031-dab809cbc1ab.mov" type="video/mp4">
 </video>
 
+## Creating Notes via Importing
+
+You can upload a **CSV** file and turn it into a database using the obsidian page header. 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`.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197636176-44eeaeb3-a753-4afc-b96b-4072b2e87fca.mov" type="video/mp4">
+</video>
+
 ## Deleting & Renaming Notes
 
-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.
+You can right-click on the numbers to the right of every row, to bring up a menu where you can delete or rename the note associated with the row.
 
 <video  width="670" controls>
   <source src="https://user-images.githubusercontent.com/38974541/197634302-a1081f6b-12da-40a5-a476-b222d4686b98.mov" type="video/mp4">
 </video>
 
+## Opening Note
+
+You can either display a preview of the note inside the database by clicking on the numbers to the right. In this preview, you can't edit the file but you can check the tasks. You can also click on the link symbol to open the note in its own pane.
+
 ## Moving Notes Based on Metadata
 
 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. 

docs/docs/features/Properties.md

@@ -1,6 +1,6 @@
 ## Types
 
-- **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 ;
+- **Text**: this property support markdown, internal links, external links, and tags. If you're using links you can enable alias in the column settings or in the plugin global settings ;
 - **Number**: this property only accepts numbers ;
 - **Checkbox**: this property is represented by `true/false` in the underlying markdown ;
 - **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` ;

docs/docs/features/Rows.md

@@ -0,0 +1,19 @@
+## Row Number
+
+To help with displaying a lot of data, by default the database displays only 10 rows and allows changing the pages using the numbers displayed in the bottom right or by using the commands `DB Folder: Go to previous/next page`. You can change the number of rows displayed per page in the database settings under `Rows section`.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197636349-f473a874-4c6a-434e-8b90-56aa05f368f6.mov" type="video/mp4">
+</video>
+
+## Row Shadow
+
+You can enable or disable alternate row shadowing in the plugin global settings under `Rows section`.
+
+## Row Height
+
+In the database settings under `cell size`, you can change the row height between 3 options (compact, normal, wide). There is also a global setting under `Folder adjustments` if you want to change the default behavior.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197636446-9f17f8a7-baa5-4b7e-b910-557b0c5a478c.mov" type="video/mp4">
+</video>

docs/docs/features/Sources.md

@@ -3,10 +3,11 @@
 Just like dataview, you can use multiple sources for your data :
 
 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 ;
-2. **Tag**: this will match all files with the given tag ;
-3. **Incoming_link**: this will match all files that have links to the select file ;
-4. **Outgoing_link**: this will match all files that have links from the select file ;
-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.
+2. **Current folder without subfolders**: Just like the previous source, but doesn't recognize notes under subfolders ;
+3. **Tag**: this will match all files with the given tag ;
+4. **Incoming_link**: this will match all files that have links to the select file ;
+5. **Outgoing_link**: this will match all files that have links from the select file ;
+6. **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.
 
 ## Destination Folders
 
@@ -15,7 +16,7 @@ There are two types of destinations :
 1. Where you will store the database file ;
 2. Where you will store the notes of the database.
 
-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.
+If the source is `tag/incoming_link/outgoing_link/dataview`, you have to choose both types of destinations. But if you right-clicked a folder or the source is `current_folder with or without subfolders`, everything is stored under one folder, so you'll only choose once.
 
 <video  width="670" controls>
   <source src="https://user-images.githubusercontent.com/38974541/197635750-10d783f1-169a-4e6c-8c07-9c38dcf7938d.mov" type="video/mp4">

docs/docs/features/Viewing data.md

@@ -20,8 +20,24 @@ There are 3 ways of creating a database:
 
 ## How Do I Access Settings?
 
-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.
+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 obsidian page header or by using the command `DB Folder: Open to Database settings`. The database settings take priority over the plugin global settings.
 
 <video  width="670" controls>
   <source src="https://user-images.githubusercontent.com/38974541/197639146-d48fb28e-f14d-4f52-84b0-ee380cfd4db8.mov" type="video/mp4">
 </video>
+
+## How Do I Change the Database Name?
+
+The database is not the name of the note. You have to change the database name and description in the database settings. The name of the database along with the number of rows will be displayed in the status bar.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197635940-0b3c351d-9325-408e-8711-71cf8830bccc.mov" type="video/mp4">
+</video>
+
+## How Can I View the Markdown File?
+
+You can view the database markdown note by using the command `open as markdown` in obsidian menu or in the obsidian page header. To re-enable the database view, just close the pane and re-open it again.
+
+<video  width="670" controls>
+  <source src="https://user-images.githubusercontent.com/38974541/197636284-ad2d5772-e65e-4e7b-bffa-fce53b52b16e.mov" type="video/mp4">
+</video>

docs/docs/index.md

@@ -6,9 +6,10 @@ nav:
   - Features:
       - Sources: "features/Sources.md"
       - Columns: "features/Columns.md"
+      - Rows: "features/Rows.md"
       - Properties: "features/Properties.md"
       - Notes: "features/Notes.md"
-      - Viewing data: "features/Viewing data.md"
+      - Displaying data: "features/Displaying data.md"
       - Relations: "features/Relations.md"
       - Formulas: "features/Formulas.md"
   - About: "about.md"