Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove redundant parameters to fancy list item renderers and fix tight fancy lists #170

Merged
merged 2 commits into from
Aug 21, 2022
+105 −93
Merged

Remove redundant parameters to fancy list item renderers and fix tight fancy lists #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fcf3ad
Remove redundant parameters to fancy list item renderers
Witiko Aug 19, 2022
069bd4a
Fix tight fancy losts
Witiko Aug 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 87 additions & 33 deletions markdown.dtx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11314,9 +11314,7 @@ receives a single numeric argument that corresponds to the item number.
The \mdef{markdownRendererFancyOlItem} macro represents an item in a fancy
ordered list. This macro will only be produced, when the \Opt{startNumber}
option is disabled and the \Opt{fancyLists} option is enabled. The macro receives
two arguments: the style of the list item labels, and the style of delimiters
between list item labels and texts. See the
\mref{markdownRendererFancyOlBegin} macro for the valid style values.
no arguments.

% \end{markdown}
%
Expand All @@ -11335,7 +11333,7 @@ between list item labels and texts. See the
\prop_put:Nnn
\g_@@_renderer_arities_prop
{ fancyOlItem }
{ 2 }
{ 0 }
\ExplSyntaxOff
% \end{macrocode}
% \par
Expand Down Expand Up @@ -11382,10 +11380,8 @@ option is enabled. The macro receives no arguments.

The \mdef{markdownRendererFancyOlItemWithNumber} macro represents an item in a
fancy ordered list. This macro will only be produced, when the \Opt{startNumber}
and \Opt{tightLists} options are enabled. The macro receives three arguments:
the style of the list item labels, the style of delimiters between list item
labels and texts, and the item number. See the
\mref{markdownRendererFancyOlBegin} macro for the valid style values.
and \Opt{fancyLists} options are enabled. The macro receives a single numeric
argument that corresponds to the item number.

