Version 2.0.0 (2016-03-17)

sunaku · Mar 18, 2016 · fe3abd0 · fe3abd0
1 parent 1937421
commit fe3abd0
Show file tree

Hide file tree

Showing 23 changed files with 95 additions and 22 deletions.
diff --git a/VERSION.md b/VERSION.md
@@ -1,3 +1,76 @@
+## Version 2.0.0 (2016-03-17)
+
+This release improves the local search engine's responsiveness, usability, and
+appearance (especially on small displays, like those found in mobile devices);
+improves search term highlighting; and fixes escaping bugs and HTML5 validity.
+
+### Major:
+
+ * dasht-query-exec(1) now groups by first letter when nothing is searched.
+
+ This gives you a better overview of the breadth of available topics (A-Z)
+ than the previous approach of simply returning the first 100 topics did.
+
+ * dasht-query-html(1) now wraps its HTML output, if any, in `<table>` tags.
+
+ This moves the printing of HTML `<table>` tags into dasht-query-html(1)
+ and makes dasht(1) run w3m(1) eagerly, which provides visual feedback to
+ the user when a large HTML document is being read and buffered, and in
+ the case where no results are found: terminate with a message on stderr.
+
+### Minor:
+
+ * dasht-server-http(1) now streams search results to you as they are found.
+
+ Serve the HTML header and search form immediately---before the search is
+ even performed---so that the user instantly (and at the very least) sees
+ the search form in case they decide to abort the HTTP transfer partway.
+
+ * dasht-server-http(1) now provides a drop-down menu for docset selection.
+
+ Drop the HTML5 `<datalist>` because it can only suggest a single item, and
+ that too only when the text field is empty! Instead, provide a `<select>`
+ drop-down menu from which the user can choose a single item and build up
+ multiple docset selections iteratively, with repeated form submissions.
+
+ * dasht-server-http(1) now word-wraps search results to fit small displays.
+
+ Insert word-break opportunity `<wbr>` tags at the end of capitalized
+ words, runs of lowercase text, numbers, and punctuation marks to help the
+ browser fit search results to small displays, as found in mobile devices.
+
+ * dasht-query-html(1): Underline search terms so they stand out in w3m(1).
+
+### Patch:
+
+ * dasht-query-exec(1): escape SQL single quotes in the search pattern.
+
+ * dasht-query-html(1): escape HTML entities in search result token name.
+
+ * dasht-query-line(1): `tr -s` squeezes _after_ translation, not beforehand.
+
+ Searching for `% %` resulted in SQL LIKE `%\%\%` instead of `%\%%\%%`.
+
+ * dasht-server-http(1): Fix W3C Validator error on scoped `<style>` element.
+
+ > Error: Element style is missing required attribute scoped.
+
+ * dasht-server-http(1): Fix W3C Validator error on docsets `<label>` element.
+
+ > Error: The label element may contain at most one button, input, keygen,
+ > meter, output, progress, select, or textarea descendant.
+
+ * dasht-server-http(1): Specify UTF-8 charset for special chars in docsets.
+
+ Bash and Docker docsets use the special "…" ellipsis Unicode character.
+
+ * dasht-query-html(1): Optimize search term highlighting and rework style.
+
+ When an empty pattern was given, useless empty highlights (bold and
+ italic) were added between every single character in a search result.
+
+ * dasht-query-html(1): Emulate the IGNORECASE=1 feature for POSIX awk(1).
+
 ## Version 1.2.0 (2016-03-14)
 
 ### Minor:

diff --git a/bin/dasht b/bin/dasht
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT 1 2016-03-14 1.2.0
+# # DASHT 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-docsets b/bin/dasht-docsets
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-DOCSETS 1 2016-03-14 1.2.0
+# # DASHT-DOCSETS 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-docsets-extract b/bin/dasht-docsets-extract
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-DOCSETS-EXTRACT 1 2016-03-14 1.2.0
+# # DASHT-DOCSETS-EXTRACT 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-docsets-install b/bin/dasht-docsets-install
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-DOCSETS-INSTALL 1 2016-03-14 1.2.0
+# # DASHT-DOCSETS-INSTALL 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-docsets-remove b/bin/dasht-docsets-remove
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-DOCSETS-REMOVE 1 2016-03-14 1.2.0
+# # DASHT-DOCSETS-REMOVE 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-docsets-update b/bin/dasht-docsets-update
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-DOCSETS-UPDATE 1 2016-03-14 1.2.0
+# # DASHT-DOCSETS-UPDATE 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-query-exec b/bin/dasht-query-exec
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-QUERY-EXEC 1 2016-03-14 1.2.0
+# # DASHT-QUERY-EXEC 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-query-html b/bin/dasht-query-html
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-QUERY-HTML 1 2016-03-14 1.2.0
+# # DASHT-QUERY-HTML 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-query-line b/bin/dasht-query-line
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-QUERY-LINE 1 2016-03-14 1.2.0
+# # DASHT-QUERY-LINE 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-server b/bin/dasht-server
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-SERVER 1 2016-03-14 1.2.0
+# # DASHT-SERVER 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-server-http b/bin/dasht-server-http
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-SERVER-HTTP 1 2016-03-14 1.2.0
+# # DASHT-SERVER-HTTP 1 2016-03-17 2.0.0
 #
 # ## NAME
 #

