Skip to content

Commit c15cc96

Browse files
authored
Merge pull request #4 from tu2-atmanand/dev-updating
update installation process images
2 parents e161fa6 + 25b96f0 commit c15cc96

File tree

7 files changed

+38
-14
lines changed

7 files changed

+38
-14
lines changed

assets/HowToSetupTaskBoard.gif

2.95 MB
Loading

docs/Components/Task_Board_Pane.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The View consists of various sections as can be seen in the below image :
1414

1515
## View Header Section
1616

17-
This is the panel of any normal view. In this Bar you will able to see the current name of the active pane, which is the Task Board. On the right side in this bar, you can see the `Re-Scan Vault` button, which will open the [Re-Scan Vault Window](../Features/ReScan_Vault_Feature.md). After that there is a `More Options` button.
17+
This is the panel of any normal view. In this Bar you will able to see the current name of the active pane, which is the Task Board. On the right side in this bar, you can see the `Scan Vault` button, which will open the [Scan Vault Window](../Features/Scan_Vault_Feature.md). After that there is a `More Options` button.
1818

1919
## Boards Tab Section
2020

docs/Features/ReScan_Vault_Feature.md renamed to docs/Features/Scan_Vault_Feature.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
22
parent: Features
3-
title: Re-scan Vault
3+
title: Scan Vault
44
nav_order: 5
55
---
66

7-
# Re-Scan Vault Feature
7+
# Scan Vault Feature
88

99
This feature helps you to scan your whole Vault files to extract the tasks. After installing the plugin you will be required to run this feature to extract all tasks only for the first time.
1010

1111
You dont have to run this feature after the initial setup, since all your tasks will be [auto-scanned](../Features/Auto_Scanning_Files.md) from the files you have modified.
1212

1313
But you can make use of this feature, if you have found some issue while extracting the tasks or few of your tasks has not been extracted properly.
1414

15-
You can also use an option from the setting to run this feature at Obsidian startup. This settings option is been kept OFF by default, since in normal case, you wont be required to run the Re-Scan feature often. But if in your specific situation, if you are modifying your markdown files outside of Obsidian or when Obsidian is closed, you can turn on this setting option.
15+
You can also use an option from the setting to run this feature at Obsidian startup. This settings option is been kept OFF by default, since in normal case, you wont be required to run the Scan feature often. But if in your specific situation, if you are modifying your markdown files outside of Obsidian or when Obsidian is closed, you can turn on this setting option.
1616

1717
Please note that, if your Vault is very large in size and contains files with huge amount of data, then consider applying [Scan Filter](../Features/Filters_for_Scanning.md) to only scan specific files or restrict from scanning certain files, to save the scanning time.
1818

19-
## Re-Scan Window
19+
## Scan Window
2020

2121
![ReScan Vault Window Open](../../assets/ReScanVaultModalOpen.png)
2222

docs/Features/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ Your contribution for updating the current content in any language or adding a n
5353

5454
### Re Scan Vault
5555

56-
This is a Special feature which allows you to re-scan your whole vault to detect any undetected changes or when you update the [Scan Filters](./Filters_for_Scanning.md) settings from the Global Settings.
56+
This is a Special feature which allows you to Scan your whole vault to detect any undetected changes or when you update the [Scan Filters](./Filters_for_Scanning.md) settings from the Global Settings.

docs/Getting_Started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ nav_order: 3
77

88
## **Step 1 :** Opening the Task Board
99

10-
After you have installed the plugin properly, you will able to see a new Icon on the ribbon bar. Open Task Board using this Task Board Icon as shown in the below image.
10+
After you have installed the plugin properly, you will able to see a new Icon on the ribbon bar. Open Task Board using this Icon as shown in the below image.
1111

12-
![RibbonIcon](../assets/RibbonIcon.png)
12+
![RibbonIcon](../assets/HowToSetupTaskBoard.gif)
1313

1414
You can also open the Task Board using the command `Open Task Board` from the Command Palette.
1515
Assign a shortcut to the command from the Hotkey tab from the settings pane for easy access.
1616

1717
## **Step 2 :** Scan tasks for first time
1818

19-
Click on the Re-Scan Vault button which you will see inside the View Header from Kanban View on top-right corner. This will open the Scanning Pop-up window to scan tasks from all your files from the Vault.
19+
Click on the **Scan Vault window** button which you will see inside the View Header on top-right corner. This will open the Scanning Pop-up window to scan tasks from all your files throughout the Vault.
2020

