all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Adam Porter <adam@alphapapa.net>
To: emacs-devel <emacs-devel@gnu.org>
Cc: Stefan Monnier <monnier@iro.umontreal.ca>,
	Philip Kaludercic <philipk@posteo.net>
Subject: [ELPA] [PATCH] CSS readability improvements
Date: Sat, 16 Mar 2024 23:07:53 -0500	[thread overview]
Message-ID: <02a14c45-2b27-4067-bbe4-95a5c086f53d@alphapapa.net> (raw)

[-- 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


             reply	other threads:[~2024-03-17  4:07 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-17  4:07 Adam Porter [this message]
2024-03-17  4:14 ` [ELPA] [PATCH] CSS readability improvements Stefan Monnier
2024-03-17  4:19   ` Adam Porter
2024-03-17 14:43     ` Philip Kaludercic

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=02a14c45-2b27-4067-bbe4-95a5c086f53d@alphapapa.net \
    --to=adam@alphapapa.net \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=philipk@posteo.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.