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