www: support $MESSAGE_ID/R/ endpoint for replies

[public-inbox.git] / Documentation / design_www.txt

diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt
index b73a79875b57d71782ac77ed4250fb32d6302a38..1be4d18e28e1602dc0ae8d13032560fec3c25cb2 100644 (file)
--- a/Documentation/design_www.txt
+++ b/Documentation/design_www.txt
@@ -15,8 +15,9 @@ URL naming
 /$LISTNAME/$MESSAGE_ID                    -> 301 to /$LISTNAME/$MESSAGE_ID
 /$LISTNAME/$MESSAGE_ID/raw                -> raw mbox
 /$LISTNAME/$MESSAGE_ID/f/                 -> HTML content (full quotes)
+/$LISTNAME/$MESSAGE_ID/R/                 -> HTML reply instructions
 
-### Legacy endpoints (may be ambiguous given Message-IDs with similar suffies)
+### Legacy endpoints (may be ambiguous given Message-IDs with similar suffixes)
 /$LISTNAME/m/$MESSAGE_ID/                 -> 301 to /$LISTNAME/$MESSAGE_ID/
 /$LISTNAME/m/$MESSAGE_ID.html             -> 301 to /$LISTNAME/$MESSAGE_ID/
 /$LISTNAME/m/$MESSAGE_ID.txt              -> 301 to /$LISTNAME/$MESSAGE_ID/raw
@@ -25,6 +26,8 @@ URL naming
 
 /$LISTNAME/atom.xml [2]                   -> identical to /$LISTNAME/new.atom
 
+Additionally, we support "git clone" pointed to http://$HOST/$LISTNAME
+
 FIXME: we must refactor/cleanup/add tests for most of our CGI before
 adding more endpoints and features.
 
@@ -45,6 +48,7 @@ of the original email.
 
 Guidelines for using limited HTML
 ---------------------------------
+
 We mainly use HTML for linking pages together with <a>.
 We also set <title> to make window management easier.
 
@@ -59,6 +63,16 @@ variable-width fonts.
 
 * No setting colors or font sizes, power to users to decide those.
 
+* Only one font type (fixed or variable) per page.  This is for
+  accessibility, we must not blow certain elements out-of-proportion
+  when a reader increases font size.
+
+* Bold and underline elements are OK since they should render fine
+  regardless of chosen font and gracefully degrade if a display does
+  not support them.  Italics and strike-through elements must be
+  avoided as they do not render well with some displays or user-chosen
+  fonts.
+
 * No JavaScript. JS is historically too buggy and insecure, and we will
   never expect our readers to do either of the following:
   a) read and audit all our code for on every single page load