It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Is there a way in Confluence to create a checkbox without it being a task?

I would like to create a checklist on a confluence page, but the list is not a list of tasks. I have looked at the checklist plug-in, but don't want to create a page for each item on the list (could be as large as 20 or 30 items). Anyone have any ideas?

9 answers

1 accepted

8 votes
Answer accepted

How about something like this? Just put a comma separated list in the macro body.

Macro Name:
dynamic_checkboxes

Macro Title:
Dynamic Checkboxes

Description:
This will create dynamic checkboxes from a comma separated list.

Macro Body Processing:
Escaped

Template:

## Developed by: Davin Studer
## Date created: 12/2/2014
## @noparams

#set ($containerManagerClass=$content.class.forName('com.atlassian.spring.container.ContainerManager'))
#set ($getInstanceMethod=$containerManagerClass.getDeclaredMethod('getInstance',null))
#set ($containerManager=$getInstanceMethod.invoke(null,null))
#set ($containerContext=$containerManager.containerContext)
#set ($contentPropertyManager=$containerContext.getComponent('contentPropertyManager'))
#set ($d = '$')

#if($req.getParameter('submit') == "true" && $req.getParameter('checkbox') && $req.getParameter('checkbox') != "")
    #if($req.getParameter('value') && $req.getParameter('value') != "")
        #set ($value = $req.getParameter('value'))
    #else
        #set ($value = "")
    #end
    $contentPropertyManager.setStringProperty($content, $req.getParameter('checkbox'), $value)
#end
 
#if ($body != "")
    <form class="aui" id="dynCheckboxForm">
    #foreach($box in $body.split(","))
        #if($contentPropertyManager.getStringProperty($content, "dynCheckbox$box") == "checked")
            #set($checked = 'checked="checked"')
        #else
            #set($checked = '')
        #end
        <div class="checkbox">
            <input class="checkbox dynCheckbox" type="checkbox" name="dynCheckbox$box" id="dynCheckbox$box" $checked value="checked" />
            <label for="dynCheckbox$box">$box</label>
        </div>  
    #end
    </form>
#end

<script type="text/javascript">
AJS.toInit(function(){
    AJS.$('.dynCheckbox').click(function(){
        AJS.${d}.ajax({
            type: 'GET',
			data: {
                submit: 'true',
                checkbox: AJS.$(this).attr('id'),
                value: AJS.$(this).is(':checked') ? 'checked' : ''
            },
			url: "$content.getUrlPath()",
			success: function(data) {
			},
			error: function() {
			}
        });
    });
});
</script>

I guess I hit my limit for comments yesterday, so had to wait until today to say thanks. This is exactly what I needed.

Davin Studer Community Leader Dec 03, 2014

Glad it works.

This is Fansastic! Thank you

This is a fantastic macro but it doesn't save the checked state for me. Is there any way to do it?

Hello Davin, you're an absolute legend for sharing this! The code doesn't seem to work for me. I pasted the code and entered the corresponding title,name and macro body processing.

 

When I insert the macro i get this error 

 

"Error rendering macro 'dynamic_checkboxes' : Error occurred rendering template content"

 

Any ideas? I'm on confluence server 6.4.0

That is because when Atlassian migrated this forus from their previous site they messed up code blocks. So, all the html is now escaped out. Copy the code and do a find a replace on these in this order ...

 FindReplace
&amp;&
&lt;<
&gt;>
Like Alexander Khrennikov likes this

If I have Conflunce-cloud, where do I write this code?

Davin Studer Community Leader Apr 04, 2018

There is no way to do this with the cloud version as you cannot write user macros.

Hi Davin, 

Are you still able to answer questions about this?

I'd like to share a page I'm creating with our staff. It has a checklist to refer to in it. However, if I use the built in formatting, everything is automatically considered a Task. Almost none of our staff have edit rights to pages, so they can't tick anything off.

Your code up there works perfectly to create non-Task checkboxes, so thank you very much for sharing it! 

However, I can't use it, because Confluence remembers what's checked between sessions. Is there a way that I can set it up so that if the page is refreshed, all the check boxes are cleared?

Thanks very much in advance.

Just enter [] without blanks - automaticly converted to a checkbox. Very usefull in tables instead of using yes/no or similar stuff

Awesome! Thanks Rob!

Just want to add a simple solution that I found to this problem in case others are still looking to do this.

If the task does not have any text after it, it does not register as a task. So to create a checklist I put the task checkbox into a table cell by itself with the items for the checklist in a cell beside it.

