HTML Reporting

[slwiseman]

I'm trying to find out if it's possible to modify the navigation bar created within html reports so that only packages and diagrams are displayed and not the elements that are used within a diagram.  I find the current system messy and confusing for the customer and would prefer to only show them limited information.

any thoughts, etc would be much appriciated

[Martin Terreni]

I might be wrong, but AFAIK there is not much manipulation you can do to HTML generation...

[Eve]

You can modify the HTML templates, but it's not quite as easy as the RTF templates.

Open the Resource Browser.  (View | Resources)  Open 'Templates', right click on 'Web Style Templates' and select 'Create HTML Template'.

[gpc]

Never played with it (okay just briefly a long time ago), but there is a 'web style template' in the resources tab. It looks like you may be able to add / remove items using this?

[slwiseman]

My colleague and I have worked out how to do it now.  For those of you that may be interested you need to modify the tocBuild Function which is shown below.  Basically we've added an if statement that will only include packages or diagrams into the final TOC

function tocBuild(data) {
var tocType = new Array();
var tocTypes = new Array();
var tocErrs = new Array();

for (var i=0; i<tocTab.length; i++) {

if (!tocTab[8]) tocTab[8] = 'misc';

if (tocTab[8].toLowerCase().indexOf('diagram')!=-1) tocTab[8] = "0Diagram";

if (tocTab[8].toLowerCase().indexOf('package')!=-1) tocTab[8] = "1Package";

if (!tocType[tocTab[8]])
{
tocType[tocTab[8]] = new Array();
tocTypes[tocTypes.length]=tocTab[8];
}
tocType[tocTab[8]][tocType[tocTab[8]].length] = i;
}

tocTypes.sort();

for (var i=0; i<tocTypes.length; i++)
{
for (var j=0; j<tocType[tocTypes].length; j++)
{
if ((tocTab[8].toLowerCase().indexOf('package')!=-1) || (tocTab[8].toLowerCase().indexOf('diagram')!=-1))
{
   var build = tocBuildItem(tocType[tocTypes][j]);

   if (build!=true)
   tocErrs[tocErrs.length]=build;
   }    
}
}

var errRuns=0;
var errTotal=tocErrs.length;

while(tocErrs.length!=0) {
if (errNums==tocErrs.length) { errRuns++;

if (errRuns>errTotal) { break;
}
}

var errNums=tocErrs.length;
var tmp=tocBuildItem(tocErrs.shift());

if(tmp!=true) tocErrs[tocErrs.length]=tmp;
}

while(tocErrs.length!=0) {

tocTab[tocErrs[0]][6]="0";
tocBuildItem(tocErrs.shift());
}

if (tocLastID!=0) {
var tocLastSrc = document.getElementById("toc"+tocLastID).parentNode.childNodes[document.getElementById("toc"+tocLastID).parentNode.childNodes.length-4];

tocLastSrc.src = tocLastSrc.src.substring(tocLastSrc.src.lastIndexOf('images')).replace("01","02");

}
}

[Martin Terreni]

Well done!

[Aaron B]

While I haven't personally tested the modification that you posted, I thought it looked interesting and potentially useful to other people, so I have posted a copy on the EA User Group WIKI site for future reference.

HTML (Packages And Diagrams Only)

[jdewitt]

Thanks a lot for steering me in the right direction. We received several requests at my company to filter the table of contents.

The code as posted contains a bug. The 'if' statement around the tocBuildItem() function should be changed from

 if ((tocTab[8].toLowerCase().indexOf('package')!=-1) || (tocTab[8].toLowerCase().indexOf('diagram')!=-1))

to

  if ((tocTypes.toLowerCase().indexOf('package')!=-1) || (tocTypes.toLowerCase().indexOf('diagram')!=-1))