| Name | Overlib Macro |
|---|---|
| Vendor | JavaPolis (Website) |
| Authors | Alain Moran, Stephen Janssen |
| Homepage | http://confluence.atlassian.com/display/CONFEXT/Overlib+Macro |
| Issue Management | http://jira.adaptavist.com/browse/overlib |
| Continuous Integration | n/a |
| Categories | Formatting Macros |
| Most Recent Version | 0.1.2 |
| Availability | Confluence v2.1 to v2.10 |
| State | Alpha |
| Support |
|
| License | Freeware / Open Source (BSD) |
| Price | Donate |
| Release Docs | http://confluence.atlassian.com/display/CONFEXT/Overlib+Macro |
| Java API Docs | n/a |
| Download Source | n/a |
| Download JAR | javapolis-plugin-overlib-0.1.2.jar |
Description/Features
The OverLib confluence macro is a wrapper around the OverLib JavaScript library.
It takes an excerpt from a given wiki page and shows this as a popup on another page, including a link to that page.
You can check out some examples on the JavaPolis 2006 site.
Sticky OverLib popup
Installation
Step 1 - Create OverLib user macro
Create a confluence Users macro which you can call overlib-include.
This user macro points to the latest overlib.js file that you can attach for example on your confluence home page.
You'll need to download the latest version from the OverLib home page.
Example:
<script type="text/javascript" src="http://www.javapolis.com/confluence/download/attachments/23548/overlib.js"><!-- overLIB (c) Erik Bosrup --></script>
Step 2 - Install plugin
Go to Confluence Administration, Plugins and install one of the following plugin JARs.
| Name | Size | Creator (Last Modifier) | Creation Date | Last Mod Date | Comment | ||
|---|---|---|---|---|---|---|---|
 |
 plugins-OverLib-0.1.jar |
19 kB | stephan janssen | Sep 23, 2006 | Sep 23, 2006 | Overlib plugin version 0.1 | |
|
plugins-overlib-0.1-jdk4.jar |
4 kB | stephan janssen | Nov 08, 2006 | Nov 08, 2006 | Overlib plugin version 0.1 - JDK 1.4 |
Parameters
 | Belows plugin help is not yet available in the "notation guide" popup window of Confluence. |