It functions purely as a checkbox then with saved state and does not register as a task. Really easy to add with the shortcut [] as well.

image2016-8-8 21:8:40.png

Davin Studer Community Leader Aug 08, 2016

Nice work around.

not "working arround" with me.

placing the "checkbox-symbol" OUTSIDE the table (somewhere on the page) = OK
saving the page will create a checkbox that users can click on the viewpage.

placing the "checkbox-symbol" INSIDE the table = NOK. users cannot click the checkbox on the viewpage.

see https://answers.atlassian.com/questions/41460975

Still working fine for me after all these years, even in latest Confluence Cloud.

Roland,

I understand you have no plans to spend money purchasing the plugin to help you with checkboxes, but may be, a bit more advanced plugin will help you to solve this particular problem, as well as anything else when you want to store some structured data in Confluence. Take a look at ConfiForms

Various types of forms: checklists, registrations, feedback... also, with rest api, so you can do some reporting when needed 

0 votes

Hi Ronald,

I believe you are looking to a macro like this one: Checkbox by Gumvillage.

I hope this helps.

Cheers,

Rodrigo

Thanks for your response. I did see that macro, but was trying to avoid spending money for a checkbox.

Addons also cause headaches when upgrading to the next build. I find it very unfortunate that most answers on answers.atlassian.com are someone telling us to buy paid plugins, especially considering the price of the base product.

Like Tauhid Smith likes this
Davin Studer Community Leader Jul 06, 2016

The above user macro is free. I promise I won't charge for it. smile

Like Sushma likes this
0 votes
Davin Studer Community Leader Dec 02, 2014

Is there a reason you can't use the task list for this?

A little more information might help. We have spaces for client projects. The space has an area with meeting notes and action items are identified during these meetings and tracked as tasks in confluence. Additional project work is tracked in JIRA. The main page of the clients space shows these action items. As part of the project plan there is a "shopping list" of items we need from the client. The space contains a page with a list of these items and I would like to turn this list into a checklist without adding to the action item list. I can filter tasks from that page using a label, but then I would also lose the ability to note action items/tasks on that page and wanted to avoid that. I think what I'm really going to need to do, is learn how to write my own macro for a checkbox and add it as a user macro, but I just don't have the time to do that right now.

If you are creating the page from a template, the following code populates a checkbox:

<ac:task-list><ac:task><ac:task-id>2</ac:task-id><ac:task-status>incomplete</ac:task-status></ac:task></ac:task-list>

I don't think the task-id is very important, but you may want to increment it depending on what you're doing.

Hi @Davin Studer

In your macro ,how to store the checkbox status as checked or unchecked ?

Suppose if we create a checkbox from the confluence UI ,we will get the status as complete or incomplete in the storage format as below.

<ac:task-list>
<ac:task>
<ac:task-id>1</ac:task-id>
<ac:task-status>incomplete</ac:task-status>
<ac:task-body><span>Type your task here, using &quot;@&quot; to assign to a user and &quot;//&quot; to select a due date</span></ac:task-body>
</ac:task>
</ac:task-list>

Similarly is it possible to get the status from your macro?

Please help me 

Regards

Sushma

Davin Studer Community Leader Sep 04, 2019

No. The user macro above does not create tasks ... so the task report won't work with it.

Like Sushma likes this

Thanks for the response @Davin Studer 

Hi @Davin Studer 

I have one doubt, If we create tasklist /task report from User macro in confluence, are we able to get the state/status of tasklist while viewing the storage format from the confluence page?

Regards

Sushma

Any response ?

Hi @Sushma I think you will need to look elsewhere for a solution as this was about creating a checkbox that is NOT a task.

So the purpose is just to have a visual checkbox you can check/uncheck that will hold state.

To do this, there is no task created.

Like Davin Studer likes this
Davin Studer Community Leader Sep 06, 2019

Yeah, unfortunately I don't have any great ideas for you.

Best bet is to hope someday Atlassian kills their crappy markup and adopts what is used almost everywhere else; GitHub, Slack, .... Checkboxes would be nice, but inline code blocks cannot even be created.  ...no, `code` which converts the font to monospace is not how a inline code should appear!

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Confluence

What's New in Confluence Cloud – November 2019 Edition

Hey community! This month we’re excited to share brand new features to help you make your mark on Confluence. If you haven’t already, check out our updates from October and September too! Expre...

11,387 views 11 30
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you