[libvirt] [PATCH] docs: Space out entries in news.html

Peter Krempa posted 1 patch 4 years, 10 months ago
Test syntax-check passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/f19a82b558790b7b265f8de02f3306b2c83b7001.1561104317.git.pkrempa@redhat.com
docs/libvirt.css   | 15 +++++++++++++++
docs/news-html.xsl | 13 +++++++++----
2 files changed, 24 insertions(+), 4 deletions(-)
[libvirt] [PATCH] docs: Space out entries in news.html
Posted by Peter Krempa 4 years, 10 months ago
The header for the news entry blends together with the text and other
entries. This patch tries to space them out somewhat for better visual
separation.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
---

You can see the difference here:

https://github.com/pipo/libvirt/blob/screenshots/before.png
https://github.com/pipo/libvirt/blob/screenshots/after.png

 docs/libvirt.css   | 15 +++++++++++++++
 docs/news-html.xsl | 13 +++++++++----
 2 files changed, 24 insertions(+), 4 deletions(-)

diff --git a/docs/libvirt.css b/docs/libvirt.css
index 4c7afc4042..e44ef616d8 100644
--- a/docs/libvirt.css
+++ b/docs/libvirt.css
@@ -591,3 +591,18 @@ td.enumvalue {
 .deprecatedhv {
     color: darkred;
 }
+
+ul.news-section {
+    margin-top: 0.5em;
+}
+
+ul.news-section li dl dt {
+    margin: 0;
+}
+
+ul.news-section li dl dd {
+    margin-left: 1em;
+    margin-right: 0;
+    margin-top: 0.5em;
+    margin-bottom: 0.5em;
+}
diff --git a/docs/news-html.xsl b/docs/news-html.xsl
index 4d40798028..fb0178f9e2 100644
--- a/docs/news-html.xsl
+++ b/docs/news-html.xsl
@@ -58,7 +58,7 @@
         <xsl:value-of select="@title"/>
       </strong>
       <xsl:if test="*">
-        <ul>
+        <ul class="news-section">
           <xsl:apply-templates select="change"/>
         </ul>
       </xsl:if>
@@ -68,8 +68,14 @@
   <!-- Change -->
   <xsl:template match="change">
     <li>
-      <xsl:apply-templates select="summary"/>
-      <xsl:apply-templates select="description"/>
+      <dl>
+        <dt>
+          <xsl:apply-templates select="summary"/>
+        </dt>
+        <dd>
+          <xsl:apply-templates select="description"/>
+        </dd>
+      </dl>
     </li>
   </xsl:template>

@@ -80,7 +86,6 @@

   <!-- Change description -->
   <xsl:template match="description">
-    <br/>
     <xsl:apply-templates/>
   </xsl:template>

-- 
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH] docs: Space out entries in news.html
Posted by Martin Kletzander 4 years, 10 months ago
On Fri, Jun 21, 2019 at 10:06:01AM +0200, Peter Krempa wrote:
>The header for the news entry blends together with the text and other
>entries. This patch tries to space them out somewhat for better visual
>separation.
>
>Signed-off-by: Peter Krempa <pkrempa@redhat.com>
>---
>
>You can see the difference here:
>
>https://github.com/pipo/libvirt/blob/screenshots/before.png
>https://github.com/pipo/libvirt/blob/screenshots/after.png
>

I think it looks better with your change, so:

Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH] docs: Space out entries in news.html
Posted by Andrea Bolognani 4 years, 10 months ago
On Fri, 2019-06-21 at 10:06 +0200, Peter Krempa wrote:
[...]
> +++ b/docs/news-html.xsl
> @@ -58,7 +58,7 @@
>          <xsl:value-of select="@title"/>
>        </strong>
>        <xsl:if test="*">
> -        <ul>
> +        <ul class="news-section">

Can you rename this to "news-section-contents" please? The current
name would be more fitting if it was used for the *outer* <li>, the
one that encompasses the section title too.

Either way,

  Reviewed-by: Andrea Bolognani <abologna@redhat.com>

-- 
Andrea Bolognani / Red Hat / Virtualization

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list