View Issue Details

IDProjectCategoryView StatusLast Update
0016887ScribusGeneralpublic2023-04-05 11:22
Reporterpmjdebruijn Assigned To 
Status newResolutionopen 
Product Version1.6.0.svn 
Summary0016887: Multilevel Table of Content support
DescriptionCurrently the Scribus Table of Contents generator effectively only supports Chapter/Heading1 level table of contents entries. This is problematic for non-trivial documents, which requires manual (and therefore error-prone) intervention to get a multi-level Table of Contents.

This one-liner change, introduces basic multi-level ToC support:

tocMap.insert(key, QString("\t").repeated(objAttr.parameter.toInt() - 1) + objAttr.value);

Important notes:

repeated(n) returns an empty string, if n is 0 or less
toInt() returns 0 on error, so if attribute parameter is empty or has non-numeric content, 0-1=-1, results in an empty string prefix
when parameter has a numeric value of 2(-1=1), results in a single Tab character being prefixed
TagsNo tags attached.



2023-01-08 17:26


tocgenerator-levels.patch (616 bytes)   
Index: a/scribus/tocgenerator.cpp
--- a/scribus/tocgenerator.cpp	(revision 25241)
+++ a/scribus/tocgenerator.cpp	(working copy)
@@ -117,7 +117,7 @@
 				//Third is the section based page number which is actually used in the TOC.
 				QString tocID = QString("%1").arg(pageCounter[currentDocItem->OwnPage]++, 3 , 10, QChar('0'));
 				QString key = QString("%1,%2,%3").arg(pageID, tocID, sectionID);
-				tocMap.insert(key, objAttr.value);
+				tocMap.insert(key, QString("\t").repeated(objAttr.parameter.toInt() - 1) + objAttr.value);
tocgenerator-levels.patch (616 bytes)   


2023-01-08 17:30

reporter   ~0049865

Tab stops need to be setup via the Stylist to actually make it look good of course :)


2023-01-08 17:32

reporter   ~0049866

And I might add a qMin(lvl, 4) to guard against weird behavior if large values are accidentally entered?


2023-01-08 17:43

reporter   ~0049867

Here is a patch with qmin(4, lvl) added
tocgenerator-levels-qmin4.patch (625 bytes)   
Index: a/scribus/tocgenerator.cpp
--- a/scribus/tocgenerator.cpp	(revision 25241)
+++ a/scribus/tocgenerator.cpp	(working copy)
@@ -117,7 +117,7 @@
 				//Third is the section based page number which is actually used in the TOC.
 				QString tocID = QString("%1").arg(pageCounter[currentDocItem->OwnPage]++, 3 , 10, QChar('0'));
 				QString key = QString("%1,%2,%3").arg(pageID, tocID, sectionID);
-				tocMap.insert(key, objAttr.value);
+				tocMap.insert(key, QString("\t").repeated(qMin(4, objAttr.parameter.toInt() - 1)) + objAttr.value);


2023-01-12 17:08

reporter   ~0049886

Here's a screenshot illustrating the crucial part:


2023-01-14 21:13

manager   ~0049927

... just a thought: wouldn't it be better to apply a different styles for each level of the TOC?
(personally, i normally prefer not to indent the TOC)

the simplest way to do so, might be to add a checkbox:

[ ] Use indexed style names for the table of contents

some notes:

- I don't know what would be a good label for the new checkbox... but the one above might be good enough to get started... or you can always use the style and remove the checkbox...
- if the checkbox is checked, only style names that end in 1 are shown in "Paragraph Style"
- for each level use the style with the same name as the one that has been chosen and the correct index (toc_1 -> toc_2; if the style does not exist, use the "highest" that exists)

this might be added in a second step, after the attached patch has been accepted.


2023-01-15 12:15

reporter   ~0049929

I do see this as out of scope for my efforts, but I'm not opposed to having more flexibility.

BTW, not indenting subsection is already the default behavior, because the default style doesn't have any tab stops defined. To get the indent you need to define a tab stop.


2023-01-22 16:13

manager   ~0049965

i gave up on the idea of adding support for multiple TOC styles in the TOC frame. (in favor of a python only solution)

since now there is a ok way to create style based multilevel TOCs, i would prefer to see some work towards a real style based TOC in scribus that replaces the current implementation rather than putting more efforts in a tool that is basically broken by design.


2023-01-22 19:38

reporter   ~0049966

Given the trivial nature of the change, I don't see why long term future development should prevent my patch from being applied, as it immediately makes the toc generator more useful.


2023-01-23 09:36

manager   ~0049967

yes, it's a trivial patch.
and it should be a trivial thing to accept it.

