asciidoctor-tabs 1.0.0.alpha.2 → 1.0.0.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3efce4ce7fa405dd4983609797c24e85e5ee768ff1e70ee3df4e702cd579d79
-  data.tar.gz: b7671c6c76d775c1e46850fd0464c45e9b4ef7f9478c478b5f8c13d9a2cebb02
+  metadata.gz: e968b72b74144aad60adceb6290712b43017a61b74cc80c73793f474473e59c3
+  data.tar.gz: c7a33865929a61775548be25bda28627c6d9687e68e5d498134d3d87a4eef82b
 SHA512:
-  metadata.gz: 18b40647d4c424f1d9ce9749c7ca038342ae31ce4660ba4099b89cf9ca5a4c37540eb984384212f74f7b11b8987b9762847ff32710b2372a9bb3f186a720cd31
-  data.tar.gz: 21296914a580547da6f0703af319390351f9326a18ccc99b51719482fa6e73f2e466b6d2f9b0e99c673d7337aaf32faa8cc7a1d221f9b9bc5b6dc427b89bef34
+  metadata.gz: afdc6a70cec6b9a9519a9f8d72a29e234099ab3b58ed0cceabdcfff3a14574ad905214af88b6c32ffa527994607d30d3ed66403c22f4c60442cd318fd2f9dc7c
+  data.tar.gz: d09843fadb14ddee7d2fa5baf42e0125faeebe6342f7428175100ad7d0401cb6d8693045d51dfe53225e637849cefd15085ca7c7d52ec94f847d3949fc31e2a4

data/CHANGELOG.adoc

@@ -4,6 +4,48 @@
 This document provides a curated view of the changes to Asciidoctor Tabs per release.
 For a detailed view of what has changed, refer to the {url-repo}/commits/main[commit history] on GitHub.
 
