From 1c9f55ec640741fb8d4484c09802cd02636e67bb Mon Sep 17 00:00:00 2001 From: pennae Date: Wed, 8 Feb 2023 06:30:27 +0100 Subject: [PATCH] nixos/manual: convert elements to bracketed spans since support for kbd elements was added with explicit intent in #175128 it seems like a good idea to support this in nixos-render-docs instead of just dropping it in favor of `*F12*` etc. since it's a very rare thing in the manual and purely presentational it makes sense to use bracketed spans instead of a new myst role. the html-elements.lua plugin is now somewhat misnamed, but it'll go away very soon so we don't want to bother renaming it. --- .../pandoc-filters/docbook-writer/html-elements.lua | 10 +++++----- nixos/doc/manual/installation/installing.chapter.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/build-aux/pandoc-filters/docbook-writer/html-elements.lua b/doc/build-aux/pandoc-filters/docbook-writer/html-elements.lua index 8f4de40ce5f8..ba4d519429eb 100644 --- a/doc/build-aux/pandoc-filters/docbook-writer/html-elements.lua +++ b/doc/build-aux/pandoc-filters/docbook-writer/html-elements.lua @@ -2,10 +2,10 @@ Converts some HTML elements commonly used in Markdown to corresponding DocBook elements. ]] -function RawInline(elem) - if elem.format == 'html' and elem.text == '' then - return pandoc.RawInline('docbook', '') - elseif elem.format == 'html' and elem.text == '' then - return pandoc.RawInline('docbook', '') +function Span(elem) + if #elem.classes == 1 and elem.classes[1] == 'keycap' then + elem.content:insert(1, pandoc.RawInline('docbook', '')) + elem.content:insert(pandoc.RawInline('docbook', '')) + return elem end end diff --git a/nixos/doc/manual/installation/installing.chapter.md b/nixos/doc/manual/installation/installing.chapter.md index c44ae1e4b76f..e1908017a7e4 100644 --- a/nixos/doc/manual/installation/installing.chapter.md +++ b/nixos/doc/manual/installation/installing.chapter.md @@ -15,16 +15,16 @@ To begin the installation, you have to boot your computer from the install drive ::: {.note} The key to open the boot menu is different across computer brands and even - models. It can be F12, but also F1, - F9, F10, Enter, Del, - Esc or another function key. If you are unsure and don't see + models. It can be [F12]{.keycap}, but also [F1]{.keycap}, + [F9]{.keycap}, [F10]{.keycap}, [Enter]{.keycap}, [Del]{.keycap}, + [Esc]{.keycap} or another function key. If you are unsure and don't see it on the early boot screen, you can search online for your computers brand, model followed by "boot from usb". The computer might not even have that feature, so you have to go into the BIOS/UEFI settings to change the boot order. Again, search online for details about your specific computer model. - For Apple computers with Intel processors press and hold the ⌥ + For Apple computers with Intel processors press and hold the [⌥]{.keycap} (Option or Alt) key until you see the boot menu. On Apple silicon press and hold the power button. ::: @@ -41,7 +41,7 @@ To begin the installation, you have to boot your computer from the install drive 3. Shortly after selecting the appropriate boot drive, you should be presented with a menu with different installer options. Leave the default - and wait (or press Enter to speed up). + and wait (or press [Enter]{.keycap} to speed up). 4. The graphical images will start their corresponding desktop environment and the graphical installer, which can take some time. The minimal images