utils/jalopy/docs/settings.html

   1
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
   4  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   5  *
   6  * This file is part of Jalview.
   7  *
   8  * Jalview is free software: you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  18 -->
  19     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  20   <html><head>
  21       <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  22    <title>Chapter&nbsp;4.&nbsp;Settings</title><link rel="stylesheet" href="site.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="manual.html" title="Jalopy User Manual"><link rel="up" href="part-core.html" title="Part&nbsp;I.&nbsp;Jalopy core"><link rel="previous" href="usage.html" title="Chapter&nbsp;3.&nbsp;Usage"><link rel="next" href="project.html" title="4.2.&nbsp;Projects"><link rel="preface" href="dedication.html" title="Dedication"><link rel="preface" href="acknowledge.html" title="Acknowledgements"><link rel="preface" href="introduction.html" title="Introduction"><link rel="part" href="part-core.html" title="Part&nbsp;I.&nbsp;Jalopy core"><link rel="chapter" href="installation.html" title="Chapter&nbsp;1.&nbsp;Installation"><link rel="chapter" href="build.html" title="Chapter&nbsp;2.&nbsp;Building"><link rel="chapter" href="usage.html" title="Chapter&nbsp;3.&nbsp;Usage"><link rel="chapter" href="settings.html" title="Chapter&nbsp;4.&nbsp;Settings"><link rel="part" href="part-plugins.html" title="Part&nbsp;II.&nbsp;Plug-ins"><link rel="chapter" href="plugin-ant.html" title="Chapter&nbsp;5.&nbsp;Ant Plug-in task"><link rel="chapter" href="plugin-console.html" title="Chapter&nbsp;6.&nbsp;Console Application"><link rel="chapter" href="plugin-eclipse.html" title="Chapter&nbsp;7.&nbsp;Eclipse Plug-in"><link rel="chapter" href="plugin-jbuilder.html" title="Chapter&nbsp;8.&nbsp;JBuilder OpenTool"><link rel="chapter" href="plugin-jdev.html" title="Chapter&nbsp;9.&nbsp;JDeveloper Extension"><link rel="chapter" href="plugin-jedit.html" title="Chapter&nbsp;10.&nbsp;jEdit Plug-in"><link rel="chapter" href="plugin-netbeans.html" title="Chapter&nbsp;11.&nbsp;NetBeans/Sun ONE Studio module"><link rel="appendix" href="dependencies.html" title="Appendix&nbsp;A.&nbsp;Library Dependencies"><link rel="appendix" href="license-bsd.html" title="Appendix&nbsp;B.&nbsp;The Jalopy BSD License"><link rel="appendix" href="license-antlr.html" title="Appendix&nbsp;C.&nbsp;ANTLR SOFTWARE RIGHTS"><link rel="appendix" href="license-apache.html" title="Appendix&nbsp;D.&nbsp;The Apache Software License, Version 1.1"><link rel="appendix" href="license-gnu.html" title="Appendix&nbsp;E.&nbsp;GNU GENERAL PUBLIC LICENSE Version 2, June 1991"><link rel="appendix" href="license-gnu-doc.html" title="Appendix&nbsp;F.&nbsp;GNU Free Documentation License Version 1.1, March 2000"><link rel="appendix" href="license-common-public.html" title="Appendix&nbsp;G.&nbsp;Common Public License Version 1.0"><link rel="appendix" href="license-sun-public.html" title="Appendix&nbsp;H.&nbsp;SUN PUBLIC LICENSE Version 1.0"><link rel="index" href="ix01.html" title="Index"><link rel="section" href="settings.html#general" title="4.1.&nbsp;General"><link rel="section" href="project.html" title="4.2.&nbsp;Projects"><link rel="section" href="printer.html" title="4.3.&nbsp;Printer"><link rel="section" href="inspector.html" title="4.4.&nbsp;Code Inspector"><link rel="section" href="messages.html" title="4.5.&nbsp;Messages">
  23       <meta name="description" content="Jalopy Java Source Code Formatter Beautifier Pretty Printer">
  24       <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" l gen true for "http://jalopy.sf.net" r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://jalopy.sf.net" r (n 0 s 0 v 0 l 0))'>
  25     </head><body id="toppage" bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table width="700" border="0" cellpadding="0" cellspacing="0" align="left"><tbody><tr><td><table cellpadding="0" cellspacing="0" width="100%" style="border:1px solid #336699"><tbody><tr><td height="16"></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr style="border:none"><td style="border:none"><table border="0" cellspacing="0" cellpadding="0"><tbody><tr><td class="logo">JALOPY</td><td class="sublogo" valign="bottom">Java Source Code Formatter Beautifier Pretty Printer</td></tr></tbody></table></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr><td height="10"></td></tr><tr><td bgcolor="#ff8000" height="4"></td></tr><tr><td height="20" bgcolor="#336699" style="color:#ffffff;padding-left:10px"><a href="./index.html" class="navlink">Overview</a> &#149;
  26                     <a href="./download.html" class="navlink">Download</a> &#149;
  27                     <a href="./docs.html" class="navlink">Documentation</a> &#149;
  28                     <a href="./plugins.html" class="navlink">Plug-ins</a> &#149;
  29                     <a href="./links.html" class="navlink">Links</a> &#149;
  30                     <a href="./contact.html" class="navlink">Contact</a></td></tr><tr><td height="1" bgcolor="#ffffff"></td></tr></tbody></table></td></tr><tr valign="top"><td valign="top" bgcolor="#ffffff"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tbody><tr><td height="20" bgcolor="#faebd7" style="padding-left:15px"><a href="./features.html" class="navlink2">Features</a> |
  31                     <a href="./history.html" class="navlink2">History</a> |
  32                     <a href="./manual.html" class="navlink2">Manual</a> |
  33                     <a href="./faq.html" class="navlink2">FAQ</a> |
  34                     <a href="./api/index.html" class="navlink2">Javadoc</a></td></tr><tr><td height="20" bgcolor="#ffffff"></td></tr><tr><td bgcolor="#eeeecc" height="17" align="right" style="font-size:10px;padding-right:3px">
  35                     This page generated: <strong>June 8 2004</strong></td></tr></tbody></table><table border="0" width="100%" cellspacing="0" cellpadding="5"><tr><td><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;4.&nbsp;Settings</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="usage.html">Prev</a>&nbsp;</td><th width="60%" align="center">Part&nbsp;I.&nbsp;Jalopy core</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="project.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="settings"></a>Chapter&nbsp;4.&nbsp;Settings</h2></div></div><div></div></div><a class="indexterm" name="d0e942"></a><p>
  36 Provides a detailed discussion of all available settings to configure Jalopy.
  37 </p><p><a name="settings-directory"></a>
  38 Jalopy stores all settings as files inside its
  39 <i class="firstterm">Settings directory</i> (or subdirectories thereof).
  40 This directory is located in the user home directory (<tt class="filename">$HOME/.jalopy</tt>).
  41 </p><a class="indexterm" name="d0e957"></a><p>
  42 A graphical user interface is provided to easily configure the settings.
  43 Please refer to the individual Plug-in chapters in <a href="part-plugins.html" title="Part&nbsp;II.&nbsp;Plug-ins">Part&nbsp;II, &#8220;Plug-ins&#8221;</a>
  44 for information on how to display it from within the Plug-in you received.
  45 </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="general"></a>4.1.&nbsp;General</h2></div></div><div></div></div><p><a name="code-convention"></a>
  46 Jalopy stores its settings in a binary file
  47 <tt class="filename">$HOME/.jalopy/<i class="replaceable"><tt>PROJECT_DIR</tt></i>/preferences.dat</tt>.
  48 However you can import/export your settings in both the binary, and a textual
  49 XML format. A group of settings forms a <i class="firstterm">code convention</i>.
  50 </p><a class="indexterm" name="d0e979"></a><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="general-convention"></a>4.1.1.&nbsp;Convention</h3></div></div><div></div></div><p>
  51 Lets you name a group of settings, a code convention.
  52 </p><div class="itemizedlist"><ul type="disc"><li><p>
  53 Name
  54 </p><p>
  55 The name of the code convention. The name must be no longer than 10 characters.
  56 </p></li><li><p>
  57 Description
  58 </p><p>
  59 Stores a short description for the code convention.
  60 </p></li></ul></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="general-compliance"></a>4.1.2.&nbsp;Compliance</h3></div></div><div></div></div><p>
  61 Lets you specify whether Java sources should be treated as JDK 1.3 or
  62 as JDK 1.4 compatible. The latter means <tt class="literal">assert</tt> will be
  63 recognized as a reserved keyword.
  64 </p><a class="indexterm" name="d0e1006"></a><a class="indexterm" name="d0e1009"></a><a class="indexterm" name="d0e1012"></a><div class="itemizedlist"><ul type="disc"><li><p>
  65 Source compatibility
  66 </p><p>
  67 Lets you choose the JDK version to use for source compatibility.
  68 </p></li></ul></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="import-export"></a>4.1.3.&nbsp;Import/Export</h3></div></div><div></div></div><p>
  69 Use the <span><b class="guibutton">Import...</b></span> and <span><b class="guibutton">Export...</b></span>
  70 buttons to import an already-saved code convention, or export your current settings as
  71 a new code convention. You can choose between the binary <tt class="filename">.jal</tt> format
  72 or an XML representation.
  73 </p><p>
  74 Jalopy is able to import settings from both local and distributed locations.
  75 Just specify a valid Internet address (either starting with <i class="firstterm">http://</i> or
  76 <i class="firstterm">www.</i>) for the latter. Jalopy will then attempt to synchronize
  77 its settings with the given url on every invocation. That way it is easy to
  78 share a single code convention across a group of developers.
  79 </p><p>
  80 Please note that versions prior to 1.0b8 stored the backup directory always as
  81 an absolute file. Therefore after importing a code convention, you should
  82 check whether this directory points to your preferred backup directory. This
  83 advice holds true even for later versions in case you've changed the default
  84 backup directory.
  85 </p><p>
  86 However if the backup directory setting is left untouched, the directory is
  87 stored relative to the Jalopy settings directory. This way you can savely
  88 share your code convention across different systems and platforms.
  89 </p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="usage.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="part-core.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="project.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;3.&nbsp;Usage&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="manual.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;4.2.&nbsp;Projects</td></tr></table></div></td></tr></table></td></tr><tr><td bgcolor="#eeeecc" height="17" style="font-size:9px;padding-left:5px"><a href="#toppage">to top</a></td></tr><tr><td height="30"><br></td></tr><tr><td height="3"></td></tr><tr><td bgcolor="#336699" height="1"></td></tr><tr><td height="1"></td></tr><tr><td bgcolor="#336699" height="16"></td></tr><tr><td bgcolor="#ff9966" height="4"></td></tr><tr><td class="footer" align="center" height="15" valign="middle">
  90             Copyright &copy; 2001-2004, <a class="footer" href="./contact.html">Marco Hunsicker</a>. All rights reserved. Hosted by <a href="http://sourceforge.net">SourceForge.net</a></td></tr></tbody></table><img src="http://sourceforge.net/sflogo.php?group_id=45216&amp;type=1" width="1" height="1" border="0" hspace="0" vspace="0" alt=""></body></html>