Documentation/design_www.txt

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