This server will be upgraded at 3pm Sydney time on December 3rd (December 2nd, 8pm PST) and will be down for up to 30 minutes.

Index Glossary Plugin

Name List Spaces Plugin
Version 1.0.0
Vendor SGCIB
Author(s)
  • Florent GERBOD
  • Kedar LEE
  • François FEY
Contact
Price free
License Open Source (LGPL)
Download JAR indexGlossary-1.0.0.jar
Source Control indexGlossary-1.0.0.src.rar

Description

This plugin contains 2 macros which can generate a index of word and a glossary.  

  • Glossary : This macro sort in alphabetical order the words received by the body macro and gives an acces by letter.  The result is stock in bandana context and refresh only if the page is edited.
  • ShowIndex : This macro seek each word in each pages of a space and gives the list of pages where words are written. Words are also sorted in alphabetical order.  The result is stocked in bandana context. The index can be refreshed by clicking on . A warning tell if the index may be out-of-date (pages modified or added in the space).

Downloading & Installing

  • Download from above the plugin jar.
  • Install the plugin through Confluence's plugin upload feature.

Syntax

  • Glossary
    {glossary}
    DCOM: Distributed Component Object Model
    RAS: Remote Access Server
    RBAC: Role-Based Access Control
    RDBMS: Relational DataBase Management Systems
    DFI: Debt Finance ITEC business line
    RDF: Reuters Data Feed
    {glossary}
    
  • ShowIndex
    {ShowIndex:space=SpaceKey}
    Dell
    EAI
    {ShowIndex}
    

    space argument is optional, by default current space is used.

Screenshots

Developer information

Package action "regenerateIndex"

<xwork name="pluginaction" key="pluginaction">
  <package name="indexAction" extends="default" namespace="/plugins/sgcibMacro">
    <default-interceptor-ref name="defaultStack" />
    <action name="regenerateIndex" class="com.sgcib.confluence.macros.indexGlossary.RegenerateIndexAction" method="doDefault">
      <result name="input" type="velocity">/vm/showIndexAction.vm</result>
      <result name="error" type="velocity">/vm/showIndexAction.vm</result>
      <result name="success" type="velocity">/vm/showIndexAction.vm</result>
    </action>
  </package>
</xwork>

This package contains 1 action. This action is used in order to regenerate index in asynchronous mode (Ajax).

Class Java

The AlphaTab class is used by the 2 macro in order to generate html tabs.

For more please see javadoc

Bugs

Please report bugs in comments.

Labels

