Support
Get a Free Demo

Checklist Plugin

Table of Contents

Introduction #

The Redmineflux Checklist Plugin is a powerful tool, a flexible project management tool. This plugin enhances Redmine’s functionality by adding checklist capabilities to issues, allowing users to create and manage task lists within issues. With the Redmine Checklist Plugin, users can easily track progress, ensure task completion, and improve overall productivity. It provides a straightforward way to create, edit, and track checklist items within issues, making it easier to stay organized and focused on project milestones.

Version Compatibility #

Redmine Versions

  • 4.0.x, 4.1.x, 4.2.x
  • 5.0.x
  • 6.0.x(coming soon)

Installation #

To install Redmine Checklist Plugin follow these steps

  1. Make sure you have a working installation of Redmine.
  2. Download the Checklist plugin from the redmineflux.com website. The plugin typically comes in the form of a ZIP file.
  3. Extract the Checklist Plugin zip file to Redmine’s plugins directory (/path/to/redmine/plugins) and do not change the plugin folder name.
  4. Run the following command to install the required dependencies
    Bundle install 
  5. Run migrate command for database migration  
    -> In Production 
    RAILS_ENV=Production bundle exec rails redmine:plugins:migrate 
    -> In Development
        RAILS_ENV=Development bundle exec rails redmine:plugins:migrate 
  6. Restart Redmine server to load the plugin 
    Rails s

Configuration #

  1. Log in to Redmine as an administrator or user.
  2. Navigate to the header tab and click on the “Issues” tab.
  3. Open the issue where you want to add a checklist.
  4. Scroll down to the Checklist section or tab.
  5. Click the add button to create a new checklist item.
  6. Enter the title or description of the checklist item and enter to create checklist item.
  7. Also, have the feature to edit or delete the checklist and change the progress of the checklist.

How To #

How to Create Checklist #

  1. Open the issue where you want to add a checklist. 
  2. Scroll down to the Checklist section. 
  3. Click the “Actions” button and choose “New checklist” to create a new checklist. 
  4. Enter the title or description of the checklist. 
  5. Press Enter to create the checklist. 

How to Edit and Delete the Checklist #

  1. Open the checklist where you want to edit or delete the checklist. 
  2. Locate the checklist or checklist item and click on the action button next to it. This will open a menu with options to add, edit, or delete the checklist or checklist item. 
  3. To edit the title or description, click on the edit icon from the action menu. Modify the details as needed. 
  4. Press Enter to save or update the edited checklist item. 
  5. If you want to delete the checklist or checklist item, click on the trash bin icon or delete option from the action menu. Confirm the deletion if prompted. 

How To Create Sub Checklist item #

  1. Locate the checklist and click on the action button next to it. This will open a menu with options to add, edit, or delete the checklist. 
  2. Choose “Add” to create a new checklist item. 
  3. Enter the title or description of the checklist item. 
  4. Press Enter to create the checklist item.  

How to Change the Progress of Checklist #

  1. Locate the checklist item you want to modify. 
  2. Click on the up-arrow icon next to the checklist to open its item lists. 
  3. Select or click on the drop-down menu to change the progress status of the checklist item, such as “New, “In progress” or “Done”. 
  4. Alternatively, you can simply check or uncheck the checkbox to mark the item as Done. 

How to Create a Checklist Template #

  1. Log in to Redmine with administrator, navigate to the administration page by clicking on the “Administration” link in the top menu. 
  2. In the administration page, locate the “Plugins” section and click on it. 
  3. Find the “Redmineflux Checklist Plugin” in the list of installed plugins and click on the “Configure” link next to it. 
  4. On the plugin configuration page, in the “Checklist templates” tab you should find and click the “Add Checklist Template” button to create a new checklist template. 
  5. Click on the dropdown menu to view the list of available trackers (e.g., Bug, Feature, Task, etc.). Choose the appropriate tracker based on the nature of the issue you are working on. 
  6. Provide a name for your template in the Template Name field. 
  7. Add the individual checklist for the template by entering each checklist’s title or description. 
  8. To add more items, click the “Add checklist” button. 
  9. Once you’ve added all the necessary checklist and details, click “Create Checklist template” to create the checklist template. 
  10. After saving, the template will be available for use. You can apply it to issues as required. 

