X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fdesign_www.txt;h=a265a890bd21ec36c364f73087610428686ba4d7;hb=e022d3377fd2c50fd9931bf96394728958a90bf3;hp=0f63fdf2a3b301d5e3112b7e0349234a8734be2d;hpb=93310d10f0d74554f36537639b2abd9903da3620;p=public-inbox.git

diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt
index 0f63fdf2..a265a890 100644
--- a/Documentation/design_www.txt
+++ b/Documentation/design_www.txt
@@ -1,17 +1,65 @@
 URL naming
 ----------
 
+### Unstable endpoints
 /$LISTNAME/?r=$GIT_COMMIT                       -> HTML only
-/$LISTNAME/index.atom.xml                       -> Atom feed
-/$LISTNAME/all.atom.xml                         -> Atom feed, includes replies
+/$LISTNAME/atom.xml                             -> Atom feed
+
+### Stable endpoints
 /$LISTNAME/m/$MESSAGE_ID.html                   -> HTML content (short quotes)
 /$LISTNAME/m/$MESSAGE_ID.txt                    -> raw original
 /$LISTNAME/m/$MESSAGE_ID                        -> 301 to .html version
 /$LISTNAME/f/$MESSAGE_ID.html                   -> HTML content (full quotes)
 /$LISTNAME/f/$MESSAGE_ID                        -> 301 to .html version
 /$LISTNAME/f/$MESSAGE_ID.txt                    -> 301 to m/$MESSAGE_ID.txt
+
+FIXME: we must refactor/cleanup/add tests for most of our CGI before
+adding more endpoints and features.
+
+Maybe TODO (these might be expensive)
+-------------------------------------
 /$LISTNAME/t/$MESSAGE_ID.html                   -> HTML content of thread
 /$LISTNAME/t/$MESSAGE_ID.mbox                   -> mbox content of thread
 
 We use file name suffixes on all of these (except /) so URLs may easily
 cached/memoized using a static file server.
+
+Encoding notes
+--------------
+
+Raw HTML and XML should only contain us-ascii characters which render
+to UTF-8.
+
+Plain text (raw message) endpoints display in the original encoding(s)
+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.
+
+We favor <pre>-formatted text since public-inbox is intended as a place
+to share and discuss patches and code.  Unfortunately, long paragraphs
+tends to be less readable with fixed-width serif fonts which GUI
+browsers default to.  So perhaps we will add different endpoints for
+variable-width fonts.
+
+* Do not build <a> links from user-generated-content, this prevents
+  public-inbox deployments from being turned into a spam linkfarm.
+
+* No graphics, images, or icons at all.  We tolerate, but do not
+  encourage the use of GUIs.
+
+* No setting colors or font sizes, power to users to decide those.
+
+* 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
+  b) trust us and and run code without reading it
+
+* We only use CSS for one reason: wrapping pre-formatted text
+  This is necessary because unfortunate GUI browsers tend to be
+  prone to layout widening.  lynx is fine here without CSS :)
+  No other CSS is allowed, especially with scary things like:
+
+	http://thejh.net/misc/website-terminal-copy-paste