zinface
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

wikiheaders: fixed wikilinks in Markdown code sections.

This commit is contained in:
Ryan C. Gordon 2023-02-27 23:07:43 -05:00
parent 02fede7c8c
commit a479633455
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
build-scripts/wikiheaders.pl
View File

@ -260,12 +260,30 @@ sub wikify_chunk {
$str .= "<syntaxhighlight lang='$codelang'>$code<\/syntaxhighlight>"; $str .= "<syntaxhighlight lang='$codelang'>$code<\/syntaxhighlight>";
} }
} elsif ($wikitype eq 'md') { } elsif ($wikitype eq 'md') {
# Convert obvious API things to wikilinks. You can't make links # convert `code` things first, so they aren't mistaken for other markdown items.
# inside code blocks, but you _can_ make sure that single identifiers my $codedstr = '';
# wrapped in backticks encode correctly. while ($str =~ s/\A(.*?)(\`.*?\`)//ms) {
if (defined $apiprefixregex) { my $codeblock = $2;
$str =~ s/(?<LEFT>\b|\`?)(?<SYM>$apiprefixregex[a-zA-Z0-9_]+)(?<RIGHT>\`?)/[$+{"LEFT"}$+{"SYM"}$+{"RIGHT"}]($+{"SYM"})/gms; $codedstr .= wikify_chunk($wikitype, $1, undef, undef);
if (defined $apiprefixregex) {
# Convert obvious API things to wikilinks, even inside `code` blocks,
# BUT ONLY IF the entire code block is the API thing,
# So something like "just call `SDL_Whatever`" will become
# "just call [`SDL_Whatever`](SDL_Whatever)", but
# "just call `SDL_Whatever(7)`" will not. It's just the safest
# way to do this without resorting to wrapping things in html <code> tags.
$codeblock =~ s/\A\`($apiprefixregex[a-zA-Z0-9_]+)\`\Z/[`$1`]($1)/gms;
}
$codedstr .= $codeblock;
} }
# Convert obvious API things to wikilinks.
if (defined $apiprefixregex) {
$str =~ s/\b($apiprefixregex[a-zA-Z0-9_]+)/[$1]($1)/gms;
}
$str = $codedstr . $str;
if (defined $code) { if (defined $code) {
$str .= "```$codelang$code```"; $str .= "```$codelang$code```";
} }
@ -335,7 +353,7 @@ sub dewikify_chunk {
} elsif ($wikitype eq 'md') { } elsif ($wikitype eq 'md') {
# Dump obvious wikilinks. The rest can just passthrough. # Dump obvious wikilinks. The rest can just passthrough.
if (defined $apiprefixregex) { if (defined $apiprefixregex) {
$str =~ s/\[(?<LEFT>\`?)(?<SYM>$apiprefixregex[a-zA-Z0-9_]+)(?<RIGHT>\`?)\]\(($apiprefixregex[a-zA-Z0-9_]+)\)/$+{"LEFT"}$+{"SYM"}$+{"RIGHT"}/gms; $str =~ s/\[(\`?$apiprefixregex[a-zA-Z0-9_]+\`?)\]\($apiprefixregex[a-zA-Z0-9_]+\)/$1/gms;
} }
} }
@ -370,7 +388,7 @@ sub dewikify_chunk {
} elsif ($wikitype eq 'md') { } elsif ($wikitype eq 'md') {
# Dump obvious wikilinks. # Dump obvious wikilinks.
if (defined $apiprefixregex) { if (defined $apiprefixregex) {
$str =~ s/\[(?<LEFT>\`?)(?<SYM>$apiprefixregex[a-zA-Z0-9_]+)(?<RIGHT>\`?)\]\(($apiprefixregex[a-zA-Z0-9_]+)\)/\n.BR $+{"SYM"}\n/gms; $str =~ s/\[(\`?$apiprefixregex[a-zA-Z0-9_]+\`?)\]\($apiprefixregex[a-zA-Z0-9_]+\)/\n.BR $1\n/gms;
} }
# links # links