Documentation/design_www.txt

   1 URL naming
   2 ----------
   3
   4 ### Unstable endpoints
   5 /$LISTNAME/?r=$GIT_COMMIT                       -> HTML only
   6 /$LISTNAME/atom.xml                             -> Atom feed
   7
   8 #### Optional, relies on Search::Xapian
   9 /$LISTNAME/t/$MESSAGE_ID.html                   -> HTML content of thread
  10
  11 ### Stable endpoints
  12 /$LISTNAME/m/$MESSAGE_ID.html                   -> HTML content (short quotes)
  13 /$LISTNAME/m/$MESSAGE_ID.txt                    -> raw original
  14 /$LISTNAME/m/$MESSAGE_ID                        -> 301 to .html version
  15 /$LISTNAME/f/$MESSAGE_ID.html                   -> HTML content (full quotes)
  16 /$LISTNAME/f/$MESSAGE_ID                        -> 301 to .html version
  17 /$LISTNAME/f/$MESSAGE_ID.txt                    -> 301 to ../m/$MESSAGE_ID.txt
  18
  19 FIXME: we must refactor/cleanup/add tests for most of our CGI before
  20 adding more endpoints and features.
  21
  22 Maybe TODO (these might be expensive)
  23 -------------------------------------
  24 /$LISTNAME/t/$MESSAGE_ID.mbox                   -> mbox content of thread
  25
  26 We use file name suffixes on all of these (except /) so URLs may easily
  27 cached/memoized using a static file server.
  28
  29 Encoding notes
  30 --------------
  31
  32 Raw HTML and XML should only contain us-ascii characters which render
  33 to UTF-8.
  34
  35 Plain text (raw message) endpoints display in the original encoding(s)
  36 of the original email.
  37
  38 Guidelines for using limited HTML
  39 ---------------------------------
  40 We mainly use HTML for linking pages together with <a>.
  41 We also set <title> to make window management easier.
  42
  43 We favor <pre>-formatted text since public-inbox is intended as a place
  44 to share and discuss patches and code.  Unfortunately, long paragraphs
  45 tends to be less readable with fixed-width serif fonts which GUI
  46 browsers default to.  So perhaps we will add different endpoints for
  47 variable-width fonts.
  48
  49 * No graphics, images, or icons at all.  We tolerate, but do not
  50   encourage the use of GUIs.
  51
  52 * No setting colors or font sizes, power to users to decide those.
  53
  54 * No JavaScript. JS is historically too buggy and insecure, and we will
  55   never expect our readers to do either of the following:
  56   a) read and audit all our code for on every single page load
  57   b) trust us and and run code without reading it
  58
  59 * We only use CSS for one reason: wrapping pre-formatted text
  60   This is necessary because unfortunate GUI browsers tend to be
  61   prone to layout widening.  w3m is fine here without CSS :)
  62   No other CSS is allowed, especially with scary things like:
  63
  64         http://thejh.net/misc/website-terminal-copy-paste