+PublicInbox::WWW (PSGI interface) design notes
+
URL and anchor naming
---------------------
/$INBOX/?r=$GIT_COMMIT -> HTML only
/$INBOX/new.atom -> Atom feed
-#### Optional, relies on Search::Xapian
-/$INBOX/$MESSAGE_ID/t/ -> HTML content of thread
+#### Optional, relies on Search::Xapian (or Xapian SWIG binding)
+/$INBOX/$MESSAGE_ID/t/ -> HTML content of thread (nested)
+/$INBOX/$MESSAGE_ID/T/ -> HTML content of thread (flat)
anchors:
#u location of $MESSAGE_ID in URL
#m<SHA-1> per-message links, where <SHA-1> is of the Message-ID
of each message (stable)
#s<NUM> relative numeric position of message in thread (unstable)
+ #i<...> diffstat location for patch emails
+ #Z?<...> per-file diff header location for patch emails
/$INBOX/$MESSAGE_ID/t.atom -> Atom feed for thread
/$INBOX/$MESSAGE_ID/t.mbox.gz -> gzipped mbox of thread
+/$INBOX/$GIT_OID/s/ -> "git show" (via "git apply")
+ This endpoint requires "coderepo" entries configured for
+ a given inbox. It can recreate ("solve") blobs from
+ patch emails using Xapian and git-apply(1). It can also
+ display non-blob content, but that remains a
+ work-in-progress.
+
+/$INBOX/$GIT_OID/s/$FILENAME -> "git show", raw output
+ As above, but shows the raw (usually text/plain) output.
+
### Stable endpoints
/$INBOX/$MESSAGE_ID/ -> HTML content
anchors:
* 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 setting font sizes, power to users to decide those.
We will include and document <span class=?> to support colors
for user-supplied CSS.
* 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 from unwrapped mailers.
- w3m is fine here without CSS :)
- No other CSS is allowed, especially with scary things like:
+ Do not expect CSS to be enabled, especially with scary things like:
- http://thejh.net/misc/website-terminal-copy-paste
+ https://thejh.net/misc/website-terminal-copy-paste
However, we will try to make it easy for users to supply their
own colors via user-side CSS.
CSS classes (for user-supplied CSS)
-----------------------------------
-span.q - quoted text in email messages
-...
+
+See examples in contrib/css/ and lib/PublicInbox/WwwText.pm
+(or https://public-inbox.org/meta/_/text/color/ soon)