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

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
Atlassian Community Anniversary

Happy Anniversary, Atlassian Community!

This community is celebrating its one-year anniversary and Atlassian co-founder Mike Cannon-Brookes has all the feels.

Read more
Community showcase
Kesha Thillainayagam
Posted Apr 13, 2018 in Confluence

We want to hear how your non-technical teams are using Confluence!

Hi Community! Kesha (kay-sha) from the Confluence marketing team here! Can you share stories with us on how your non-technical (think Marketing, Sales, HR, legal, etc.) teams are using Confluen...

2,921 views 27 12
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