Page tree
Skip to end of metadata
Go to start of metadata

 

The survey macro allows Confluence users to be surveyed on several categories. For each category, users are allowed to select only one of the given choices, and the results will not be visible to them until they have voted. Users that have not logged in will be prompted to do so before allowing them to cast a vote. This macro was created to support surveys of confluence users on several categories and will provide them with the chance to give a rating (1 to 5) for each category as well as a comment.

The body of this macro defines the categories that the users will be polled on. Each line of the body will be treated as a seperate category and should be written in the format “title - description”. The title is always required but the dash and the description are optional.

ParameterRequiredDefaultDescription
titlefalsedefault no titleIf a Title is specified the Survey gets a Box around which makes it looking more compact and feeling the votes are belonging more together.
renderTitleLevelfalse2The heading level of the title. 2 means h2, 0 removes rendering as heading and therefore will not show up in the TOC.
choicesfalsedefault 1-5A comma separated List of choices. This can still be overriden by a ‘-’ separated list in each single line.
changeableVotesfalsefalseThis parameter, if set to true, will allow the users to change their responses after they have been cast.
showSummaryfalsetrueShows a summary over all existing votes therein.
showTopSummaryfalsetrueShows the summary at the beginning of the survey.
showLastfalsefalseShows the summary at the bottom of the survey. This option will win if top and last is both checked.
showCommentsfalsetrueShow comments-menu (the whole set: show, add, edit, delete)
startBoundfalse1The start of the calculation for the summary numbers
iterateStepfalse1The iteration of the calculation for the summary numbers. E.g. if this is 2 and the first is the default 1 the 2nd option will have the number 3 and the third 5. (As the first options usually are the highest priority the calculation is inverse).
votersfalseall usersThis is a comma seperated list of usernames to who are allowed to cast a vote. Users not in this list will not be allowed to vote, but if they are viewers will be shown the results of the vote. If this parameter is not specified, all users with access to the page are considered voters.
viewersfalseall usersThis is a comma seperated list of usernames to who are allowed to see the survey results. Users not in this list will be allowed to vote but after doing so will simply be shown which item they voted for. If a user is in this list but is not a voter, they will be taken straight to the results. If this parameter is not specified, all users will be able to see the results.
alwaysShowResultsfalsefalseShows the result regardless of the need to vote first
managersfalseall usersThis is a comma separated list of usernames to who are allowed to control the survey “menu” bar, e.g. exporting a survey, locking it and resetting its data (the last two are planed features)
visibleVotersfalsefalseShow the list of people who have voted.
visiblePendingVotersfalsefalseShows the list of not yet participants but which are eligible via the voters field. It also allows to easily remind them (via mail)
visibleVotersWikifalsefalseShow the list as confluence links to their profile if true.
showCondensedfalsefalseShows the votes and its choices inline (Comments, the list of already voted users and statistics per choice are not available)
lockedfalsefalseDont allow any further voting. Show a lock Symbol to indicate that. Image for Survey will only be displayed if you have the title-flag also. (It is still shown on the vote-elements)

 

Example survey macro usage

{survey:changeableVotes=true|voters=user1,user2|viewers=user3}
Knowledge - This is the knowledge category.
Communication - This is the communication category.
{survey}

Vote macro

ParameterRequiredDefaultDescription
titletrue This is the title of the ballot and must be the first parameter.
renderTitleLevelfalse3The heading level of the title. 3 means h3, 0 removes rendering as heading and therefore will not show up in the TOC.
changeableVotesfalsefalseThis parameter, if set to true, will allow the voters to change their vote after it has been cast.
showCommentsfalsetrueShow comments-menu (the whole set: show, add, edit, delete)
votersfalseall usersThis is a comma seperated list of usernames to who are allowed to cast a vote. Users not in this list will not be allowed to vote, but if they are viewers will be shown the results of the vote. If this parameter is not specified, all users with access to the page are considered voters.
viewersfalseall usersThis is a comma seperated list of usernames to who are allowed to see the survey results. Users not in this list will be allowed to vote but after doing so will simply be shown which item they voted for. If a user is in this list but is not a voter, they will be taken straight to the results. If this parameter is not specified, all users will be able to see the results.
alwaysShowResultsfalsefalseShows the result regardless of the need to vote first
visibleVotersfalsefalseShow the list of people who have voted.
visiblePendingVotersfalsefalseShows the list of not yet participants but which are eligible via the voters field. It also allows to easily remind them (via mail)
visibleVotersWikifalsefalseShow the list as confluence links to their profile if true.
lockedfalsefalseDont allow any further voting. Show a lock Symbol to indicate that.

 

Example vote macro usage

{vote:What is your favorite color?}
Red
Blue
None of the above
{vote}
{vote:What is your favorite color?|changeableVotes=true|voters=user1,user2}
Red
Blue
None of the above
{vote}
  • No labels