Menu
▾
▴
[jtrac-svn] SF.net SVN: j-trac:[1440] trunk/jtrac/doc/src/index.xml
|
From: <udi...@us...> - 2022-02-18 17:10:12
|
Revision: 1440
http://sourceforge.net/p/j-trac/code/1440
Author: udittmer
Date: 2022-02-18 17:10:10 +0000 (Fri, 18 Feb 2022)
Log Message:
-----------
update documentation for 2.2.1
Modified Paths:
--------------
trunk/jtrac/doc/src/index.xml
Modified: trunk/jtrac/doc/src/index.xml
===================================================================
--- trunk/jtrac/doc/src/index.xml 2022-02-17 17:29:02 UTC (rev 1439)
+++ trunk/jtrac/doc/src/index.xml 2022-02-18 17:10:10 UTC (rev 1440)
@@ -11,7 +11,7 @@
<bookinfo>
<title>JTrac</title>
<subtitle>User / Developer Guide</subtitle>
- <releaseinfo>2.2.0</releaseinfo>
+ <releaseinfo>2.2.1</releaseinfo>
<authorgroup>
<author>
<firstname>Peter</firstname>
@@ -136,6 +136,43 @@
For details see this <ulink url="https://sourceforge.net/p/j-trac/wiki/NewFeatures220">wiki page</ulink> on SourceForge.
</para>
</sect1>
+
+ <sect1 id="introduction-releasenotes-2_2_1">
+ <title>Release Notes: Version 2.2.1</title>
+ <para>
+ There are a couple of new database attributes (in the Space and the StoredSearch tables) in 2.2.1.
+ Instructions on how to upgrade are available in the "<link linkend="upgrading">upgrading</link>" section of this document.
+ </para>
+ <para>
+ There where a number of new features, changes and bugfixes:
+ <itemizedlist>
+ <listitem>
+ <para>Fixed a bug that caused Markdown not to be applied on the search results page.</para>
+ </listitem>
+ <listitem>
+ <para>Stored searches (a.k.a. dashboard links) can optionally be made to open in new tabs, instead of always doing so.</para>
+ </listitem>
+ <listitem>
+ <para>Guard against XSS when using Markdown</para>
+ </listitem>
+ <listitem>
+ <para><ulink url="https://sourceforge.net/p/j-trac/bugs/164/">Fix broken Excel export</ulink></para>
+ </listitem>
+ <listitem>
+ <para><ulink url="https://sourceforge.net/p/j-trac/feature-requests/175/">Make background colors configurable, using HTML5 color input fields</ulink></para>
+ </listitem>
+ <listitem>
+ <para><ulink url="https://sourceforge.net/p/j-trac/bugs/166/">Don't display time for date fields</ulink></para>
+ </listitem>
+ <listitem>
+ <para><ulink url="https://sourceforge.net/p/j-trac/feature-requests/176/">Spaces can be made inactive, so they don't display on the dashboard</ulink></para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ For details see this <ulink url="https://sourceforge.net/p/j-trac/wiki/NewFeatures221">wiki page</ulink> on SourceForge.
+ </para>
+ </sect1>
</chapter>
<chapter id="features">
@@ -1594,74 +1631,14 @@
<sect1 id="upgrading-database">
<title>Upgrading the Database</title>
<para>
- If the JTrac release notes mention database schema changes, you need to additionally run an upgrade script
- before restarting the webapp-server with the new WAR in place. Upgrade scripts come in the form of
+ Previously, if the JTrac release notes mention database schema changes, you needed to additionally run an upgrade script
+ before restarting the webapp-server with the new WAR in place. Upgrade scripts came in the form of
<ulink url="https://github.com/beanshell/beanshell">Beanshell</ulink> scripts (*.bsh) and would be always
released within the "etc" folder of the JTrac downloadable distribution.
</para>
<para>
- These files are tested on HSQLDB and may need minor changes to work with
- other databases. No re-compilation is needed, therefore making it extremely easy for you to tweak them
- if required. Of course it is strongly recommended that you backup your old data before an upgrade.
- Please use the <ulink url="https://sourceforge.net/p/j-trac/discussion/552477">JTrac forums</ulink>
- for help and for helping other users with your experiences.
+ But starting with version 2.2.1, JTrac is configured to update the database automatically, so nothing needs to be done for this.
</para>
- <para>
- If you are shadowing the development builds you would be able to obtain the latest database upgrade
- scripts from here: <ulink url="https://sourceforge.net/p/j-trac/code/HEAD/tree/trunk/jtrac/etc/"/> Look for files
- that end with ".bsh" - e.g: "jtrac-hsqldb-2_1-to-2_2.bsh"
- </para>
- <para>
- Steps to follow:
- <itemizedlist>
- <listitem>
- <para>
- First, stop the server, JTrac should not be connected to the database.
- </para>
- </listitem>
- <listitem>
- <para>
- The "java" command should be available on the command line.
- </para>
- </listitem>
- <listitem>
- <para>
- Get the latest beanshell jar file (~300 KB) from here: <ulink url="https://github.com/beanshell/beanshell/releases/download/2.1.0/bsh-2.1.0.jar"/>
- </para>
- </listitem>
- <listitem>
- <para>
- Get the right JDBC driver for your database. If you have been using the embedded HSQLDB
- database, hsqldb-x-x-x.jar will be available in the jtrac war file within "lib".
- </para>
- </listitem>
- <listitem>
- <para>
- Edit the connection params (jdbc URL, username, password) to match your database. For HSQLDB,
- to make it easier - you can copy the beanshell jar and the hsqldb jar into the "db" folder of
- "jtrac.home". The db folder will contain a "jtrac.script" file. There may also be a "jtrac.log"
- file. So when you are in the same directory as the HSQLDB data files, the URL is
- "jdbc:hsqldb:file:jtrac". Otherwise, replace the "jtrac" part in the URL with the relative or
- absolute path of where the "jtrac.script" file exists on your file-system.
- </para>
- </listitem>
- <listitem>
- <para>
- Execute the beanshell script from the command line. The database driver should be added to the
- classpath along with the beanshell jar. This is how the command would look like:
- <programlisting>
-
-java -cp bsh-2.0b5.jar;hsqldb-2.5.2.jar bsh.Interpreter jtrac-hsqldb-2_1-to-2_2.bsh
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- If there were no errors, you can now upgrade the WAR (don't forget to delete the temporary files) and restart.
- </para>
- </listitem>
- </itemizedlist>
- </para>
</sect1>
<sect1 id="upgrading-jetty">
<title>Upgrading Jetty</title>
@@ -1763,7 +1740,7 @@
<title>Download / Extract Source</title>
<para>
Download the source code from
- <ulink url="https://sourceforge.net/projects/j-trac/files/jtrac/2.2.0/">SourceForge</ulink>
+ <ulink url="https://sourceforge.net/projects/j-trac/files/jtrac/2.2.1/">SourceForge</ulink>
and extract it to a convenient location. Note that the source code is a separate download from the main (binary)
and the file name will be of the form "jtrac-src-X.Y.Z.zip".
</para>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
