diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..e07279f --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,5 @@ +{ + "cSpell.words": [ + "Kanban" + ] +} \ No newline at end of file diff --git a/docs/Advanced/HowToJoinDevelopment.md b/docs/Advanced/HowToJoinDevelopment.md index 94e5965..2a4bbb1 100644 --- a/docs/Advanced/HowToJoinDevelopment.md +++ b/docs/Advanced/HowToJoinDevelopment.md @@ -7,13 +7,13 @@ title: Join the plugin Development Advanced {: .label .label-yellow } -To contribute for development of this project on github, I have made few fixed repositories for now, which have their specific tasks. +To contribute for development of this project on github, I have made few fixed repositories for now, which have their specific intent. -The complete workflow can be tracked from the Task Board GitHub Project. +The complete workflow can be tracked from the [Task Board GitHub Project](https://github.com/users/tu2-atmanand/projects/2). -You can go through which issue/feature has been worked on at present, which issues are ready to be implemented and which issues has not been assigned at present to anyone or havent been started yet. +You can go through which issue/feature has been worked on at present, which issues are ready to be implemented and which issues has not been assigned at present to anyone or haven't been started yet. -If you feel like, you can work on any issue which has not been assigned to any one. Then open the issue, go to the end and add a new comment by taggin the project admin and mention that you want to start working on this project. Also ensure that, no one else has commented the same, else it will be same work being done by two people. +If you feel like, you can work on any issue which has not been assigned to any one. Then open the issue, go to the end and add a new comment by tagging the project admin and mention that you want to start working on this issue. Also ensure that, no one else has commented the same, else it will be same work being done by two people. After mentioning this you can directly start working on the issue by [creating a fork]() of the project and then creating a new branch from the `pluginTesting` branch. @@ -23,13 +23,20 @@ After mentioning this you can directly start working on the issue by [creating a ### Main -- This branch will only contain the code for publishing. This branch will only accept Pull request or merge request through `pluginTesting` branch. First a proper testing should be done in the pluginTesting branch to merge changes to main branch. +- This branch will only contain the code for publishing. This branch will only accept merge request through `pluginTesting` branch. First a proper testing should be done in the pluginTesting branch to merge changes to main branch. This will be done by the project admin. ### pluginTesting -- This branch will be always on the latest working code. After any new functionality implementation has been done or any bug has been resolved, it will be alwats merged to this branch. +- This branch will be always on the latest working code. After any new functionality implementation has been done or any bug has been resolved, it will be always merged to this branch. -- After the new merge, a thorogh testing will be done on this branch, to test whether the new additions are working as expected and can be moved on further. After the admin has tested everything a commit will be added to specify the same. After that you can create a new branch from this point of commit to work on a new issue. And the admin will also go for merging new Pull Request to this branch and the process will continue. +- After the new merge, a thorough testing will be done on this branch, to test whether the new additions are working as expected. After the admin has tested everything a commit will be added as : "New changes working". + +- You are requested to create a new branch from this commit, to start your development. Since this is the checkpoint that everything has been working as expected. + +- While submitting a Pull Request, please ensure that you are submitting the PR on this branch and not on the main branch. + - After the admin has reviewed your contribution, the PR will be accepted and will be merged into the `pluginTesting`. + - All the necessary changes will be done. Remember, if the feature you have suggested doesn't goes well with the overall plugin, then it will be removed at this stage. + - After proper testing, a commit will be made with the comment : "New changes working" as mentioned in the above point. ### cleanupToRelease @@ -38,9 +45,9 @@ This branch is to be used, after every planned issue for the upcoming release/mi In this branch : - Will remove all the console statements. -- All development code, delete unncesary comments. +- All development code, delete unnecessary comments. - Write better comments. -- If any strings has been chaged, translate those updated strings to other languages. +- If any strings has been changed, translate those updated strings to other languages. --- diff --git a/docs/Advanced/HowToUseForum.md b/docs/Advanced/HowToUseForum.md index 5f5e865..62770b4 100644 --- a/docs/Advanced/HowToUseForum.md +++ b/docs/Advanced/HowToUseForum.md @@ -5,7 +5,7 @@ title: Use the forum # How to use the Forum -This forum is basically the GitHub Discussion section of the Task Board repository. Any person using this plugin will be able to answer your query if the admin couldnt able to reach sooner. +This forum is basically the GitHub Discussion section of the Task Board repository. Any person using this plugin will be able to answer your query if the admin couldn't able to reach sooner. ## How to ask a question @@ -16,7 +16,7 @@ This forum is basically the GitHub Discussion section of the Task Board reposito **Step 3 :** You will see the following screen : ![QnA_DiscussionSection](../../assets/QnA_DiscussionSection.png) -**Step 4 :** Add your question in the first field : **Add a title**. Try to keep the questoin short and one liner. You can explain/elaborate your question further inside the body section. +**Step 4 :** Add your question in the first field : **Add a title**. Try to keep the question short and one liner. You can explain/elaborate your question further inside the body section. **Step 5 :** Elaborate your question further in the **Add a body** section. You can add images or links to documents and sites here. diff --git a/docs/Components/EditTaskWindow.md b/docs/Components/EditTaskWindow.md index 52b783d..0927d57 100644 --- a/docs/Components/EditTaskWindow.md +++ b/docs/Components/EditTaskWindow.md @@ -14,9 +14,9 @@ This is a pop up window which helps you to edit your tasks or add more fields to ### Left Section -- **Title Input Field :** First there will be a text field to take the Main Title of the task. This can be a complete single task, like a whole paragraph. But Kanban philosophy follows the approach of giving a title to your tasks and then explaining it further in other section. So, it will be a good practive to give a short name to your task, which you will be able to see on the Task Board. +- **Title Input Field :** First there will be a text field to take the Main Title of the task. This can be a complete single task, like a whole paragraph. But Kanban philosophy follows the approach of giving a title to your tasks and then explaining it further in other section. So, it will be a good practice to give a short name to your task, which you will be able to see on the Task Board. -- **Sub-Tasks Section :** Next will be a section to add sub-tasks to your main task. Again it will be recommended to give a short one line summary for creating a sub-task, you can explain further your sub-tasks in the Description section. Sub-Taks only works with single indentation levels, since Obsidian supports multi-layers of indentation, you can add such multi-level indented sub-tasks in the description. +- **Sub-Tasks Section :** Next will be a section to add sub-tasks to your main task. Again it will be recommended to give a short one line summary for creating a sub-task, you can explain further your sub-tasks in the Description section. Sub-Task only works with single indentation levels, since Obsidian supports multi-layers of indentation, you can add such multi-level indented sub-tasks in the description. - You can either edit the content of your old sub-tasks from the text input field. Or add more sub-tasks using the `Add Sub Task` button, which will create a new text input field for you to enter the new sub-task. - **Preview / Description Section** : This is a section where you can see two button to change the section in a Section tab. @@ -30,7 +30,7 @@ Under this section you can able to add the following fields to your task. All th - **Task Due Time :** This is a time field, when you will click on this field, you will get a menu to select the time for your task. These section is divided into a Start Time and End Time. This feature will help you, if you are using **Day Planner** plugin, to plan your every day timeline. - **Start Time :** Enter the time when you are planning to complete your task, this is the time when you will start doing the task. - - **End Time :** By default, when you will select the start time, this field will be automatically populated with an one hour incremented value from your Start Time. You can easily change this value, to chnage the duration of the task. + - **End Time :** By default, when you will select the start time, this field will be automatically populated with an one hour incremented value from your Start Time. You can easily change this value, to change the duration of the task. - **Task Due Date :** This is a date field. When you will click on this input field, you will be presented with the calender menu to select your date for scheduling the task and the value will be auto populated in the input field, which you can change later as well. diff --git a/docs/Components/MetadataFormats.md b/docs/Components/MetadataFormats.md index dcb45bb..56f6ab8 100644 --- a/docs/Components/MetadataFormats.md +++ b/docs/Components/MetadataFormats.md @@ -30,7 +30,7 @@ You can choose one of the following options in the Task Board setting to keep th | Dataview | [due:: 2024-10-31] | Any | [priority:: highest] * | #test | [completion:: 2021-10-31T21:52:22] | | Obsidian Native | @due(2024-10-31) | Any | Any | #test | @completion(2021-10-29) | -- You also have the option to mix these formats with one another. For example, say you dont like to see the emojies for priority, you can use other format, and that will still work. +- You also have the option to mix these formats with one another. For example, say you dent like to see the emojis for priority, you can use other format, and that will still work. - **Any** mean, for this field, you can use any type of format from that column, for the specific plugin/setting option you have selected. *Under Development diff --git a/docs/Components/Task_Formats.md b/docs/Components/Task_Formats.md index 0ec7b10..d689ab9 100644 --- a/docs/Components/Task_Formats.md +++ b/docs/Components/Task_Formats.md @@ -79,7 +79,7 @@ But if you haven't added the pipe symbol, then it will look like : The Description section and the sub-tasks combined are called the **task body**. - Always ensure to have atleast one-level of indentation for any line to be considered as the part of the task body. -- Also, there shouldnt be an empty line inside the task body, otherwise, the part after the empty line will be considered as a separate content even though it has an indentation. So, this criteria can be used to separate other content from the task content. +- Also, there should not be an empty line inside the task body, otherwise, the part after the empty line will be considered as a separate content even though it has an indentation. So, this criteria can be used to separate other content from the task content. ### Description @@ -87,7 +87,7 @@ The description is basically the further elaboration of the task or even the sub ### Sub Tasks -To Create a subTasks for the main task, its is important that, there has to be atleast one Level indentation and there shouldnt be any empty lines between the task title and the sub-tasks. +To Create a subTasks for the main task, its is important that, there has to be atleast one Level indentation and there should not be any empty lines between the task title and the sub-tasks. You can have any number of sub-tasks and with multi-indentation. For example: diff --git a/docs/Components/Task_Item_Card.md b/docs/Components/Task_Item_Card.md index 9c47f68..b72b106 100644 --- a/docs/Components/Task_Item_Card.md +++ b/docs/Components/Task_Item_Card.md @@ -36,7 +36,7 @@ By default the Task Description content will be hidden. You will see a light col The Description content is kept hidden by default is because, there can be a lot of content inside the description for the task, and keeping in visible will consume a lot of board area, which will defeat the methodology of a Kanban Board. Whenever you want to take a look at the content of the Description of any specific task, you can expand it and read the content or make use of the links from the content. -Another thing is, the content will be compressed, that, is the indentaion of the content lines will be removed to save space. The idea here is to just show the content and not to worry about the formatting much, although all the other formatting will be applied like bold, italic, etc. The indentation is removed to again, show all the content in as much less area as posssible. You can look at the actual content by opening the [Edit Task Window](./EditTaskWindow.md) or by directly opening the markdown file. +Another thing is, the content will be compressed, that, is the indentation of the content lines will be removed to save space. The idea here is to just show the content and not to worry about the formatting much, although all the other formatting will be applied like bold, italic, etc. The indentation is removed to again, show all the content in as much less area as possible. You can look at the actual content by opening the [Edit Task Window](./EditTaskWindow.md) or by directly opening the markdown file. ## Footer @@ -46,4 +46,4 @@ The Footer section will show the following three task properties : **2. Task Due Date :** After the Task Duration, you will be able to see the Due date of the task separated from the Duration value by a Pipe symbol. The Due Date will be mention using a Calender Icon before its value. -**3. Button Sectoin :** On the far right in this section, you will able to see two main button, first one is the `Edit Task` button, which will open the Edit Task Window and the second button is `Delete Task`, which will simply delete the task from the board as well as the content will also be removed from the parent markdown file. +**3. Button Section :** On the far right in this section, you will able to see two main button, first one is the `Edit Task` button, which will open the Edit Task Window and the second button is `Delete Task`, which will simply delete the task from the board as well as the content will also be removed from the parent markdown file. diff --git a/docs/Components/Types_Of_Columns.md b/docs/Components/Types_Of_Columns.md index e0281d7..fbada14 100644 --- a/docs/Components/Types_Of_Columns.md +++ b/docs/Components/Types_Of_Columns.md @@ -63,7 +63,7 @@ Intuitively, this column will show you all the tasks, which has not been provide ## Other Tags -Now, after you have understood what are **Untagged** and **Tagged** column, there might be case, where you have given a tag to many tasks and you havent created a **Tagged** type of column for this tasks, then these tasks wont be shown on the board at all, since they also do not fall under the **Untagged** column type criteria. For all these tasks, you can create a **Other Tags** type of column, to show all this tasks under this column +Now, after you have understood what are **Untagged** and **Tagged** column, there might be case, where you have given a tag to many tasks and you haven't created a **Tagged** type of column for this tasks, then these tasks wont be shown on the board at all, since they also do not fall under the **Untagged** column type criteria. For all these tasks, you can create a **Other Tags** type of column, to show all this tasks under this column ### Properties @@ -78,7 +78,7 @@ This type of column will show you all the tasks, which has been marked as comple ### Properties - **Column Name :** The first property will be as usual the name of the column which you want to see on the column header. -- **Max Items :** This is a number value you want to enter to set a limit to the number of task item cards you want to see under this column. This has been kept to limit the number of tasks rendered under this column, because over a time, you might complete lot of tasks, and if you havent deleted these tasks from you vault, then they will be getting appended under this column and will increase the load time of the board, hence setting a limit will help you to show only the latest completed tasks. +- **Max Items :** This is a number value you want to enter to set a limit to the number of task item cards you want to see under this column. This has been kept to limit the number of tasks rendered under this column, because over a time, you might complete lot of tasks, and if you haven't deleted these tasks from you vault, then they will be getting appended under this column and will increase the load time of the board, hence setting a limit will help you to show only the latest completed tasks. # Upcoming New Column types diff --git a/docs/Features/Filters_for_Scanning.md b/docs/Features/Filters_for_Scanning.md index 3082878..9e71df5 100644 --- a/docs/Features/Filters_for_Scanning.md +++ b/docs/Features/Filters_for_Scanning.md @@ -29,15 +29,15 @@ This is a **dropdown** which allows you to set the status of the files filter or - **Only Scan This :** If you have entered few file names and you have set this status for this filter. Then the plugin will scan only this files and rest all of your files will be ignored. The plugin will keeps tracking this files for any changes and will detect if the tasks has been updated or a new tasks has been added. Either real-time or on periodic basis. -- **Dont Scan This :** If you have selected this feature, then the plugin will not going to scan the files. All the rest of the files from the vault will be scanned and tracked for changes. Use this feature, if there are some private files/tasks you dont want to see on the Task Board. +- **Dont Scan This :** If you have selected this feature, then the plugin will not going to scan the files. All the rest of the files from the vault will be scanned and tracked for changes. Use this feature, if there are some private files/tasks you don't want to see on the Task Board. - **Disable :** This option will help you to temporarily disable this specific filter. If for some reason, you also want the entered files to be get scanned or want to scan all other files other than the entered files. Then you can disable the filter, so the plugin can scan all the files from your vault. -> Please note that, even if you have disabled this filter, dont forget to check the status of the below filter, since, the below filter will still going to get applied, if you havent set the status of the below Filters for Folder as not disabled. +> Please note that, even if you have disabled this filter, don't forget to check the status of the below filter, since, the below filter will still going to get applied, if you haven't set the status of the below Filters for Folder as not disabled. ## Filters for Folder -In the seccond row you will enter the folder names which you will be going to use for the filters. +In the second row you will enter the folder names which you will be going to use for the filters. ### Folder Names @@ -50,7 +50,7 @@ New Folder 1, New Folder 2 If you are giving a folder name which is inside another folder, then, enter the path of the folder from your Vault location. -For exaple, if you want to enter the specific folder name, say 'New folder' and this folder is inside another folder say 'Parent Folder'. Then enter the full path of this folder : +For example, if you want to enter the specific folder name, say 'New folder' and this folder is inside another folder say 'Parent Folder'. Then enter the full path of this folder : ``` Parent Folder/new folder @@ -76,7 +76,7 @@ This filter can be used, when you only want to scan tasks which has certain tags ### Tag Names -In this text input field you will enter the names of the tags along with the '#' symbol at the begining of the name/string and separate the multiple tags with comma. +In this text input field you will enter the names of the tags along with the '#' symbol at the beginning of the name/string and separate the multiple tags with comma. For example you want to enter the tags 'Bug', 'docs/bug' and 'feature'. Then enter the names as shown below : @@ -90,6 +90,6 @@ Similar to the above two files, this also works similar way. - **Only Scan This :** The plugin will only scan the tasks which contains the tags entered in the input field by you. -- **Dont Scan This :** The plugin will not going to scan any task, which contains any one of the tag mentioned in the input field by you. All the other tasks will going to get scanned, if those tasks doesnt contain any tag mentioned by you in the input field. +- **Dont Scan This :** The plugin will not going to scan any task, which contains any one of the tag mentioned in the input field by you. All the other tasks will going to get scanned, if those tasks doesn't contain any tag mentioned by you in the input field. - **Disable :** Keep this filter disabled. All tasks will going to get scanned. diff --git a/docs/Features/ReScan_Vault_Feature.md b/docs/Features/ReScan_Vault_Feature.md index fa0c6f0..7391f76 100644 --- a/docs/Features/ReScan_Vault_Feature.md +++ b/docs/Features/ReScan_Vault_Feature.md @@ -20,9 +20,9 @@ Please note that, if your Vault is very large in size and contains files with h ![ReScan Vault Window Open](../../assets/ReScanVaultModalOpen.png) -In this wiindow you can see a terminal like section. Once this window is open to scan all the files you need to click on the Run button. After you click on the run button the plugin will start scanning all the files from your vault to detect any tasks are present in them. +In this window you can see a terminal like section. Once this window is open to scan all the files you need to click on the Run button. After you click on the run button the plugin will start scanning all the files from your vault to detect any tasks are present in them. -During scanning, you can see which file is getting scanned at present or which all files got scanned in the terminal like section. The progress bar will also show the progress of the current operation and you should able to see the precentage value in the button text. +During scanning, you can see which file is getting scanned at present or which all files got scanned in the terminal like section. The progress bar will also show the progress of the current operation and you should able to see the percentage value in the button text. After the scanning operation is complete, you can see all the tasks which has been collected in the All Tasks Preview section which is hidden and can be opened using the `Show Tasks Scanned` button at the bottom. Once you click on this button, a new section will slide in from the right taking the space of the terminal section. In this preview section you will be able to see which all tasks has been extracted from the corresponding scanned files, mentioned as the heading. diff --git a/docs/Features/index.md b/docs/Features/index.md index a529013..acf64f3 100644 --- a/docs/Features/index.md +++ b/docs/Features/index.md @@ -31,7 +31,7 @@ Checkout detailed information here : [Editing a task](./EditingATask.md) ![Marking Task as Complete](../../assets/MarkTaskComplete.gif) -Marking a Task as complete from the board is real-time, as soon as you will mark or unmark the task, the changes will be instantly made in the parent markdown file. +Marking a Task as complete from the board is real-time, as soon as you will mark or un-mark the task, the changes will be instantly made in the parent markdown file. Checkout detailed information here : [Marking a task complete](./MarkingTaskComplete.md) @@ -48,7 +48,7 @@ A new type of filters are coming soon, called as Column Filters to filter out ta ### Multi-Language Support -The plugin currently supports more than 20 languages and new languages are planned to being added in subsequent relases. Although a proper care has been taken to translate the default english language to other languages, the exact content meaning cannot be guarenteed, since online services has been used to translation. +The plugin currently supports more than 20 languages and new languages are planned to being added in subsequent releases. Although a proper care has been taken to translate the default english language to other languages, the exact content meaning cannot be guaranteed, since online services has been used to translation. Your contribution for updating the current content in any language or adding a new language will be highly appreciated. It will be easy but a powerful step to make this plugin, accessible to many people. Read this doc to learn to contribute for Language Translation : [Contribute To Language Translation](../Advanced/Contribution_For_Languages.md). ### Re Scan Vault diff --git a/docs/Getting_Started.md b/docs/Getting_Started.md index d61e99f..62ff614 100644 --- a/docs/Getting_Started.md +++ b/docs/Getting_Started.md @@ -26,6 +26,6 @@ All your tasks with the [accepted format](./Components/Task_Formats.md) will goi Afterwards, use the [Scanning Filters](./Features/Filters_for_Scanning.md) from the main settings to only scan specific files and ignore the other files. -There are already two predefined board for your convenience as an example. Feel free to delete or edit the boards and create your own boards. Check out more informat on Board here : [Creating Boards](./How_To/HowToCreateNewBoard.md) +There are already two predefined board for your convenience as an example. Feel free to delete or edit the boards and create your own boards. Check out more information on Board here : [Creating Boards](./How_To/HowToCreateNewBoard.md) **Enjoy the plugin !** diff --git a/docs/How_To/HowToAddNewColumn.md b/docs/How_To/HowToAddNewColumn.md index 6518696..a1a1bff 100644 --- a/docs/How_To/HowToAddNewColumn.md +++ b/docs/How_To/HowToAddNewColumn.md @@ -19,7 +19,7 @@ If you have created a fresh new board you board configuration will look like fol **Step 4 :** Click on `Submit` button once you have filled the required options. -**Step 5 :** You new colmn will appear inside your board. you can choose to add more different types of columns as you need inside the board. +**Step 5 :** You new column will appear inside your board. you can choose to add more different types of columns as you need inside the board. {: .new-title } > Save Button diff --git a/docs/Installation.md b/docs/Installation.md index 62b1c22..4ba5c69 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -33,7 +33,7 @@ There are two ways you can install this plugin, either from the Official Obsidia **Step 1 :** Open this link : [Task Board Release]() -**Step 2 :** Downlod the `main.js`, `styles.css` and `data.json` file. +**Step 2 :** Download the `main.js`, `styles.css` and `data.json` file. **Step 3 :** Open the vault in your system Explore/File Manager. diff --git a/index.md b/index.md index 7899dc1..20fe50a 100644 --- a/index.md +++ b/index.md @@ -56,7 +56,7 @@ Understand the complete UI of Task Board from here : [Task Board Pane](./docs/Co ## Motivation for the Project -I always used the [Kanban Plugin](https://github.com/mgmeyers/obsidian-kanban) to manage my tasks. And it use to work nice for me with all the amazing features. But as soon as I came across the [CardBoard plugin](obsidian://show-plugin?id=card-board) everything changed. The idea of adding tasks anywhere in your vault and managing them from a single board amazed me. While using Kanban plugin the issue was, i wasn't able to add tasks directly to any markdown file, i was required to use the Kanabn Board only to add/edit my tasks, and it use to keep all this tasks in a single markdown file. I immediately switched to the CardBoard plugin after I came across it. But after using it for few days, i realized there are few important features this plugin is lacking and hence I went to first contribute to the main project, but I wasn't familiar with the elm files, hence decided to start my own plugin. +I always used the [Kanban Plugin](https://github.com/mgmeyers/obsidian-kanban) to manage my tasks. And it use to work nice for me with all the amazing features. But as soon as I came across the [CardBoard plugin](obsidian://show-plugin?id=card-board) everything changed. The idea of adding tasks anywhere in your vault and managing them from a single board amazed me. While using Kanban plugin the issue was, i wasn't able to add tasks directly to any markdown file, i was required to use the Kanban Board only to add/edit my tasks, and it use to keep all this tasks in a single markdown file. I immediately switched to the CardBoard plugin after I came across it. But after using it for few days, i realized there are few important features this plugin is lacking and hence I went to first contribute to the main project, but I wasn't familiar with the elm files, hence decided to start my own plugin. While development I took inspirations from CardBoard and Kanban plugin as well as many feature ideas from [GitHub Project KanBan board](https://docs.github.com/en/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view#about-the-board-layout). I hope I am able to give the best of all this three plugins into one, and will be improving this further.