Various list numbering improvements #565

satsuper · 2014-04-30T03:57:32Z

This PR adds support for displaying multi level list numbering. The approach used was to use a different counter for each level instead of using nested CSS counters. This was because you can limit the levels of numbering displayed to a subset of the current level e.g. displaying two levels

Level 1
    1.1. Level 2
        1.1. Level 3
            1.1. Level 4

The nested counter approach was not compatible with the above option of list numbering.

Also added was continuing the numbering of previous lists in the document. This approach was intially modeled off existing code in OdfCanvas that partially implemented this feature but due to a regression this code was not being reached anymore.

The new approach assigns unique counters to all text:list elements regardless of whether they need to be continued or not. This allows us to circumvent CSS scoping rules that prevent using the same counter across different lists which was how the old approach worked. If a list continues another list in the document it can simply be assigned the unique counters from the list it continues from. This is a cleaner approach overall as it reduces the amount of overridden CSS rules.

Lists can either continue the list directly preceding them in document or they can continue a list anywhere in the document by referencing its xml:id. Both these cases are handled in this PR.

To better illustrate the three main improvements made in this PR I have included a comparison screenshot of WebODF rendering the updated visual-tests.fodt.

kogmbh-ci · 2014-04-30T03:59:28Z

Build failed.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1547/

kogmbh-ci · 2014-05-02T07:59:25Z

Build succeeded.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1552/

peitschie · 2014-05-05T02:17:41Z

webodf/lib/odf/ListStylesToCss.js

+                while (displayLevels > 0) {
+                    content += " counter(" + listCounterName + (textLevel - displayLevels + 1) + "," + stylemap[style] + ")";
+                    if(displayLevels > 1) {
+                        content += '"' + suffix + '"';


Should suffix use the escapeCSSString function?

To clarify, is this expected to add a suffix char after each individual list item? I can't find anything in the ODT specs around how this should work, but from playing with LibreOffice, this seems to be purely a suffix (i.e., after the complete counter). The joining character looks like it's always a decimal.

If this isn't the case, it'd be good to make sure your test document contains a list definition showing the behaviour you expect from this loop.

I had assumed that suffix was also the list separator but your analysis is correct and supported by this helpful link https://wiki.openoffice.org/wiki/Number_labels

peitschie · 2014-05-05T03:19:00Z

Due to the difficulties with getting the actual rendered text from a pseudo element, I'd suggest additional tests be added to webodf/tests/visual-tests.fodt for these new list behaviours. This allows a document that can be loaded and manually verified by a human to ensure WebODF behaviour remains correct.

kogmbh-ci · 2014-05-06T04:51:02Z

Build succeeded.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1558/

peitschie · 2014-05-06T05:54:38Z

webodf/lib/odf/ListStylesToCss.js

+            // check the previous list to be continued has the same list style
+            if (styleName === previousStyleName) {
+                list.setAttributeNS(helperns, "reset-none", "true");
+                rule = 'text|list[webodfhelper|reset-none="true"] ';


I think this is now a general rule that can be placed in webodf.css.

I tried this but this doesn't seem to work as this rule needs to override an existing dynamic rule for the list counter reset.

probably would need to be { counter-reset: none !important; }

kogmbh-ci · 2014-05-06T08:09:37Z

Build failed.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1562/

kogmbh-ci · 2014-05-07T11:46:27Z

Build succeeded.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1577/

peitschie · 2014-05-07T11:53:15Z

webodf/lib/odf/ListStylesToCss.js

+            } else if (node.localName === "list-level-style-bullet") {
+                contentRule = getBulletRule(node);
+            }
+            return contentRule + ';';


The surrounding \n's and the comments above should be kept together with the content rule creation.

kogmbh-ci · 2014-05-08T07:54:27Z

Build succeeded.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1581/

thz · 2014-05-08T07:56:21Z

May I propose to also update the welcome.odt file to feature the improvements with this PR?

peitschie · 2014-05-08T09:03:04Z

@thz we would definitely be open to that. Do you have any suggestions?

kogmbh-ci · 2014-05-09T00:48:58Z

Build succeeded.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1584/

kossebau · 2014-06-10T18:13:59Z

webodf/lib/odf/ListStylesToCss.js

+         * Assigns a unique identifier to this list element and gives it a list counter
+         * using CSS rules that target the unique identifier
+         * @param {!string} id
+         * @param {!Element} listElement


Please note in the API dox that this could be a list or a list-item. Ideally the name of the argument would hint to that as well, because I initially with just listElement understood that this could be just a text:list element and was puzzled by the code.

Have changed some of this code around now, the rule generation method only takes text:list elements while the recursive tree traversal deals with all elements.

kogmbh-ci · 2014-06-16T05:42:59Z

Build succeeded.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1838/

kogmbh-ci · 2014-06-16T07:38:13Z

Build succeeded.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1839/

kogmbh-ci · 2014-07-08T01:01:59Z

Build succeeded.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1916/

satsuper · 2014-07-08T01:08:27Z

Just pushed up a rebase so that this can be looked at again soon

kossebau · 2014-07-10T17:43:25Z

On my schedule for tomorrow/this friday. Really looking forward to get this finally in.

kossebau · 2014-07-11T13:46:54Z

webodf/lib/odf/ListStylesToCss.js

+     * <office:document>
+     *     <text:list>
+     *         <text:list-item/> counter: level1 value: 1
+     *         <text:list>


Thanks for adding the detailed explanation, helps a lot!
One nitpick: the example does not match the ODF spec, <text:list> elements can be only childs of <text:list-item> elements, not <text:list>directly, so the example should be something like

<text:list> <text:list-item> counter: level1 value: 1 <text:list> <text:list-item/> counter: level2 value: 1 </text:list> </text:list-item>

etc.

kossebau · 2014-07-11T15:42:44Z

Cool 🍦 ! Might be that my eyes got tired by looking at it a third(?) time, but could only find those minor problems :) So please work on those, then rebase, for the final testing. I put the "Ship it" stamp already on my desk, to be able to quickly apply it :)