the problem with it, is that -- in my eyes -- adding a tab is the wrong way to do the multilevel TOC.
it really should apply different styles.

that is not a huge problem per se.
but i really fear that if the tab "feature" gets added now, future versions of the TOC might need to support that too (the team has a hard time removing features, even if it's very likely that nobody uses them).
and that would be a useless complexity. (and scribus is full of such things!)

all in all: i still believe that the current TOC tool is not usable (for trivial TOCs you'd better write them as text; for complex ones you won't be able to fill the attributes with the titles and it's really impossible to make sure that edits in the titles are reflected in the attributes).

the script i've wrote make it usable, if there is the support for a multilevel TOC.
but if you need to run a script, why would you want it to fill the attribute and then run the TOC tool and still not get proper styles in the TOC... if you can run a better script that directly fills the TOC?

i understand that you did some work and it would be a pity to throw it away... but, in this case, it might be for the better (in exchange you get a nice script that creates TOCs with styles : - )


2023-01-24 16:51

reporter   ~0049970

That's a concern I get, though it's 2023, and Scribus still doesn't have multi-level ToC, so I'm not exactly hopeful for a "proper" implementation of multi-level ToC any time soon, and while I totally get you've had to prioritize given limited resources...

Given there's no real alternative on the horizon, isn't the tiny long term risk worth taking, so Scribus gains this fairly rudimentary function?


2023-01-24 18:23

manager   ~0049972

as said, you can use the script i've put in my github repository... utnik tested it and i fixed a couple of bugs already that he has reported...

on the other side, i'm all for having a real TOC (and remove the thing that is now in scribus) and maybe my script can be used as a prototype for the real thing in scribus.


2023-01-25 16:24

reporter   ~0049975

I thought you had given up on that... Presumably you mean:

BTW, I'd suggest using (by default) 'Heading 1', 'Heading 2', 'Heading 3' and 'Content 1', 'Content 2', 'Content 3' respectively, since this is what LibreOffice Writer uses.


2023-04-05 10:53

reporter   ~0050075

@ale, I've just tested but it doesn't seem to account for Document Sections, which incorrect page numbers are generated for non-trivial documents.


2023-04-05 10:55

reporter   ~0050076

@ale also overwriting whatever frame is currently selection isn't ideal either, it would be rather nice if the Destination Frame from the Table of Contents properties could be used.

Luna Nightshade

2023-04-05 11:22

reporter   ~0050077

Multilevel TOC would be nice. Doing this with a TAB though is (1)cumbersome and (2) unintuitive.

As for how I'd implement the feature - which is probably a lot of work - I'd add a checkbox to the paragraph styles "Use in TOC". This should give a sub-style (maybe another Tab in the Styles-Section dubbed ToC-Style; that has all the style-features a Paragraph allows). Then on generating the ToC, the ToC-Substyle would be used for the ToC.
An easier way would be to create another Paragraph-Style automatically when that check-box is set, and name it ToC-{ParagraphName}. Which would probably be a lot easier to implement.
This should give an intuitive way of doing the multilevel ToC.

The more hidden ToC-Approach, that would build on what's currently there, would be to add a fixed Attribute of "ToC-Style". It's probably even quicker to implement, but, as others have already said, more prone to errors.

Issue History

Date Modified Username Field Change
2023-01-08 17:26 pmjdebruijn New Issue
2023-01-08 17:26 pmjdebruijn File Added: tocgenerator-levels.patch
2023-01-08 17:30 pmjdebruijn Note Added: 0049865
2023-01-08 17:32 pmjdebruijn Note Added: 0049866
2023-01-08 17:43 pmjdebruijn Note Added: 0049867
2023-01-08 17:43 pmjdebruijn File Added: tocgenerator-levels-qmin4.patch
2023-01-12 17:08 pmjdebruijn Note Added: 0049886
2023-01-12 17:08 pmjdebruijn File Added: scribus_tableofcontents_parameter.png
2023-01-14 21:13 ale Note Added: 0049927
2023-01-15 12:15 pmjdebruijn Note Added: 0049929
2023-01-22 16:13 ale Note Added: 0049965
2023-01-22 19:38 pmjdebruijn Note Added: 0049966
2023-01-23 09:36 ale Note Added: 0049967
2023-01-24 16:51 pmjdebruijn Note Added: 0049970
2023-01-24 18:23 ale Note Added: 0049972
2023-01-25 16:24 pmjdebruijn Note Added: 0049975
2023-04-05 10:53 pmjdebruijn Note Added: 0050075
2023-04-05 10:55 pmjdebruijn Note Added: 0050076
2023-04-05 11:22 Luna Nightshade Note Added: 0050077