Dictionary in Confluence for technical terms

Hello!

I am looking for a solution to integrate a dictionary into CONFLUENCE.

We have a few hundred technical terms. Those are very special internal terms, so I can not use a common dictionary that can be found anywhere on the web.

At the moment i use a simple table on a Confluence page to provide those translations to our staff.

Problem is:

- Automatic sorting (A-Z) is not possible in EDIT-Mode, User has to find the correct line to fill in new words manually.

- Long list does not perform well in Confluence.

Do you use Confluence to display a dictionary in your business?

Do you have a better solution than a simple list?

External application displayed in Confluence? CSV-Lists? SQL? Anything else?

7 answers

Would this plugin be the sort of thing that could help?

Explainer for Confluence

It's cheap but I see that it only supports Confluence 4.3 - 5.1.3. So you might want to contact the plugin's support email to check about later versions of Confluence.

We have a separate space that contains our glossary (similar to what Kay described), with one page for each letter, and then terms under each letter. We then included the definition within an excerpt macro.

Looking at this question, I wondered how I could duplicate the functionality of the Explainer plugin for free, so I wrote this user macro, which I called excerpt-tooltip (NOTE - Requires Confluence 5.0+):

## @param space:title=Space|type=string|required=true|desc=enter space key
## @param page:title=Page|type=string|required=true|desc=enter page to extract data from
<style>
.tipsy-inner {
max-width: 400px !important;
text-align: left !important;
}
</style>
<script type="text/javascript">
AJS.$(document).ready(function(){
	AJS.$('.excerpttip').filter(function() {
    	return AJS.$(this).offset().left >= AJS.$(window).width() / 2;
		})
		.tooltip({ html:true, gravity: 'e' });
	AJS.$('.excerpttip').filter(function() {
    	return AJS.$(this).offset().left < AJS.$(window).width() / 2;
		})
		.tooltip({ html:true, gravity: 'w' });
});
</script>

<a id="tooltip-$parampage" class="excerpttip" style="text-decoration:none; border-bottom:2px dotted;" title='$action.getHelper().renderConfluenceMacro("{excerpt-include:$paramspace:$parampage}")'>$parampage</a>

For example, if there is a page in the space with the key "GLOSSARY" called "Technical Term", this macro will insert the text "Technical Term" into the page, and when you put your mouse over it, you will see the text of the definition that is defined within the excerpt macro on the "Technical Term" page.

Edit: Fixed bug where tooltip would go off the right side of the screen.

Sounds neat,mhow does it look on the performance side, esp. On mobile devices and netbooks ?

The performance shouldn't be any different than putting an {extract-include} macro into a page. I think it would be fine on a netbook. On a mobile device, I don't think you could use this, as it requires you to hover the mouse over the term, but I did not test it.

I updated the code so that it uses the confluence page selector.

## @param page:title=Page|type=confluence-content|required=true|desc=enter page to extract data from
#foreach ($p in $parampage.split(":"))
	#set ($pagename = $p)
#end

<style>
.tipsy-inner {
max-width: 400px !important;
text-align: left !important;
}
</style>

<script type="text/javascript">
AJS.$(document).ready(function(){
	AJS.$('.excerpttip').filter(function() {
    	return AJS.$(this).offset().left >= AJS.$(window).width() / 2;
		})
		.tooltip({ html:true, gravity: 'e' });
	AJS.$('.excerpttip').filter(function() {
    	return AJS.$(this).offset().left < AJS.$(window).width() / 2;
		})
		.tooltip({ html:true, gravity: 'w' });
});
</script>

<a class="excerpttip" style="text-decoration:none; border-bottom:2px dotted;" title='$action.getHelper().renderConfluenceMacro("{excerpt-include:$parampage}")'>$pagename</a>

You can choose whichever version works best for your needs.

This is great, but for some reason it doesn't want to properly render inline. Example:

  • Input: This is a sentence with the term <your-macro> in it.
  • Result: This is a sentence with the term
    <your-macro>
    in it. 

Any idea why that might be? It looks fine in preview, by the way!

Yet now there is a completely new add-on Glossary, https://marketplace.atlassian.com/plugins/fr.spectrumgroupe.confluence.plugins.glossary

It's easy to use and it lets you manage thousands of terms and their definitions inside a smart wiki page tree. Use it to add new letters, create terms and use live-search to quickly find a specific term.


http://lab.spectrumgroupe.fr/confluence/display/SBD/Glossary+user+guide

The Add-On isn't available for Confluence Cloud, and even if it were, it costs.

A year or so ago I was looking up how to create a Glossary and there was good advice in the Confluence online documentation - it involved using Anchors, from memory. I can't find any similar supportive suggestions now.

Is that because Atlassian wants to push users towards a paid-for solution?! That wouldn't be good..........

Maybe I'm just missing the advice in the online docs. If so, I'd be grateful if someone were to point me in the right direction.

thx

I would create a separate page for each letter of the alphabet. Display all the pages as children on the parent page. It would be easy to find, add and edit terms.

Regards,

Kay

"Explainermakro sounds best, i think, but using your approach, my favourite is following: use templates + addpagemacro to set up a Glossary page and create one child per term. Then set up the glossary page like this Addpage "create new definition" A-z macro + children macro ( displays all children,grouped by a-z), maybe even showing excerpts Template for a glossary entry Excerpt macro: short definition Long definition follows

MJP,

how about embedding an Excel file using the Excel macro? That way you'd have all the benefits of using an Excel spreadsheet, which you can then edit without leaving Confluence.

Cheers.

Hi Gents,

Excuse me for stupid question; how do I add this macro to the Wiki? Should I have admin access, or I just can add it somehow as a simple user?

I'm familiar with excerpt macros, but how do I build this custom macro?

 

Regards,
Lev

Steven Behnke Community Champion Nov 24, 2015

This is a late answer, but Confluence for Server allows you to define custom User Macros, leveraging custom HTML, CSS, JS, and Velocity.

Suggest an answer

Log in or Sign up to answer
How to earn badges on the Atlassian Community

How to earn badges on the Atlassian Community

Badges are a great way to show off community activity, whether you’re a newbie or a Champion.

Learn more
Community showcase
Published Thursday in Confluence

Three common content challenges + how to manage them

An efficient enterprise content management system, or ECM, is a must-have for companies that create work online (cough   cough, all companies). If content calendars, marketing plans, and bu...

89 views 0 6
Read article

Atlassian User Groups

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

Find a group

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

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you