Moved the processing of the list style to get the content rule into a separate method so it can be re used for continue list styles. Also ensured that the new getContentRule function returns a complete rule with the semicolon on the end.

Implemented a changed list counter setup where each list level has its own counter. This is to support behaviour defined where you can display only a subset of the list numbers. This is defined here: http://docs.oasis-open.org/office/v1.2/os/OpenDocument-v1.2-os-part1.html#__RefHeading__1418890_253892949

Giving each list a unique counter allows us to implement continued numbering functionality while avoiding unexpected numbering due to how CSS counter values are scoped to an elements sibilings or children.

This adds support for the text:continue-numbering and text:continue-list attributes. The text:continue-numbering attribute specifies whether to continue the immediately preceding list if it has the same style. http://docs.oasis-open.org/office/v1.2/os/OpenDocument-v1.2-os-part1.html#attribute-text_continue-numbering The text:continue-list attribute specifes the unique identifier of a list to continue numbering from in the document. These must also have the same style. http://docs.oasis-open.org/office/v1.2/os/OpenDocument-v1.2-os-part1.html#attribute-text_continue-list https://tools.oasis-open.org/issues/browse/OFFICE-3558

The removed code was intended to implement continue list functionality. However this code no longer worked due to a regression introduced in commit 3ae9e0c. As I have refactored this area and implemented the continue list functionality in the new list styles class this old code is no longer required. The removed code in OdfCanvas also made use of the getFirstNonWhitespaceChild function in OdfUtils and the removed code was the last remaining usage of it. As it is preferable to make use of DOM API calls which give us the desired behaviour such as element.firstElementChild I have removed this function.

Added unit tests for the continue lists and added some examples of continued and multi level lists to visual-tests.fodt

kogmbh-ci · 2014-07-11T17:40:26Z

