https://github.com/aljawaid/templatemanager
Save templates in this new interface improving consistency and content formatting of your project data. Project Editors can create, update and delete templates for each project. Templates can be created for task descriptions, comments, global templates and email subjects all in one place.
https://github.com/aljawaid/templatemanager
auditing comments kanboard kanboard-plugin plugin projects tasks templates
Last synced: about 1 month ago
JSON representation
Save templates in this new interface improving consistency and content formatting of your project data. Project Editors can create, update and delete templates for each project. Templates can be created for task descriptions, comments, global templates and email subjects all in one place.
- Host: GitHub
- URL: https://github.com/aljawaid/templatemanager
- Owner: aljawaid
- License: mit
- Created: 2023-02-05T14:26:06.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T08:20:01.000Z (12 months ago)
- Last Synced: 2025-02-27T03:47:52.151Z (about 2 months ago)
- Topics: auditing, comments, kanboard, kanboard-plugin, plugin, projects, tasks, templates
- Language: PHP
- Homepage:
- Size: 4.61 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
TemplateManager
Speed through your tasks replacing Predefined Contents with the new Template Manager. Users can impove consistency of project data whilst saving time creating repetitive comments using saved templates. Project Editors can easily manage their template content for each project.
Templates can be created for task descriptions (core feature), comments (new feature), global templates (new feature) and email subjects (core feature) all in one place including adding notes and instructions separate to the template content to help keep content neat. The global templates feature displays for every project and can be used as a way to guide and advise users within tasks. Templates can also be useful in environments where auditing or standardization is required.
## Features
- Improved and extended the layout, modal and form designs for the `predefined contents` section
- Renamed the `predefined contents` section to `Template Manager`
- Show the total template count in the project dropdown menu directly linking to the Template Manager
- Show individual counts for each template section
- Compatibility with [ApplicationBranding](https://github.com/aljawaid/ApplicationBranding)
- Total number of templates are shown in the Admin Dashboard
- Add pretty URLs _[(if globally configured)](https://docs.kanboard.org/v1/admin/url-rewriting/ "URL Rewriting must be configured for this feature to work")_
- `https://mydomain.com/project/[project_id]/templates`
- _Links to the relevant project's Template Manager section_
- `https://mydomain.com/global-templates`
- _Links to the Global Templates section_
- _Tasks:_
- `https://mydomain.com/project/[project_id]/templates/tasks/add`
- `https://mydomain.com/project/[project_id]/templates/tasks/view/[template_id]`
- `https://mydomain.com/project/[project_id]/templates/tasks/edit/[template_id]`
- `https://mydomain.com/project/[project_id]/templates/tasks/delete/[template_id]`
- _Comments:_
- `https://mydomain.com/project/[project_id]/templates/comments/add`
- `https://mydomain.com/project/[project_id]/templates/comments/view/[template_id]`
- `https://mydomain.com/project/[project_id]/templates/comments/edit/[template_id]`
- `https://mydomain.com/project/[project_id]/templates/comments/delete/[template_id]`
- _Global Templates:_
- `https://mydomain.com/global-templates/add`
- `https://mydomain.com/global-templates/view/[template_id]`
- `https://mydomain.com/global-templates/edit/[template_id]`
- `https://mydomain.com/global-templates/delete/[template_id]`
- Revised Email Subject Templates
- Added user instructions related to tasks and automatic actions
- **Template Previews** - Preview just the template without the instructions
- **Topics** - Label common templates into topics to help group them together
- **Notes** - Add a short note to describe each template (notes appear as tooltips)
- **Instructions** - Add optional instructions for each template (instructions show in view mode only)
- **This plugin replicates and extends the features from [TemplateTitle](https://github.com/creecros/TemplateTitle). It is safe to uninstall _TemplateTitle_ after installing _TemplateManager_**
- All data is saved in the database
**Task Description Templates**
- Revised `predefined contents` as `Task Description Templates`
- Automatically populate the title of the template into the task title when creating or modifying tasks - imported [TemplateTitle](https://github.com/creecros/TemplateTitle) feature
- Show the template notes to end users in a tooltip when selecting the task description
**NEW Comment Templates**
- Add, update or delete templates for your regular comments which can be used repetitively in any task
- Templates utilise the Markdown Editor to enable complete formatting of comments
- Automatically populate the comment template to the text editor when creating comments
**NEW Global Templates**
- Show generic templates common to your personal or organisational workflow (to your end users)
- Inside tasks, global templates are shown under a new **General Templates & Actions** accordion section
- These templates are visible to all user roles and are not restricted by project
- Can be disabled through `Settings`
**Task Comments**
- Show total number of comments created
- Saved comment templates can be quickly copied from each task
- Global templates are shown in each task above the comments section
- Shows the template notes to end users in a tooltip
**Revised Project Sidebar**
- Replaced the default code to extend the functionality of the project sidebar menu
- Moved the core hook `'template:project:sidebar'`
- _Now shows before the Close Project menu link to show content to **all users**_
- Changed the sort order of the sidebar menu for faster access to project configuration sections
- Add a new hook `'template:project:sidebar:top'`
- _Displays_ after the Summary menu link to show content to **all users**_
- Add a new hook `'template:project:sidebar:bottom'`
- _Displays_ after the Delete Project menu link to show content to **all users**_
[↓ Bottom] [← Previous] [→ Next] [↑ Top]
## Screenshots
**Template Manager** - Interface
**Template Manager** - Settings
**Task Description Templates** - Frontend
**Comment Templates** - Frontend
**Global Templates** - Frontend
**Comment Templates** - View
**Task Description Templates** - Create
**Global Templates** - Edit
**Comment Templates** - Delete
[↓ Bottom] [← Previous] [→ Next] [↑ Top]
## Usage
- Go to `Settings` ⥂ About
- _To view global totals for your saved templates_
- _Requires [ApplicationBranding](https://github.com/aljawaid/ApplicationBranding "Remove Kanboard brnading and whitelabel your application using this plugin")_
- Go to `Settings` ⥂ `Application` ⥂ Template Manager
- _To manage settings_
- Go to any `Project` ⥂ `Project Settings` ⥂ Template Manager
- _To manage your templates_
- Go to any `Project` ⥂ `Task` ⥂ Create Task
- _To use your task description templates_
- Go to any `Project` ⥂ `Task` ⥂ Add Comment
- _To use your comment templates_
- Go to `Settings` ⥂ `Global Templates`
- _To manage your global templates_
- Go to any `Task` ⥂ General Templates & Actions
- _To use your global templates_
[↓ Bottom] [← Previous] [→ Next] [↑ Top]
## Installation & Compatibility
Installation
- Install via the **[Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") Plugin Directory** or see [INSTALL.md](../master/INSTALL.md)
- Read the full [**Changelog**](../master/changelog.md "See changes") to see the latest updates
Compatibility
- Requires [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") ≥`1.2.20`
- **Other Plugins & Action Plugins**
- _No known issues_
- Compatible with [KanboardCSS](https://github.com/aljawaid/KanboardCSS), [TemplateTitle](https://github.com/creecros/TemplateTitle), [ApplicationBranding](https://github.com/aljawaid/ApplicationBranding), [Glancer](https://github.com/aljawaid/Glancer), [Group_assign](https://github.com/creecros/Group_assign), [PluginManager](https://github.com/aljawaid/PluginManager)
- **Core Files & Templates**
- `04` Template overrides
- Database Changes:
- `01` New database table created as `comment_templates`
- `01` New database table created as `global_templates`
- `03` New columns added to the `predefined_task_descriptions` table as `topic` `note` `instructions`
Translations
- _Starter template available_
[↓ Bottom] [← Previous] [→ Next] [↑ Top]
## Authors & Contributors
- [@aljawaid](https://github.com/aljawaid) - Author
- [Craig Crosby](https://github.com/creecros) - Contributor
- _Contributors welcome_
[↓ Bottom] [← Previous] [↑ Top]
## License
- This project is distributed under the [MIT License](../master/LICENSE "Read The MIT license")
---
[↑ Top]