Add list package for creating lists #614

Darkyenus · 2019-05-10T10:54:42Z

Supports:

numbered/ordered lists with arbitrary numbering (based on counters)
non-numbered lists with different bullets for each nesting level
nesting
text does not flow under the bullet/number (what happens currently in the SILE book)

Not done:

Not tested for RTL
Gaps for bullets/numbers should probably adapt to their real width, now they are sometimes too large. This is a concern especially if it should allow something like this (text "bullets" with custom alignment). I don't know how to do that.
Think more about the system of bullet styling. Current system does not allow for e.g. numbers in parentheses, alternating bullets by row, etc. One idea would be to define global object which holds all styles by their name. Styles would then be represented by a function, which would return a texlike string for given nest level and item number. (The function could be replaced with tables and/or strings for less complex styles.) Example:

ListStyle.bullet = { {"•"}, {"◦"} }

ListStyle.arabic = function (nestLevel) 
    return function (itemNumber) return itemNumber .. "." end
end

Current output:

\begin[class=plain]{document}
\script[src=packages/list]
\font[family=Arial, size=15pt]
Quis ipsa omnis aut nihil sed sit. Quaerat minus aut est et. Laudantium aut corporis in rem animi repudiandae. Et facere aut beatae.
\begin{list}
\list:item{First}
\list:item{Second}
\begin[numbered=true]{list}
\list:item{Uno}
\list:item{Dos}
\begin{list}
\list:item{Three times nested}
\end{list}
\end{list}     %
\begin{list}     %
\list:item{Two times nested}
\end{list}
\end{list}
Facere dolores eligendi a reiciendis alias quaerat atque esse. Ut quia assumenda nesciunt alias illum. Perspiciatis et dolorum tempore doloremque.
\end{document}

simoncozens · 2019-05-11T10:05:44Z

This is much needed, thank you. “Two times nested” should start with a 3, not an open bullet, shouldn’t it?

Darkyenus · 2019-05-11T12:12:55Z

No, that is intentional, but a bad example. Imagine another top level bullet "Third" right before it, then it will make more sense. What you suggest is of course also possible, just without the two lines that I have marked with comment in above code.

alerque · 2019-05-11T12:21:19Z

packages/list.lua

+  local topLevel = level == 1
+  if topLevel then SILE.call("smallskip") else SILE.typesetter:leaveHmode() end
+
+  local numbered = SU.boolean(options.numbered, SU.boolean(options.ordered, options.numbering ~= nil))


The mashup of variable names "options.numbered", "options.ordered", and "options.numbering" here combined with nested boolean tests is a bit confusing.

I didn't know which one is better. I would pick based on precedent (html - unordered/ordered, tex - ?), but allowing both as an alias could be also fine, users wouldn't have to remember it.

In the grand scheme of things, it could be useful to implement a system which warns for unused options and possibly knows and suggests valid options. But right now, if I specify for example \list[unordered=false], it won't work and I will get no warning. So if I don't notice incorrect output, I am out of luck. But it wouldn't be hard to do warning like:

! Option unordered is not used. Did you mean: ordered, numbering or bullet?

That is obviously completely out of scope for this PR, but I could contribute it sometime in the future, if you want.

Obscure, not understandable.

Omikhleia · 2022-04-14T22:27:02Z

packages/list.lua