diff --git a/man/man1/dasht-docsets-extract.1 b/man/man1/dasht-docsets-extract.1
@@ -1,4 +1,4 @@
-.TH DASHT\-DOCSETS\-EXTRACT 1 2016\-03\-14 1.2.0
+.TH DASHT\-DOCSETS\-EXTRACT 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht\-docsets\-extract \- extracts Dash \[la]https://kapeli.com/dash\[ra] docset archives (\fB\fC*.tgz\fR files)

diff --git a/man/man1/dasht-docsets-install.1 b/man/man1/dasht-docsets-install.1
@@ -1,4 +1,4 @@
-.TH DASHT\-DOCSETS\-INSTALL 1 2016\-03\-14 1.2.0
+.TH DASHT\-DOCSETS\-INSTALL 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht\-docsets\-install \- installs new Dash \[la]https://kapeli.com/dash\[ra] docsets

diff --git a/man/man1/dasht-docsets-remove.1 b/man/man1/dasht-docsets-remove.1
@@ -1,4 +1,4 @@
-.TH DASHT\-DOCSETS\-REMOVE 1 2016\-03\-14 1.2.0
+.TH DASHT\-DOCSETS\-REMOVE 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht\-docsets\-remove \- removes installed Dash \[la]https://kapeli.com/dash\[ra] docsets

diff --git a/man/man1/dasht-docsets-update.1 b/man/man1/dasht-docsets-update.1
@@ -1,4 +1,4 @@
-.TH DASHT\-DOCSETS\-UPDATE 1 2016\-03\-14 1.2.0
+.TH DASHT\-DOCSETS\-UPDATE 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht\-docsets\-update \- updates installed Dash \[la]https://kapeli.com/dash\[ra] docsets

diff --git a/man/man1/dasht-docsets.1 b/man/man1/dasht-docsets.1
@@ -1,4 +1,4 @@
-.TH DASHT\-DOCSETS 1 2016\-03\-14 1.2.0
+.TH DASHT\-DOCSETS 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht\-docsets \- lists installed Dash \[la]https://kapeli.com/dash\[ra] docsets

diff --git a/man/man1/dasht-query-exec.1 b/man/man1/dasht-query-exec.1
@@ -1,4 +1,4 @@
-.TH DASHT\-QUERY\-EXEC 1 2016\-03\-14 1.2.0
+.TH DASHT\-QUERY\-EXEC 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht\-query\-exec \- searches a Dash \[la]https://kapeli.com/dash\[ra] docset's SQLite3 database file

diff --git a/man/man1/dasht-query-html.1 b/man/man1/dasht-query-html.1
@@ -1,4 +1,4 @@
-.TH DASHT\-QUERY\-HTML 1 2016\-03\-14 1.2.0
+.TH DASHT\-QUERY\-HTML 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht\-query\-html \- searches Dash \[la]https://kapeli.com/dash\[ra] docsets and emits HTML table rows

diff --git a/man/man1/dasht-query-line.1 b/man/man1/dasht-query-line.1
@@ -1,4 +1,4 @@
-.TH DASHT\-QUERY\-LINE 1 2016\-03\-14 1.2.0
+.TH DASHT\-QUERY\-LINE 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht\-query\-line \- searches Dash \[la]https://kapeli.com/dash\[ra] docsets and emits groups of lines

diff --git a/man/man1/dasht-server-http.1 b/man/man1/dasht-server-http.1
@@ -1,4 +1,4 @@
-.TH DASHT\-SERVER\-HTTP 1 2016\-03\-14 1.2.0
+.TH DASHT\-SERVER\-HTTP 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht\-server\-http \- simple search engine that powers 

diff --git a/man/man1/dasht-server.1 b/man/man1/dasht-server.1
@@ -1,4 +1,4 @@
-.TH DASHT\-SERVER 1 2016\-03\-14 1.2.0
+.TH DASHT\-SERVER 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht\-server \- runs a local search engine for your web browser

diff --git a/man/man1/dasht.1 b/man/man1/dasht.1
@@ -1,4 +1,4 @@
-.TH DASHT 1 2016\-03\-14 1.2.0
+.TH DASHT 1 2016\-03\-17 2.0.0
 .SH NAME
 .PP
 dasht \- API documentation in your terminal