Uploaded image for project: 'Confluence Data Center'
  1. Confluence Data Center
  2. CONFSERVER-26825

Expose Documentation Theme settings to other plugins

    XMLWordPrintable

Details

    • We collect Confluence feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

    Description

      NOTE: This suggestion is for Confluence Server. Using Confluence Cloud? See the corresponding suggestion.

      We have an in-house plugin that creates a Review Space based on an existing space. It configures the new space with the Documentation Theme and sets up the navigation bar and other bits with plugin-generated material.

      In order to achieve this we made com.atlassian.confluence.plugins.doctheme.Settings a public component by patching the DocTheme plugin's atlassian-plugin.xml as follows:

      --- doctheme-plugin/atlassian-plugin.xml	Thu Feb 17 01:24:32 2011
      +++ doctheme-plugin/atlassian-plugin.xml	Fri Aug 05 17:38:30 2011
      @@ -17,6 +17,11 @@
               <interface>com.atlassian.confluence.plugins.doctheme.ThemeService</interface>
           </component>
       
      +    <component key="themeSettings" name="Theme Settings" class="com.atlassian.confluence.plugins.doctheme.Settings" public="true">
      +        <description>Services to store and retrieve theme configuration information.</description>
      +        <interface>com.atlassian.confluence.plugins.doctheme.Settings</interface>
      +    </component>
      +
           <web-resource name="Doc Theme Resources" key="resources">
               <resource name="doc-theme.js" type="download" location="doctheme/doc-theme.js" />
           </web-resource>
      

      We have to remake this patch for each update to DocTheme (not a problem since we have automated the application of it) but the change may be useful to other plugin developers so I thought I'd raise it here.

      Attachments

        Issue Links

          Activity

            People

              smansour Sherif Mansour
              ea3576dbb6a1 Adam Butcher
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: