[ELPA] [PATCH] CSS readability improvements

[ELPA] [PATCH] CSS readability improvements

[Adam Porter]

[-- Attachment #1: Type: text/plain, Size: 134 bytes --]

Hi Stefan, Philip, et al,

Attached please find two patches which improve the readability of 
package's manuals on ELPA.

Thanks,
Adam

[-- Attachment #2: 0001-html-layout.css-table-margin-1em-0-1em.patch --]
[-- Type: text/x-patch, Size: 652 bytes --]

From 870631825430258d9b156e38165f5205af0b5bfd Mon Sep 17 00:00:00 2001
From: Adam Porter <adam@alphapapa.net>
Date: Sat, 16 Mar 2024 22:54:59 -0500
Subject: [PATCH 1/2] * html/layout.css (table): margin: 1em 0 1em

Ensure some margin around tables, otherwise they run up against body
text and other tables.
---
 html/layout.css | 1 +
 1 file changed, 1 insertion(+)

diff --git a/html/layout.css b/html/layout.css
index 7d3be41ffd..6d0dc4a5ff 100644
--- a/html/layout.css
+++ b/html/layout.css
@@ -54,6 +54,7 @@ q:before, q:after {
 table {
   border-collapse: collapse;
   border-spacing: 0;
+  margin: 1em 0 1em;
 }
 
 /* End of reset */
-- 
2.30.2


[-- Attachment #3: 0002-html-layout.css-Improve-readability-of-DL-elements.patch --]
[-- Type: text/x-patch, Size: 1674 bytes --]

From 09e654b09b86f1331fe9c939bd08b8f74c97881e Mon Sep 17 00:00:00 2001
From: Adam Porter <adam@alphapapa.net>
Date: Sat, 16 Mar 2024 22:59:18 -0500
Subject: [PATCH 2/2] * html/layout.css: Improve readability of DL elements

(dl): Don't decrease font size.  Indent list slightly to set off from
body text.
(dt): Don't limit width.  Don't display inline.  Ensure small margin
above each term.
(dd): Don't limit width.  Don't display inline.

While DL lists might be expected to be, e.g. a glossary, where each DT
element is just one term, these lists are commonly used for other
purposes, in which DT elements may be a sentence or more; this is
especially so for some ELPA packages' manuals which are exported to
HTML from Org files.  Cramming these terms into a narrow column next
to their definition makes such lists hard to read.  Instead, this
change puts the terms and definitions on their own lines.
---
 html/layout.css | 19 ++++---------------
 1 file changed, 4 insertions(+), 15 deletions(-)

diff --git a/html/layout.css b/html/layout.css
index 6d0dc4a5ff..f14a8ff4f9 100644
--- a/html/layout.css
+++ b/html/layout.css
@@ -168,24 +168,13 @@ p.centered {
 }
 
 dl {
-  margin: 30px 0;
-  font-size: .8em;
+  margin: 30px 2em;
 }
 
 dt {
-  font-weight: bold;
-  width: 300px;
-  display: inline-block;
-  vertical-align: top;
-}
-
-dd {
-  /* We should reduce vertical space use in the "header".
-     Yuan Fu <casouri@gmail.com> suggested to do that simply by
-     commenting this out:
-     margin-bottom: 10px; */
-  width: 460px;
-  display: inline-block;
+    font-weight: bold;
+    margin: 0.25em 0 0 0;
+    vertical-align: top;
 }
 
 .button {
-- 
2.30.2

Re: [ELPA] [PATCH] CSS readability improvements

[Stefan Monnier]

Hi Adam,

Thank you very much for these.  Could you point to existing places in
`elpa.(non)gnu.org` where we can see the current problems, so as to help
me understand what's the actual intended impact of your changes?


        Stefan


> Attached please find two patches which improve the readability of package's
> manuals on ELPA.
>
> Thanks,
> Adam
>
> From 870631825430258d9b156e38165f5205af0b5bfd Mon Sep 17 00:00:00 2001
> From: Adam Porter <adam@alphapapa.net>
> Date: Sat, 16 Mar 2024 22:54:59 -0500
> Subject: [PATCH 1/2] * html/layout.css (table): margin: 1em 0 1em
>
> Ensure some margin around tables, otherwise they run up against body
> text and other tables.
> ---
>  html/layout.css | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/html/layout.css b/html/layout.css
> index 7d3be41ffd..6d0dc4a5ff 100644
> --- a/html/layout.css
> +++ b/html/layout.css
> @@ -54,6 +54,7 @@ q:before, q:after {
>  table {
>    border-collapse: collapse;
>    border-spacing: 0;
> +  margin: 1em 0 1em;
>  }
>  
>  /* End of reset */
> -- 
> 2.30.2
>
>
> From 09e654b09b86f1331fe9c939bd08b8f74c97881e Mon Sep 17 00:00:00 2001
> From: Adam Porter <adam@alphapapa.net>
> Date: Sat, 16 Mar 2024 22:59:18 -0500
> Subject: [PATCH 2/2] * html/layout.css: Improve readability of DL elements
>
> (dl): Don't decrease font size.  Indent list slightly to set off from
> body text.
> (dt): Don't limit width.  Don't display inline.  Ensure small margin
> above each term.
> (dd): Don't limit width.  Don't display inline.
>
> While DL lists might be expected to be, e.g. a glossary, where each DT
> element is just one term, these lists are commonly used for other
> purposes, in which DT elements may be a sentence or more; this is
> especially so for some ELPA packages' manuals which are exported to
> HTML from Org files.  Cramming these terms into a narrow column next
> to their definition makes such lists hard to read.  Instead, this
> change puts the terms and definitions on their own lines.
> ---
>  html/layout.css | 19 ++++---------------
>  1 file changed, 4 insertions(+), 15 deletions(-)
>
> diff --git a/html/layout.css b/html/layout.css
> index 6d0dc4a5ff..f14a8ff4f9 100644
> --- a/html/layout.css
> +++ b/html/layout.css
> @@ -168,24 +168,13 @@ p.centered {
>  }
>  
>  dl {
> -  margin: 30px 0;
> -  font-size: .8em;
> +  margin: 30px 2em;
>  }
>  
>  dt {
> -  font-weight: bold;
> -  width: 300px;
> -  display: inline-block;
> -  vertical-align: top;
> -}
> -
> -dd {
> -  /* We should reduce vertical space use in the "header".
> -     Yuan Fu <casouri@gmail.com> suggested to do that simply by
> -     commenting this out:
> -     margin-bottom: 10px; */
> -  width: 460px;
> -  display: inline-block;
> +    font-weight: bold;
> +    margin: 0.25em 0 0 0;
> +    vertical-align: top;
>  }
>  
>  .button {

Re: [ELPA] [PATCH] CSS readability improvements

[Adam Porter]

Hi Stefan,

On 3/16/24 23:14, Stefan Monnier wrote:
> Hi Adam,
> 
> Thank you very much for these.  Could you point to existing places in
> `elpa.(non)gnu.org` where we can see the current problems, so as to help
> me understand what's the actual intended impact of your changes?

You can see these issues on various packages of mine whose readmes on 
ELPA are generated from Org manuals, such as 
<https://elpa.gnu.org/devel/listen.html> (see the tables listing 
commands under "Commands", which are displayed without any space between 
them; and the DL list under "Repeat modes"), and 
<https://elpa.gnu.org/packages/activities.html> (see the FAQ section).

--Adam

Re: [ELPA] [PATCH] CSS readability improvements

[Philip Kaludercic]

Adam Porter <adam@alphapapa.net> writes:

> Hi Stefan,
>
> On 3/16/24 23:14, Stefan Monnier wrote:
>> Hi Adam,
>> Thank you very much for these.  Could you point to existing places
>> in
>> `elpa.(non)gnu.org` where we can see the current problems, so as to help
>> me understand what's the actual intended impact of your changes?
>
> You can see these issues on various packages of mine whose readmes on
> ELPA are generated from Org manuals, such as
> <https://elpa.gnu.org/devel/listen.html> (see the tables listing
> commands under "Commands", which are displayed without any space
> between them; and the DL list under "Repeat modes"), and
> <https://elpa.gnu.org/packages/activities.html> (see the FAQ section).

Not related to the patch, why are you using description lists for FAQs?

-- 
	Philip Kaludercic on peregrine