+== 1.0.0-alpha.4 (2022-10-08) - @mojavelinux
+
+=== Added
+
+* Define exports for behavior (tabs.js) and style (tabs.css) in npm package
+
+=== Changed
+
+* Use value of `idseparator` attribute in front of tabset number in auto-generated ID (#16)
+* Add aliases for `Block` and `Docinfo` classes to `Extensions` class; remove workaround in js module
+* Move `margin-bottom` style to tabset element
+* Move behavior (tabs.js) and style (tabs.css) to dist folder in npm package
+
+=== Fixed
+
+* Increase specificity of sibling selector for tab to work with Antora default UI
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0-alpha.4[git tag] | {url-repo}/compare/v1.0.0-alpha.3\...v1.0.0-alpha.4[full diff]
+
+== 1.0.0-alpha.3 (2022-10-05) - @mojavelinux
+
+=== Added
+
+* Provide fallback behavior for non-HTML backends (filetype is not html) (#4)
+* Support multiple tab labels (terms) for the same content (description) (#8)
+* Allow alternate stylesheet for tabs to be specified using `tabs-stylesheet` attribute (#6)
+
+=== Changed
+
+* Assign ID directly to tab (list item) node (instead of using inline anchor) if backend supports it (#11)
+
+=== Fixed
+
+* Preserve text of dlist item for tab if item has both text and blocks (#13)
+* Create empty pane instead of crashing if dlist item has term only / no description
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0-alpha.3[git tag] | {url-repo}/compare/v1.0.0-alpha.2\...v1.0.0-alpha.3[full diff]
+
 == 1.0.0-alpha.2 (2022-10-03) - @mojavelinux
 
 === Added
@@ -21,7 +63,9 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 === Fixed
 
 * Honor explicit ID on tabs block and use it as ID prefix for tabs
+* Register reference for tabset in document catalog
 * Autogenerate IDs for tabsets and tabs in a manner consistent with section ID generation (#2)
+* Fix context value on pass blocks created by extension
 
 === Details
 

data/README.adoc

@@ -1,12 +1,21 @@
 = Asciidoctor Tabs
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.0-alpha.2, 2022-10-03
+v1.0.0-alpha.4, 2022-10-08
 :idprefix:
 :idseparator: -
+ifndef::env-github[:icons: font]
+ifdef::env-github[]
+:note-caption: :paperclip:
+:tip-caption: :bulb:
+endif::[]
 
 An Asciidoctor extension that adds a tabs block to the AsciiDoc syntax.
 Each set of tabs (a "tabset") is constructed from a dlist enclosed in an example block marked with the tabs style.
-This extension is only designed to be used with the `html` backend.
+
+NOTE: This extension is intended to be used with HTML backends (e.g., `html`).
+For other backends (i.e., filetype is not html), the example block enclosure will be taken away and the dlist will be converted normally.
+
+TIP: This extension is also published as an npm package named `@asciidoctor/tabs` for use with Asciidoctor.js (and thus Antora).
 
 == Install
 
@@ -69,8 +78,51 @@ Contains more than one block.
 
 == Usage
 
+=== CLI
+
  $ asciidoctor -r asciidoctor-tabs document-with-tabs.adoc
 
+You can specify an alternate stylesheet for tabs using the `tabs-stylesheet` document attribute.
+The value of this attribute is handled in the same way as the built-in `stylesheet` document attribute.
+A relative path is resolved starting from the value of the `stylesdir` document attribute, which defaults to the directory of the document.
+
+ $ asciidoctor -r asciidoctor-tabs -a tabs-stylesheet=my-tabs.css document-with-tabs.adoc
+
+=== API
+
+There are two ways to use the extension with the Asciidoctor API.
+In either case, you must require the Asciidoctor gem (`asciidoctor`) before requiring this one.
+
+You can require `asciidoctor/tabs` to register the extension as a global extension, just like with the CLI.
+
+[,js]
+----
+require 'asciidoctor'
+require 'asciidoctor/tabs'
+
+Asciidoctor.convert_file 'document-with-tabs.adoc', safe: :safe
+----
+
+Or you can pass a registry instance to the `Extensions.register` method to register the extension with a scoped registry.
+
+[,js]
+----
+require 'asciidoctor'
+require 'asciidoctor/tabs/extensions'
+
+registry = Asciidoctor::Extensions.create
+Asciidoctor::Tabs::Extensions.register registry
+
+Asciidoctor.convert_file 'document-with-tabs.adoc', extension_registry: registry, safe: :safe
+----
+
+If you're not using other scoped extensions, you can pass in the extensions group without creating a registry instance:
+
+[,js]
+----
+Asciidoctor.convert_file 'document-with-tabs.adoc', extensions: Asciidoctor::Tabs::Extensions.group, safe: :safe
+----
+
 == Authors
 
 Asciidoctor Tabs was written by Dan Allen of OpenDevise Inc. and contributed to the Asciidoctor project.

data/data/css/tabs.css

@@ -1,5 +1,5 @@
-/*! Asciidoctor Tabs stylesheet | Copyright (c) 2018-present Dan Allen | MIT License */
-.tabs ul {
+/*! Asciidoctor Tabs | Copyright (c) 2018-present Dan Allen | MIT License */
+.tabs > ul {
   display: flex;
   flex-wrap: wrap;
   list-style: none;
@@ -7,7 +7,7 @@
   padding: 0;
 }
 
-.tabs li {
+.tabs > ul li {
   align-items: center;
   border: 1px solid black;
   border-bottom: 0;
@@ -21,14 +21,18 @@
   position: relative;
 }
 
-.tabs.ulist li, .tabs.ulist p {
+.tabs > ul li, .tabs > ul p {
   margin-bottom: 0;
 }
 
-.tabs li + li {
+.tabs > ul li + li[id] {
   margin-top: 0;
 }
 
+.tabset {
+  margin-bottom: 1.25em;
+}
+
 .tabset.is-loading .tabs li:not(:first-child),
 .tabset:not(.is-loading) .tabs li:not(.is-active) {
   background-color: black;
@@ -50,7 +54,6 @@
 .tabset > .content {
   border: 1px solid gray;
   padding: 1.25em;
-  margin-bottom: 1.25em;
 }
 
 .tabset.is-loading .tab-pane:not(:first-child),

data/data/js/tabs.js

@@ -1,4 +1,4 @@
-/*! Asciidoctor Tabs behavior | Copyright (c) 2018-present Dan Allen | MIT License */
+/*! Asciidoctor Tabs | Copyright (c) 2018-present Dan Allen | MIT License */
 ;(function () {
   'use strict'
 
@@ -11,7 +11,8 @@
       find('li', tabs).forEach(function (tab, idx) {
         var id = (tab.querySelector('a[id]') || tab).id
         if (!id) return
-        var pane = getPane(id, tabset)
+        var pane = tabset.querySelector('.tab-pane[aria-labelledby~="' + id + '"]')
+        if (!pane) return
         if (!idx) first = { tab: tab, pane: pane }
         if (!active && hash === '#' + id && (active = true)) {
           tab.classList.add('is-active')
@@ -42,10 +43,4 @@
   function find (selector, from) {
     return Array.prototype.slice.call((from || document).querySelectorAll(selector))
   }
-
-  function getPane (id, tabset) {
-    return find('.tab-pane', tabset).find(function (it) {
-      return it.getAttribute('aria-labelledby') === id
-    })
-  }
 })()

data/lib/asciidoctor/tabs/block.rb

@@ -10,47 +10,53 @@ module Asciidoctor
         block = create_block parent, attrs['cloaked-context'], nil, attrs, content_model: :compound
         children = (parse_content block, reader).blocks
         return block unless children.size == 1 && (source_tabs = children[0]).context == :dlist && source_tabs.items?
-        nodes = []
-        tabset_number = (doc = parent.document).counter 'tabset-number'
-        id = attrs['id'] || %(#{doc.attributes['idprefix'] || '_'}tabset#{tabset_number})
-        nodes << (create_html_fragment parent, %(<div id="#{id}" class="tabset is-loading">))
-        tabs = create_list parent, :ulist
-        tabs.add_role 'tabs'
+        unless (doc = parent.document).attr? 'filetype', 'html'
+          source_tabs.id ||= attrs['id']
+          (reftext = attrs['reftext']) && (source_tabs.set_attr 'reftext', reftext) unless source_tabs.attr? 'reftext'
+          return source_tabs
+        end
+        tabset_number = doc.counter 'tabset-number'
+        id = attrs['id'] ||
+          %(#{doc.attributes['idprefix'] || '_'}tabset#{doc.attributes['idseparator'] || '_'}#{tabset_number})
+        parent << (create_html_fragment parent, %(<div id="#{id}" class="tabset is-loading">))
+        (tabs = create_list parent, :ulist).add_role 'tabs'
         panes = {}
-        source_tabs.items.each do |(title), details|
-          tab = create_list_item tabs
-          tabs << tab
-          tab_id = generate_id title.text, id, doc
-          tab.text = %([[#{tab_id}]]#{title.instance_variable_get :@text})
-          if details.blocks?
-            blocks = details.blocks
-          elsif details.text?
-            blocks = [(create_paragraph parent, (details.instance_variable_get :@text), {})]
-          else
-            next
+        set_id_on_tab = (doc.backend == 'html5') || (list_item_supports_id? doc)
+        source_tabs.items.each do |labels, content|
+          tab_ids = labels.map do |tab|
+            tabs << tab
+            tab_id = generate_id tab.text, id, doc
+            set_id_on_tab ? (tab.id = tab_id) : (tab.text = %([[#{tab_id}]]#{tab.instance_variable_get :@text}))
+            tab_id
           end
-          if (block0 = blocks[0]).context == :open && blocks.size == 1 && block0.blocks?
-            blocks = block0.blocks
+          if content
+            text = create_paragraph parent, (content.instance_variable_get :@text), nil if content.text?
+            if content.blocks?
+              if (block0 = (blocks = content.blocks)[0]).context == :open && blocks.size == 1 && block0.blocks?
+                blocks = block0.blocks
+              end
+              blocks.unshift text if text
+            elsif text
+              blocks = [text]
+            end
           end
-          (panes[tab_id] = blocks).each {|it| it.parent = parent }
+          panes[tab_ids] = blocks || []
         end
-        nodes << tabs
-        nodes << (create_html_fragment parent, '<div class="content">')
-        panes.each do |tab_id, blocks|
-          nodes << (create_html_fragment parent, %(<div class="tab-pane" aria-labelledby="#{tab_id}">))
-          nodes.push(*blocks)
-          nodes << (create_html_fragment parent, '</div>')
+        parent << tabs
+        parent << (create_html_fragment parent, '<div class="content">')
+        panes.each do |tab_ids, blocks|
+          parent << (create_html_fragment parent, %(<div class="tab-pane" aria-labelledby="#{tab_ids.join ' '}">))
+          blocks.each {|it| parent << it }
+          parent << (create_html_fragment parent, '</div>')
         end
-        nodes << (create_html_fragment parent, '</div>')
-        nodes << (create_html_fragment parent, '</div>')
-        nodes.each {|it| parent.blocks << it }
-        nil
+        parent << (create_html_fragment parent, '</div>')
+        create_html_fragment parent, '</div>', 'id' => id
       end
 
       private
 
-      def create_html_fragment parent, html
-        create_block parent, 'pass', html, nil
+      def create_html_fragment parent, html, attributes = nil
+        create_block parent, :pass, html, attributes
       end
 
       def generate_id str, base_id, doc
@@ -60,6 +66,15 @@ module Asciidoctor
       ensure
         restore_idprefix ? (attrs['idprefix'] = restore_idprefix) : (attrs.delete 'idprefix')
       end
+
+      def list_item_supports_id? doc
+        if (converter = doc.converter).instance_variable_defined? :@list_item_supports_id
+          converter.instance_variable_get :@list_item_supports_id
+        else
+          output = (create_list doc, :ulist).tap {|ul| ul << (create_list_item ul).tap {|li| li.id = 'name' } }.convert
+          converter.instance_variable_set :@list_item_supports_id, (output.include? ' id="name"')
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/tabs/docinfo.rb

@@ -5,20 +5,22 @@ module Asciidoctor
     module Docinfo
       if RUBY_ENGINE == 'opal'
         DATA_DIR = ::File.absolute_path '../data', %x(__dirname)
-        FILE_READ_MODE = 'r'
       else
         DATA_DIR = ::File.join (::File.absolute_path '../../..', __dir__), 'data'
-        FILE_READ_MODE = 'rb:utf-8:utf-8'
       end
 
       class Styles < ::Asciidoctor::Extensions::DocinfoProcessor
         use_dsl
         at_location :head
 
-        STYLESHEET_FILE = ::File.join DATA_DIR, 'css/tabs.css'
+        DEFAULT_STYLESHEET_FILE = ::File.join DATA_DIR, 'css/tabs.css'
 
-        def process _doc
-          %(<style>\n#{(::File.read STYLESHEET_FILE, mode: FILE_READ_MODE).chomp}\n</style>)
+        def process doc
+          return unless (path = doc.attr 'tabs-stylesheet')
+          return unless (styles = path.empty? ?
+            (doc.read_asset DEFAULT_STYLESHEET_FILE) :
+            (doc.read_contents path, start: (doc.attr 'stylesdir'), warn_on_failure: true, label: 'tabs stylesheet'))
+          %(<style>\n#{styles.chomp}\n</style>)
         end
       end
 
@@ -28,8 +30,9 @@ module Asciidoctor
 
         JAVASCRIPT_FILE = ::File.join DATA_DIR, 'js/tabs.js'
 
-        def process _doc
-          %(<script>\n#{(::File.read JAVASCRIPT_FILE, mode: FILE_READ_MODE).chomp}\n</script>)
+        def process doc
+          return unless (script = doc.read_asset JAVASCRIPT_FILE)
+          %(<script>\n#{script.chomp}\n</script>)
         end
       end
     end

data/lib/asciidoctor/tabs/extensions.rb

@@ -8,12 +8,19 @@ end
 module Asciidoctor
   module Tabs
     module Extensions
+      const_set :Block, Block
+      const_set :Docinfo, Docinfo
+
       module_function
 
       def group
         proc do
           block Block, :tabs
-          next if @document.embedded?
+          next if (doc = @document).embedded? || !(doc.attr? 'filetype', 'html')
+          unless (doc.attribute_locked? 'tabs-stylesheet') ||
+              ((doc.options[:attributes] || {}).transform_keys {|it| it.delete '@!' }.key? 'tabs-stylesheet')
+            doc.set_attr 'tabs-stylesheet'
+          end
           docinfo_processor Docinfo::Styles
           docinfo_processor Docinfo::Behavior
           nil

data/lib/asciidoctor/tabs/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Tabs
-    VERSION = '1.0.0.alpha.2'
+    VERSION = '1.0.0.alpha.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-tabs
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.2
+  version: 1.0.0.alpha.4
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor