Fix GH-152 + GH-213: Admonition id propagation and semantic title

phpdotnet/phd/Package/Generic/XHTML.php

@@ -1974,11 +1974,15 @@ protected function normalizeFQN(string $fqn): string {
 
     public function admonition_title($title, $lang)
     {
-        return '<strong class="' .(strtolower($title)). '">' .($this->autogen($title, $lang)). '</strong>';
+        return '<h5 class="' .(strtolower($title)). '">' .($this->autogen($title, $lang)). '</h5>';
     }
     public function format_admonition($open, $name, $attrs, $props) {
         if ($open) {
-            return '<div class="'. $name. '">' .$this->admonition_title($name, $props["lang"]);
+            $idstr = "";
+            if (isset($attrs[Reader::XMLNS_XML]["id"])) {
+                $idstr = ' id="' . $attrs[Reader::XMLNS_XML]["id"] . '"';
+            }
+            return '<div class="'. $name. '"' . $idstr . '>' .$this->admonition_title($name, $props["lang"]);
         }
         return "</div>";
     }
@@ -1999,7 +2003,12 @@ public function format_editor($open, $name, $attrs, $props) {
     }
     public function format_note($open, $name, $attrs, $props) {
         if ($open) {
-            return '<blockquote class="note"><p>'.$this->admonition_title("note", $props["lang"]). ': ';
+            $idstr = "";
+            if (isset($attrs[Reader::XMLNS_XML]["id"])) {
+                $idstr = ' id="' . $attrs[Reader::XMLNS_XML]["id"] . '"';
+            }
+            return '<blockquote class="note"' . $idstr . '><p>'
+                .$this->admonition_title("note", $props["lang"]). ': ';
         }
         return "</p></blockquote>";
     }

phpdotnet/phd/Package/PEAR/XHTML.php

@@ -868,7 +868,11 @@ public function format_replaceable($open, $name, $attrs, $props)
     public function format_warning($open, $name, $attrs, $props)
     {
         if ($open) {
-            return '<blockquote class="warning">' . "\n";
+            $idstr = "";
+            if (isset($attrs[Reader::XMLNS_XML]["id"])) {
+                $idstr = ' id="' . $attrs[Reader::XMLNS_XML]["id"] . '"';
+            }
+            return '<blockquote class="warning"' . $idstr . '>' . "\n";
         }
         return "</blockquote>\n";
     }

tests/package/php/admonition_rendering_001.phpt

@@ -0,0 +1,69 @@
+--TEST--
+Admonition rendering (GH-152 id propagation + GH-213 semantic title)
+--FILE--
+<?php
+namespace phpdotnet\phd;
+
+require_once __DIR__ . "/../../setup.php";
+
+$xmlFile = __DIR__ . "/data/admonition_rendering.xml";
+
+$config->xmlFile = $xmlFile;
+
+$format = new TestPHPChunkedXHTML($config, $outputHandler);
+
+$render = new TestRender(new Reader($outputHandler), $config, $format);
+
+$render->run();
+?>
+--EXPECT--
+Filename: admonition_rendering.html
+Content:
+<div id="admonition_rendering" class="chapter">
+
+ <div class="section">
+  <p class="para">1. Warning with xml:id</p>
+  <div class="warning" id="warn.test"><h5 class="warning">Warning</h5>
+   <p class="para">This is a warning with an id.</p>
+  </div>
+ </div>
+
+ <div class="section">
+  <p class="para">2. Caution without xml:id</p>
+  <div class="caution"><h5 class="caution">Caution</h5>
+   <p class="para">This is a caution without an id.</p>
+  </div>
+ </div>
+
+ <div class="section">
+  <p class="para">3. Tip with xml:id</p>
+  <div class="tip" id="tip.test"><h5 class="tip">Tip</h5>
+   <p class="para">This is a tip with an id.</p>
+  </div>
+ </div>
+
+ <div class="section">
+  <p class="para">4. Note with xml:id</p>
+  <blockquote class="note" id="note.test"><p><h5 class="note">Note</h5>: 
+   <p class="para">This is a note with an id.</p>
+  </p></blockquote>
+ </div>
+
+ <div class="section">
+  <p class="para">5. Important without xml:id</p>
+  <div class="important"><h5 class="important">Important</h5>
+   <p class="para">This is an important without an id.</p>
+  </div>
+ </div>
+
+ <div class="section">
+  <p class="para">6. Warning with constructorsynopsis</p>
+  <div class="warning"><h5 class="warning">Warning</h5>
+   <p class="para">This constructor is deprecated:</p>
+   <div class="constructorsynopsis dc-description"><span class="modifier">public</span>
+    <span class="methodname"><strong>ClassName::__construct</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.html" class="type string">string</a></span> <code class="parameter">$param</code></span>)</div>
+
+  </div>
+ </div>
+
+</div>

tests/package/php/data/admonition_rendering.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter xml:id="admonition_rendering" xmlns="http://docbook.org/ns/docbook">
+
+ <section>
+  <para>1. Warning with xml:id</para>
+  <warning xml:id="warn.test">
+   <para>This is a warning with an id.</para>
+  </warning>
+ </section>
+
+ <section>
+  <para>2. Caution without xml:id</para>
+  <caution>
+   <para>This is a caution without an id.</para>
+  </caution>
+ </section>
+
+ <section>
+  <para>3. Tip with xml:id</para>
+  <tip xml:id="tip.test">
+   <para>This is a tip with an id.</para>
+  </tip>
+ </section>
+
+ <section>
+  <para>4. Note with xml:id</para>
+  <note xml:id="note.test">
+   <para>This is a note with an id.</para>
+  </note>
+ </section>
+
+ <section>
+  <para>5. Important without xml:id</para>
+  <important>
+   <para>This is an important without an id.</para>
+  </important>
+ </section>
+
+ <section>
+  <para>6. Warning with constructorsynopsis</para>
+  <warning>
+   <para>This constructor is deprecated:</para>
+   <constructorsynopsis>
+    <modifier>public</modifier>
+    <methodname>ClassName::__construct</methodname>
+    <methodparam><type>string</type><parameter>param</parameter></methodparam>
+   </constructorsynopsis>
+  </warning>
+ </section>
+
+</chapter>