excerpt
This option is mandatory and is the confluence page name where the excerpt tag is used, this is the text that will get shown in the popup window.
caption
This will set the window caption of the popup, if left out the excerpt page name will be used instead.
fgcolor
The foreground color of the popup box (for example fgcolor=#0f0f0f)
bgcolor
The background color ofthe popup box
border
The border size of the popup
width
The width of the popup (default is 200 pixels)
textsize
The text size of the font.
Sticky
If set to true it will create a sticky popup window which the user needs to close manually (see screenshot)
Examples
This example will show the excerpt defined in the confluence wiki page (see also screen shot above)
 | Don't forget to add the overlib-include macro to each page that wants to use the overlib macro!! |
{overlib-include}
...
{overlib:excerpt=Conference|fgcolor=#cfe6ff|bgcolor=#336699|border=3|width=300}
This is an example using a sticky popup.
{overlib-include}
...
{overlib:excerpt=Conference|fgcolor=#cfe6ff|bgcolor=#336699|border=3|width=300|sticky=true}
Version History
| Ver. | Date | Notes | Author |
|---|---|---|---|
| 0.1 | 2006 Sep 23 | Initial Release | Stephan Janssen |
ToDo
Introduce an AJAX call instead of inlining the excerpt within the overlib method.
Screenshots
|
|
|
|
|
Comments (25)
Oct 03, 2006
Guy Fraser says:
This bombs real bad if there are images or indeed anything other than plain text...This bombs real bad if there are images or indeed anything other than plain text in the excerpt of the target page....
Oct 03, 2006
Alain Moran says:
By the looks of things it's just the quotes that are killing it ... adding in a ...By the looks of things it's just the quotes that are killing it ... adding in a myStr.replaceAll("\"","\\\"") shoudl fix it.
Oct 04, 2006
stephan janssen says:
I haven't tested it with images, I only needed text excerpts for the JavaPolis s...I haven't tested it with images, I only needed text excerpts for the JavaPolis site
Also the special characters like quote and single quote are already replaced with escaped versions...
During another rainy weekend I'll continue on some more features like images etc.
Nov 08, 2006
Hitesh Seth says:
Is the source code of the macro available? Can you post the source code or a lin...Is the source code of the macro available? Can you post the source code or a link where I could download it?
Nov 08, 2006
Alain Moran says:
Yes, it's available here: http://svn.atlassian.com/fisheye/browse/public/contrib...Yes, it's available here: http://svn.atlassian.com/fisheye/browse/public/contrib/confluence/overlib-macro/trunk
I've recently updated it to version 0.1.1 which now contains the overlib source (the license explicitly allows this) and fixes the problems with images in the excerpt.
I've actually had this done for a while now, but havent had chance to release it to the repository yet.
May 22, 2007
Hitesh Seth says:
Thanks. One potential enhancement is to alow metadata to be used along with exce...Thanks. One potential enhancement is to alow metadata to be used along with exceprts as an option. so something like
{overlib:metadata=Definition\|page=PageName\|space=SpaceName}, this way you could use different parts of the page for different places or even consolidate all "glossary of terms" at one place.
Very useful macro. Thanks.
I had noticed that in the previous version there were a bunch of log/debugigng entries (i believe with the exceprts). don't se them in this version.
Nov 14, 2006
Hitesh Seth says:
Alain, Currently the link generated by the macro is the confluence root directo...Alain,
Currently the link generated by the macro is the confluence root director /server/confluence instead of actually the actual page which has the excerpt? I think this was working fine before, but isn't in the new version. Is there a specific reason why you did that?
Hitesh
Nov 14, 2006
Alain Moran says:
Bob Dobbs made me do it! He came down unto me and spaketh 'thou shalt remove th...Bob Dobbs made me do it!
He came down unto me and spaketh 'thou shalt remove this line of code and not replace it as you originally intended' ... and so I did his bidding, and it was good.
Then there came upon the land, much wailing and gnashing of teeth! For the line of code was sorely missed, and lo the line of code was recreated and version 0.1.2 was born.
This should also now be installable via the repository.
Nov 28, 2006
Michael says:
I want to use the overlib macro over a picture and not just a text link ... So ...I want to use the overlib macro over a picture and not just a text link ...
So i typed this :
{overlib:excerpt=Page1|fgcolor=#cfe6ff|bgcolor=#336699|border=3|width=300|sticky=true|caption=<IMG src=\'http://***/confluence/download/attachments/12324/ajp.JPG\' border=\'0\'>}
The picture with the link on it is well displayed ... But not the overlib box ...
Is there a way to do that ?
Feb 08, 2007
Gilad David Maayan says:
I can't find the plugin JAR. Where is it?I can't find the plugin JAR. Where is it?
Feb 13, 2007
Matt Ryall (Atlassian) says:
They were on the attachments tab, but now I've added links to them in the instal...They were on the attachments tab, but now I've added links to them in the installation section.
Feb 13, 2007
Alain Moran says:
You should really install this using the plugin repository, that way you will ge...You should really install this using the plugin repository, that way you will get 0.1.1 and not 0.1
I have added the {repository-plugin} macro to this page.
Apr 24, 2007
David Saia says:
I installed the plugin, and my Confluence system confirms that it's installed (i...I installed the plugin, and my Confluence system confirms that it's installed (in Admin view), but for some reason, the
{overlib}Here is the code I'm using for overlib-include:
and here is the code on my test page:
Here we are, {overlib:excerpt=testing|fgcolor=#cfe6ff|bgcolor=#336699|border=3|width=300} this macro.Can anyone help?
Apr 25, 2007
stephan janssen says:
Are you sure the wiki page 'testing' uses the excerpt tag ? Otherwise Overlib h...Are you sure the wiki page 'testing' uses the excerpt tag ? Otherwise Overlib has nothing to display...
Apr 25, 2007
David Saia says:
Ah! Yes! That was the problem. I haven't been able to locate the documen...Ah! Yes! That was the problem. I haven't been able to locate the documentation that says anything about an "excerpt" tag, but I put one in before and after the text in "testing" and now it's showing up.
THANKS!
Apr 27, 2007
David Saia says:
Re: This will set the window caption of the popup, if left out the excerpt pa...Re:
I've noticed that use of "caption" not only customizes the caption in the tooltip, but also changes the linked word. In the original script, captions can be configured independently of the link content.
Original Javascript:
Attachment: "original_overlib.GIF"
but in the Overlib Macro, the closest you can get is:
Attachment: "overlib_macro.GIF"
Is it possible to NOT change the linked word but customize the caption in the tooltip?
For example, I might want a sentence like:
but have the tooltip caption be something like "About Widgets" instead of just "widget." But if I put in a caption that said, "About Widgets," then the link would also change:
May 01, 2007
N Waanders says:
The current version doesn't seem to allow references to excerpts from pages in a...The current version doesn't seem to allow references to excerpts from pages in a different space - this would be a great improvement !
Nick
May 21, 2007
Nana says:
I am having problems installing this jar. I download into my C: then upload it v...I am having problems installing this jar. I download into my C: then upload it via the confluence plugin under adminstration. I see the status bar moving like something is uploading however once its complete, its not in my list of plugins. This is not the only plugin that behaved this way for me
Please assist,
thanks
May 22, 2007
Nana says:
Can someone please assist me? I downloaded the overlib jar and tried to upload ...Can someone please assist me?
I downloaded the overlib jar and tried to upload it into my plugins under site administration, however I see the status bar loading but once its done, the plugin is not in my list. This happens for some other plugins I have tried to upload as well.
Please Assist ASAP!
Thanks
Jun 07, 2007
Nana says:
The text on the overlib popup centered. Is there a tag to change that?The text on the overlib popup centered. Is there a tag to change that?
Sep 06, 2007
N Waanders says:
There may be an issue with overlib421.zip - I received the following error messa...There may be an issue with overlib421.zip - I received the following error message when attempting to upload to confluence v.2.5.7:
Sep 07, 2007
Alain Moran says:
To start off with 'overlib421.zip' que? Next: I dont see your error message! F...To start off with 'overlib421.zip' que?
Next: I dont see your error message!
Finally - please post any bug reports in jira so that they dont get lost amongst comments
http://jira.adaptavist.com/browse/overlib
May 30, 2008
manns says:
I am still waiting for the answer of my query ? Kindly help..I am still waiting for the answer of my query ? Kindly help..
May 19, 2008
manns says:
Hi.. This macro is very useful. Liked it a lot. However, i have some queries: ...Hi.. This macro is very useful. Liked it a lot.
However, i have some queries:
I wish to get the content of an excerpt from another space. For eg:
I have 2 spaces A & B. I have a page in B called This is a page in B which has the content in except macro. I wish to call this excerpt contents in a Page This is a Page in A of space A. Could any one tell me how to do that.
I tried adding the following in This is a Page in A page, but they are not helpful..
{overlib:excerpt=B:This is a page in B} : This does not seems to work at all.
Awaiting response..
Thanx
Manns
May 30, 2008
manns says:
Hey.. I am still waiting for a feedback here.. Is any one interested..?Hey.. I am still waiting for a feedback here.. Is any one interested..?