Skip to content

tools/2xep improvements #1470

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

Open
mwild1 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

tools/2xep improvements #1470

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd6c70e
tools/2xep: Fix generation of non-repeated elements such as dependencies
mwild1 Oct 8, 2025
4f050b7
tools/2xep: Fixes/improvements for handling entities
mwild1 Oct 8, 2025
da0800f
tools/2xep: Support for captions in examples
mwild1 Oct 8, 2025
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
41 changes: 35 additions & 6 deletions tools/2xep.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,19 @@ end
-- to pandoc, and pandoc will add do the template processing as
-- usual.
function Doc(body, metadata, variables)
local entities = {
"<!ENTITY % ents SYSTEM 'xep.ent'>";
};

if metadata.entities and type(metadata.entities) == "table" then
for sk, sv in pairs(metadata.entities) do
table.insert(entities, string.format("<!ENTITY %s \"\n%s\n\" >\n", sk, sv:gsub("\"", "'")));
end
end
local buffer = { [[
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
<!ENTITY % ents SYSTEM 'xep.ent'>
]]..table.concat(entities, "\n")..[[
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
Expand All @@ -61,9 +70,10 @@ function Doc(body, metadata, variables)
(title , abstract , legal , number , status , lastcall* ,
interim* , type , sig , approver* , dependencies , supersedes ,
supersededby , shortname , schemaloc* , registry? , discuss? ,
expires? , author+ , revision+ , councilnote?)
expires? , author+ , revision+ , councilnote? , entities?)
]];
for field, r in string.gmatch(header_schema, "(%w+)(%p?)") do
local repeated = r ~= "";
local v = metadata[field] or variables[field];
if not v then
if field == "legal" then
Expand All @@ -85,10 +95,22 @@ function Doc(body, metadata, variables)
if v ~= "xxxx" then
v = string.format("%04d", tonumber(v));
end
elseif field == "entities" then
goto next;
end
if type(v) == "table" then
for sk, sv in pairs(v) do
if not repeated then
-- Field is not repeated, so a single element
-- contains all children
add(string.format("<%s>", field));
end

for sk, sv in pairs(v) do
if r ~= "" then
-- This field is repeated for each child
add(string.format("<%s>", field));
end

if type(sk) == "string" then
add(("<%s>%s</%s>"):format(sk, tostring(sv), sk));
elseif field == "author" then
Expand Down Expand Up @@ -120,6 +142,11 @@ function Doc(body, metadata, variables)
else
add(tostring(sv));
end
if repeated then
add(string.format("</%s>", field));
end
end
if not repeated then
add(string.format("</%s>", field));
end
else
Expand All @@ -142,8 +169,10 @@ end
-- Comments indicate the types of other variables.

function Str(s)
if string.match(s, "^&[%w%-.]+;$") then return s; end
return escape(s)
s = s:gsub("&[%w%-.]+;", function (ent)
return "2XEPREF:"..ent:sub(2);
end);
return (escape(s):gsub("2XEPREF:", "&"));
end

function Space()
Expand Down Expand Up @@ -289,7 +318,7 @@ end

function CodeBlock(s, attr)
if attr and attr.class and (has(attr.class, "example") or has(attr.class, "xml")) then
return "<example><![CDATA[".. s .. "]]></example>"
return "<example "..attributes({ caption = attr.caption }).."><![CDATA[".. s .. "]]></example>"
else
return "<code><![CDATA[".. s .. "]]></code>"
end
Expand Down