unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: "W. Trevor King" <wking@tremily.us>
To: notmuch@notmuchmail.org
Cc: Tomi Ollila <tomi.ollila@iki.fi>
Subject: [PATCH v2 16/20] nmbug-status: Slug the title when using it as an id
Date: Mon, 10 Feb 2014 10:40:37 -0800	[thread overview]
Message-ID: <a0b13a24fabf443c7c4f954c1fda50cb2db761f8.1392056624.git.wking@tremily.us> (raw)
In-Reply-To: <cover.1392056624.git.wking@tremily.us>
In-Reply-To: <cover.1392056624.git.wking@tremily.us>

Also allow manual id overrides from the JSON config.  Sluggin avoids
errors like:

   Bad value '#Possible bugs' for attribute href on element a:
   Whitespace in fragment component. Use %20 in place of spaces.

from http://validator.w3.org.

I tried just quoting the titles (e.g. 'Possible%20bugs'), but that
didn't work (at least with Firefox 24.2.0).  Slugging avoids any
ambiguity over when the quotes are expanded in the client.  The specs
are unclear about quoting, saying only [1]:

  Value: Any string, with the following restrictions:

    must be at least one character long
    must not contain any space characters

[1]: http://dev.w3.org/html5/markup/global-attributes.html#common.attrs.id
---
 devel/nmbug/nmbug-status | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/devel/nmbug/nmbug-status b/devel/nmbug/nmbug-status
index 2b1f364..989d065 100755
--- a/devel/nmbug/nmbug-status
+++ b/devel/nmbug/nmbug-status
@@ -21,6 +21,7 @@ except ImportError:  # Python 2
 import json
 import argparse
 import os
+import re
 import sys
 import subprocess
 
@@ -168,16 +169,20 @@ class Page (object):
 
 
 class HtmlPage (Page):
+    _slug_regexp = re.compile('\W+')
+
     def _write_header(self, views, stream):
         super(HtmlPage, self)._write_header(views=views, stream=stream)
         stream.write('<ul>\n')
         for view in views:
+            if 'id' not in view:
+                view['id'] = self._slug(view['title'])
             stream.write(
-                '<li><a href="#{title}">{title}</a></li>\n'.format(**view))
+                '<li><a href="#{id}">{title}</a></li>\n'.format(**view))
         stream.write('</ul>\n')
 
     def _write_view_header(self, view, stream):
-        stream.write('<h3 id="{title}">{title}</h3>\n'.format(**view))
+        stream.write('<h3 id="{id}">{title}</h3>\n'.format(**view))
         if 'comment' in view:
             stream.write(view['comment'])
             stream.write('\n')
@@ -224,6 +229,9 @@ class HtmlPage (Page):
                 ).format(**d)
         return (running_data, display_data)
 
+    def _slug(self, string):
+        return self._slug_regexp.sub('-', string)
+
 
 _PAGES['text'] = Page()
 _PAGES['html'] = HtmlPage(
-- 
1.8.5.2.8.g0f6c0d1

  parent reply	other threads:[~2014-02-10 18:45 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-02-10 18:40 [PATCH v2 00/20] nmbug-status: Python-3-compatibility and general refactoring W. Trevor King
2014-02-10 18:40 ` [PATCH v2 01/20] nmbug-status: Convert to Python-3-compatible print functions W. Trevor King
2014-02-10 18:40 ` [PATCH v2 02/20] nmbug-status: Use email.utils instead of rfc822 W. Trevor King
2014-02-10 18:40 ` [PATCH v2 03/20] nmbug-status: Decode Popen output using the user's locale W. Trevor King
2014-02-10 18:40 ` [PATCH v2 04/20] nmbug-status: Factor config-loading out into read_config W. Trevor King
2014-02-10 18:40 ` [PATCH v2 05/20] nmbug-status: Add metavars for --config and --get-query W. Trevor King
2014-02-10 18:40 ` [PATCH v2 06/20] nmbug-status: Consolidate functions and main code W. Trevor King
2014-02-10 18:40 ` [PATCH v2 07/20] nmbug-status: Don't require write access W. Trevor King
2014-02-10 18:40 ` [PATCH v2 08/20] nmbug-status: Consolidate HTML header printing W. Trevor King
2014-02-10 18:40 ` [PATCH v2 09/20] nmbug-status: Add a Python-3-compatible urllib.parse.quote import W. Trevor King
2014-02-10 18:40 ` [PATCH v2 10/20] nmbug-status: Add Page and HtmlPage for modular rendering W. Trevor King
2014-02-10 18:40 ` [PATCH v2 11/20] nmbug-status: Add an OrderedDict stub for Python 2.6 W. Trevor King
2014-02-10 18:40 ` [PATCH v2 12/20] nmbug-status: Normalize table HTML indentation W. Trevor King
2014-02-10 18:40 ` [PATCH v2 13/20] nmbug-status: Convert from XHTML 1.0 to HTML 5 W. Trevor King
2014-02-12 23:35   ` David Bremner
2014-02-13  2:06     ` W. Trevor King
2014-02-13  7:30       ` Tomi Ollila
2014-02-10 18:40 ` [PATCH v2 14/20] nmbug-status: Encode output using the user's locale W. Trevor King
2014-02-11 12:12   ` David Bremner
2014-02-11 14:14     ` Tomi Ollila
2014-02-11 20:11       ` W. Trevor King
2014-02-11 22:02         ` David Bremner
2014-02-11 22:33           ` W. Trevor King
2014-02-13  2:13             ` David Bremner
2014-02-13  2:35               ` W. Trevor King
2014-02-13 11:47                 ` David Bremner
2014-02-10 18:40 ` [PATCH v2 15/20] nmbug-status: Anchor with h3 ids instead of a names W. Trevor King
2014-02-10 18:40 ` W. Trevor King [this message]
2014-02-10 18:40 ` [PATCH v2 17/20] nmbug-status: Use <code> and <p> markup where appropriate W. Trevor King
2014-02-10 18:40 ` [PATCH v2 18/20] nmbug-status: Color threads in HTML output W. Trevor King
2014-02-10 18:40 ` [PATCH v2 19/20] nmbug-status: Escape &, <, and > in HTML display data W. Trevor King
2014-02-10 18:40 ` [PATCH v2 20/20] nmbug-status: Add inter-message padding W. Trevor King
2014-02-10 20:29 ` [PATCH v2 00/20] nmbug-status: Python-3-compatibility and general refactoring Tomi Ollila

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

  List information: https://notmuchmail.org/

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

  git send-email \
    --in-reply-to=a0b13a24fabf443c7c4f954c1fda50cb2db761f8.1392056624.git.wking@tremily.us \
    --to=wking@tremily.us \
    --cc=notmuch@notmuchmail.org \
    --cc=tomi.ollila@iki.fi \
    /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 public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).