Mercurial > p > roundup > code
comparison doc/upgrading.txt @ 6589:5ce396880899
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.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 24 Jan 2022 21:16:30 -0500 |
| parents | 91ab3e0ffcd0 |
| children | 39308a49fdc3 |
comparison
equal
deleted
inserted
replaced
| 6588:91ab3e0ffcd0 | 6589:5ce396880899 |
|---|---|
| 33 .. index:: Upgrading; 2.0.0 to 2.1.0 | 33 .. index:: Upgrading; 2.0.0 to 2.1.0 |
| 34 | 34 |
| 35 Migrating from 2.1.0 to 2.x.y | 35 Migrating from 2.1.0 to 2.x.y |
| 36 ============================= | 36 ============================= |
| 37 | 37 |
| 38 Check compression settings | 38 Check compression settings (optional) |
| 39 -------------------------- | 39 ------------------------------------- |
| 40 | 40 |
| 41 Read the `administration guide`_ section on 'Configuring Compression'. | 41 Read the `administration guide`_ section on 'Configuring Compression'. |
| 42 | 42 |
| 43 Upgrade tracker's config.ini file. Use:: | 43 Upgrade tracker's config.ini file. Use:: |
| 44 | 44 |
| 48 merge any local comments from the tracker's ``config.ini`` into | 48 merge any local comments from the tracker's ``config.ini`` into |
| 49 ``newconfig.ini``. Compare the old and new files and configure new | 49 ``newconfig.ini``. Compare the old and new files and configure new |
| 50 compression settings as you want. Then replace ``config.ini`` with the | 50 compression settings as you want. Then replace ``config.ini`` with the |
| 51 ``newconfig.ini`` file. | 51 ``newconfig.ini`` file. |
| 52 | 52 |
| 53 Search added to user index page | 53 Search added to user index page (optional) |
| 54 ------------------------------- | 54 ------------------------------------------ |
| 55 | 55 |
| 56 A search form and count of number of hits has been added to the | 56 A search form and count of number of hits has been added to the |
| 57 ``user.index.html`` template page in the classic template. You may | 57 ``user.index.html`` template page in the classic template. You may |
| 58 want to merge the search form and footer into your template. | 58 want to merge the search form and footer into your template. |
| 59 | 59 |
| 60 Enhanced full-text search | 60 Enhanced full-text search (optional) |
| 61 ------------------------- | 61 ------------------------------------ |
| 62 | 62 |
| 63 SQLite's `FTS5 full-text search engine`_ is available. It should work | 63 SQLite's `FTS5 full-text search engine`_ is available. It should work |
| 64 with any recent sqlite3 installation. Any full text search field will | 64 with any recent sqlite3 installation. Any full text search field will |
| 65 allow searching using the MATCH query format described at: | 65 allow searching using the MATCH query format described at: |
| 66 https://www.sqlite.org/fts5.html#full_text_query_syntax. A list of | 66 https://www.sqlite.org/fts5.html#full_text_query_syntax. A list of |
| 97 commands:: | 97 commands:: |
| 98 | 98 |
| 99 delete from __words; | 99 delete from __words; |
| 100 delete from __textids; | 100 delete from __textids; |
| 101 | 101 |
| 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. | |
| 102 | 117 |
| 103 Migrating from 2.0.0 to 2.1.0 | 118 Migrating from 2.0.0 to 2.1.0 |
| 104 ============================= | 119 ============================= |
| 105 | 120 |
| 106 Rdbms version change from 5 to 6 (**) | 121 Rdbms version change from 5 to 6 (**) |