Download it now!
Bug 44448 - Option to auto-update Table of Contents, or question offered to do so at printing, is desirable
Summary: Option to auto-update Table of Contents, or question offered to do so at prin...
Status: NEW
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Writer (show other bugs)
Version:
(earliest affected)
Inherited From OOo
Hardware: Other All
: high enhancement
Assignee: Not Assigned
URL:
Whiteboard:
Keywords:
: 89596 96834 103107 133048 135339 (view as bug list)
Depends on:
Blocks: TableofContents-Indexes
  Show dependency treegraph
 
Reported: 2012-01-04 03:00 UTC by Winfried Donkers
Modified: 2020-09-25 05:41 UTC (History)
20 users (show)

See Also:
Crash report or crash signature:


Attachments
New Check Boxes for "Indexes And Tables" (87.76 KB, image/png)
2016-09-27 12:10 UTC, Muhammet Kara
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Winfried Donkers 2012-01-04 03:00:24 UTC
Presently, a TOC is not updated automaticaly and must be updated manually.

It would be very usefull if an TOC-update is executed or suggested before printing/saving.
Comment 1 Winfried Donkers 2012-01-04 03:02:08 UTC
Possibly related to bug 34121 ?
Comment 2 Mohith Manoj 2012-01-21 01:09:19 UTC
The problem is more difficult to live with if your document contains hidden paragraphs that are hidden from PDF or printed outputs.

I have this writer document template which contains conditionally hidden paragraphs which are hidden from PDF and printed outputs. 

Suppose I have a heading in page 4 and page 3 is full of hidden paragraphs (hidden from print / pdf only). This heading will be included in the TOC and page number would read 4. Now I enter a cross-reference to the page number of this heading anywhere within the document. This also would read 4 (for now). Then when I print this document the TOC would say that the heading is still in page 4 and the cross-reference would say its in 3 which is correct by the way.