% \end{markdown}
%
Expand All @@ -11404,7 +11400,7 @@ labels and texts, and the item number. See the
\prop_put:Nnn
\g_@@_renderer_arities_prop
{ fancyOlItemWithNumber }
{ 3 }
{ 1 }
\ExplSyntaxOff
% \end{macrocode}
% \par
Expand Down Expand Up @@ -22568,7 +22564,7 @@ M.extensions.fancy_lists = function()
local buffer = {}
local num = startnum
for _,item in ipairs(items) do
buffer[#buffer + 1] = self.fancyitem(item,numstyle,numdelim,num)
buffer[#buffer + 1] = self.fancyitem(item,num)
if num ~= nil then
num = num + 1
end
Expand All @@ -22589,20 +22585,17 @@ M.extensions.fancy_lists = function()
%
% Define \luamdef{writer->fancyitem} as a function that will transform an
% input fancy ordered list item to the output format, where `s` is the text of
% the list item, `numstyle` is the style of the list item labels, and
% `numdelim` is the style of delimiters between list item labels. If the
% optional parameter `num` is present, it is the number of the list item.
% the list item. If the optional parameter `num` is present, it is the number
% of the list item.
%
% \end{markdown}
% \begin{macrocode}
function self.fancyitem(s,numstyle,numdelim,num)
function self.fancyitem(s,num)
if num ~= nil then
return {"\\markdownRendererFancyOlItemWithNumber{",numstyle,
"}{",numdelim,"}{",num,"}",s,
return {"\\markdownRendererFancyOlItemWithNumber{",num,"}",s,
"\\markdownRendererFancyOlItemEnd "}
else
return {"\\markdownRendererFancyOlItem{",numstyle,"}{",numdelim,
"}",s,"\\markdownRendererFancyOlItemEnd "}
return {"\\markdownRendererFancyOlItem ",s,"\\markdownRendererFancyOlItemEnd "}
end
end
end, extend_reader = function(self)
Expand All @@ -22625,6 +22618,35 @@ M.extensions.fancy_lists = function()
* (parsers.tab + parsers.space^-1)
+ parsers.space * parsers.space * C(label^1
* numdelim) * #parsers.spacing
local starter = parsers.bullet + enumerator

local NestedList = Cs((parsers.optionallyindentedline
- starter)^1)
/ function(a) return "\001"..a end

local ListBlockLine = parsers.optionallyindentedline
- parsers.blankline - (parsers.indent^-1
* starter)

local ListBlock = parsers.line * ListBlockLine^0

local ListContinuationBlock = parsers.blanklines * (parsers.indent / "")
* ListBlock

local TightListItem = function(starter)
return -parsers.HorizontalRule
* (Cs(starter / "" * parsers.tickbox^-1 * ListBlock * NestedList^-1)
/ self.parser_functions.parse_blocks_nested)
* -(parsers.blanklines * parsers.indent)
end

local LooseListItem = function(starter)
return -parsers.HorizontalRule
* Cs( starter / "" * parsers.tickbox^-1 * ListBlock * Cc("\n")
* (NestedList + ListContinuationBlock^0)
* (parsers.blanklines / "\n\n")
) / self.parser_functions.parse_blocks_nested
end

local function roman2number(roman)
local romans = { ["L"] = 50, ["X"] = 10, ["V"] = 5, ["I"] = 1 }
Expand Down Expand Up @@ -22687,11 +22709,11 @@ M.extensions.fancy_lists = function()
end

local FancyList = Cg(enumerator, "listtype") *
( Ct(parsers.TightListItem(Cb("listtype"))
* parsers.TightListItem(enumerator)^0)
( Ct(TightListItem(Cb("listtype"))
* TightListItem(enumerator)^0)
* Cc(true) * parsers.skipblanklines * -enumerator
+ Ct(parsers.LooseListItem(Cb("listtype"))
* parsers.LooseListItem(enumerator)^0)
+ Ct(LooseListItem(Cb("listtype"))
* LooseListItem(enumerator)^0)
* Cc(false) * parsers.skipblanklines
) * Cb("listtype") / fancylist

Expand Down Expand Up @@ -22954,8 +22976,8 @@ end
\def\markdownRendererOlItemPrototype{}%
\def\markdownRendererOlItemWithNumberPrototype#1{}%
\def\markdownRendererOlItemEndPrototype{}%
\def\markdownRendererFancyOlItemPrototype#1#2{\markdownRendererOlItem}%
\def\markdownRendererFancyOlItemWithNumberPrototype#1#2#3{\markdownRendererOlItemWithNumber{#3}}%
\def\markdownRendererFancyOlItemPrototype{\markdownRendererOlItem}%
\def\markdownRendererFancyOlItemWithNumberPrototype{\markdownRendererOlItemWithNumber}%
\def\markdownRendererFancyOlItemEndPrototype{}%
\def\markdownRendererOlEndPrototype{}%
\def\markdownRendererOlEndTightPrototype{}%
Expand Down Expand Up @@ -24326,8 +24348,12 @@ end
% \begin{macrocode}
\ExplSyntaxOn
\@ifpackageloaded{paralist}{
\tl_new:N
\l_@@_latex_fancy_list_item_label_number_style_tl
\tl_new:N
\l_@@_latex_fancy_list_item_label_delimiter_style_tl
\cs_new:Nn
\@@_latex_translate_list_item_label_number:nn
\@@_latex_fancy_list_item_label_number:nn
{
\str_case:nn
{ #1 }
Expand All @@ -24340,7 +24366,7 @@ end
}
}
\cs_new:Nn
\@@_latex_translate_list_item_label_delimiter:n
\@@_latex_fancy_list_item_label_delimiter:n
{
\str_case:nn
{ #1 }
Expand All @@ -24351,11 +24377,11 @@ end
}
}
\cs_new:Nn
\@@_latex_translate_list_item_label:nnn
\@@_latex_fancy_list_item_label:nnn
{
\@@_latex_translate_list_item_label_delimiter:n
\@@_latex_fancy_list_item_label_delimiter:n
{ #2 }
\@@_latex_translate_list_item_label_number:nn
\@@_latex_fancy_list_item_label_number:nn
{ #1 }
{ #3 }
}
Expand All @@ -24371,28 +24397,56 @@ end
{ LowerAlpha } { a }
{ UpperAlpha } { A }
}
\@@_latex_translate_list_item_label_delimiter:n
\@@_latex_fancy_list_item_label_delimiter:n
{ #2 }
}
\markdownSetup{rendererPrototypes={
ulBeginTight = {\begin{compactitem}},
ulEndTight = {\end{compactitem}},
fancyOlBegin = {
\group_begin:
\tl_set:Nn
\l_@@_latex_fancy_list_item_label_number_style_tl
{ #1 }
\tl_set:Nn
\l_@@_latex_fancy_list_item_label_delimiter_style_tl
{ #2 }
\begin{enumerate}[ \@@_latex_paralist_style:nn { #1 } { #2 } ]
},
fancyOlEnd = {\end{enumerate}},
fancyOlEnd = {
\end{enumerate}
\group_end:
},
olBeginTight = {\begin{compactenum}},
olEndTight = {\end{compactenum}},
fancyOlBeginTight = {
\group_begin:
\tl_set:Nn
\l_@@_latex_fancy_list_item_label_number_style_tl
{ #1 }
\tl_set:Nn
\l_@@_latex_fancy_list_item_label_delimiter_style_tl
{ #2 }
\begin{compactenum}[ \@@_latex_paralist_style:nn { #1 } { #2 } ]
},
fancyOlEndTight = {\end{compactenum}},
fancyOlEndTight = {
\end{compactenum}
\group_end:
},
fancyOlItemWithNumber = {
\markdownRendererOlItemWithNumber
{ \@@_latex_translate_list_item_label:nnn { #1 } { #2 } { #3 } }
{
\@@_latex_fancy_list_item_label:VVn
\l_@@_latex_fancy_list_item_label_number_style_tl
\l_@@_latex_fancy_list_item_label_delimiter_style_tl
{ #1 }
}
},
dlBeginTight = {\begin{compactdesc}},
dlEndTight = {\end{compactdesc}}}}
\cs_generate_variant:Nn
\@@_latex_fancy_list_item_label:nnn
{ VVn }
}{
\markdownSetup{rendererPrototypes={
ulBeginTight = {\markdownRendererUlBegin},
Expand Down
11 changes: 2 additions & 9 deletions tests/support/markdownthemewitiko_markdown_test.sty
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,18 +128,11 @@
olItemWithNumber = {%
\TYPE{olItemWithNumber: #1}},
fancyOlItem = {%
\TYPE{BEGIN fancyOlItem}%
\TYPE{- numstyle: #1}%
\TYPE{- numdelim: #2}%
\TYPE{END fancyOlItem}},
\TYPE{fancyOlItem}},
fancyOlItemEnd = {%
\TYPE{fancyOlItemEnd}},
fancyOlItemWithNumber = {%
\TYPE{BEGIN fancyOlItemWithNumber}%
\TYPE{- numstyle: #1}%
\TYPE{- numdelim: #2}%
\TYPE{- number: #3}%
\TYPE{END fancyOlItemWithNumber}},
\TYPE{fancyOlItemWithNumber: #1}},
olEnd = {%
\TYPE{olEnd}},
olEndTight = {%
Expand Down
15 changes: 4 additions & 11 deletions tests/support/plain-setup.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,19 +112,12 @@
\TYPE{olItemEnd}}%
\def\markdownRendererOlItemWithNumber#1{%
\TYPE{olItemWithNumber: #1}}%
\def\markdownRendererFancyOlItem#1#2{%
\TYPE{BEGIN fancyOlItem}%
\TYPE{- numstyle: #1}%
\TYPE{- numdelim: #2}%
\TYPE{END fancyOlItem}}%
\def\markdownRendererFancyOlItem{%
\TYPE{fancyOlItem}}%
\def\markdownRendererFancyOlItemEnd{%
\TYPE{fancyOlItemEnd}}%
\def\markdownRendererFancyOlItemWithNumber#1#2#3{%
\TYPE{BEGIN fancyOlItemWithNumber}%
\TYPE{- numstyle: #1}%
\TYPE{- numdelim: #2}%
\TYPE{- number: #3}%
\TYPE{END fancyOlItemWithNumber}}%
\def\markdownRendererFancyOlItemWithNumber#1{%
\TYPE{fancyOlItemWithNumber: #1}}%
\def\markdownRendererOlEnd{%
\TYPE{olEnd}}%
\def\markdownRendererOlEndTight{%
Expand Down
52 changes: 12 additions & 40 deletions tests/testfiles/lunamark-markdown/fancy-lists.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,9 @@ BEGIN fancyOlBegin
- numstyle: LowerRoman
- numdelim: Period
END fancyOlBegin
BEGIN fancyOlItemWithNumber
- numstyle: LowerRoman
- numdelim: Period
- number: 4
END fancyOlItemWithNumber
fancyOlItemWithNumber: 4
fancyOlItemEnd
BEGIN fancyOlItemWithNumber
- numstyle: LowerRoman
- numdelim: Period
- number: 5
END fancyOlItemWithNumber
fancyOlItemWithNumber: 5
fancyOlItemEnd
fancyOlEnd
interblockSeparator
Expand All @@ -63,11 +55,9 @@ BEGIN fancyOlBeginTight
- numstyle: UpperRoman
- numdelim: Period
END fancyOlBeginTight
BEGIN fancyOlItemWithNumber
- numstyle: UpperRoman
- numdelim: Period
- number: 4
END fancyOlItemWithNumber
fancyOlItemWithNumber: 4
fancyOlItemEnd
fancyOlItemWithNumber: 5
fancyOlItemEnd
fancyOlEndTight
interblockSeparator
Expand All @@ -77,17 +67,9 @@ BEGIN fancyOlBegin
- numstyle: LowerAlpha
- numdelim: Period
END fancyOlBegin
BEGIN fancyOlItemWithNumber
- numstyle: LowerAlpha
- numdelim: Period
- number: 4
END fancyOlItemWithNumber
fancyOlItemWithNumber: 4
fancyOlItemEnd
BEGIN fancyOlItemWithNumber
- numstyle: LowerAlpha
- numdelim: Period
- number: 5
END fancyOlItemWithNumber
fancyOlItemWithNumber: 5
fancyOlItemEnd
fancyOlEnd
interblockSeparator
Expand All @@ -97,11 +79,9 @@ BEGIN fancyOlBeginTight
- numstyle: UpperAlpha
- numdelim: Period
END fancyOlBeginTight
BEGIN fancyOlItemWithNumber
- numstyle: UpperAlpha
- numdelim: Period
- number: 4
END fancyOlItemWithNumber
fancyOlItemWithNumber: 4
fancyOlItemEnd
fancyOlItemWithNumber: 5
fancyOlItemEnd
fancyOlEndTight
interblockSeparator
Expand All @@ -111,17 +91,9 @@ BEGIN fancyOlBegin
- numstyle: Decimal
- numdelim: OneParen
END fancyOlBegin
BEGIN fancyOlItemWithNumber
- numstyle: Decimal
- numdelim: OneParen
- number: 4
END fancyOlItemWithNumber
fancyOlItemWithNumber: 4
fancyOlItemEnd
BEGIN fancyOlItemWithNumber
- numstyle: Decimal
- numdelim: OneParen
- number: 5
END fancyOlItemWithNumber
fancyOlItemWithNumber: 5
fancyOlItemEnd
fancyOlEnd
documentEnd