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