hans/Fediversity
1
0
Fork 0
forked from Fediversity/Fediversity
Code Pull requests Activity

reiterate on mandatory headings in sections

Browse source
This commit is contained in:
Valentin Gagarin 2024-11-13 15:24:41 +01:00 committed by Valentin Gagarin
parent 661158223a
commit 95f7e5e162
1 changed files with 33 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
website/presentation/dom.nix
View file

@ -369,7 +369,7 @@ let
process-with-depth = depth: content: process-with-depth = depth: content:
map map
(x: (x:
if isAttrs x && x ? section && x.section ? heading if isAttrs x && x ? section
then x // { then x // {
section = x.section // { section = x.section // {
heading-level = depth; heading-level = depth;
@ -383,7 +383,7 @@ let
find-with-depth = depth: content: find-with-depth = depth: content:
let let
sections = map (v: { inherit (def) file; value = v; depth = depth; }) sections = map (v: { inherit (def) file; value = v; depth = depth; })
(filter (x: isAttrs x && x ? section && x.section ? heading) content); (filter (x: isAttrs x && x ? section) content);
subsections = concatMap subsections = concatMap
(x: (x:
if isAttrs x && x ? section && x.section ? content if isAttrs x && x ? section && x.section ? content
@ -441,29 +441,37 @@ let
type = with types; nullOr (submodule { options = global-attrs; }); type = with types; nullOr (submodule { options = global-attrs; });
default = null; default = null;
}; };
# TODO: make `pre-`/`post-heading` wrap the heading in `<hgroup>` if non-empty
# https://html.spec.whatwg.org/multipage/sections.html#the-hgroup-element
pre-heading = mkOption {
type = with types; listOf (attrTag ({ inherit p; } // categories.scripting));
default = [ ];
};
heading = mkOption { heading = mkOption {
# XXX: while there are no explicit rules on whether sections should contain headers,
# sections should have content that would be listed in an outline.
#
# https://html.spec.whatwg.org/multipage/sections.html#use-div-for-wrappers
#
# such an outline is rather meaningless without headings for navigation,
# which is why we enforce headings in sections.
# arguably, and this is encoded here, a section *is defined* by its heading.
type = with types; submodule ({ ... }: { type = with types; submodule ({ ... }: {
imports = [ element ]; imports = [ element ];
options = { options = {
attrs = mkAttrs { }; attrs = mkAttrs { };
# TODO: make `before`/`after` wrap the heading in `<hgroup>` if non-empty
# https://html.spec.whatwg.org/multipage/sections.html#the-hgroup-element
before = mkOption {
type = with types; listOf (attrTag ({ inherit p; } // categories.scripting));
default = [ ];
};
content = mkOption { content = mkOption {
# https://html.spec.whatwg.org/multipage/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements # https://html.spec.whatwg.org/multipage/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements
type = with types; either str (listOf (attrTag categories.phrasing)); type = with types; either str (listOf (attrTag categories.phrasing));
}; };
}; after = mkOption {
});
};
post-heading = mkOption {
type = with types; type = with types;
listOf (attrTag ({ inherit p; } // categories.scripting)); listOf (attrTag ({ inherit p; } // categories.scripting));
default = [ ]; default = [ ];
}; };
};
});
};
# https://html.spec.whatwg.org/multipage/sections.html#headings-and-outlines # https://html.spec.whatwg.org/multipage/sections.html#headings-and-outlines
content = mkOption { content = mkOption {
type = with types; listOf (either str (attrTag categories.flow)); type = with types; listOf (either str (attrTag categories.flow));
@ -476,12 +484,13 @@ let
type = with types; ints.between 1 6; type = with types; ints.between 1 6;
internal = true; internal = true;
}; };
config.categories = [ "flow" "sectioning" "palpable" ]; config = {
config.__toString = self: with lib; categories = [ "flow" "sectioning" "palpable" ];
__toString = self: with lib;
let let
n = toString config.heading-level; n = toString config.heading-level;
content = content = ''<h${n}${print-attrs self.heading.attrs}>${self.heading.content}</h${n}>
"<h${n}${print-attrs self.heading.attrs}>${self.heading.content}</h${n}>" + join "\n" (map '' + join "\n" (map
(e: (e:
if isAttrs e if isAttrs e
then toString (lib.head (attrValues e)) then toString (lib.head (attrValues e))
@ -494,6 +503,7 @@ let
else content; else content;
}; };
}; };
};
in in
{ {
imports = [ element ]; imports = [ element ];