asciidoctor-html5s 0.1.0.beta.9 → 0.1.0.beta.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9949bf88aa17ad0064e393ab78e67057841e1b1da5a5fa1cdd3d916e0c203c94
-  data.tar.gz: fa1298c9b61194d9e2e21883580654008e5e5c576b77b71ac04ee4340c92f626
+  metadata.gz: a9dd49e828ffd4bb710c4d52a5f5bb290b5a3a83a9c5f8914bfc57750445d7c4
+  data.tar.gz: 9c22dddaab49d8bd4bf19c46431f8682bf0bb7747a568982863818c09df514ac
 SHA512:
-  metadata.gz: cd4f1dc8b891c1af710b7a71f0460d696d3b1b4407339324f9968f7eed7b42699e77caf240bdb409cd7d550a21ef9ec39047139b1536f50496c04321f13c5fc4
-  data.tar.gz: e8f0a3088f2da2e244194592f932497b9dc55a6390ab6825e7261daa6e676ae8a8c0d8c71f3d45fa1d63a5e6379ede5b397e36ee6bf84a4afb81e34ded930d8b
+  metadata.gz: 4da3a9fe59f111342e69c30c03852a66a61e48140a81d236fc69201d312858338e3870def8af77bf1b1c2080b21bf957c10742c4b0348526a68af2b2d1ac851b
+  data.tar.gz: 14111e7154edd3c1cfc12e330133ff5011576f7701b1e9a4e460e4ebb175e539f9c12d9d7e6ea568fe0e35d6fc4ad6c453ef301d44d0e6ec0eec66e494a87c1a

data/README.adoc

@@ -28,6 +28,88 @@ This project provides alternative HTML5 converter (backend) for http://asciidoct
 * Compatibility with existing Asciidoctor CSS styles.
 
 
+== Text Substitutions
+
+=== Quotes
+
+Asciidoctor provides syntax for so-called https://asciidoctor.org/docs/user-manual/#curved[“curved quotation marks”] (which are actually just the _correct_ quotation marks), but the built-in converters outputs only one (hard-coded) type of the single/double quotation marks -- that one used in English and few other languages.
+This converter outputs the correct type of the quotation marks based on the specified language (using standard `lang` attribute).
+
+
+[cols="2,^1l,3,^1l,^1"]
+|===
+| Name | Syntax | Languages (:lang:) | HTML | Rendered
+
+.4+| double quotes
+.4+| "`word`"
+| af, en, eo, ga, hi, ia, id, ko, mt, th, tr, zh
+| “word”
+| “word”
+
+| bs, fi, sv
+| ”word”
+| ”word”
+
+| cs, da, de, is, lt, sl, sk, sr
+| „word“
+| „word“
+
+| hu, pl, nl, ro
+| „word”
+| „word”
+
+.5+| single quotes
+.5+| '`word`'
+| af, en, eo, ga, hi, ia, id, ko, mt, th, tr, zh
+| ‘word’
+| ‘word’
+
+| bs, fi, sv
+| ’word’
+| ’word’
+
+| cs, da, de, is, lt, sl, sk, sr
+| ‚word‘
+| ‚word‘
+
+| nl
+| ‚word’
+| ‚word’
+
+| hu, pl, ro
+| «word»
+| «word»
+|===
+
+The default (fallback) type is the first one.
+
+
+=== Replacements
+
+Asciidoctor replaces `--` with em dash (—) and does not provide any replacement for en dash (–).
+That’s not very convenient, because en dash is more common than em dash; at least in (British) English and Czech (actually we don’t use em dash at all).
+So this extension also modifies the https://asciidoctor.org/docs/user-manual/#replacements[replacements table]: changes `--` to en dash and adds `---` for em dash.
+
+[cols="2,^1l,^1l,^1,2"]
+|===
+| Name | Syntax | Unicode | Rendered | Notes
+
+| En dash
+| --
+| –
+| –
+.2+| Only replaced if between two word characters, between a word character and a line boundary, or flanked by spaces.
+
+When flanked by space characters (e.g. `+a -- b+` or `+a --- b+`), the normal spaces are replaced by thin spaces (\ ).
+
+| Em dash
+| ---
+| —
+| —
+
+|===
+
+
 == Requirements
 
 * https://www.ruby-lang.org/[Ruby] 2.0+, http://jruby.org/[JRuby] 9.1+ or https://nodejs.org/[Node.js]

data/data/templates/helpers.rb

@@ -10,14 +10,27 @@ module Slim::Helpers
   # URIs of external assets.
   FONT_AWESOME_URI     = '//cdn.jsdelivr.net/npm/font-awesome@4.7.0/css/font-awesome.min.css'
   HIGHLIGHTJS_BASE_URI = '//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.12.0/build/'
-  KATEX_CSS_URI        = '//cdn.jsdelivr.net/npm/katex@0.8.3/dist/katex.min.css'
-  KATEX_JS_URI         = '//cdn.jsdelivr.net/npm/katex@0.8.3/dist/katex.min.js'
+  KATEX_CSS_URI        = '//cdn.jsdelivr.net/npm/katex@0.9.0/dist/katex.min.css'
+  KATEX_JS_URI         = '//cdn.jsdelivr.net/npm/katex@0.9.0/dist/katex.min.js'
 
   # Defaults
   DEFAULT_HIGHLIGHTJS_THEME = 'github'