The only work around I have is to instruct my users to disable display of hidden paragraphs, update TOC and then print.
Comment 3 Cor Nouws 2013-03-30 23:09:12 UTC
Good idea :-)
Looks as an easy hack?
Comment 4 Winfried Donkers 2013-05-03 11:58:51 UTC Comment hidden (obsolete)
Comment 5 Cor Nouws 2013-05-03 21:00:25 UTC Comment hidden (obsolete)
Comment 6 Winfried Donkers 2013-05-06 05:47:04 UTC Comment hidden (obsolete)
Comment 7 Cor Nouws 2014-11-04 20:47:31 UTC Comment hidden (obsolete)
Comment 8 Arnaud Versini 2015-02-25 19:43:10 UTC
*** Bug 89596 has been marked as a duplicate of this bug. ***
Comment 9 Cor Nouws 2015-12-30 19:45:32 UTC
*** Bug 96834 has been marked as a duplicate of this bug. ***
Comment 10 Muhammet Kara 2016-09-07 08:27:31 UTC Comment hidden (obsolete)
Comment 11 Muhammet Kara 2016-09-07 08:35:39 UTC
(In reply to Muhammet Kara from comment #10)
> The bug is still valid on 5.2.0.4. Actually, TOC is not updated either on
> save or print.

Also the same on:

Version: 5.3.0.0.alpha0+
Build ID: f7dd958ad383c31fe380273d4a59e24fe6fe8caf
CPU Threads: 4; OS Version: Linux 4.6; UI Render: default; 
Locale: en-US (en_US.utf8);


I would like to fix this. Any code pointers?
Comment 12 Winfried Donkers (retired) 2016-09-07 08:47:26 UTC Comment hidden (obsolete)
Comment 13 Cor Nouws 2016-09-07 09:27:42 UTC Comment hidden (obsolete)
Comment 14 jani 2016-09-07 09:47:47 UTC
(In reply to Cor Nouws from comment #13)
> Hi Muhammet,
> 
> (In reply to Muhammet Kara from comment #11)
> > 
> > I would like to fix this. Any code pointers?
> 
> kind! @jani, can you help Muhammet finding the right people (if he not
> already did on irc ;) )

Please remark that bug is still at "needDevEval" set so I am afraid code pointers as such is not enough. This is also not a easyHack and looking at the code it is a complicated bug.

But as suggested earlier, IRC is the best place to ask for pointers, and maybe understand why it still has needsDevEval set (which normally means it is something not very simple).

A good person to talk to on IRC is sweetshark.

have fun, looking forward to see your work.
Comment 15 Cor Nouws 2016-09-08 07:59:30 UTC
(In reply to jan iversen from comment #14)

> Please remark that bug is still at "needDevEval" set so I am afraid code
> pointers as such is not enough. This is also not a easyHack and looking at
> the code it is a complicated bug.

Then maybe first back to discussion..

A possible way to circumvent that complicated part may be:
  - user starts print / pdf export
  - a dialog pops up
    "Do you want to update the TOC first"
    [ ]  do not show this question again
           [ YES ]   [  NO  ] 

Similar to Overwrite warning in Calc.

What do the UX people think of this?
Comment 16 Yousuf Philips (jay) (retired) 2016-09-09 20:20:45 UTC
I've used TOCs and never saw the point of having to manually refresh it, i would compare it to creating a chart and then manually telling it to refresh it after i changed some of the values associated to it.

So i'd suggest that the TOC be automatically refreshed without user prompt when a document is saved and before the launch of the print dialog.
Comment 17 Cor Nouws 2016-09-09 20:39:00 UTC
(In reply to Yousuf Philips (jay) from comment #16)
> I've used TOCs and never saw the point of having to manually refresh it, 

From what I remember, Word did not do this automatically always.
So Google learns me there is the setting Options > Print > Update fields
Comment 18 Muhammet Kara 2016-09-27 12:08:40 UTC
What about adding some check boxes to the options of Writer?

There is already some checkboxes for Fields and Charts. What I understand from the LO Help is that these fields are automatically updated whenever their linked fields are updated. So the timing of updates seems a little different than what we discuss here.

Please check the attached screenshot to see what I mean. (I added the "Indexes and Tables" part.)
Comment 19 Muhammet Kara 2016-09-27 12:10:00 UTC
Created attachment 127669 [details]
New Check Boxes for "Indexes And Tables"
Comment 20 Yousuf Philips (jay) (retired) 2016-09-28 10:32:05 UTC
Unless we can identify a scenario that there would be a reason why a user wouldnt want this behaviour, i wouldnt suggest adding it to the already bloated options dialog. But if we have to add it to options dialog, then a single entry would be sufficient called 'Indexes and Tables' and have it in the 'Automatically Update' section.
Comment 21 Muhammet Kara 2016-10-04 12:11:12 UTC
(In reply to Yousuf Philips (jay) from comment #20)
> Unless we can identify a scenario that there would be a reason why a user
> wouldnt want this behaviour, i wouldnt suggest adding it to the already
> bloated options dialog. But if we have to add it to options dialog, then a
> single entry would be sufficient called 'Indexes and Tables' and have it in
> the 'Automatically Update' section.

I agree that the natural flow would be automatically updating those tables and indexes on save/print. I wonder if some users would want to disable this feature for performance reasons (maybe while working on very large documents?).
Comment 22 Yousuf Philips (jay) (retired) 2016-10-17 04:43:04 UTC
*** Bug 103107 has been marked as a duplicate of this bug. ***
Comment 23 Muhammet Kara 2016-10-25 05:54:06 UTC
De-assigning for now to avoid blocking others' work. I'll get back to this if not fixed after a while. Sorry for the noise.
Comment 24 Yousuf Philips (jay) (retired) 2017-05-03 17:36:43 UTC
(In reply to Muhammet Kara from comment #21)
> I agree that the natural flow would be automatically updating those tables
> and indexes on save/print. I wonder if some users would want to disable this
> feature for performance reasons (maybe while working on very large
> documents?).

Well printing the most accurate document would always be in the user's interest so i doubt there would be an issue there. For save, which a user can do multiple times in a session, if the updating of the ToC can always be done with minimal performance reduction to the saving process, then that would be idea. Else it should be done when the user saves during closing the document, which would only occur once.

@Heiko: What's your take?

@Muhammet: So you gonna take this back on as its been 6 months?
Comment 25 Heiko Tietze 2017-05-03 20:20:18 UTC
(In reply to Yousuf Philips (jay) from comment #24)
> @Heiko: What's your take?

Dont get the point why someone wants to print/save without updating the TOC. But Benjamin would also want to refresh it manually to ensure that things went right. Similar to a print preview. Putting that together an auto update checkbox being enabled by default sounds reasonable to me.
Comment 26 Ferdinand 2017-05-05 17:29:33 UTC
IMO there is no reason to NOT update the TOC on preview/print/save/create pdf/send/etc.

it's annoying to realize that the TOC was not updated prior printing, have to throw away paper.

it's embarrassing to hand out documents with wrong TOC, it does not look like professional work.

just my 2c
Comment 27 Cor Nouws 2018-09-24 22:19:10 UTC Comment hidden (no-value)
Comment 28 Daniel Frost 2018-09-25 19:45:27 UTC
Thumbs up for an automaticaly updated TOC from me as well!
Comment 29 Dieter 2020-05-18 16:52:47 UTC
*** Bug 133048 has been marked as a duplicate of this bug. ***
Comment 30 Rizal Muttaqin 2020-05-18 22:10:20 UTC
In my case, I often create many Writer documents from a file. So when I change a header in the original file, I had to update its ToC and repeating tirelessly every ToC of all the documents. In some cases, I can trick the header by adding some fields so I just need to change it in the document properties. But the story of ToC quietly different, especially when I forget to update in a hurry situation.

Adding an option to make it updated automatically by default would not make it cluterred. We talk about an important part of a document here. I am not sure how this would affect performance but we have field and chart being update automatically by default. So, set is automatic update by default would might be no issue. Otherwise, we can set it to be updated after saving/printing.
Comment 31 Timur 2020-08-02 15:13:57 UTC
*** Bug 135339 has been marked as a duplicate of this bug. ***
Comment 32 Heiko Tietze 2020-08-06 14:42:25 UTC Comment hidden (obsolete)
Comment 33 Heiko Tietze 2020-08-07 11:13:48 UTC
(In reply to Heiko Tietze from comment #32)
> Is this change really desperately needed? Importance is high...

Given the number of duplicates and people on CC it is a highly expected feature. So my take: keep it high. (It was questioned whether enhancement can have a high importance at all. It makes a lot of sense to me and I like the clear rules to set it.)

Skimming through the comments it looks like automatic update is welcome, even without an option to switch it off. Rizal is right, OTOH, the option wouldn't clutter too much and fits well into the current dialog.

Muhammet, as you were interested in this topic, could you please add a code pointer? Shouldn't be too difficult.

Don't see the need for deveval, removing the keyword.
Comment 34 Daniel Frost 2020-09-25 05:41:00 UTC
I certainly (still) back the importance of this feature. :-)

(I think) It is quite natural to open the TOC's context menu for refreshing the TOC. So placing an option there seems a good alternative too. A tick-option could be added to the TOC's context menu.
Example: tables context menu, entry *template*, subentry *linebreak on end of page*