Build succeeded.
Refer to this link for build results: http://ci.kogmbh.com/jenkins/job/WebODF-PullReq/1939/

kossebau · 2014-07-11T18:03:57Z

Really good work! Let's have it in master. Please merge!

Various list numbering improvements

peitschie mentioned this pull request Apr 30, 2014

Escape list prefix, suffix and bullet chars in the CSS rules #550

Merged

peitschie reviewed May 5, 2014
View reviewed changes

peitschie reviewed May 6, 2014
View reviewed changes

peitschie reviewed May 7, 2014
View reviewed changes

satsuper changed the title ~~List numbering~~ Various list numbering improvements May 7, 2014

kossebau reviewed Jun 10, 2014
View reviewed changes

kossebau reviewed Jul 11, 2014
View reviewed changes

Satvik Kumar added 6 commits July 12, 2014 02:58

Refactor calculation of CSS content for lists

b97acba

Moved the processing of the list style to get the content rule into a separate method so it can be re used for continue list styles. Also ensured that the new getContentRule function returns a complete rule with the semicolon on the end.

Provide each text:list with a unique CSS counter

88c88c9

Giving each list a unique counter allows us to implement continued numbering functionality while avoiding unexpected numbering due to how CSS counter values are scoped to an elements sibilings or children.

Added tests for continued and multi level lists

f72cf4b

Added unit tests for the continue lists and added some examples of continued and multi level lists to visual-tests.fodt

satsuper added a commit that referenced this pull request Jul 11, 2014

Merge pull request #565 from satsuper/list-numbering

85fff61

Various list numbering improvements

satsuper merged commit 85fff61 into webodf:master Jul 11, 2014

satsuper deleted the list-numbering branch August 8, 2014 01:12

satsuper mentioned this pull request Sep 15, 2014

Handling of nested lists within lists - double/triple/etc bullet points #91

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Various list numbering improvements #565

Various list numbering improvements #565

satsuper commented Apr 30, 2014

kogmbh-ci commented Apr 30, 2014

kogmbh-ci commented May 2, 2014

peitschie May 5, 2014

peitschie May 5, 2014

satsuper May 5, 2014

peitschie commented May 5, 2014

kogmbh-ci commented May 6, 2014

peitschie May 6, 2014

satsuper May 6, 2014

peitschie May 6, 2014

kogmbh-ci commented May 6, 2014

kogmbh-ci commented May 7, 2014

peitschie May 7, 2014

kogmbh-ci commented May 8, 2014

thz commented May 8, 2014

peitschie commented May 8, 2014

kogmbh-ci commented May 9, 2014

kossebau Jun 10, 2014

satsuper Jun 16, 2014

kogmbh-ci commented Jun 16, 2014

kogmbh-ci commented Jun 16, 2014

kogmbh-ci commented Jul 8, 2014

satsuper commented Jul 8, 2014

kossebau commented Jul 10, 2014

kossebau Jul 11, 2014

kossebau commented Jul 11, 2014

kogmbh-ci commented Jul 11, 2014

kossebau commented Jul 11, 2014

Various list numbering improvements #565

Various list numbering improvements #565

Conversation

satsuper commented Apr 30, 2014

kogmbh-ci commented Apr 30, 2014

kogmbh-ci commented May 2, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peitschie commented May 5, 2014

kogmbh-ci commented May 6, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kogmbh-ci commented May 6, 2014

kogmbh-ci commented May 7, 2014

Choose a reason for hiding this comment

kogmbh-ci commented May 8, 2014

thz commented May 8, 2014

peitschie commented May 8, 2014

kogmbh-ci commented May 9, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kogmbh-ci commented Jun 16, 2014

kogmbh-ci commented Jun 16, 2014

kogmbh-ci commented Jul 8, 2014

satsuper commented Jul 8, 2014

kossebau commented Jul 10, 2014

Choose a reason for hiding this comment

kossebau commented Jul 11, 2014

kogmbh-ci commented Jul 11, 2014

kossebau commented Jul 11, 2014