Menu
▾
▴
[jtrac-svn] SF.net SVN: j-trac:[1422] trunk/jtrac/doc
|
From: <udi...@us...> - 2021-12-13 17:02:35
|
Revision: 1422
http://sourceforge.net/p/j-trac/code/1422
Author: udittmer
Date: 2021-12-13 17:02:32 +0000 (Mon, 13 Dec 2021)
Log Message:
-----------
work on docs for 2.2.0
Modified Paths:
--------------
trunk/jtrac/doc/src/index.xml
trunk/jtrac/doc/styles/fopdf.xsl
Modified: trunk/jtrac/doc/src/index.xml
===================================================================
--- trunk/jtrac/doc/src/index.xml 2021-12-13 10:27:43 UTC (rev 1421)
+++ trunk/jtrac/doc/src/index.xml 2021-12-13 17:02:32 UTC (rev 1422)
@@ -75,7 +75,7 @@
JTrac is extremely easy to install and the only pre-requisite is a Java 8 (or higher) Runtime Environment.
You can be up and running in seconds because JTrac comes bundled with a small-footprint web-application
server called <ulink url="https://www.eclipse.org/jetty/">Jetty</ulink> and an embedded database called
- <ulink url="https://www.hsqldb.org/">HSQLDB</ulink>. Please refer to the
+ <ulink url="https://www.hsqldb.org/">HSQLDB</ulink>. Please refer to the
<link linkend="installation">installation</link> section of this documentation for details.
You can also choose to drop the WAR file into an application server of your choice and start using JTrac right away.
</para>
@@ -84,7 +84,7 @@
<sect1 id="introduction-releasenotes">
<title>Release Notes: Version 2.1.0</title>
<para>
- There are no database changes between version 2.0 and 2.1.0. Instructions on how to upgrade are
+ There are no database changes between version 2.0 and 2.1.0. Instructions on how to upgrade are
available in the "<link linkend="upgrading">upgrading</link>" section of this document. The bundled
Jetty web-app server has been upgraded from version 6.0.2 to 6.1.1 but it is not mandatory that you upgrade.
</para>
@@ -93,24 +93,42 @@
<sect1 id="introduction-releasenotes-2_2">
<title>Release Notes: Version 2.2.0</title>
<para>
- There are no database changes between version 2.1.0 and 2.2.0. Instructions on how to upgrade are
- available in the "<link linkend="upgrading">upgrading</link>" section of this document.
+ There is a new table in the database in 2.2.0 to accommodate the new saved link/bookmark feature. Instructions
+ on how to upgrade are available in the "<link linkend="upgrading">upgrading</link>" section of this document.
</para>
<para>
- There where some minor changes and bugfixes:
+ There where a number of new features, changes and bugfixes:
<itemizedlist>
<listitem>
+ <para>The details and comments fields support Markdown syntax.</para>
+ </listitem>
+ <listitem>
+ <para>All dates and times can optionally be displayed in a "pretty" format like "10 minutes ago", "2 months ago" etc.</para>
+ </listitem>
+ <listitem>
+ <para>It's now possible to bookmarks searches, as all relevant parameters are part of the URL.</para>
+ </listitem>
+ <listitem>
+ <para>The dashboard can be configured to show a number of links that are relevant to the project,
+ like saved searches ("All Open Tickets") or to other pages.</para>
+ </listitem>
+ <listitem>
+ <para>Outgoing emails can be signed using DKIM.</para>
+ </listitem>
+ <listitem>
+ <para>More items can be configured at runtime under Options -> Manage Settings</para>
+ </listitem>
+ <listitem>
<para>It is possible to configure an individual header and an individual logo for your own JTrac.</para>
</listitem>
<listitem>
- <para>Errors that were occured because of missing language ressources are fixed.</para>
+ <para>Errors that occured because of missing language resources are fixed.</para>
</listitem>
<listitem>
- <para>Some email-issues e.g. sending duplicate mails are fixed.</para>
+ <para>Some email issues e.g. sending duplicate mails are fixed.</para>
</listitem>
</itemizedlist>
- For details see the <ulink url="https://sourceforge.net/projects/j-trac/">different tracker at
- the sourceforge website.</ulink>
+ For details see this <ulink url="https://sourceforge.net/p/j-trac/wiki/NewFeatures220">wiki page on SourceForge.</ulink>
</para>
</sect1>
</chapter>
@@ -179,8 +197,7 @@
</para>
<para>
The screenshot below shows how creating a new item would look like for the typical
- project (space) where 'Severity', 'Module', 'Type' and 'Priority' have been defined
- as custom fields.
+ project (space) where 'Severity', 'Module', 'Type' and 'Priority' have been defined as custom fields.
</para>
<para>
<mediaobject>
@@ -317,10 +334,9 @@
</para>
<para>
Field-level permissions can be mapped to roles which allows for even more flexibility.
- For example, you can set a project up so that only a "MANAGER" can change the "Severity" level
- after a bug is submitted. JTrac makes it possible for you to define very complex workflows, complete
- with both Status and Role dependent field-level permissions, and you can do all this within a
- single admin screen.
+ For example, you can set a project up so that only a "MANAGER" can change the "Severity" level after
+ a bug is submitted. JTrac makes it possible for you to define very complex workflows, complete with both
+ Status and Role dependent field-level permissions, and you can do all this within a single admin screen.
</para>
</sect1>
<sect1 id="features-search">
@@ -327,13 +343,11 @@
<title>Search Custom Fields</title>
<para>
The intuitive search screen (shown below) allows for easy execution of common queries such as
- find all items "logged by" or "assigned to" a user (or users). JTrac allows for filtering even
- on custom fields.
+ find all items "logged by" or "assigned to" a user (or users). JTrac allows for filtering even on custom fields.
</para>
<para>
You can navigate back to the search setup screen from the search results screen and have the
- search parameters still active. This is useful when trying to tweak complex queries by
- trial and error.
+ search parameters still active. This is useful when trying to tweak complex queries by trial and error.
</para>
<para>
<mediaobject>
@@ -465,8 +479,7 @@
<sect1 id="features-guest">
<title>Read-Only Access</title>
<para>
- When setting up a Space you can define whether this space can be viewed by users without
- having to log-in.
+ When setting up a Space you can define whether this space can be viewed by users without having to log-in.
</para>
<para>
<mediaobject>
@@ -598,17 +611,17 @@
</listitem>
<listitem>
<para>
- Polish - pl
+ Norwegian - no
</para>
</listitem>
<listitem>
<para>
- Portugese (Brazil) - pt_BR
+ Polish - pl
</para>
</listitem>
<listitem>
<para>
- Russian - ru
+ Portugese (Brazil) - pt_BR
</para>
</listitem>
<listitem>
@@ -628,6 +641,16 @@
</listitem>
<listitem>
<para>
+ Turkish - tr
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Ukrainian - uk
+ </para>
+ </listitem>
+ <listitem>
+ <para>
Chinese (China) - zh_CN
</para>
</listitem>
@@ -691,8 +714,7 @@
<listitem>
<para>
First, download the latest release from
- <ulink url="https://sourceforge.net/project/showfiles.php?group_id=162983&package_id=184104">
- the JTrac downloads area</ulink>
+ <ulink url="https://sourceforge.net/projects/j-trac/files/jtrac/"> the JTrac downloads area</ulink>
</para>
</listitem>
<listitem>
@@ -704,7 +726,7 @@
</para>
</listitem>
<listitem>
- <para>Point your web-browser to <ulink url="http://localhost/jtrac"/></para>
+ <para>Point your web-browser to <ulink url="http://localhost:8888/"/></para>
</listitem>
<listitem>
<para>Sign on with the user name "admin" and password "admin"</para>
@@ -715,9 +737,9 @@
</itemizedlist>
</para>
<para>
- You can use the "stop.bat" script to stop the application. The "start.bat" file configures the
- Jetty server to use port 80 which you can easily change by editing "start.bat". You may need to do this
- if for example JTrac does not start because a web-server (like Apache or IIS) is already running on port 80.
+ You can use the "stop.bat" script to stop the application. The "start.int" file configures the Jetty server
+ to use port 8888 which you can easily change by editing "start.int" (search for "jetty.http.port=8888").
+ You may need to do this if JTrac does not start because another server (like Apache, IIS or Tomcat) is already running on port 8888.
</para>
<para>
Remote users should be able to access JTrac over the network by using the machine name instead of "localhost"
@@ -729,9 +751,8 @@
<para>
If you are not on Windows, you may want to rename the start and stop *.bat files to e.g. *.sh for Linux
(*.bat is reported to work for Ubuntu). The commands within the batch files will work unchanged as long as
- Java has been installed correctly i.e. "java" is in the PATH and it is the expected 1.5 or greater version.
+ Java has been installed correctly i.e. "java" is in the PATH and it is expecting version 8 or greater.
You may need to do things like apply executable permissions to the batch files on Linux, e.g. "chmod +x *.bat".
- And also - unless you have "root" permissions, you may face problems starting services on port 80 etc.
</para>
<para>
You can also read this forum thread for more details: <ulink url="https://sourceforge.net/forum/forum.php?thread_id=1971135&forum_id=552477">link</ulink>
@@ -866,9 +887,8 @@
<title>Using a different database such as MySQL</title>
<para>
You can configure the database that JTrac uses by editing the "jtrac.properties" file that JTrac expects
- within the "jtrac.home" folder. Note that if JTrac does not find a "jtrac.properties" file in the
- expected location, JTrac creates a fresh one which is pre-configured for HSQLDB. The default contents of
- this file are as follows:
+ within the "jtrac.home" folder. Note that if JTrac does not find a "jtrac.properties" file in the expected location,
+ JTrac creates a fresh one which is pre-configured for HSQLDB. The default contents of this file are as follows:
</para>
<para>
<programlisting>
@@ -887,8 +907,7 @@
the driver and URL. You can look up the Hibernate dialect corresponding to your database type
from <ulink url="https://www.hibernate.org/hib_docs/reference/en/html/session-configuration.html#configuration-optional-dialects">this list</ulink>.
When using a custom database such as MySQL, you have to create an empty database before starting JTrac.
- When JTrac starts, it will connect to the configured database and create the schema (database tables)
- if not already present.
+ When JTrac starts, it will connect to the configured database and create the schema (database tables) if not already present.
</para>
<para>
If you edit the "jtrac.properties" file, ensure that there are no trailing spaces in the entries shown above
@@ -1083,8 +1102,7 @@
Note that the Java Service Wrapper project supports other operating systems such as Linux or Mac also.
</para>
<para>
- Place some of the files from the Java Service Wrapper distribution into the JTrac folder structure
- as follows:
+ Place some of the files from the Java Service Wrapper distribution into the JTrac folder structure as follows:
<itemizedlist>
<listitem>
<para>From the "bin" folder, copy "wrapper.exe" to the "jtrac" root folder</para>
@@ -1310,6 +1328,12 @@
you can also consider joining the JTrac
<ulink url="https://lists.sourceforge.net/lists/listinfo/j-trac-users">mailing-list</ulink>.
</para>
+ <para>
+ Note that this roadmap dates all the way back to the 2.1.0 days, and no longer reflects the priorities of the current
+ development team. Much of this will likely not be implemented, whereas other features not mentioned here will see
+ the light of the day. If you're missing something in particular (or found a bug), file a ticket in the
+ <ulink url="https://sourceforge.net/p/j-trac/_list/tickets">appropriate ticket tracker</ulink>, and we'll take it from there.
+ </para>
<sect1 id="roadmap-hide">
<title>Field-Level "Hide" Permissions</title>
<para>
@@ -1348,29 +1372,20 @@
<title>Submit By Email</title>
<para>
JTrac should be able to monitor an e-mail account and incoming e-mail should trigger
- creation / updation of items. It would be handy to have attachments submitted through
- email also.
+ creation / updation of items. It would be handy to have attachments submitted through email also.
</para>
</sect1>
- <sect1 id="roadmap-screenshot">
- <title>Screenshot Capture</title>
- <para>
- Using a Java applet, it should be possible for the user to upload a screenshot directly from the
- system clipboard. The user should be able to annotate (e.g. highlight a particular area of) the
- image before uploading.
- </para>
- </sect1>
<sect1 id="roadmap-savedsearches">
<title>Saved Searches</title>
<para>
- It should be possible for users to save search filters and re-use them.
+ It should be possible for users to save search filters and re-use them. This has been partially implemented in 2.2.0
+ with the saved search/bookmark feature.
</para>
</sect1>
<sect1 id="roadmap-wiki">
<title>Wiki Engine</title>
<para>
- There is a plan to embed a wiki-engine into JTrac. This will supplement the requirements management
- road map.
+ There is a plan to embed a wiki-engine into JTrac. This will supplement the requirements management road map.
</para>
</sect1>
<sect1 id="roadmap-svn">
@@ -1491,8 +1506,7 @@
<listitem>
<para>
Interim builds are provided only as WAR files. If you are using the embedded Jetty
- webapp-server, you have to replace the WAR that came along with the formal
- downloadable distribution.
+ webapp-server, you have to replace the WAR that came along with the formal downloadable distribution.
</para>
</listitem>
<listitem>
@@ -1499,8 +1513,7 @@
<para>
When you are replacing the WAR file in an existing installation it is best that you
delete the contents of the webapp-server temporary / work folder before re-starting.
- Details on how to do this are provided in the "<link linkend="upgrading">upgrading</link>"
- section of this document.
+ Details on how to do this are provided in the "<link linkend="upgrading">upgrading</link>" section of this document.
</para>
</listitem>
<listitem>
@@ -1670,7 +1683,7 @@
<para>
<itemizedlist>
<listitem>
- <para>JDK 5.0 (or higher)</para>
+ <para>JDK 8 (or higher)</para>
</listitem>
<listitem>
<para><ulink url="https://maven.apache.org/">Maven 2.X</ulink></para>
@@ -1736,8 +1749,7 @@
<ulink url="https://ntlmaps.sourceforge.net/">NTLMAPS</ulink> to check out from Subversion.
</para>
<para>
- If you are using Windows, we recommend <ulink url="https://tortoisesvn.net/">TortoiseSVN</ulink>
- as a Subversion client.
+ If you are using Windows, we recommend <ulink url="https://tortoisesvn.net/">TortoiseSVN</ulink> as a Subversion client.
</para>
</sect1>
<sect1 id="dev-build-properties">
Modified: trunk/jtrac/doc/styles/fopdf.xsl
===================================================================
--- trunk/jtrac/doc/styles/fopdf.xsl 2021-12-13 10:27:43 UTC (rev 1421)
+++ trunk/jtrac/doc/styles/fopdf.xsl 2021-12-13 17:02:32 UTC (rev 1422)
@@ -210,6 +210,7 @@
<xsl:param name="callout.extensions">1</xsl:param>
<!-- FOP provide only PDF Bookmarks at the moment -->
<xsl:param name="fop.extensions">1</xsl:param>
+ <xsl:param name="fop1.extensions">1</xsl:param>
<!--###################################################
Table Of Contents
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
