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

doc update 3.0.0 -> 3.2.0

Author: RafaelGB

docs/docs/features/Displaying data.md

@@ -1,6 +1,14 @@
 ## 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.
+You can enable a footer from the database or plugin global setting under `Rows section`. You can choose between a number of options :
+
+-   Percentage of empty cells
+-   Percentage of cells with a value
+-   Count of empty cells
+-   Count of cells with a value
+-   Count of unique values
+-   Formula
+-   Sum of number columns
 
 ## Filtering
 
@@ -10,19 +18,20 @@ After opening the filter modal via the obsidian bar button or the command `DB Fo
 
 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`.
+Each `group filter` will have a dedicated **named colored 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.
+> You can make search/filter bar always visible in the plugin global settings under `Helpers/Commands related to the table`
 
 <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.
+The databaes should refresh after every change, but you can use the `activate/desactive filter` button if you want to manually refresh it. On the other hand, you can disable auto-refreshing when an external change is detected in the plugin global settings.
 
 <video  width="670" controls>
   <source src="https://user-images.githubusercontent.com/38974541/197636392-0c1c17fa-8f21-47dc-8c1f-887ca96d4bab.mov" type="video/mp4">

docs/docs/features/Formulas.md

@@ -33,7 +33,9 @@ The root object `db` has the following functions:
 - `dataview`: expose the dataview API. (see [Dataview API](https://github.com/blacksmithgu/obsidian-dataview/blob/master/src/api/plugin-api.ts))
 - `rollup`: expose the rollup functions of the dbfolder plugin.  (see [Rollup documentation](/obsidian-db-folder/features/Relations/#rollups))
 - Internal functions of the plugin (see [API DatabaseFnType](https://github.com/RafaelGB/obsidian-db-folder/blob/master/src/cdm/ModulesFnModel.ts))
+
 #### Javascript file structure
+
 To add a javascript file to the `js` folder, it must be a `.js` file and have the following structure:
 
 ```javascript

docs/docs/features/Properties.md

@@ -1,6 +1,6 @@
 ## Types
 
-- **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 ;
+- **Text**: this property support markdown, internal links, external links, tags and lists in this format `[a,b,c,1,2,3]`. If you're using links you can enable alias in the column settings or in the plugin global settings. You can also resize the cell while editing to display more text. ;
 - **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` ;
@@ -9,8 +9,8 @@
 - **Tags**: similar to the previous property, but instead of only selecting one option, you can select multiples options per cell ;
 - **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.
 - **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 ;
-- **Created time**: this column can be added only once from the database settings and will display the created time of the row ;
-- **Modified time**: this column can be added only once from the database settings and will display the last modified time of the row ;
+- **Created time**: this column can be added only once from the database settings and will display the created time of the row. The date format can be changed in the global settings under `Configuration about editing engine > Metadata datetime format` ;
+- **Modified time**: this column can be added only once from the database settings and will display the last modified time of the row. The date format can be changed in the global settings under `Configuration about editing engine > Metadata datetime format` ;
 - **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 ;
 - **Inlinks**: this column can be added only once from the database settings and will display the files that have links to the select file ;
 - **Outlinks**: this column can be added only once from the database settings and will display the files that have links from the select file ;
@@ -30,7 +30,7 @@ Where you create a column, the `column name` (name displayed in the database) is
 
 The plugin works with YAML and dataview inline fields, but looks for metadata in YAML by default. To make it work with inline fields, you have two options :
 
-- 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 the bottom of the file ;
+- 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, the bottom or after the last field  ;
 - Or you can change it in the column's settings to use it with one property only. This change will not convert the underlying YAML to an inline format until you edit one of the cells in the column.
 
 If there is no metadata in your notes, it will be created when you fill the corresponding cell in the database. 
@@ -58,7 +58,7 @@ If you want to add existing nested metadata, you'll have to abide by the format
 
 ## Appearance
 
-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.
+You can enable text wrapping and you can change the text's horizontal or vertical alignment from the column settings.
 
 <video  width="670" controls>
   <source src="https://user-images.githubusercontent.com/38974541/197635327-31c273a1-6cb5-4283-a9a5-dddbdcc6b831.mov" type="video/mp4">

docs/docs/features/Relations.md

@@ -6,7 +6,7 @@ Relations are a very important part of any database. They allow you to model com
 
 ### How to Use
 
-To create a relation, you need to create a column with the `Relation` type. You can then select the table you want to relate to. You can also select the column you want to use as the relation key as `Rollup`. This is the column that will be used to match the rows. For example, if you have a `User` table with a `Name` column, and a `Post` table with an `Author` column, you can use the `Name` column as the relation key.
+To create a relation, you need to create a column with the `Relation` type. You can then select the table you want to relate to (or select same database to relate to itself). You can also select the column you want to use as the relation key as `Rollup`. This is the column that will be used to match the rows. For example, if you have a `User` table with a `Name` column, and a `Post` table with an `Author` column, you can use the `Name` column as the relation key.
 
 ## Rollups
 

docs/docs/features/Rows.md

@@ -1,6 +1,6 @@
 ## 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`.
+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`, or you can change the default number of rows when creating a database in the global plugin settings.
 
 <video  width="670" controls>
   <source src="https://user-images.githubusercontent.com/38974541/197636349-f473a874-4c6a-434e-8b90-56aa05f368f6.mov" type="video/mp4">
@@ -16,4 +16,26 @@ In the database settings under `cell size`, you can change the row height betwe
 
 <video  width="670" controls>
   <source src="https://user-images.githubusercontent.com/38974541/197636446-9f17f8a7-baa5-4b7e-b910-557b0c5a478c.mov" type="video/mp4">
-</video>
+</video>
+
+## Row Font Size
+
+You can select the font size of the cells in the database settings, you can set a default font size in the plugin's global settings for all newly created databases.
+
+## Row Navigation
+
+You can navigate the cells by using `Tab` or the arrow keys. You can also edit each one by using the `Enter` key.
+
+## Display Rows From Top to Bottom
+
+If you don't use pagination, you can enable a full pane display of the rows by creating and enabling this CSS snippet. Keep in mind, though, that when enabling the search/filter bar, the last row will not be accessible.
+
+```css
+@media {
+  .database-plugin__scroll-container {
+    will-change: transform;
+    width: 100%;
+    height: 100%;
+  }
+}
+```

docs/docs/features/Sources.md

@@ -4,7 +4,7 @@ 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. **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 ;
+3. **Tag(s)**: this will match all files with the given tag(s) ;
 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.