GNU bug report logs - #3473
[PATCH] sgml-tag-help fixes for HTML mode

Previous Next

Package: emacs;

Reported by: "Aaron S. Hawley" <aaron.s.hawley <at> gmail.com>

Date: Fri, 5 Jun 2009 04:55:05 UTC

Severity: normal

Done: Chong Yidong <cyd <at> stupidchicken.com>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (Emacs bug Tracking System)
To: Chong Yidong <cyd <at> stupidchicken.com>
Subject: bug#3473: marked as done ([PATCH] sgml-tag-help fixes for HTML mode)
Date: Sun, 18 Oct 2009 04:15:04 +0000
[Message part 1 (text/plain, inline)]
Your message dated Sun, 18 Oct 2009 00:07:22 -0400
with message-id <87pr8lcpl1.fsf <at> stupidchicken.com>
and subject line Re: [PATCH] sgml-tag-help fixes for HTML mode
has caused the Emacs bug report #3473,
regarding [PATCH] sgml-tag-help fixes for HTML mode
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact help-debbugs <at> gnu.org
immediately.)


-- 
3473: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3473
Emacs Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: "Aaron S. Hawley" <aaron.s.hawley <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] sgml-tag-help fixes for HTML mode
Date: Fri, 5 Jun 2009 00:48:12 -0400
[Message part 3 (text/plain, inline)]
I noticed that `C-c ?' in HTML mode doesn't work as it is described in
the Emacs manual, and for a few of the tags that it supports.  Some of
the tags lacked descriptions, notably DIV and SPAN.  The patch below
tries to rectify both of these.

Here's the Emacs manual's description of `C-c ?':

`C-c ? TAG <RET>'
     Display a description of the meaning of tag TAG (`sgml-tag-help').
     If the argument TAG is empty, describe the tag at point.

Thanks for Emacs,
/a

Index: sgml-mode.el
===================================================================
2009-06-05  Aaron S. Hawley  <aaron.s.hawley <at> gmail.com>

        * textmodes/sgml-mode.el (sgml-tag-help): Prompt user for tag as
        the documentation describes.
        (html-tag-alist, html-tag-help): Add descriptions for undocumented
        entries and make note of obsolete tags.

--- sgml-mode.el        9 Jan 2009 04:19:12 -0000       1.139
+++ sgml-mode.el        5 Jun 2009 04:31:18 -0000
@@ -720,8 +720,10 @@

 (defun sgml-tag-help (&optional tag)
   "Display description of tag TAG.  If TAG is omitted, use the tag at point."
-  (interactive)
-  (or tag
+  (interactive
+   (list (completing-read "Tag: "
+                         sgml-tag-alist nil nil nil 'sgml-tag-history)))
+  (or (and tag (> (length tag) 0))
       (save-excursion
        (if (eq (following-char) ?<)
            (forward-char))
@@ -1731,7 +1733,7 @@
       ("array" (nil \n
                    ("Item: " "<item>" str (if sgml-xml-mode "</item>") \n))
        "align")
-      ("au")
+      ("au") ;; Cite an author.
       ("b")
       ("big")
       ("blink")
@@ -1755,7 +1757,7 @@
       ("dt" (t _ (if sgml-xml-mode "</dt>")
              "<dd>" (if sgml-xml-mode "</dd>") \n))
       ("em")
-      ;("fn" "id" "fn")  ; ???
+      ("fn" "id" "fn")  ;; Footnotes were deprecated in HTML 3.2
       ("head" \n)
       ("html" (\n
               "<head>\n"
@@ -1777,7 +1779,7 @@
       ("nobr")
       ("option" t ("value") ("label") ("selected" t))
       ("over" t)
-      ("person")
+      ("person") ;; Tag for person's name tag deprecated in HTML 3.2
       ("pre" \n)
       ("q")
       ("rev")
@@ -1809,11 +1811,11 @@
 (defvar html-tag-help
   `(,@sgml-tag-help
     ("a" . "Anchor of point or link elsewhere")
-    ("abbrev" . "?")
-    ("acronym" . "?")
+    ("abbrev" . "Abbreviation")
+    ("acronym" . "Acronym")
     ("address" . "Formatted mail address")
     ("array" . "Math array")
-    ("au" . "?")
+    ("au" . "Author")
     ("b" . "Bold face")
     ("base" . "Base address for URLs")
     ("big" . "Font size")
@@ -1828,9 +1830,10 @@
     ("cite" . "Citation of a document")
     ("code" . "Formatted source code")
     ("dd" . "Definition of term")
-    ("del" . "?")
-    ("dfn" . "?")
+    ("del" . "Deleted text")
+    ("dfn" . "Defining instance of a term")
     ("dir" . "Directory list (obsolete)")
+    ("div" . "Generic block-level container")
     ("dl" . "Definition list")
     ("dt" . "Term to be definined")
     ("em" . "Emphasized")
@@ -1839,7 +1842,7 @@
     ("figa" . "Figure anchor")
     ("figd" . "Figure description")
     ("figt" . "Figure text")
-    ;("fn" . "?")  ; ???
+    ("fn" . "Footnote") ;; No one supports special footnote rendering.
     ("font" . "Font size")
     ("form" . "Form with input fields")
     ("group" . "Document grouping")
@@ -1855,7 +1858,7 @@
     ("i" . "Italic face")
     ("img" . "Graphic image")
     ("input" . "Form input field")
-    ("ins" . "?")
+    ("ins" . "Inserted text")
     ("isindex" . "Input field for index search")
     ("kbd" . "Keybard example face")
     ("lang" . "Natural language")
@@ -1871,15 +1874,16 @@
     ("over" . "Math fraction rule")
     ("p" . "Paragraph start")
     ("panel" . "Floating panel")
-    ("person" . "?")
+    ("person" . "Person's name") ;; Originally for people harvesting.
     ("pre" . "Preformatted fixed width text")
-    ("q" . "?")
+    ("q" . "Quotation")
     ("rev" . "Reverse video")
-    ("s" . "?")
+    ("s" . "Strikeout")
     ("samp" . "Sample text")
     ("select" . "Selection list")
     ("small" . "Font size")
     ("sp" . "Nobreak space")
+    ("span" . "Generic inline container")
     ("strong" . "Standout text")
     ("sub" . "Subscript")
     ("sup" . "Superscript")

-- 
In general, we reserve the right to have a poor
memory--the computer, however, is supposed to
remember!  Poor computer.  -- Guy Lewis Steele Jr.
[sgml-mode.el.diff (application/octet-stream, attachment)]
[Message part 5 (message/rfc822, inline)]
From: Chong Yidong <cyd <at> stupidchicken.com>
To: "Aaron S. Hawley" <aaron.s.hawley <at> gmail.com>
Cc: 3473-done <at> debbugs.gnu.org
Subject: Re: [PATCH] sgml-tag-help fixes for HTML mode
Date: Sun, 18 Oct 2009 00:07:22 -0400
> I noticed that `C-c ?' in HTML mode doesn't work as it is described in
> the Emacs manual, and for a few of the tags that it supports.  Some of
> the tags lacked descriptions, notably DIV and SPAN.  The patch below
> tries to rectify both of these.

Thanks, and sorry for the late reply.  I've checked in your patch, with
minor modifications (adding a default argument to completing read).

This bug report was last modified 15 years and 280 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.