add convert description lists to the semantic HTML 5 converter

asciidoctor · Jul 30, 2022 · 2c61693 · 2c61693
1 parent d15b25e
commit 2c61693
Show file tree

Hide file tree

Showing 15 changed files with 117 additions and 0 deletions.
diff --git a/lib/asciidoctor/converter/semantic_html5.rb b/lib/asciidoctor/converter/semantic_html5.rb
@@ -151,6 +151,39 @@ def convert_olist node
     ret.join LF
   end
 
+  def convert_dlist node
+    roles = []
+    roles << node.style if node.style
+    roles << node.role if node.role
+    role = roles.join " "
+    attributes = common_html_attributes node.id, role.empty? ? nil : role
+    if node.list_marker_keyword
+      attributes << %( type="#{node.list_marker_keyword}")
+    end
+    ret = []
+    ret << if node.title?
+      %(<dl#{attributes}>
+<strong class="title">#{node.title}</strong>)
+    else
+      %(<dl#{attributes}>)
+    end
+    node.items.each do |terms, desc|
+      terms.each do |term|
+          ret << %(<dt>#{term.text}</dt>)
+      end
+      sub_content = if desc.blocks?
+        %(
+#{desc.content}
+)
+      else
+        ""
+      end
+      ret << %(<dd>#{desc.text}#{sub_content}</dd>)
+    end
+    ret << %{</dl>}
+    ret.join LF
+  end
+
   def convert_image node
     roles = []
     roles << node.role if node.role

diff --git a/test/fixtures/semantic-html5-scenarios/description-list-horizontal.adoc b/test/fixtures/semantic-html5-scenarios/description-list-horizontal.adoc
@@ -0,0 +1,4 @@
+[horizontal]
+Description Term 1:: Description Body 1.
+Description Term 2:: Description Body 2.
+Description Term 3:: Description Body 3.
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-horizontal.html b/test/fixtures/semantic-html5-scenarios/description-list-horizontal.html
@@ -0,0 +1,8 @@
+<dl class="horizontal">
+<dt>Description Term 1</dt>
+<dd>Description Body 1.</dd>
+<dt>Description Term 2</dt>
+<dd>Description Body 2.</dd>
+<dt>Description Term 3</dt>
+<dd>Description Body 3.</dd>
+</dl>
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-id-roles.adoc b/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-id-roles.adoc
@@ -0,0 +1,4 @@
+[qanda#the_dl.style1.style2]
+Question 1?:: Answer 1.
+Question 2?:: Answer 2.
+Question 3?:: Answer 3.
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-id-roles.html b/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-id-roles.html
@@ -0,0 +1,8 @@
+<dl id="the_dl" class="qanda style1 style2">
+<dt>Question 1?</dt>
+<dd>Answer 1.</dd>
+<dt>Question 2?</dt>
+<dd>Answer 2.</dd>
+<dt>Question 3?</dt>
+<dd>Answer 3.</dd>
+</dl>
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-id.adoc b/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-id.adoc
@@ -0,0 +1,4 @@
+[qanda#the_dl]
+Question 1?:: Answer 1.
+Question 2?:: Answer 2.
+Question 3?:: Answer 3.
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-id.html b/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-id.html
@@ -0,0 +1,8 @@
+<dl id="the_dl" class="qanda">
+<dt>Question 1?</dt>
+<dd>Answer 1.</dd>
+<dt>Question 2?</dt>
+<dd>Answer 2.</dd>
+<dt>Question 3?</dt>
+<dd>Answer 3.</dd>
+</dl>
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-roles.adoc b/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-roles.adoc
@@ -0,0 +1,4 @@
+[qanda.style1.style2]
+Question 1?:: Answer 1.
+Question 2?:: Answer 2.
+Question 3?:: Answer 3.
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-roles.html b/test/fixtures/semantic-html5-scenarios/description-list-qanda-with-roles.html
@@ -0,0 +1,8 @@
+<dl class="qanda style1 style2">
+<dt>Question 1?</dt>
+<dd>Answer 1.</dd>
+<dt>Question 2?</dt>
+<dd>Answer 2.</dd>
+<dt>Question 3?</dt>
+<dd>Answer 3.</dd>
+</dl>
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-qanda.adoc b/test/fixtures/semantic-html5-scenarios/description-list-qanda.adoc
@@ -0,0 +1,4 @@
+[qanda]
+Question 1?:: Answer 1.
+Question 2?:: Answer 2.
+Question 3?:: Answer 3.
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-qanda.html b/test/fixtures/semantic-html5-scenarios/description-list-qanda.html
@@ -0,0 +1,8 @@
+<dl class="qanda">
+<dt>Question 1?</dt>
+<dd>Answer 1.</dd>
+<dt>Question 2?</dt>
+<dd>Answer 2.</dd>
+<dt>Question 3?</dt>
+<dd>Answer 3.</dd>
+</dl>
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-with-title.adoc b/test/fixtures/semantic-html5-scenarios/description-list-with-title.adoc
@@ -0,0 +1,4 @@
+.The Description List
+Description Term 1:: Description Body 1.
+Description Term 2:: Description Body 2.
+Description Term 3:: Description Body 3.
diff --git a/test/fixtures/semantic-html5-scenarios/description-list-with-title.html b/test/fixtures/semantic-html5-scenarios/description-list-with-title.html
@@ -0,0 +1,9 @@
+<dl>
+<strong class="title">The Description List</strong>
+<dt>Description Term 1</dt>
+<dd>Description Body 1.</dd>
+<dt>Description Term 2</dt>
+<dd>Description Body 2.</dd>
+<dt>Description Term 3</dt>
+<dd>Description Body 3.</dd>
+</dl>
diff --git a/test/fixtures/semantic-html5-scenarios/description-list.adoc b/test/fixtures/semantic-html5-scenarios/description-list.adoc
@@ -0,0 +1,3 @@
+Description Term 1:: Description Body 1.
+Description Term 2:: Description Body 2.
+Description Term 3:: Description Body 3.
diff --git a/test/fixtures/semantic-html5-scenarios/description-list.html b/test/fixtures/semantic-html5-scenarios/description-list.html
@@ -0,0 +1,8 @@
+<dl>
+<dt>Description Term 1</dt>
+<dd>Description Body 1.</dd>
+<dt>Description Term 2</dt>
+<dd>Description Body 2.</dd>
+<dt>Description Term 3</dt>
+<dd>Description Body 3.</dd>
+</dl>