How to Edit and Delete a Checklist Template  #

  1. Log in to Redmine with administrator, navigate to the administration area by clicking on the “Administration” link in the top menu. 
  2. In the administration area, locate the “Plugins” section and click on it. 
  3. Find the “Redmineflux Checklist Plugin” in the list of installed plugins and click on the “Configure” link next to it. 
  4. On the plugin configuration page, navigate to the Checklist Templates tab. 
  5. Here, you will see a list of all existing checklist templates. Each template will have Edit and Delete buttons. 
  6. Click the Edit button next to the template you want to modify. 
  7. Make the necessary changes to the template name, description, or checklists, and click Save to update the template. 
  8. Click the Delete button next to the template you wish to remove. Confirm the deletion if prompted. 
  9. Note that deleting a template will remove it permanently from the system. 

How to Create the Checklist from template #

  1. Open the issue where you want to add a checklist. 
  2. Scroll down to the Checklist section. 
  3. Click the “Actions” button and choose “Add from template” to create a new checklist item. 
  4. Choose the template from which you have to create checklist. 

How to Enable Block Issue Closing feature #

  1. Log in to Redmine with administrator, navigate to the administration page by clicking on the “Administration” link in the top menu. 
  2. In the administration page, locate the “Plugins” section and click on it. 
  3. Find the “Redmineflux Checklist Plugin” in the list of installed plugins and click on the “Configure” link next to it. 
  4. On the plugin configuration page, in the general tab you should find checkbox related to “Block issue closing”. 
  5. Check this box if you want to prevent an issue from being closed until all checklist items are completed. If any checklist item remains unfinished, the issue will not be allowed to close. 
  6. After checking the option, make sure to save the configuration to apply the change.

Troubleshooting #

  1. Verify that the plugin is correctly installed and enabled.
  2. Check the Redmine logs for any error messages related to the plugin.
  3. Ensure that the plugin is compatible with your version of Redmine.
  4. If you made any changes to the plugin or Redmine configuration, clear the Redmine cache and restart the application.
  5. Disable any other plugins that modify the same fields or interfere with the inline editing feature. Test if the issue persists without those plugins.
  6. If you are experiencing a specific problem, consult the plugin’s documentation or seek assistance from the plugin’s developer or support channels.

Frequently Asked Questions (FAQ) #

Q: Can I create multiple checklists within a single issue?
A: Yes, with the Redmine Checklist Plugin, you can create multiple checklists within a single issue. Each checklist will be associated with the specific issue, allowing you to manage multiple sets of tasks or subtasks within one issue.

  1. Open the issue where you want to add a checklist.
  2. Scroll down to the Checklist section or tab.
  3. Click the “Add” button to create a new checklist item.
  4. Enter the title or description of the checklist item.
  5. Press enter to create the checklist item.
  6. Repeat the above steps to create additional checklists as needed.

Q: Can I track the progress of a checklist?
A: Yes, the Redmine Checklist Plugin includes a progress indicator in the form of a visual progress bar. The progress bar displays the percentage of completed checklist items, giving you an overview of the checklist’s progress.

Q: Is Redmineflux’s Checklist plugin easy to use?
A: Yes, Redmineflux’s Checklist Plugin offers an intuitive and easy-to-use interface making it the best choice for users with minimal technical knowledge. Just integrate the plugin into your Redmine software and start using it effortlessly.

Uninstallation of Plugin  #

To uninstall the Redmineflux Checklist Plugin, follow these steps

  1. Go to the Checklist Plugin directory in Redmine. 
  2. Delete the entire Checklist Plugin directory from Redmine/plugins directory. This step removes the plugin files from your Redmine installation. 
  3. If the plugin required a migration, run the following command to downgrade your database (make a db backup before): 
    Bundle exec rake redmine:plugins:migrate Name=plugin name VERSION=0 RAILS_ENV=production 
  4. Restart the Redmine server to see the changes. 
  5. This will uninstall the Redmineflux Checklist Plugin from Redmine.

Updates and Revisions #

  • Plugin Updates: Keep track of plugin updates and new releases. Visit the official plugin website, plugin repository, Plugin updates may include bug fixes, performance improvements, or new features related to tag management.
  • Documentation Revisions: Regularly review the plugin’s official documentation for any revisions or updates. Documentation may be revised to reflect changes in the plugin’s functionality, configuration options, or integration with the latest versions of Redmine.
What are your Feelings

Redmineflux All Right Reserved.

Made with ❤ by Zehntech