Theme Builder

Here is what I have learned thus far in a Confluence 2.5.7, Builder 2.0.9, Connector 1.3.6 environment:

1. I actually can get the "Edit in Word" menu item to display without an image if I use the following syntax:

   {menuitem}{menulink:webui|location=system.page.actions|key=editinworditem1}Edit in Word{menulink}{menuitem}
   

   • This was being hidden by the fact that I was using the wrong syntax to display the accompanying image.
2. I can see the "Edit in Word" menu item with the "editinword" image if:
   1. I unzip the entire contents of the connector plugin JAR file to a directory using WinZip.
   2. I create a GIF equivalent for the editinword.png file.
      • We've configured all of our themes to not use PNG images, as their apparent larger size when compared to GIFs slows the rendering of the top menu bar to a crawl.
        • We did this through the setting: Configure Theme -> Options -> Modify Menu Options -> Display menus as quickly as possible (faster page loads, inhibits use of PNG icons)
   3. I edit the connector's atlassian-plugin.xml to add the following line for the "editinworditem1" web-item:

       	<resource type="download" name="editinword.gif" location="templates/extra/editinword/editinword.gif"/>
      

   4. I update my menuitem to add the following menuicon declaration:

      {menuitem}{menuicon:../../com.atlassian.confluence.extra.officeconnector:editinworditem1/editinword}{menulink:webui|location=system.page.actions|key=editinworditem1}Edit in Word{menulink}{menuitem}
      

      • Yes, there is probably a security risk in allowing upward navigation in the menuicon macro, but our Prod Support team is the only group who has permission to change the menu bar, as it is {import}ed into the theme via a view-only Confluence page.
      • FYI, the importworditem probably always worked, and I define it as follows:

        {menuitem}{menuicon:../../com.atlassian.confluence.extra.officeconnector:editinworditem1/editinword}{menulink:webui|location=system.page|key=importworditem}Import from Word{menulink}{menuitem}
        

        • Yes, I'm using the same icon for both edit and import, but there isn't an icon for import yet, so feel free to vote on the enhancement request.
   5. I re-zip the contents of the unzipped folder into a JAR file using Java's jar utility (using WinZip doesn't work).
   6. I install the updated JAR file into the Confluence Administrative Console.
3. Even with the "Edit in Word" menu item now showing along with its icon, when I click on the menu item, the only thing that happens is that the URL in the browser's address bar changes from:

   http://www.mywikisite.com/display/MYSPACE/My+Wiki+Page
   

   to:

   http://www.mywikisite.com/display/MYSPACE/My+Wiki+Page#" onclick="if (window.ActiveXObject){var ed; try{ed = new ActiveXObject(
   

   • That's because Adaptavist Theme Builder renders links generated by menu items using single quotes for the href attribute instead of double quotes, like so:

     <a href='#onclick="if (window.ActiveXObject){var ed; try{ed = new ActiveXObject('SharePoint.OpenDocuments'
     

   • So the link actually rendered in the browser never gets past that second single quote shown above.
   • I tried changing the link child element of the "editinworditem1" web-item element to use a ' instead of a " to close off the #, to use a single quote for the start of the onclick logic, and to use double quotes inside of the onclick logic to prevent premature logic termination.
     • Both the href and the onclick attributes of the link in the rendered HTML's source appeared to look right now, but when I clicked on the menu item, the only thing that happened is that a # character is added to the end of my URL.
     • I'm not sure what the problem is, but when I try as a work-around to use javascript: inside the href instead of #' onclick=', Internet Explorer tells me "'return' statement outside of function" and Firefox tells me "return not in function".

To figure out whether "return false;" statements were really needed when using the "javascript:" syntax, I exploded the JavaScript out into a readable form and removed the return statements:

if (window.ActiveXObject)
{
    var ed;

    try
    {
        ed = new ActiveXObject("SharePoint.OpenDocuments");
    }

    catch(err)
    {
        window.alert("Unable to create an ActiveX object to open the document. This is most likely because of the security settings for your browser.");
    }

    if (ed)
    {
        ed.EditDocument("$helper.action.bootstrapManager.baseUrl$relUrl$ext", "Word.Document");
    }
    else
    {
        window.alert("Cannot instantiate the required ActiveX control to open the document. This is most likely because you do not have Office installed or you have an older version of Office.");
    }

}
else if (window.URLLauncher)
{
    var wdFile = new URLLauncher();wdFile.open("$req.contextPath$relUrl$ext");
}
else if(window.InstallTrigger)
{
    if(window.confirm("A plugin is required to use this feature. Would you like to download it?"))
    {
        InstallTrigger.install({"WebDAV Launcher": "$req.contextPath/download/resources/com.atlassian.confluence.extra.officeconnector:editinworditem1/webdavloader.xpi"});
    }
}
else
{
    window.alert("Internet Explorer or Firefox is required to use this feature");
}

As you can see, because you do a sufficient amount of "if" tests and error checking, I don't think you would ever be sent down a path you should not go down based on your browser, etc.

So I packed up that version of the JavaScript, made that the logic to be executed after the "javascript:" call in all three web-items within atlassian-plugin.xml, re-JAR'ed the files, and re-installed the plugin JAR.

Now, when I click on "Edit in Word", in both Firefox and IE, the file is opened via WebDAV for editing, and I can apply changes, save them, and refresh the corresponding Wiki page to see them.

I ran into additional issues after reaching this point, but I don't think they're Theme Builder-related, so I have captured them as potential Office Connector issues:

• WORDDV-120
• WORDDV-121
• WORDDV-122