···

       
11
       
11
       
 
       
pandoc_flags = --extract-media=$(pandoc_media_dir) \

     

       
12
       
12
       
 
       
	--lua-filter=$(PANDOC_LUA_FILTERS_DIR)/diagram-generator.lua \

     

       
13
       
13
       
 
       
	--lua-filter=build-aux/pandoc-filters/myst-reader/roles.lua \

     

       
14
       
14
       
+
       
	--lua-filter=build-aux/pandoc-filters/link-unix-man-references.lua \

     

       
14
       
15
       
 
       
	--lua-filter=build-aux/pandoc-filters/docbook-writer/rst-roles.lua \

     

       
15
       
16
       
 
       
	--lua-filter=build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua \

     

       
16
       
17
       
 
       
	-f commonmark$(pandoc_commonmark_enabled_extensions)+smart

     

···

       
1
       
1
       
+
       
--[[

     

       
2
       
2
       
+
       
Turns a manpage reference into a link, when a mapping is defined

     

       
3
       
3
       
+
       
in the unix-man-urls.lua file.

     

       
4
       
4
       
+
       
]]

     

       
5
       
5
       
+
       


     

       
6
       
6
       
+
       
local man_urls = {

     

       
7
       
7
       
+
       
  ["tmpfiles.d(5)"] = "https://www.freedesktop.org/software/systemd/man/tmpfiles.d.html",

     

       
8
       
8
       
+
       
  ["nix.conf(5)"] = "https://nixos.org/manual/nix/stable/#sec-conf-file",

     

       
9
       
9
       
+
       
  ["systemd.time(7)"] = "https://www.freedesktop.org/software/systemd/man/systemd.time.html",

     

       
10
       
10
       
+
       
  ["systemd.timer(5)"] = "https://www.freedesktop.org/software/systemd/man/systemd.timer.html",

     

       
11
       
11
       
+
       
}

     

       
12
       
12
       
+
       


     

       
13
       
13
       
+
       
function Code(elem)

     

       
14
       
14
       
+
       
  local is_man_role = elem.classes:includes('interpreted-text') and elem.attributes['role'] == 'manpage'

     

       
15
       
15
       
+
       
  if is_man_role and man_urls[elem.text] ~= nil then

     

       
16
       
16
       
+
       
    return pandoc.Link(elem, man_urls[elem.text])

     

       
17
       
17
       
+
       
  end

     

       
18
       
18
       
+
       
end

     

···

       
53
       
53
       
 
       
  This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing).

     

       
54
       
54
       
 
       


     

       
55
       
55
       
 
       
- []{#ssec-contributing-markup-inline-roles}

     

       
56
       
56
       
-
       
  If you want to link to a man page, you can use ``{manpage}`nix.conf(5)```, which will turn into {manpage}`nix.conf(5)`.

     

       
56
       
56
       
+
       
  If you want to link to a man page, you can use `` {manpage}`nix.conf(5)` ``, which will turn into {manpage}`nix.conf(5)`.

     

       
57
       
57
       
+
       


     

       
58
       
58
       
+
       
  The references will turn into links when a mapping exists in {file}`doc/build-aux/pandoc-filters/unix-man-urls.lua`.

     

       
57
       
59
       
 
       


     

       
58
       
60
       
 
       
  This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#roles-an-in-line-extension-point). Though, the feature originates from [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-manpage) with slightly different syntax.

     

       
59
       
61
       
 
       


     

···

       
17
       
17
       
 
       
  # - media extraction (was only required for diagram generator)

     

       
18
       
18
       
 
       
  # - docbook-reader/citerefentry-to-rst-role.lua (only relevant for DocBook → MarkDown/rST/MyST)

     

       
19
       
19
       
 
       
  "--lua-filter=$DIR/../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua"

     

       
20
       
20
       
+
       
  "--lua-filter=$DIR/../../../doc/build-aux/pandoc-filters/link-unix-man-references.lua"

     

       
20
       
21
       
 
       
  "--lua-filter=$DIR/../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua"

     

       
21
       
22
       
 
       
  "--lua-filter=$DIR/../../../doc/build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua"

     

       
22
       
23
       
 
       
  -f "commonmark${pandoc_commonmark_enabled_extensions}+smart"