non-repository non-repository Delete
confluence22 confluence22 Delete
plugin plugin Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Feb 28, 2007

    Marc Crawford says:

    This is a very useful plug-in. But I noticed that when you have lots of entries ...

    This is a very useful plug-in. But I noticed that when you have lots of entries for a given letter, the layout switches from one column to three. While that may be useful to cut down on page length, I would like to have the option to show everything in one column instead. Is there a way to do that? Or can that maybe be added to a new release?

  2. Mar 02, 2007

    David Kozlowski says:

    These macros are not presently working in 2.3.3, but I don't see any notificatio...

    These macros are not presently working in 2.3.3, but I don't see any notification of this on this page. What gives? Please explain.

  3. Aug 21, 2007

    Richard Clark says:

    I've tried installing this plugin on a Confluence v2.4.5 installation running on...

    I've tried installing this plugin on a Confluence v2.4.5 installation running on Tomcat 5.5 and JDK 1.5.0_12. When I use upload the plugin I get the following error:

    The following error(s) occurred: There were errors when uploading this plugin: com.atlassian.plugin.PluginParseException: Cannot open JAR file for reading: /app/users/gbbrbi/Confluence_server_2/CONFLUENCE/temp/indexGlossary-1.0.0.jar
    Checking on the server the file has been uploaded to the server, but the jar file doesn't appear acceptable. The file has a size of 14826. Any suggestions? 

  4. Aug 27, 2007

    Jaime Seoane says:

    Richard: the reason you get the message seems to be because the jar has been pac...

    Richard: the reason you get the message seems to be because the jar has been packed twice and therefore Confluence sees it as a corrupted jar. What I did to get it to work was:

    1. Download the jar "indexGlossary-1[1].0.0.jar" from the site.
    2. Unpack or unzip the jar and you will a file named "indexGlossary-1[1].0.0".
    3. Renamed the file such that you add the extension ".jar" to it such as "indexGlossary-1.0.0.jar"

    You should now be able to upload the jar "indexGlossary-1.0.0.jar" via the plugins administraiton page.

    Cheers

    1. Aug 28, 2007

      Richard Clark says:

      Thanks, that works a treat.

      Thanks, that works a treat.

  5. Aug 28, 2007

    Bob Swift says:

    Can the source be published for this plugin?

    Can the source be published for this plugin?

  6. Aug 29, 2007

    Guy Fraser says:

    Could the "Acronym" table heading be changed to "Term" - not all glossary entrie...

    Could the "Acronym" table heading be changed to "Term" - not all glossary entries are acronyms.

  7. Aug 29, 2007

    Florent Gerbod says:

    I have add the source files. I don't think i am going to make new version of tha...

    I have add the source files. I don't think i am going to make new version of that plugin so feel free to improve it.

  8. Sep 10, 2007

    M Dhivya says:

    Hi when i try to upload the jar file, it throws the exception as below There wa...

    Hi when i try to upload the jar file, it throws the exception as below

    There was an error opening the downloaded file as a JAR: C:\confluence\temp\indexGlossary-1.0.0.jar

    With Regards,

    Dhivya.M

    1. Sep 10, 2007

      Richard Clark says:

      See Jaime's comment above in reply to me reporting the same thing. The solution ...

      See Jaime's comment above in reply to me reporting the same thing. The solution works, the files just been jar'd twice.

  9. Mar 19, 2008

    Sebastian Stigler says:

    Hi, my glossary is displayed verticaly: A B ... how can i have it diplayed ...

    Hi,

    my glossary is displayed verticaly:

    A

    B

    ...

    how can i have it diplayed horizontally?

    Best Regrads,

    Sebastian 

  10. Jun 10

    David Matsumoto says:

    Has anyone been able to get the glossary macro to work with external links, i.e....

    Has anyone been able to get the glossary macro to work with external links, i.e. Example: [http://www.example.com]?

     It appears to be an issue with how the macro parses the colons in this case getting confused between the colon on the acronym vs the link.  If an external link is included the resulting table structure gets mangled with the a new "Acronym" column getting added for each external link.  Escaping the colon with a back slash restores the proper table behavior, but the link gets truncated and displayed the text of the link up to the colon instead.

    Any help with resolution would be appreciated 

  11. Jun 25

    Richmond-rae Dalisay says:

    Aug 29, 2007 Guy Fraser says: Could the "Acronym" table heading be changed...
    Aug 29, 2007 
    Guy Fraser says:
    Could the "Acronym" table heading be changed to "Term" - not all glossary entries are acronyms.
    

    Same problem encountered. Is there a way to change it?

    Thanks and God bless.

  12. Oct 17

    Yair Krauze says:

    This looks like a useful plugin and we are looking into using it. It would be v...

    This looks like a useful plugin and we are looking into using it.

    It would be very useful if the following features were available for it:

    • Have multiple glossaries on a page, probably requiring an id to be specified
      {glossary:id=First}
      ...
      {glossary}
         
      {glossary: id=Second}
      ...
      {glossary}
      
    • Specify column heading names (as mentioned here before, but for both columns)
      {glossary: acronym_heading=Term | definition_heading=Explanation}
      
    • Flag to display only sections that have values (so that letters with no terms are not displayed)
      {glossary: show_only_used=true}