CDR Tickets

Issue Number 3973
Summary Modify TOC Word Macro
Created 2015-09-18 11:51:53
Issue Type Improvement
Submitted By Englisch, Volker (NIH/NCI) [C]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2016-05-27 15:51:19
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.170446
Description

The Word macro to create a table of content with page numbers includes all of the level headings but lists them all as a level 3 heading.
We need to modify the TOC to display the same level headings that's shown on the QC report

Comment entered 2015-09-18 11:55:50 by Englisch, Volker (NIH/NCI) [C]

Unfortunately, the Word TOC is displaying all headings that are the 3rd level in or deeper at the same level. I'll upload a screenshot from the Genetics of Colorectal Cancer summary, which shows all headings under "Lynch syndrome" has being of the same level.

Just to be sure: We don't want to display all levels but instead only display the levels created as part of the QC report as part of the TOC. In other words, the problem is not that the headings displayed aren't displaying at the appropriate level but that not all of those lower levels should display at all.
Is this correct?

Comment entered 2015-09-18 12:30:02 by Englisch, Volker (NIH/NCI) [C]

I was wrong. This is not a problem with the Word macros but with the QC filter. It appears that all header levels from level 4 and down are displayed as a header-4 in the QC report and that's why those levels are included in the TOC.

Comment entered 2015-09-18 12:39:42 by Juthe, Robin (NIH/NCI) [E]

I prefer for it to display all levels, but I will need to see what the other Board managers prefer. I find it much easier to find things when all of the levels are displayed. However, the problem isn't the number of levels that are displaying but the fact that level 4 and down is showing up at the same level, as it sounds like you determined already.

Comment entered 2015-09-18 12:39:50 by Englisch, Volker (NIH/NCI) [C]

The Title templates (PT and HT versions) of the following filter will need to be updated to address the issue:

  • CDR339576: Module: InLine Markup Formatter

Comment entered 2015-09-18 13:35:14 by Englisch, Volker (NIH/NCI) [C]

This means you would like the Word TOC to display different levels than the TOC of the QC report (which currently only displays 3 levels if you don't count the document header)?

Comment entered 2015-09-18 13:41:17 by Juthe, Robin (NIH/NCI) [E]

I am checking with the other Board managers on this. Please don't change the number of levels until I have a consensus. 🙂

Comment entered 2015-09-18 13:59:26 by Englisch, Volker (NIH/NCI) [C]

Don't worry, I won't make any changes at this point. I just started with some requirements gathering to see what would need to be done.

Comment entered 2015-09-23 17:53:10 by Juthe, Robin (NIH/NCI) [E]

We discussed this today and we are all in favor of displaying all section levels in the TOC (for both the QC report and the Word macro).

Comment entered 2015-09-23 18:21:10 by Englisch, Volker (NIH/NCI) [C]

Unfortunately, I'll have to disappoint you here. Since HTML only allows headings from H1 to H6 we won't be able to include your levels 6-9 in the QC report and therefore the Word TOC won't be able to distinguish between those.

Comment entered 2015-09-23 19:25:20 by Juthe, Robin (NIH/NCI) [E]

That's okay. Most summaries probably don't get to levels 7-9, anyway (although I know some that do 😉).

Comment entered 2016-02-18 10:50:32 by Learn, Blair (NIH/NCI) [C]

- estimate is 5 points.

Comment entered 2016-04-04 14:40:20 by Englisch, Volker (NIH/NCI) [C]

Without any changes to the macro, it now displays all of the headings included in the document just as I would have expected it. However, I'm guessing you may expect a different result.

Comment entered 2016-04-07 17:52:52 by Englisch, Volker (NIH/NCI) [C]

The changes necessary to achieve the requested output are handled in the QC report. There is most likely nothing that will need to be changed for the Word Macro.

Comment entered 2016-04-08 14:56:48 by Englisch, Volker (NIH/NCI) [C]

There was some formatting required for the new levels that are now included. In order to test this you'll have to copy the file CDR_Marcos.bas from

L:\OCPL\_Cross\CDR\WordStartup

to

C:\CDR\WordStartup

You will need to close MS-Word before copying the file.

Please note: While modifying the macro file I also updated the template creating the CDR Footer. Therefore I will have to make additional changes on the client desktops in order for the Summary macro to work again.
This additional change fixes OCECDR-4070.

Comment entered 2016-04-14 14:11:59 by Juthe, Robin (NIH/NCI) [E]

Reopened in status meeting to address font size of lower-level headings (H5 and higher).

Comment entered 2016-04-21 11:13:15 by Englisch, Volker (NIH/NCI) [C]

I have to quote Alan here: Works for me!

I'm wondering which version of Office you're using and if that makes a difference with the heading size. I went through the process
Create QC Report --> copy/paste to Word and the higher level headings are displayed just like all the other levels.

Comment entered 2016-04-21 13:10:34 by Englisch, Volker (NIH/NCI) [C]

Both, Robin and I are currently unable to reproduce the smaller size of the lower level section headings. Unless the problem re-appears during QC I'm marking the ticket as fixed.

Comment entered 2016-04-28 18:22:48 by Juthe, Robin (NIH/NCI) [E]

As we discussed, please remove levels 6 and deeper from the TOC macro, since these are all showing up with the same indentation as level 5 headings. Thanks!

Comment entered 2016-05-27 15:51:08 by Englisch, Volker (NIH/NCI) [C]

The Word TOC macro has been modified and is displaying up to TOC level 5 only.

The following file has been updated:

  • CDR_Marcos.dotm

Comment entered 2016-06-15 10:13:29 by Juthe, Robin (NIH/NCI) [E]

I am seeing 4 levels - but I may be counting wrong! I will post a screenshot.

Comment entered 2016-06-15 10:55:18 by Englisch, Volker (NIH/NCI) [C]

No, you're counting correctly. The first level is the summary title itself and we didn't want to display the 6th level because it would lump all levels 6-9 to this level since HTML only allows 6 levels in total. This leaves 4 levels to be displayed in the TOC.

Comment entered 2016-06-17 14:53:05 by Englisch, Volker (NIH/NCI) [C]

Can we close this ticket or move it to the backlog so we can close out the Darwin sprint?

Comment entered 2016-06-17 17:49:38 by Juthe, Robin (NIH/NCI) [E]

Yes, we can close this. Thank you!

Attachments
File Name Posted User
screenshot-1.png 2016-06-15 10:13:44 Juthe, Robin (NIH/NCI) [E]

Elapsed: 0:00:00.002072