| Name | Sticky Notes and Snip-Edit Plugin |
|---|---|
| Vendor | Comala Technology Solutions, Inc. (Website) |
| Authors | Roberto Dominguez |
| Homepage | http://confluence.atlassian.com/display/CODEGEIST/Sticky+Notes+and+Snip-Edit+Plugin |
| Issue Management | http://developer.atlassian.com/jira/browse/CSTKY |
| Categories | Content Macros |
| Version | 1.0.1 |
| Availability | Confluence v2.3.3 to v2.10-m1 |
| State | Stable |
| Support |
|
| License | Freeware / Open Source (BSD) |
| Price | Free |
| Release Docs | n/a |
| Java API Docs | n/a |
| Download Source | https://svn.atlassian.com/svn/public/contrib/confluence/confluence-stickynotes-plugin/ |
| Download JAR | stickynotes-1.0.1.jar |
Description/Features
The Sticky Notes and Snip-Edit Plugin allows users to add notes on different sections of a page or blog post, and to modify any text excerpt.
Sticky notes are stored as page Comments, so they are searchable.
Installation
Usage
Sticky Notes
Simply add the macro {stickynotes} in the beginning of the page. Any user with edit permissions on the page will be able to add notes on any of the headings.
Additionally, you can use the {stickable} macro to enable other sections of the document.
You can hide all the notes through the Show/Hide Sticky Notes action on the top right of the page:
| 2.7 and earlier |  |
| 2.8 and newer |  |
Snip-Edit
Simply add the {snipedit} macro at the beginning of the page, and then select any text excerpt in a page or blog post. to modify it:
If there if there are more than one excerpts on the page, you can have it replace in all instances:
Macros
{stickynotes}
Enables the sticky notes in the page. By default all the headings h1, h2, h3, h4, h5 will become stickable.
| Parameter | Required | Default | Description |
|---|---|---|---|
| selector | no | h1, h2, h3, h4, h5 | A comma-separated list of HTML elements on which you want to add the sticky notes. I.e. you could set it to h1, h2, h3, h4, h5, p, a if you want to add sticky notes to all the headings, all paragraphs and anchors in the page. |
{stickable}
Allows you to define an arbitrary location where you want users to add notes.
| Parameter | Required | Default | Description |
|---|---|---|---|
| unnamed or id | yes | None | A unique id for the note |
{snipedit}
Enables snip-editting in the page.
| Parameter | Required | Default | Description |
|---|---|---|---|
| unnamed | no | enabled | Set to disabled to make it disabled by default |
Plugin Configuration
You can define what libraries are to be included by the plugin. The plugin uses jQuery javascript libraries, which could be already included by your theme or other library.
You can also define what is the default selector for the {stickynotes} macro.
If you want to be able to snip-edit any page, you can add the following line into the page.vmd decorator, within the wiki-content div:
$helper.renderConfluenceMacro("{snipedit:disabled}")
It should look like this:
You can apply the same change to the blogpost.vmd decorator.
Then you have to enable the 'Snip-Edit Action' module in the plugin's configuration.
To be able to edit, you have to enable it:
| 2.7 and earlier |  |
| 2.8 and newer |  |
Version History
| Version | Date | State | License | Price |
0.9
(#1)
|
14 Apr 2008 | Beta | Freeware / Open Source (BSD) | Free |
|
0.91
(#2)
|
23 Apr 2008 | Beta | Freeware / Open Source (BSD) | Free |
|
0.92
(#3)
|
23 Apr 2008 | Beta | Freeware / Open Source (BSD) | Free |
|
1.0
(#4)
|
08 May 2008 | Stable | Freeware / Open Source (BSD) | Free |
|
1.0.1
(#5)
|
15 Sep 2008 | Stable | Freeware / Open Source (BSD) | Free |
Resolved
Comments (38)
Apr 14
David Peterson [CustomWare] says:
Looks pretty cool Roberto! One future feature which came to mind straight away w...Looks pretty cool Roberto! One future feature which came to mind straight away would be allowing some configuration on who can view/edit/create the notes. In particular, I can see situations where you would want to hide the notes from 'regular' viewers. For example, you might be putting notes for updating the page, but don't want the general public to see them.
Apr 15
Roberto Dominguez says:
Good idea. It could be a simple as a parameter view in the macro, where the valu...Good idea. It could be a simple as a parameter view in the macro, where the values could be any (default) or editors. Ditto for edit. I wouldn't go beyond that because, after all, it is a macro in the page, so anybody who can edit the page, could change the parameters.
Apr 15
David Peterson [CustomWare] says:
Yeah, at the macro level there's no point going beyond page editors/viewers. How...Yeah, at the macro level there's no point going beyond page editors/viewers. However, at the space (and even global) level, it could be an administration screen that lets you specify groups with different permissions. But it's not a high priority - macro level perms will cover most cases for starters.
Apr 15
john martin says:
Man, this is shiny. I think anything that makes it easier to trackably modify o...Man, this is shiny. I think anything that makes it easier to trackably modify or comment on a page is wicked cool. This'll be great for longer pages.
I have two suggestions so far, though:
Apr 15
Roberto Dominguez says:
I've been thinking on making the notes actual comments: They'd be shown at the b...I've been thinking on making the notes actual comments: They'd be shown at the bottom, like any other comment, but also as sticky notes...
WRT the icons, I not good at design, so that's the best I could come up with... so we'll see if somebody has some suggestions.
Apr 15
David Dembo says:
Very nice, looks like this could be very useful in a number of scenarios. Migh...Very nice, looks like this could be very useful in a number of scenarios.
Might as well throw a couple more ideas into the mix while they're flying around:
Apr 15
Roberto Dominguez says:
Man, you really want to keep me busy Once you pin a sticky note, you can drag/...Man, you really want to keep me busy
Once you pin a sticky note, you can drag/move it, right?
The other two suggestions make sense... however they are very difficult to implement without some changes in the way confluence render content.
This plugin came up as a proof of concept... I have other ideas, but it requires some changes on Confluence...
Regards,
Roberto
Apr 24
David Dembo says:
Well you know what they say, no rest for the wicked! Maybe you could also adop...Well you know what they say, no rest for the wicked!
Maybe you could also adopt a 20% time policy... 80% spent on your development projects, 20% spent modifying Confluence to make them work? I'm sure Atlassian wouldn't complain!
Apr 16
David Keene says:
Nice tool, could you also include the ability to keep the note pinned open when ...Nice tool, could you also include the ability to keep the note pinned open when the page is first displayed. Maybe collapsible via defined users and other users can collapse it during that session.
Hope that makes sense.
Keep up the good work
Dave
Apr 22
Stephen Morad says:
To add to this request, perhaps making an option as to whether all of the notes ...To add to this request, perhaps making an option as to whether all of the notes will be opened or closed when the page is loaded -- sort of like the options available with the cloak macro as part of the Composition Plugin.
May 08
Roberto Dominguez says:
Done on 1.0Done on 1.0
May 11
Tomi Strugar says:
What is the parameter that tells stickynotes to be opened or closed when the pag...What is the parameter that tells stickynotes to be opened or closed when the page is loaded? Pls add to doco.
Great plugin. Thnx.
Apr 23
Stephen Morad says:
When using {stickable}, I'm getting sticky notes on headings, as well as the sti...When using {stickable}, I'm getting sticky notes on headings, as well as the sticky note associated with the {stickable} macro - even though I do not have {stickynotes} on the page. I worked around this issue by using {stickynotes:selector=h9}.
I recommend updating the macros so that stickynotes are not associated with any headings if only {stickable} is used on a page.
Edited to add:
Issue trackering URL was just provided, so I opened CSTKY-1.
May 08
Roberto Dominguez says:
Fixed on 0.92.Fixed on 0.92.
Apr 23
Stephen Morad says:
This plugin truely is awesome – especially {snipedit}. Question, I just u...This plugin truely is awesome – especially {snipedit}. Question, I just upgraded from 0.9 to 0.91, and two macros (SnipEdit and SnipEdit 2.8) were disabled. It looked like snipedit was enabled, but the macro didn't seem to work until these other two were enabled. I understand this is still beta, but is SnipEdit going to replace snipedit. Or was there some reason SnipEdit and SnipEdit 2.8 were disabled by default?
Apr 23
Roberto Dominguez says:
"SnipEdit" and "Snip Edit28" are 'page actions' required only if you embed the m..."SnipEdit" and "Snip Edit28" are 'page actions' required only if you embed the macro to be able to edit all the pages without having to include the {snipedit}, as described above. They are disabled because they're require only if the macro is embedded.
If you include the {snipedit} macro in a page, it should just work, even if you don't see the icon in the top right.
Could you disable "SnipEdit" and "Snip Edit28" and confirm that it works? Let me know either way.
Apr 23
Stephen Morad says:
Disabling SnipEdit and SnipEdit 2.8 "break" {snipedit} in our environment (Confl...Disabling SnipEdit and SnipEdit 2.8 "break" {snipedit} in our environment (Confluence 2.6.0).
Apr 23
Roberto Dominguez says:
Weird, I tried it on 2.6.2 and no problem... I'll have a look, could you create ...Weird, I tried it on 2.6.2 and no problem... I'll have a look, could you create a issue and we'll take it from therE?
Apr 23
Stephen Morad says:
Done - CSTKY-3Done - CSTKY-3
May 08
Roberto Dominguez says:
Fixed on 0.92Fixed on 0.92
Apr 24
Stephen Morad says:
Just tested this with the {include} macro and it works really well! Don't know ...Just tested this with the {include} macro and it works really well! Don't know if you made this compatiable on purpose, but it works really well. Sticky Notes are seemlessly integrated (e.g. you can read/add notes, they show up on both pages, and you say on the "parent" page even though the note is associated with the included page.
Snip Edit works too, but after saving a change, you end up on the included page, not the parent. This is the same "issue" that edit-include has, and I doubt there is an easy way to fix this behavior. Ideally you would be able to snipedit content of an included page, but stay on the "parent" page after the change has been made.
Apr 24
Chris Paquin says:
Hey Roberto - real neat set of macros! Quick suggestion: it would be really...Hey Roberto - real neat set of macros!
Quick suggestion: it would be really good to be able to leverage the snipedit info across a site, or within a specific set of pages. So, if I used snipedit to set a definition on a term, for example, I'd like to see that same information pop up on ever instance of that term in a site.. and it would also be good if I could specify a master "definitions" page within the site to store this information for quick reference.
(probably more than you're looking to tackle with this macro, but it can't hurt to ask...
)
Chris
Apr 25
Tibor Hegyi says:
Hi Roberto, Thanks for this plugin - I think this is the best entry up to now (...Hi Roberto,
Thanks for this plugin - I think this is the best entry up to now (at least for Confluence).
One q: can the notes be searched? If not, it would be great to index them somehow...
Good luck in CODEGEIST,
Tibor
Apr 26
Wish J says:
Hi Roberto, Really a great macro.. it helps me lot in designing and docum...Hi Roberto,
Really a great macro.. it helps me lot in designing and documenting the information..
Great one..