Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

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

Peter Kahn
Contributor
January 23, 2013

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

0 votes
EddieW
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
April 17, 2013

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.

Peter Kahn
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
April 19, 2013

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

EddieW
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
April 19, 2013

Not sure,never used it.

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events