about summary refs log tree commit homepage
path: root/Documentation/design_www.txt
blob: d25afca3f911082de6b367da8bee061ba29de18e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
URL naming
----------

### Unstable endpoints
/$LISTNAME/?r=$GIT_COMMIT                       -> HTML only
/$LISTNAME/atom.xml                             -> Atom feed

#### Optional, relies on Search::Xapian
/$LISTNAME/t/$MESSAGE_ID/                       -> HTML content of thread
/$LISTNAME/t/$MESSAGE_ID/atom                   -> Atom feed for thread
/$LISTNAME/t/$MESSAGE_ID/mbox.gz                -> gzipped mbox of thread

### Stable endpoints
/$LISTNAME/m/$MESSAGE_ID/                       -> HTML content (short quotes)
/$LISTNAME/m/$MESSAGE_ID                        -> 301 to above
/$LISTNAME/m/$MESSAGE_ID/raw                    -> raw mbox
/$LISTNAME/f/$MESSAGE_ID/                       -> HTML content (full quotes)
/$LISTNAME/f/$MESSAGE_ID                        -> 301 to above
/$LISTNAME/f/$MESSAGE_ID/raw (*)                -> 301 to ../m/$MESSAGE_ID/raw

### Legacy endpoints (may be ambiguous given Message-IDs with similar suffies)
/$LISTNAME/m/$MESSAGE_ID.html                   -> 301 to $MESSAGE_ID/
/$LISTNAME/m/$MESSAGE_ID.txt                    -> 301 to $MESSAGE_ID/raw
/$LISTNAME/f/$MESSAGE_ID.html                   -> 301 to $MESSAGE_ID/
/$LISTNAME/f/$MESSAGE_ID.txt (*)                -> 301 to ../m/$MESSAGE_ID/raw


FIXME: we must refactor/cleanup/add tests for most of our CGI before
adding more endpoints and features.

(*) These URLs were never linked, but only exist as a convenience to folks
    who edit existing URLs

Encoding notes
--------------

Raw HTML and XML should only contain us-ascii characters which render
to UTF-8.

Plain text (raw message) endpoints display in the original encoding(s)
of the original email.

Guidelines for using limited HTML
---------------------------------
We mainly use HTML for linking pages together with <a>.
We also set <title> to make window management easier.

We favor <pre>-formatted text since public-inbox is intended as a place
to share and discuss patches and code.  Unfortunately, long paragraphs
tends to be less readable with fixed-width serif fonts which GUI
browsers default to.  So perhaps we will add different endpoints for
variable-width fonts.

* No graphics, images, or icons at all.  We tolerate, but do not
  encourage the use of GUIs.

* No setting colors or font sizes, power to users to decide those.

* No JavaScript. JS is historically too buggy and insecure, and we will
  never expect our readers to do either of the following:
  a) read and audit all our code for on every single page load
  b) trust us and and run code without reading it

* We only use CSS for one reason: wrapping pre-formatted text
  This is necessary because unfortunate GUI browsers tend to be
  prone to layout widening.  w3m is fine here without CSS :)
  No other CSS is allowed, especially with scary things like:

	http://thejh.net/misc/website-terminal-copy-paste