Documentation/design_www.txt

   1 URL and anchor naming
   2 ---------------------
   3
   4 ### Unstable endpoints
   5 /$INBOX/?r=$GIT_COMMIT                 -> HTML only
   6 /$INBOX/new.atom                       -> Atom feed
   7
   8 #### Optional, relies on Search::Xapian
   9 /$INBOX/$MESSAGE_ID/t/                 -> HTML content of thread
  10         anchors:
  11         #u          location of $MESSAGE_ID in URL
  12         #m<SHA-1>   per-message links, where <SHA-1> is of the Message-ID
  13                     of each message (stable)
  14         #s<NUM>     relative numeric position of message in thread (unstable)
  15
  16 /$INBOX/$MESSAGE_ID/t.atom             -> Atom feed for thread
  17 /$INBOX/$MESSAGE_ID/t.mbox.gz          -> gzipped mbox of thread
  18
  19 ### Stable endpoints
  20 /$INBOX/$MESSAGE_ID/                   -> HTML content
  21         anchors:
  22         #r          location of the current message in thread skeleton
  23                     (requires Xapian search)
  24         #b          start of the message body (linked from thread skeleton)
  25
  26 /$INBOX/$MESSAGE_ID                    -> 301 to /$INBOX/$MESSAGE_ID/
  27 /$INBOX/$MESSAGE_ID/raw                -> raw mbox
  28 /$INBOX/$MESSAGE_ID/#R                 -> HTML reply instructions
  29
  30 # Covering up a pre-1.0 design mistake:
  31 /$INBOX/$MESSAGE_ID/f/                 -> 301 to /$INBOX/$MESSAGE_ID/
  32
  33 ### Legacy endpoints (may be ambiguous given Message-IDs with similar suffixes)
  34 /$INBOX/m/$MESSAGE_ID/                 -> 301 to /$INBOX/$MESSAGE_ID/
  35 /$INBOX/m/$MESSAGE_ID.html             -> 301 to /$INBOX/$MESSAGE_ID/
  36 /$INBOX/m/$MESSAGE_ID.txt              -> 301 to /$INBOX/$MESSAGE_ID/raw
  37 /$INBOX/f/$MESSAGE_ID.html             -> 301 to /$INBOX/$MESSAGE_ID/
  38 /$INBOX/f/$MESSAGE_ID.txt [1]          -> 301 to /$INBOX/$MESSAGE_ID/raw
  39
  40 /$INBOX/atom.xml [2]                   -> identical to /$INBOX/new.atom
  41
  42 Additionally, we support git clone/fetch over HTTP (dumb and smart):
  43
  44         git clone --mirror http://$HOSTNAME/$INBOX
  45
  46 FIXME: we must refactor/cleanup/add tests for most of our CGI before
  47 adding more endpoints and features.
  48
  49 [1] These URLs were never linked, but only exist as a convenience to folks
  50     who edit existing URLs
  51
  52 [2] Do not make this into a 301 since feed readers may not follow them as well
  53     as normal browsers do.
  54
  55 Encoding notes
  56 --------------
  57
  58 Raw HTML and XML should only contain us-ascii characters which render
  59 to UTF-8.  We must not rely on users having the necessary fonts
  60 installed to render uncommon characters.
  61
  62 Plain text (raw message) endpoints display in the original encoding(s)
  63 of the original email.
  64
  65 Guidelines for using limited HTML
  66 ---------------------------------
  67
  68 We mainly use HTML for linking pages together with <a>.
  69 We also set <title> to make window management easier.
  70
  71 We favor <pre>-formatted text since public-inbox is intended as a place
  72 to share and discuss patches and code.  Unfortunately, long paragraphs
  73 tends to be less readable with fixed-width serif fonts which GUI
  74 browsers default to.
  75
  76 * No graphics, images, or icons at all.  We tolerate, but do not
  77   encourage the use of GUIs.
  78
  79 * No setting colors or font sizes, power to users to decide those.
  80   We will include and document <span class=?> to support colors
  81   for user-supplied CSS, and may support client-supplied CSS
  82   via cookie.
  83
  84 * Only one font type: fixed.  This is for accessibility, we must
  85   not blow certain elements out-of-proportion with different
  86   fonts on the page when a reader increases font size.
  87
  88 * Bold and underline elements are OK since they should render fine
  89   regardless of chosen font and gracefully degrade if a display does
  90   not support them.  Italics and strike-through elements must be
  91   avoided as they do not render well with some displays or user-chosen
  92   fonts.
  93
  94 * No JavaScript. JS is historically too buggy and insecure, and we will
  95   never expect our readers to do either of the following:
  96   a) read and audit all our code for on every single page load
  97   b) trust us and and run code without reading it
  98
  99 * We only use CSS for one reason: wrapping pre-formatted text
 100   This is necessary because unfortunate GUI browsers tend to be
 101   prone to layout widening from unwrapped mailers.
 102   w3m is fine here without CSS :)
 103   No other CSS is allowed, especially with scary things like:
 104
 105         http://thejh.net/misc/website-terminal-copy-paste
 106
 107   However, we will try to make it easy for users to supply their
 108   own colors and perhaps offer color options over cookies.
 109
 110 CSS classes (for user-supplied CSS)
 111 -----------------------------------
 112 span.q  - quoted text in email messages
 113 ...