Alternative to Snippet Plugin? (Including excerpts from Javadoc in pages)

Hi all,

Do you know of an alternative to the snippet plugin? We use it to pull in documentation from javadoc output into our doc pages. Our user macro takes the space name and builds snippet macro. This pulls in a section of text from a javadoc file.

For example:

{super-snippet:id=classConfig|javadoc=true|url=/module-dbconnector/com/us/connector/DatabaseScanner.html}

Transforms to

{snippet:id=classConfig|url=<spacename>/module-dbconnector/com/us/connector/DatabaseScanner.html}

Snippet plugin

  • transforms the <spacename> into a baseURL
  • Accesses the DatabaseScanner.html file
  • Locates the classConfig snippet, marked by xml comments (<!-- SNIPPED BEGIN classConifg-->)
  • Includes the snippet in the confluence page

This lets us update javadoc and documentation together knowing that the examples or configuration specs are up to date.

However, the snippet plugin appears to have been abandoned and isn't compatible with the latest version of confluence.

Please let me know if you can think of any alternatives that would allow us to slice html files into section and include them in confluence pages.

Thanks

Peter

1 answer

This widget could not be displayed.

Would something like https://marketplace.atlassian.com/plugins/net.flosdorf.confluence.plugin.javadoc-macro work for you? It allows Javadoc to be embedded in wiki pages.

Can it include sections of the javadoc or just whole javadoc pages?

Not sure,never used it.

Suggest an answer

Log in or Sign up to answer
Community showcase
Posted Monday in Confluence

Why start from scratch? Introducing four new templates for Confluence Cloud

Hi my Community friends!  For those who don't know me, I'm a product marketer on the Confluence Cloud team - nice to meet you! For those of you who do, you know that I've been all up in your Co...

457 views 6 6
Join discussion

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