TodoNotes plugin for Kanboard

---

-= UNDER DEVELOPMENT =-

⚠ This README is still out of date ! ⚠

TODO-style Notes for Kanboard

The plugin allows to keep TODO-style notes on every KB project and as standalone lists. The notes that may appear unsuitable for creating board tasks are totally fine on the custom TODO list. They are easy and fast to create, change and rearrange, with convenient visual aids. Every user can privately see and operate ONLY his own notes, even if notes of multiple users are are bound to the same project.

[↓ Bottom] [↑ Top]

Features, Issues, Todo

Features

TODO: update

Old Take

• Take notes quickly. Write the note title and press ENTER to save.
• Press TAB in the new note title to show the detailed menu
• Add detailed description to new notes
• Add a category to notes. The category is the same as the projects categories. (Please see the section for bugs)
• Get pie analytic on open and done notes
• Delete all done notes
• One-click for editing notes status (open/in progress/done)
• Edit note title. Click on title, edit and press ENTER
• Press the show more button on a note to see the note details
• Edit an existing notes description. Click on the description, type, press TAB to save
• Change category on existing notes. If you want to remove the category, just choose option 2 (the blank)
• Free sorting. Move the notes around. The sorting is saved.
• Export note to task. (Please see the secton for bugs)
• Generate report for printing notes.
• Filter report on category

New Take

• There are custom lists available only to you, and project lists which are automatically defined by the projects you have access to. Even though, notes on a project list are per user - i.e. your notes are visible and manageable only to and by you.
• Editing of the same lists is possible from multiple devices (and users if they have access to the same project), and the lists auto update on 15sec interval. If there are clashes between local and remote changes, the locals are discarded.
• Stat counts are available for every list. those also auto update upon clicking the items as open/in progress/done. Remote change of notes status get updated every 15secs.
• Main list toolbar and each note personal toolbar provide numerous actions, including transfer of notes btw lists and creating a KB board task from note, sorting and colorizing as visuals.
• Useful keyboard shortcuts (for desktop) to create and edit notes fast and easy. Click note checkbox to change its status. DblClick note to show/hide details. Reordering of notes using drag.
• Finally, all the above functionalities and visualizations are swiftly adapted to work on mobile devices, considering smaller screen and touch input.

Issues

TODO: update

• Focus on description textarea when pressing TAB on new notes title is not working
• Category is saved as text in database and does not have foreing key to the projects real category table
• Category not updating in title after manually changing the category
• Analytic chart on categories not developed
• Margin bottom not added
• The only folder in the Template folder is todonotes, and not specified out on dashboard etc.
• There is no description of shortcuts (ENTER and TAB key)
• Delete directly on trash button on single note - to fast?
• If note has empty title, it's not possible to change it afterwards
• Analytic is breaking when viewing all projects (js not reloading correctly)
• Exporting note to task: Swimlanes not working. Category not working.
• Div modal for "Delete all done" and "Analytic" is repeated on every reload
• Should disabled projects show on all todonotes page?
• Functions in controller (TodoNotesController) missing variables in () - needed?
• Markups as Kanboard

Todo

TODO: update

• Implement fault procedures (verify it is number, etc.)
• Adding possibility to attach image from mobile
• Finish exporting notes to task in specific swimlane and with category
• Update styling for a more simplicity view
• Better overview of multiple projects with tabs

[↓ Bottom] [↑ Top]

Screenshots

TODO: update

All features are accessible via the Project View and the Dashboard View.
Might you excuse my custom dark theme, the cyrillic texts on my board, and the rainbow colored categories ✨😝

(temporary pic of) Project View

(temporary pic of) Dashboard View

[↓ Bottom] [↑ Top]

Usage

TODO: update

Take notes on the fly. Developed to easily take project specific notes. The purpose of the notes is not to be tasks, but for keeping information - a flexible alternative to metadata. I'm using Kanboard as projectmanagement tool for managing construction projects, where I often need to take notes regarding specific installations, during site-visits or phonemeetings.

The notes is accessible from the project dropdown, where only the project specific notes will be shown. On the dashboard there's a link in the sidebar to view all notes, the notes will be separated in tabs.

[↓ Bottom] [↑ Top]

Installation & Compatibility

Installation

• Install via the Kanboard Plugin Directory or see INSTALL.md
• Read the full Changelog to see the latest updates

Compatibility

• Requires Kanboard ≥1.2.33
• Other Plugins & Action Plugins
  • No known issues
• Core Files & Templates
  • 0 Template override
  • No database changes

Translations

• Translation for en_US is the default, currently there are no other translation packs.

[↓ Bottom] [↑ Top]

Authors & Contributors

• Im[F(x)] - Author
• Contributors welcome for translations !

[↓ Bottom] [↑ Top]

Credits & References

• TTJ (c) 2016-2023
• aljawaid (c) 2023

[↓ Bottom] [↑ Top]

License

• This project is distributed under the MIT License

[↑ Top]

---