From 43c0f38b8dc27254deb10204cf97d7af7e49d368 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 20 Aug 2015 04:15:31 +0000 Subject: misc documentation updates Threading in Xapian is mostly supported by now; so start documenting things. --- Documentation/design_notes.txt | 2 +- Documentation/design_www.txt | 6 ++++-- Documentation/include.mk | 6 ++++-- 3 files changed, 9 insertions(+), 5 deletions(-) (limited to 'Documentation') diff --git a/Documentation/design_notes.txt b/Documentation/design_notes.txt index d7313cb6..5bb68ce5 100644 --- a/Documentation/design_notes.txt +++ b/Documentation/design_notes.txt @@ -144,5 +144,5 @@ where `n' is the number of history splits. Copyright --------- -Copyright 2013, Eric Wong and all contributors. +Copyright 2013-2015, all contributors License: AGPLv3 or later diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt index 0c38ae5f..92897043 100644 --- a/Documentation/design_www.txt +++ b/Documentation/design_www.txt @@ -5,20 +5,22 @@ URL naming /$LISTNAME/?r=$GIT_COMMIT -> HTML only /$LISTNAME/atom.xml -> Atom feed +#### Optional, relies on Search::Xapian +/$LISTNAME/t/$MESSAGE_ID.html -> HTML content of thread + ### Stable endpoints /$LISTNAME/m/$MESSAGE_ID.html -> HTML content (short quotes) /$LISTNAME/m/$MESSAGE_ID.txt -> raw original /$LISTNAME/m/$MESSAGE_ID -> 301 to .html version /$LISTNAME/f/$MESSAGE_ID.html -> HTML content (full quotes) /$LISTNAME/f/$MESSAGE_ID -> 301 to .html version -/$LISTNAME/f/$MESSAGE_ID.txt -> 301 to m/$MESSAGE_ID.txt +/$LISTNAME/f/$MESSAGE_ID.txt -> 301 to ../m/$MESSAGE_ID.txt FIXME: we must refactor/cleanup/add tests for most of our CGI before adding more endpoints and features. Maybe TODO (these might be expensive) ------------------------------------- -/$LISTNAME/t/$MESSAGE_ID.html -> HTML content of thread /$LISTNAME/t/$MESSAGE_ID.mbox -> mbox content of thread We use file name suffixes on all of these (except /) so URLs may easily diff --git a/Documentation/include.mk b/Documentation/include.mk index 162bf543..55bfc97a 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -1,4 +1,4 @@ -# Copyright (C) 2013, Eric Wong and all contributors +# Copyright (C) 2013-2015 all contributors # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) all:: @@ -40,7 +40,9 @@ install-man: man $(pandoc) -s -t man < $< > $@+ && mv $@+ $@ txt2pre = ./Documentation/txt2pre < $< > $@+ && touch -r $< $@+ && mv $@+ $@ -txt = INSTALL README COPYING +txt := INSTALL README COPYING +dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt +txt += $(addprefix Documentation/, $(dtxt)) %.html: % $(txt2pre) -- cgit v1.2.3-24-ge0c7