2121
![ReScanVaultModalOpen](../assets/ReScanVaultModalOpen.png)
2222

23-
**NOTE** : You wont need to use this Re-Scan Vault feature often its only for fresh install or for special cases like troubleshooting or solving any other issue. Learn more here : [Re-Scan Vault Feature](./Features/ReScan_Vault_Feature.md)
23+
**NOTE** : You wont need to use this Scan Vault feature often its only for fresh install or for special cases like troubleshooting or solving any other issue. Learn more here : [Scan Vault Feature](./Features/Scan_Vault_Feature.md)
2424

2525
All your tasks with the [accepted format](./Components/Task_Formats.md) will going to get scanned from all your files and will be displayed on the board based on the specific [Column Criteria](./Components/Types_Of_Columns.md).
2626

docs/How_To/HowToUseGlobalSettings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,9 @@ This option help you add due date automatically if you havent entered any value
107107
|---------------|---------------|
108108
| Toggle Button | OFF |
109109

110-
This option will help you to decide whether you want to scan all your files or filtered files every time when the Obsidian starts. The Vault-Scanning feature can be understood from here : [Vault-Scanning](../Features/ReScan_Vault_Feature.md).
110+
This option will help you to decide whether you want to scan all your files or filtered files every time when the Obsidian starts. The Vault-Scanning feature can be understood from here : [Vault-Scanning](../Features/Scan_Vault_Feature.md).
111111

112-
This can be a beneficial feature for those who edit their files outside of Obsidian, so when Obsidian opens, Task Board is unaware that the tasks has been updated from various files, in this case you will be required to run the [Re-Scan Vault](../Features/ReScan_Vault_Feature.md) feature manually, so you can set this option to ON, to scan all the files automatically whenever Obsidian starts.
112+
This can be a beneficial feature for those who edit their files outside of Obsidian, so when Obsidian opens, Task Board is unaware that the tasks has been updated from various files, in this case you will be required to run the [Scan Vault](../Features/Scan_Vault_Feature.md) feature manually, so you can set this option to ON, to scan all the files automatically whenever Obsidian starts.
113113

114114
{: .warning } Do not enable this feature if you vault is very big and contains lot of large files with lot of data. This feature will work the best if you have set the file and folder [Scanning Filters](../Features/Filters_for_Scanning.md).
115115

docs/Installation.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,39 @@ There are two ways you can install this plugin, either from the Official Obsidia
2121

2222
**Step 5 :** Search for `Task Board` in the search bar.
2323

24-
**Step 6 :** Click on this plugin result by `Atmanand Gauns`.
24+
**Step 6 :** Click on the plugin by `Atmanand Gauns`.
2525

2626
**Step 7 :** Click on **Install**.
2727

2828
**Step 8 :** After installing you will see a **Enable** button, click on it.
2929

3030
**Step 9 :** The plugin has been Enabled. Move to the next step on how to start using the plugin here : [Getting Started.](Getting_Started.md)
3131

32-
## Method 2 : Download the source files from Github
32+
---
33+
34+
## Method 2 : Using [BRAT plugin](https://github.com/TfTHacker/obsidian42-brat)
35+
36+
**Step 1:** Install [**BRAT plugin**](obsidian://show-plugin?id=obsidian42-brat), same way you install any other plugin :
37+
38+
`Open Obsidian settings` > `Community plugins` > `click on Browse button` > `search for Brat` > `Install and Enable`.
39+
40+
**Step 3 :** Add **Task Board** plugin into the Brat beta plugin list. See below gif :
41+
42+
![Installation using BRAT](./assets/InstallInBRAT.gif)
43+
44+
`Open Obsidian settings` > `BRAT` > `Add Beta plugin button` > `Paste the below link` > `Click on Add Plugin`.
45+
46+
```md
47+
https://github.com/tu2-atmanand/Task-Board
48+
```
49+
50+
**Step 4 :** Thats it! You will see a notification that the plugin has been successfully installed. You should able to see a ribbon icon to open **Task Board**.
51+
52+
**Step 5 :** Proceed to initialization step :[Opening **Task Board** for first time.](Getting_Started.md#step-1--opening-the-task-board)
53+
54+
---
55+
56+
## Method 3 : Download the source files from Github
3357

3458
**Step 1 :** Open this link : [Task Board Release]()
3559

0 commit comments

Comments
 (0)