From 0df0212d23b9c373d042c56213c06bde16b62b1c Mon Sep 17 00:00:00 2001 From: Jim Procter Date: Thu, 3 Sep 2020 11:42:43 +0100 Subject: [PATCH] JAL-3675 whats new, logging and release notes tidying for 2.11.1.1. --- help/help/helpTOC.xml | 2 +- help/help/html/index.html | 7 +++- help/help/html/logging.html | 19 +++++---- help/help/html/whatsNew.html | 95 ++++++++++++++++++++++-------------------- 4 files changed, 68 insertions(+), 55 deletions(-) diff --git a/help/help/helpTOC.xml b/help/help/helpTOC.xml index c5660fe..a72f5ac 100755 --- a/help/help/helpTOC.xml +++ b/help/help/helpTOC.xml @@ -27,7 +27,7 @@ - + diff --git a/help/help/html/index.html b/help/help/html/index.html index 442c508..8adbdb8 100755 --- a/help/help/html/index.html +++ b/help/help/html/index.html @@ -56,7 +56,12 @@ then get in contact over at http://www.jalview.org/community

- +

+ Logging, troubleshooting and reporting bugs
If + something seems to be wrong with your Jalview installation, or you + think you've found a problem, take a look at Jalview's + logging and bug reporting documentation. +

Citing Jalview
If you use Jalview in your work, please cite the Jalview 2 paper in Bioinformatics: diff --git a/help/help/html/logging.html b/help/help/html/logging.html index dce1c7b..0975a47 100644 --- a/help/help/html/logging.html +++ b/help/help/html/logging.html @@ -26,10 +26,15 @@

The Java Console, Logging and Reporting Bugs

-

Like most programs, Jalview produces a series of messages - during its operation, often referred to as 'logs'. These logs can be - extremely useful for diagnosing and helping the Jalview developers - find a workaround for specific problems that you might encounter.

+

+ Like most programs, Jalview contains bugs, despite our best efforts. + However, Jalview also produces a series of messages during its + operation, often referred to as 'logs'. These logs provide a record + of Jalview's operation. They can also be extremely useful when reporting bugs, since they help the + Jalview developers diagnose and find a workaround for specific + problems that you might encounter. +

The primary place to look for logs is in the Java Console which you can open from within Jalview by going to the Tools @@ -45,7 +50,7 @@ are not shown in the Jalview Console. The location of these depends on how you launched Jalview:

- Jalview Desktop Installations
If you are using + Jalview Desktop Installation Launch Logs
If you are using a standard desktop version of Jalview installed from one of our install4j installers, then messages about Jalview's initial launch can be found in @@ -65,7 +70,7 @@ by default -

Jalview Executable Jar
If you are using the Jalview executable jar file (also +

Jalview Executable Jar Launch Logs
If you are using the Jalview executable jar file (also used by bioconda and OSX homebrew installations) then the default run class ( jalview.bin.Launcher -- a minimised launcher that will set memory and linux dpi settings before re-launching @@ -144,7 +149,7 @@ composer or issue tracker).

-

Reporting Bugs

+

Reporting Bugs

If you come across a problem in Jalview where something is not diff --git a/help/help/html/whatsNew.html b/help/help/html/whatsNew.html index 0f0c7f1..a62e71d 100755 --- a/help/help/html/whatsNew.html +++ b/help/help/html/whatsNew.html @@ -24,58 +24,61 @@

- Jalview 2.11.1.0 -

-

- Jalview 2.11.1.0 is the first minor release for the 2.11 series. - Along with a number of critical bug fixes and improvements it brings - new functionality for mapping sequence features between CDS and - Protein alignments. It is also the first release made under a new four - number versioning scheme, which will allow us to keep track of - patches and bug fixes. + Jalview 2.11.1.1

+

Jalview 2.11.1.1 is the first patch release for Jalview version + 2.11.1. In addition to fixes for some critical it also contains a + handful of new features suggested by the Jalview community.

+
    +
  • Shift+arrow keys navigate to next gap or residue in cursor + mode (enable with F2)
  • +
  • Support import of VCF 4.3 by updating HTSJDK from 2.12 to + 2.23
  • +
  • Improved recognition of GZipped files from local disk or + retrieved via the web
  • +
  • EMBL and EMBL CDS database records retrieved from the + European Nucleotide Archive's Data API as 'EMBL Flatfile' records
  • +
  • Improved Java Console and + logging to help track down problems +
  • +
  • Improved support for Hi-DPI (4K) screens when running on + Linux (Requires Java 11+)
  • +
+

Critical bug fixes include

    -
  • Virtual Features
    In previous - versions of Jalview, specific nucleotide sequence features such as - genomic variants and exons were transferred to protein products on - import. Jalview 2.11.1 instead provides 'virtual features' that - can be enabled and overlaid on linked CDS/Protein views via their - Sequence - Features dialog. This allows more analyses of nucleotide and - peptide sequence features on alignments in a more flexible and - memory efficient way than in earlier versions.
    - Note: Virtual features work best when variants are - annotated with CSQ fields. Please see this - Groovy script workaround if you are working with VCF files - without CSQ fields. -
  • -
  • Improved VCF data import
    Standard attributes for - filtering variants (e.g. position, QUAL field etc) are now - extracted from VCF files. This new feature was suggested by a user - at the Jalview booth during ISMB 2019.
  • -
  • Extended feature attributes are exported - in GFF3
    Complex attributes from VCF files can be exported - and imported via GFF3
  • -
  • Updated Jalview Installer and Launcher
    Jalview's - installation packages are now built with Install4j 8, which brings - better support for Linux and improved control of file - associations. New parameters on the - Jalview launcher allow an upper memory limit to be specified via - a Jalview launch file, to prevent it from hogging your system.
  • +
  • Jalview runs correctly when launched with Turkish language + settings
  • +
  • Peptide-to-CDS tracking broken when multiple EMBL gene + products shown for a single contig (such as viral genomes)
  • +
  • Errors encountered when processing variants from VCF files + yield "Error processing VCF: Format specifier '%s'" on the console
  • +
  • Count of features not shown can be wrong when there are + both DNA and Protein features mapped to the position under + the cursor
  • +
  • Sequence ID for reference sequence is clipped when Right + align Sequence IDs enabled
  • +
  • Find doesn't report matches that span hidden gapped columns
  • +
  • Jalview ignores file format parameter specifying output + format when exporting an alignment via the command line

- See the 2.11.1.0 - release notes for full details of bugs fixed and new known issues. + For the full release notes, see the + Jalview 2.11.1.1 release notes.

- JalviewJS News
With the release of Jalview 2.11.1.0, - the team are now focused on bringing JalviewJS to full production. - To follow our progress take a look at http://www.jalview.org/jalview-js/ - and follow updates on our new JalviewJS - Releases github repository. + Known Issues

+
    +
  • We've had reports from a small number of windows 10 users + who see a warning dialog pop up when Jalview tries to save a new + version of an existing file. If you are affected by this bug and + this latest version of Jalview doesn't fix it, please let us know!
  • +
  • Co-located features exported and re-imported are ordered + differently when shown on alignment and in tooltips. (Also affects + v2.11.1.0)
  • +
  • Drag and drop of alignment file onto alignment window when + in a HiDPI scaled mode in Linux only works for the top left + quadrant of the alignment window
  • +
-- 1.7.10.2