+end)
+
+SILE.registerCommand("list:item", function (options, content)
+  local settings = SILE.scratch.listStack[#SILE.scratch.listStack]


Using a global. What happens if one has, says, for the mere example a footnote in list, and a list in the footnote? A mess.

And what is expected if one mistakenly calls this list:item outside a list.

Omikhleia · 2022-04-14T22:28:48Z

packages/list.lua

+SILE.settings.declare({
+  name = "list.bullet.inset",
+  type = "Length",
+  default = SILE.length.parse("1.3em"),


Same for bullets and numbering. Ever tried it with roman numerals?

Omikhleia · 2022-04-14T22:31:43Z

packages/list.lua

+  end)
+  SILE.scratch.listStack[#SILE.scratch.listStack] = nil
+
+  if topLevel then SILE.call("smallskip") else SILE.typesetter:leaveHmode() end


Oh, a hard-coded smallskip. Explain. Now set a parskip and explain the expected behavior.

Omikhleia · 2022-04-14T22:32:39Z

packages/list.lua

+  SILE.scratch.listStack[#SILE.scratch.listStack] = nil
+
+  if topLevel then SILE.call("smallskip") else SILE.typesetter:leaveHmode() end
+  SILE.call("noindent") -- list does not create a new paragraph


Ah? They do not create a new paragraph after them? Explain why.

Omikhleia · 2022-04-14T22:33:55Z

packages/list.lua

+\command{\\list:item} has option \code{number}, to override the number of the item in case of numbered lists.
+By default, the numbered list starts at 1 and each item has a number that is one bigger than of the previous one.
+
+Lists can be arbitrarily nested.


Proof? When the documentation doesn't show it, and there are not a single test case, am I to believe it?

Omikhleia · 2022-04-14T22:39:41Z

packages/list.lua

+\code{bullet} a string with explicit bullet character to use.
+\code{numbering} a string denoting the numbering system to use for ordered lists.
+See the documentation of counters for possible values.
+\code{lskip} width reserved for the bullets.


The list seems to use options.rskip (but should it?). Maybe I missed it above, but I didn't see any any options.lskip...

Omikhleia · 2022-04-14T22:43:02Z

packages/list.lua

+SILE.settings.declare({
+  name = "list.bullet.numbered",
+  type = "string",
+  default = ".",


So it's a dot. Weird name then, list.bullet.numbered (you are numbering bullets as dots? Heh.)

Omikhleia · 2022-04-14T22:47:44Z

packages/list.lua

+  local baseLSkip = SILE.settings.get("document.lskip")
+  baseLSkip = baseLSkip and baseLSkip.width or SILE.length.new()
+  SILE.settings.temporarily(function ()
+    SILE.settings.set("document.lskip", SILE.nodefactory.newGlue({width = baseLSkip + inset}))


How does it look if the paragraph before the list has a parindent > inset ? ;)

Omikhleia · 2022-04-14T23:02:02Z

Some good points, but I think the implementation is not robust enough. I added a few comments, but I don't ask for them to be fixed here. I wanted to see how my own implementation (which I will propose at one point) compare to this, and if there were ideas I had possibly missed. Overall, I think we can do better.

See #1365

Omikhleia · 2022-08-14T07:46:52Z

I think this could now be closed without merge, since we got #1365 instead - With obviously many thanks to @alerque for the early casile attempt mentioned above and to @Darkyenus for this very PR - You were, how do we say, pioneers or precursors here! Looking at this code obviously helped a lot in reaching #1365 targets.

wip(list): Add list package for creating lists

493f020

alerque reviewed May 11, 2019

View reviewed changes

alerque force-pushed the master branch from 4c31fcf to 8172455 Compare July 18, 2020 15:57

Omikhleia reviewed Apr 14, 2022

View reviewed changes

alerque closed this Aug 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add list package for creating lists #614

Add list package for creating lists #614

Darkyenus commented May 10, 2019 •

edited

Loading

simoncozens commented May 11, 2019

Darkyenus commented May 11, 2019

alerque May 11, 2019

Darkyenus May 11, 2019

Omikhleia Apr 14, 2022

Omikhleia Apr 14, 2022

Omikhleia Apr 14, 2022

Omikhleia Apr 14, 2022 •

edited

Loading

Omikhleia Apr 14, 2022

Omikhleia Apr 14, 2022

Omikhleia Apr 14, 2022

Omikhleia Apr 14, 2022

Omikhleia Apr 14, 2022

Omikhleia Apr 14, 2022

Omikhleia commented Apr 14, 2022 •

edited

Loading

Omikhleia commented Aug 14, 2022

Add list package for creating lists #614

Add list package for creating lists #614

Conversation

Darkyenus commented May 10, 2019 • edited Loading

Supports:

Not done:

Current output:

simoncozens commented May 11, 2019

Darkyenus commented May 11, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Omikhleia Apr 14, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Omikhleia commented Apr 14, 2022 • edited Loading

Omikhleia commented Aug 14, 2022

Darkyenus commented May 10, 2019 •

edited

Loading

Omikhleia Apr 14, 2022 •

edited

Loading

Omikhleia commented Apr 14, 2022 •

edited

Loading