+  DEFAULT_LANG = 'en'
   DEFAULT_SECTNUMLEVELS = 3
   DEFAULT_TOCLEVELS = 2
 
+  CURLY_QUOTES = [
+    [%w[af en eo ga hi ia id ko mt th tr zh], ['‘', '’', '“', '”']],  # ‘…’ “…”
+    [%w[bs fi sv], ['’', '’', '”', '”']],  # ’…’ ”…”
+    [%w[cs da de is lt sl sk sr], ['‚', '‘', '„', '“']],  # ‚…‘ „…“
+    [%w[nl], ['‚', '’', '„', '”']],  # ‚…’ „…”
+    [%w[hu pl ro], ['«', '»', '„', '”']],  # «…» „…”
+  ].reduce({}) do |hsh, (langs, codes)|
+    langs.each { |lang| hsh[lang] = codes }
+    hsh
+  end
+  CURLY_QUOTES.default = CURLY_QUOTES[DEFAULT_LANG]
+
   KATEX_RENDER_CODE = <<-JS.gsub(/\s+/, ' ')
     document.addEventListener("DOMContentLoaded", function() {
       var elements = document.getElementsByClassName("math");
@@ -669,4 +682,22 @@ is book and it's a child of a book part. Excluding block content."
       ("fa-flip-#{attr :flip}" if attr? :flip)
     ].compact
   end
+
+  #--------------------------------------------------------
+  # inline_quoted
+  #
+
+  # @param text [String] the text to wrap in double quotes.
+  # @return [String] quoted *text*.
+  def double_quoted(text)
+    quotes = CURLY_QUOTES[attr(:lang, DEFAULT_LANG, true)]
+    "#{quotes[2]}#{text}#{quotes[3]}"
+  end
+
+  # @param text [String] the text to wrap in single quotes.
+  # @return [String] quoted *text*.
+  def single_quoted(text)
+    quotes = CURLY_QUOTES[attr(:lang, DEFAULT_LANG, true)]
+    "#{quotes[0]}#{text}#{quotes[1]}"
+  end
 end

data/data/templates/inline_quoted.html.slim

@@ -15,10 +15,10 @@
   mark class=role =text
 - when :double
   = html_tag_if role?, :span, :class=>role
-    | “#{text}”
+    =(double_quoted text)
 - when :single
   = html_tag_if role?, :span, :class=>role
-    | ‘#{text}’
+    =(single_quoted text)
 - when :asciimath, :latexmath
   span.math data-lang=stem_lang =(delimit_stem text, type)
 - else

data/lib/asciidoctor/html5s.rb

@@ -1,5 +1,6 @@
 require 'asciidoctor/html5s/version'
 require 'asciidoctor/html5s/converter'
+require 'asciidoctor/html5s/replacements'
 require 'asciidoctor/html5s/attached_colist_treeprocessor'
 
 unless RUBY_PLATFORM == 'opal'

data/lib/asciidoctor/html5s/converter.rb

@@ -17,14 +17,27 @@ class Asciidoctor::Html5s::Converter < ::Asciidoctor::Converter::Base
     # URIs of external assets.
     FONT_AWESOME_URI     = '//cdn.jsdelivr.net/npm/font-awesome@4.7.0/css/font-awesome.min.css'
     HIGHLIGHTJS_BASE_URI = '//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.12.0/build/'
-    KATEX_CSS_URI        = '//cdn.jsdelivr.net/npm/katex@0.8.3/dist/katex.min.css'
-    KATEX_JS_URI         = '//cdn.jsdelivr.net/npm/katex@0.8.3/dist/katex.min.js'
+    KATEX_CSS_URI        = '//cdn.jsdelivr.net/npm/katex@0.9.0/dist/katex.min.css'
+    KATEX_JS_URI         = '//cdn.jsdelivr.net/npm/katex@0.9.0/dist/katex.min.js'
 
     # Defaults
     DEFAULT_HIGHLIGHTJS_THEME = 'github'
+    DEFAULT_LANG = 'en'
     DEFAULT_SECTNUMLEVELS = 3
     DEFAULT_TOCLEVELS = 2
 
+    CURLY_QUOTES = [
+      [%w[af en eo ga hi ia id ko mt th tr zh], ['&#x2018;', '&#x2019;', '&#x201c;', '&#x201d;']],  # ‘…’ “…”
+      [%w[bs fi sv], ['&#x2019;', '&#x2019;', '&#x201d;', '&#x201d;']],  # ’…’ ”…”
+      [%w[cs da de is lt sl sk sr], ['&#x201a;', '&#x2018;', '&#x201e;', '&#x201c;']],  # ‚…‘ „…“
+      [%w[nl], ['&#x201a;', '&#x2019;', '&#x201e;', '&#x201d;']],  # ‚…’ „…”
+      [%w[hu pl ro], ['&#x00ab;', '&#x00bb;', '&#x201e;', '&#x201d;']],  # «…» „…”
+    ].reduce({}) do |hsh, (langs, codes)|
+      langs.each { |lang| hsh[lang] = codes }
+      hsh
+    end
+    CURLY_QUOTES.default = CURLY_QUOTES[DEFAULT_LANG]
+
     KATEX_RENDER_CODE = <<-JS.gsub(/\s+/, ' ')
       document.addEventListener("DOMContentLoaded", function() {
         var elements = document.getElementsByClassName("math");
@@ -676,6 +689,24 @@ class Asciidoctor::Html5s::Converter < ::Asciidoctor::Converter::Base
         ("fa-flip-#{attr :flip}" if attr? :flip)
       ].compact
     end
+
+    #--------------------------------------------------------
+    # inline_quoted
+    #
+
+    # @param text [String] the text to wrap in double quotes.
+    # @return [String] quoted *text*.
+    def double_quoted(text)
+      quotes = CURLY_QUOTES[attr(:lang, DEFAULT_LANG, true)]
+      "#{quotes[2]}#{text}#{quotes[3]}"
+    end
+
+    # @param text [String] the text to wrap in single quotes.
+    # @return [String] quoted *text*.
+    def single_quoted(text)
+      quotes = CURLY_QUOTES[attr(:lang, DEFAULT_LANG, true)]
+      "#{quotes[0]}#{text}#{quotes[1]}"
+    end
   end
 
 
@@ -1121,10 +1152,10 @@ class Asciidoctor::Html5s::Converter < ::Asciidoctor::Converter::Base
       ; _buf << ("<mark"); _temple_html_attributeremover6 = []; _slim_codeattributes7 = role; if Array === _slim_codeattributes7; _slim_codeattributes7 = _slim_codeattributes7.flatten; _slim_codeattributes7.map!(&:to_s); _slim_codeattributes7.reject!(&:empty?); _temple_html_attributeremover6 << (_slim_codeattributes7.join(" ")); else; _temple_html_attributeremover6 << (_slim_codeattributes7); end; _temple_html_attributeremover6 = _temple_html_attributeremover6.join(""); if !_temple_html_attributeremover6.empty?; _buf << (" class=\""); _buf << (_temple_html_attributeremover6); _buf << ("\""); end; _buf << (">"); _buf << (text); 
       ; _buf << ("</mark>"); when :double; 
       ; _slim_controls1 = html_tag_if role?, :span, :class=>role do; _slim_controls2 = []; 
-      ; _slim_controls2 << ("&#8220;"); _slim_controls2 << (text); _slim_controls2 << ("&#8221;"); 
+      ; _slim_controls2 << ((double_quoted text)); 
       ; _slim_controls2 = _slim_controls2.join(""); end; _buf << (_slim_controls1); when :single; 
       ; _slim_controls3 = html_tag_if role?, :span, :class=>role do; _slim_controls4 = []; 
-      ; _slim_controls4 << ("&#8216;"); _slim_controls4 << (text); _slim_controls4 << ("&#8217;"); 
+      ; _slim_controls4 << ((single_quoted text)); 
       ; _slim_controls4 = _slim_controls4.join(""); end; _buf << (_slim_controls3); when :asciimath, :latexmath; 
       ; _buf << ("<span class=\"math\""); _slim_codeattributes8 = stem_lang; if _slim_codeattributes8; if _slim_codeattributes8 == true; _buf << (" data-lang"); else; _buf << (" data-lang=\""); _buf << (_slim_codeattributes8); _buf << ("\""); end; end; _buf << (">"); _buf << ((delimit_stem text, type)); 
       ; _buf << ("</span>"); else; 

data/lib/asciidoctor/html5s/replacements.rb

@@ -0,0 +1,15 @@
+require 'asciidoctor' unless RUBY_PLATFORM == 'opal'
+
+module Asciidoctor
+  # XXX: Modifies constant defined in Asciidoctor.
+  REPLACEMENTS.unshift(
+    # foo --- bar ->  — 
+    [/(^|\n| |\\)---( |\n|$)/, ' — ', :none],
+    # foo---bar -> —{ZERO WIDTH SPACE}
+    [/(#{CG_WORD})\\?---(?=#{CG_WORD})/, '—​', :leading],
+    # foo -- bar -> &thinksp;– 
+    [/(^|\n| |\\)--( |\n|$)/, ' – ', :none],
+    # foo--bar -> –
+    [/(#{CG_WORD})\\?--(?=#{CG_WORD})/, '–', :leading],
+  )
+end

data/lib/asciidoctor/html5s/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Html5s
-    VERSION = '0.1.0.beta.9'
+    VERSION = '0.1.0.beta.10'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-html5s
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta.9
+  version: 0.1.0.beta.10
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2018-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -201,6 +201,7 @@ files:
 - lib/asciidoctor/html5s/attached_colist_treeprocessor.rb
 - lib/asciidoctor/html5s/converter.rb
 - lib/asciidoctor/html5s/logger.rb
+- lib/asciidoctor/html5s/replacements.rb
 - lib/asciidoctor/html5s/version.rb
 homepage: https://github.com/jirutka/asciidoctor-html5s
 licenses: