Merge pull request #4

* Adding code that restyles ordered lists as callout lists if they have…

Author: RayOffiah

.gitignore

@@ -7,10 +7,8 @@
 /spec/reports/
 /tmp/
 /.idea
-**/sample.html
-**/sample_global_search.html
-**/callout-list-block-sample.html
-**/sample.pdf
+/test/*.html
+/test/*.pdf
 *.gem
 /Gemfile.lock
 /.asciidoctor

CHANGELOG.md

@@ -2,10 +2,14 @@
 
 Record of bug fixes, enhancements, and changes.
 
+## [1.2.0] – 2022-07-30
+
+### Added
+- If you add the role `[calloutlist]` to an ordered list then it will be styled to look like a callout list. This allows you to add callouts to annotated images etc. 
+
 ## [1.1.3] – 2022-07-07-16
 
 ### Fixed
-
 - The global and case-insensitive flags (ig) are now parsing correctly: using ii or gg will cause prevent the callout block from being processed. Thanks to Hakim Cassimally for finding the bug.
 - Escaped slash characters were not being processed in the search.  Thanks to Hakim Cassimally for finding the bug.
 

README.md

@@ -70,6 +70,14 @@ Using the text search method means that the location of the callout will move wi
 **@/_text_/gi**
 : And of course, you can combine the two, though I'm not sure why you'd want to.
 
+## Standalone callout lists
+You can create a standalone callout list by adding the `calloutlist` role to an ordered list. This simply styles the list to make it look like a list of callouts so you can use it as a reference to annoted images etc.
+```asciidoc
+[calloutlist]
+. This list can be used to add references to annotated images
+. The list will look like a standard callout list.
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

lib/asciidoctor-external-callout.rb

@@ -18,6 +18,8 @@
   CALLOUT_SOURCE_BLOCK_ROLE ||= 'external-callout-block'
   CALLOUT_ORDERED_LIST_ROLE ||= 'external-callout-list'
 
+  STANDALONE_CALLOUT_LIST_STYLE ||= 'calloutlist'
+
   LOCATION_TOKEN_RX ||= /@(\d+)|(@\/(?:\\\/|[^\/])+?\/[ig]{0,2})/
   LOCATION_TOKEN_ARRAY_RX ||= /^(@\d+|@\/(?:\\\/|[^\/]|)+?\/[ig]{0,2})((\s+@\d+)|(\s+@\/(?:\\\/|[^\/]|)+?\/[ig]{0,2}))*$/
 
@@ -33,18 +35,30 @@
         # The makes sure it's the right kind of list.
         document.find_by context: :olist do |list|
 
-          if external_callout_list? list
+          # if there is as calloutlist style attached to the block
+          # then simply style the block as a colist. This will allow folk
+          # to create callout blocks that can be attached to annotated images etc.
 
-            owner_block = owning_block list
+          if list.style.include? STANDALONE_CALLOUT_LIST_STYLE
 
-            owner_block.subs.replace(owner_block.subs + [:callouts]).uniq
+            list.context = :colist
 
-            process_callouts(list, owner_block)
+          else
 
-            list.context = :colist
+            if external_callout_list? list
+
+              owner_block = owning_block list
 
-            owner_block.add_role(CALLOUT_SOURCE_BLOCK_ROLE) unless owner_block.has_role?(CALLOUT_SOURCE_BLOCK_ROLE)
-            list.add_role(CALLOUT_ORDERED_LIST_ROLE) unless list.has_role?(CALLOUT_ORDERED_LIST_ROLE)
+              owner_block.subs.replace(owner_block.subs + [:callouts]).uniq
+
+              process_callouts(list, owner_block)
+
+              list.context = :colist
+
+              owner_block.add_role(CALLOUT_SOURCE_BLOCK_ROLE) unless owner_block.has_role?(CALLOUT_SOURCE_BLOCK_ROLE)
+              list.add_role(CALLOUT_ORDERED_LIST_ROLE) unless list.has_role?(CALLOUT_ORDERED_LIST_ROLE)
+
+            end
 
           end
 

lib/version.rb

@@ -3,7 +3,7 @@
 module Asciidoctor
   module External
     module Callout
-      VERSION = "1.1.4"
+      VERSION = "1.2.0"
     end
   end
 end

test/asciidoctor-external-callout_test.rb

@@ -108,5 +108,16 @@ def test_for_escaped_slash
     end
   end
 
+  def test_for_standalone_callout
+
+    document = Asciidoctor.convert_file File.join(File.dirname(__FILE__), 'standalone-callout-sample.adoc'),
+                                        safe: :unsafe, backend: :html5,
+                                        attributes: {'stylesheet' => './callout.css'}
+
+
+    assert document.blocks[document.blocks.length - 1].context = :colist
+
+  end
+
 end
 

test/standalone-callout-sample.adoc

@@ -0,0 +1,65 @@
+= Test Document
+
+:source-highlighter: highlight.js
+:icons: font
+
+[source, ruby]
+----
+class ExternalCalloutTreeProcessor < Extensions::TreeProcessor
+
+  use_dsl
+
+  def process(document)
+
+    document.find_by context: :listing, style: 'source'.each do |src|
+
+      Open3.popen3 cmd do |stdin, stdout, _, wait_thr|
+        stdin.write src.source
+        stdin.close
+
+        result = []
+
+        while (line = stdout.gets)
+          result << line
+        end
+
+        result << 'Eureka'
+
+        src.lines.replace result
+        wait_thr.value
+
+      end
+
+    end
+
+  end
+
+end
+----
+
+Can we add in an extra paragraph here?
+
+How about a table?
+
+|===
+| Header Cell 1 | Header Cell 2
+
+| Row 1 Cell 1
+| Row 1 Cell 2
+
+| Row 2 Cell 1
+| Row 2 Cell 2
+|===
+
+. The `use_dsl` line @3
+. The process def at @5
+. Document object used at @5 @7
+. Result first used @/result/
+. There is no line zero @0
+. There is no line five hundred @500
+
+//-
+[calloutlist]
+. This is a standalone callout
+. Which we can restyle
+. as a callout list