- void help() {\r
- final StringBuilder sb = new StringBuilder();\r
- sb.append( "Display options\n" );\r
- sb.append( "-------------------\n" );\r
- sb.append( "Use the checkboxes to select types of information to display on the tree.\n\n" );\r
- sb.append( "Clickable tree nodes\n" );\r
- sb.append( "--------------------\n" );\r
- sb.append( "Tree nodes can be clicked, the action is determined by the 'click on node to' menu\n" );\r
- sb.append( "or by right clicking:\n" );\r
- sb.append( "o Display Node Data -- display information for a node\n" );\r
- sb.append( "o Collapse/Uncollapse -- collapse and uncollapse subtree from clicked node\n" );\r
- sb.append( "o Root/Reroot -- change tree root to clicked node\n" );\r
- sb.append( "o Sub/Super Tree -- toggle between subtree from clicked node and whole tree\n" );\r
- sb.append( "o Swap Descendants -- switch descendant on either side of clicked node\n" );\r
- sb.append( "o Colorize Subtree -- color a subtree\n" );\r
- sb.append( "o Open Sequence Web -- launch a web browser to display sequence information\n" );\r
- sb.append( "o Open Taxonomy Web -- launch a web browser to display taxonomy information\n" );\r
- sb.append( "- there may be additional choices depending on this particular setup\n\n" );\r
- sb.append( "Right clicking on a node always displays the information of a node.\n\n" );\r
- sb.append( "Zooming\n" );\r
- sb.append( "---------\n" );\r
- sb.append( "The mouse wheel and the plus and minus keys control zooming.\n" );\r
- sb.append( "Mouse wheel+Ctrl changes the text size.\n" );\r
- sb.append( "Mouse wheel+Shift controls zooming in vertical direction only.\n" );\r
- sb.append( "Use the buttons on the control panel to zoom the tree in and out, horizontally or vertically.\n" );\r
- sb.append( "The entire tree can be fitted into the window by clicking the \"F\" button, or by pressing F, Delete, or Home.\n" );\r
- sb.append( "The up, down, left, and right keys can be used to move the visible part (if zoomed in).\n" );\r
- sb.append( "Up, down, left, and right+Shift can be used to control zooming horizontally and vertically.\n" );\r
- sb.append( "Plus and minus keys+Ctrl change the text size; F+Ctrl, Delete+Ctrl, or Home+Ctrl resets it.\n\n" );\r
- sb.append( "Quick tree manipulation:\n" );\r
- sb.append( "------------------------\n" );\r
- sb.append( "Order Subtrees -- order the tree by branch length\n" );\r
- sb.append( "Uncollapse All -- uncollapse any and all collapsed branches\n\n" );\r
- sb.append( "Memory problems (Java heap space error)\n" );\r
- sb.append( "---------------------------------------\n" );\r
- sb.append( "Since the Java default memory allocation is quite small, it might by necessary (for trees\n" );\r
- sb.append( "with more than approximately 5000 external nodes) to increase the memory which Java can use, with\n" );\r
- sb.append( "the '-Xmx' Java command line option. For example:\n" );\r
- sb.append( "java -Xmx1024m -cp path\\to\\forester.jar org.forester.archaeopteryx.Archaeopteryx\n\n" );\r
- // + "General remarks\n"\r
- // + "---------------\n"\r
- // +\r
- // "o The application version permits copying to the clipboard \n"\r
- // +\r
- // " in the \"View\"|\"View as ...\" frame (either by control-c or button press).\n"\r
- // +\r
- // "o Changes made to a subtree affect this subtree and its subtrees,\n"\r
- // + " but not any of its parent tree(s).\n"\r
- // +\r
- // "o Archaeopteryx tries to detect whether the numerical values in a NH tree\n"\r
- // +\r
- // " are likely to be bootstrap values instead of branch length values.\n\n"\r
- // +\r
- // " Remarks regarding SDI (Speciation Duplication Inference):\n"\r
- // +\r
- // "o Each external node of the gene tree (in display) needs to be associated with\n"\r
- // +\r
- // " a species: either directly through the \"Species\" field, or the species\n"\r
- // +\r
- // " is part of the sequence name in the form \"XXXX_SPECIES\"\n"\r
- // +\r
- // " (e.g. \"ACON_DROME\" or \"ACON_DROME/123-4489\" which is also acceptable).\n"\r
- // +\r
- // "o A species tree for each species of the gene tree needs to be loaded with\n"\r
- // +\r
- // " \"SDI\"|\"Load species tree\" prior the SDI execution.\n"\r
- // +\r
- // "o !External nodes of the gene tree associated with species not present in\n"\r
- // +\r
- // " the species tree are REMOVED prior to SDI execution!\n"\r
- // +\r
- // "o Both the gene tree and the species tree must be completely binary.\n"\r
- // +\r
- // "o Duplications and speciations are a function of the position of the root.\n"\r
- // +\r
- // " Hence, after each manual \"Root/Reroot\"ing some duplications will be\n"\r
- // + " incorrect and need to be inferred again\n"\r
- // +\r
- // " with: \"SDI\"|\"SDI (Speciation Duplication Inference)\n\n"\r
- sb.append( "phyloXML\n" );\r
- sb.append( "-------------------\n" );\r
- sb.append( "Reference: " + Constants.PHYLOXML_REFERENCE + "\n" );\r
- sb.append( "Website: " + Constants.PHYLOXML_WEB_SITE + "\n" );\r
- sb.append( "Version: " + ForesterConstants.PHYLO_XML_VERSION + "\n" );\r
- sb.append( "\n" );\r
- sb.append( "For more information: https://sites.google.com/site/cmzmasek/home/software/archaeopteryx\n" );\r
- sb.append( "Email: " + Constants.AUTHOR_EMAIL + "\n\n" );\r
- TextFrame.instantiate( sb.toString(), "Help", _textframes );\r
- }\r
-\r