Skip to content

Commit 4697b0f

Browse files
committed
Add error templates for 400 and label each item optional
Added documenttion on adding a _generic.400.html template which can be used to display errors in FTS query syntax. It can include the chrome supplied by page.html which makes navigating etc. easier. Also labeled each section title in the current release optional as none of them are required upgrades. If we add a required step that will break a tracker if not done, it should be labeled required and put at the top of the upgrading section.
1 parent e6ca81c commit 4697b0f

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

doc/upgrading.txt

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ Contents:
3535
Migrating from 2.1.0 to 2.x.y
3636
=============================
3737

38-
Check compression settings
39-
--------------------------
38+
Check compression settings (optional)
39+
-------------------------------------
4040

4141
Read the `administration guide`_ section on 'Configuring Compression'.
4242

@@ -50,15 +50,15 @@ merge any local comments from the tracker's ``config.ini`` into
5050
compression settings as you want. Then replace ``config.ini`` with the
5151
``newconfig.ini`` file.
5252

53-
Search added to user index page
54-
-------------------------------
53+
Search added to user index page (optional)
54+
------------------------------------------
5555

5656
A search form and count of number of hits has been added to the
5757
``user.index.html`` template page in the classic template. You may
5858
want to merge the search form and footer into your template.
5959

60-
Enhanced full-text search
61-
-------------------------
60+
Enhanced full-text search (optional)
61+
------------------------------------
6262

6363
SQLite's `FTS5 full-text search engine`_ is available. It should work
6464
with any recent sqlite3 installation. Any full text search field will
@@ -99,6 +99,21 @@ commands::
9999
delete from __words;
100100
delete from __textids;
101101

102+
Adding error reporting templates (optional)
103+
-------------------------------------------
104+
105+
Currently some internal errors result in a bare html page with an
106+
error message. The usual chrome supplied by page.html is not shown.
107+
For example query language syntax errors for full text search methods
108+
will display a bare HTML error page.
109+
110+
If you add an `_generic.400.html` template to the html directory, you
111+
can display the error inside of the layout provided by the `page.html`
112+
template. This can make fixing the error and navigation easier. You
113+
can use the `_generic.404.html` template to create a
114+
`_generic.400.html` by modifying the title and body text. You can test
115+
the 400 template by appending `@template=400` to the url for the
116+
tracker.
102117

103118
Migrating from 2.0.0 to 2.1.0
104119
=============================

0 commit comments

Comments
 (0)