Merge branch 'features/JAL-1667_1668-documentation' into Release_2_8_3_Branch
[jalview.git] / help / html / features / pdbsequencefetcher.html
diff --git a/help/html/features/pdbsequencefetcher.html b/help/html/features/pdbsequencefetcher.html
new file mode 100644 (file)
index 0000000..0412a5f
--- /dev/null
@@ -0,0 +1,83 @@
+<html>
+<!--
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ -->
+<head>
+<title>PDB Sequence Fetcher</title>
+</head>
+<body>
+
+       <strong>PDB Sequence Fetcher</strong>
+       <p>From Jalview 2.x.x a speciliased interface was introduced for
+               fast and efficient discovery/retrieval of sequence data from the PDB
+               database. The introduced interface enables live querying of PDB data
+               on-the-fly thereby eliminating the need to memorise database accession
+               or to cross-reference other bioinformatics websites before retrieving
+               a sequence data in jalview. The underlying technology is provided by
+               EBI and is based on Apache Solr which is a text based search engine.</p>
+
+       <p>
+               The PDB Sequence Fetcher interface can be opened by selecting <strong>PDB</strong>
+               as the choice database from the <strong>'Select Database
+                       Retrieval Source'</strong> interface of <a href="seqfetch.html">Sequence
+                       Fetcher</a>.
+       </p>
+
+       <img src="pdbseqfetcher.png" align="left"
+               alt="PDB sequence fetcher (introduced in Jalview 2.x.x)">
+
+
+       <p>
+               <strong>Searching the PDB Database</strong><br> Once the
+               interface is opened, typing in the search text box will execute a live
+               query to the PDB database and display the results on-the-fly as seen
+               in the screen-shot above. Use the drop-down menu to select a specific
+               field to search by in the PDB database, the default option is <strong>'ALL'</strong>.
+       <br>
+       
+       <br>Wild card searching: The PDB sequence fetcher also provides support for wild card querying of the PDB database.
+       <br>Single character (matches a single character) - ?
+ The search string te?t would match both test and text.
+
+<br>Multiple characters (matches zero or more sequential characters) - *
+
+The wildcard search:
+tes*  - would match test, testing, and tester.
+
+
+You can also use wildcard characters in the middle of a term. For
+example:
+te*t - would match test and text.
+*est  - would match pest and test.
+ </p>
+       <p>
+               <strong>Customising displayed meta-data</strong> <br>To change the
+               displayed meta-data in the search result, click the <strong>'Configure
+                       Displayed Columns'</strong> tab, then tick off the options wanted. 
+       </p>
+       <p><strong>Importing Sequence</strong><br>
+       After querying the PDB database, to import the found data into Jalview, select the entries you wish to import then click the ok button at the bottom of the interface.</p>
+       <p>
+               <em>The PDB Sequence Fetcher interface was introduced in Jalview
+                       2.x.x.</em>
+       </p>
+</body>
+</html>
\ No newline at end of file