* [PATCH 5/6] hlmod: support "```$LANG" blocks in text
2019-02-05 11:10 7% [PATCH 0/6] highlighting cleanups + help update Eric Wong
@ 2019-02-05 11:10 6% ` Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2019-02-05 11:10 UTC (permalink / raw)
To: meta
This is compatible with Markdown; but we still keep the WYSIWYG
nature of plain-text with this. This is only intended for use
with our documentation. Enabling any type of Markdown support
for emails can lead to incompatibilities or interopability
problems with alternative implementations.
---
lib/PublicInbox/HlMod.pm | 21 ++++++++++++++++++++-
t/hl_mod.t | 20 ++++++++++++++++++++
2 files changed, 40 insertions(+), 1 deletion(-)
diff --git a/lib/PublicInbox/HlMod.pm b/lib/PublicInbox/HlMod.pm
index 014d82f..36e3110 100644
--- a/lib/PublicInbox/HlMod.pm
+++ b/lib/PublicInbox/HlMod.pm
@@ -16,7 +16,7 @@ package PublicInbox::HlMod;
use strict;
use warnings;
use highlight; # SWIG-generated stuff
-use PublicInbox::Hval qw(src_escape);
+use PublicInbox::Hval qw(src_escape ascii_html);
my $hl;
sub _parse_filetypes ($) {
@@ -127,4 +127,23 @@ sub do_hl_lang {
\$out;
}
+# Highlight text, but support Markdown "```$LANG" notation
+# while preserving WYSIWYG of plain-text documentation.
+# This is NOT to be enabled by default or encouraged for parsing
+# emails, since it is NOT stable and can lead to standards
+# proliferation of email.
+sub do_hl_text {
+ my ($self, $str) = @_;
+
+ $$str = join('', map {
+ if (/\A(``` ?)(\w+)\s*?\n(.+)(^```\s*)\z/sm) {
+ my ($pfx, $lang, $code, $post) = ($1, $2, $3, $4);
+ my $hl = do_hl_lang($self, \$code, $lang) || \$code;
+ $pfx . $lang . "\n" . $$hl . $post;
+ } else {
+ ascii_html($_);
+ }
+ } split(/(^``` ?\w+\s*?\n.+?^```\s*$)/sm, $$str));
+}
+
1;
diff --git a/t/hl_mod.t b/t/hl_mod.t
index f2eb5f9..84a4b57 100644
--- a/t/hl_mod.t
+++ b/t/hl_mod.t
@@ -40,4 +40,24 @@ my $orig = $str;
}
}
+if ('experimental, only for help text') {
+ my $tmp = <<'EOF';
+:>
+```perl
+my $foo = 1 & 2;
+```
+:<
+EOF
+ $hls->do_hl_text(\$tmp);
+ my @hl = split(/^/m, $tmp);
+ is($hl[0], ":>\n", 'first line escaped');
+ is($hl[1], "```perl\n", '2nd line preserved');
+ like($hl[2], qr/<span\b/, 'code highlighted');
+ like($hl[2], qr/&/, 'ampersand escaped');
+ is($hl[3], "```\n", '4th line preserved');
+ is($hl[4], ":<\n", '5th line escaped');
+ is(scalar(@hl), 5, 'no extra line');
+
+}
+
done_testing;
--
EW
^ permalink raw reply related [relevance 6%]
* [PATCH 0/6] highlighting cleanups + help update
@ 2019-02-05 11:10 7% Eric Wong
2019-02-05 11:10 6% ` [PATCH 5/6] hlmod: support "```$LANG" blocks in text Eric Wong
0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2019-02-05 11:10 UTC (permalink / raw)
To: meta
Experimenting with using Markdown-style "```$LANG" blocks
support for our user documentation. It makes the CSS
example easier-to-follow when the CSS source is in front
of the user.
Markdown-style blocks definitely won't be enabled by default for
emails. I don't want to encourage people to use Markdown in
emails (as that inevitably ends with "which flavor?") and the
same mess with privacy/compatibility problems have with HTML
mail.
But preserving the WYSIWYG nature of plain-text while allowing a
tiny subset of Markdown (we already respect it for
linkification) might be useful for mailing lists which forward
messages from Markdown-supported forums/trackers (e.g. Redmine
and ruby-core mailing list).
Eric Wong (6):
viewvcs: cleanup utf8 handling
hlmod: hoist out do_hl_lang sub
hlmod: make into a singleton
hlmod: do_hl* performs src_escape immediately
hlmod: support "```$LANG" blocks in text
wwwtext: inline sample CSS and use highlight
contrib/css/216dark.css | 30 ++++++++++--------
lib/PublicInbox/HlMod.pm | 70 ++++++++++++++++++++++++++++--------------
lib/PublicInbox/UserContent.pm | 16 +++++-----
lib/PublicInbox/ViewVCS.pm | 14 ++-------
lib/PublicInbox/WwwText.pm | 35 ++++++++++-----------
t/hl_mod.t | 34 ++++++++++++--------
6 files changed, 114 insertions(+), 85 deletions(-)
--
EW
^ permalink raw reply [relevance 7%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2019-02-05 11:10 7% [PATCH 0/6] highlighting cleanups + help update Eric Wong
2019-02-05 11:10 6% ` [PATCH 5/6] hlmod: support "```$LANG" blocks in text Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).