utils/jalopy/docs/header.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>4.3.10.&nbsp;Header</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="printer.html" title="4.3.&nbsp;Printer"><link rel="previous" href="javadoc.html" title="4.3.9.&nbsp;Javadoc"><link rel="next" href="footer.html" title="4.3.11.&nbsp;Footer"><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="subsection" href="header.html#header-options" title="4.3.10.1.&nbsp;&#xA;Options&#xA;"><link rel="subsection" href="header.html#d0e4821" title="4.3.10.2.&nbsp;&#xA;Text&#xA;">
  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">4.3.10.&nbsp;Header</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="javadoc.html">Prev</a>&nbsp;</td><th width="60%" align="center">4.3.&nbsp;Printer</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="footer.html">Next</a></td></tr></table><hr></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="header"></a>4.3.10.&nbsp;Header</h3></div></div><div></div></div><p>
  36 Controls the printing of headers. It is always a good idea (and often a
  37 recommendation) to include a copyright notice at the top of every source file
  38 for a given project.
  39 </p><a class="indexterm" name="d0e4734"></a><a class="indexterm" name="d0e4737"></a><div class="example"><a name="ex-header-template"></a><p class="title"><b>Example&nbsp;4.148.&nbsp;Typical header template</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="screen">
  40 /*
  41  *                 Sun Public License Notice
  42  *
  43  * The contents of this file are subject to the Sun Public License
  44  * Version 1.0 (the "License"). You may not use this file except in
  45  * compliance with the License. A copy of the License is available at
  46  * http://www.sun.com/
  47  *
  48  * The Original Code is NetBeans. The Initial Developer of the Original
  49  * Code is Sun Microsystems, Inc. Portions Copyright 1997-2000 Sun
  50  * Microsystems, Inc. All Rights Reserved.
  51  */
  52 </pre></td></tr></table></div><div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Headers and Javadoc comments</h3><p>
  53 Be aware that Jalopy currently does not treat the header comments any special.
  54 If you're going to use a Javadoc comment (see <a href="javadoc.html" title="4.3.9.&nbsp;Javadoc">Section&nbsp;4.3.9, &#8220;Javadoc&#8221;</a>) for
  55 your header and have the Javadoc parsing enabled, you will see your header
  56 reformatted. Therefore, you should only use multi-line comments
  57 (like in the example above).
  58 </p></div><p></p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="header-options"></a>4.3.10.1.&nbsp;
  59 Options
  60 </h4></div></div><div></div></div><p>
  61 Lets you control the different header options.
  62 </p><div class="sect4" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="header-general"></a>4.3.10.1.1.&nbsp;General</h5></div></div><div></div></div><div class="itemizedlist"><ul type="disc"><li><p>
  63 Use Header
  64 </p><p>
  65 Enables or disables the insertion of a header template at the top of every
  66 processed source file.
  67 </p></li><li><p><a name="header-smart-mode"></a>
  68 Smart Mode
  69 </p><a class="indexterm" name="d0e4772"></a><p>
  70 Lets you specify the number of single-line comments before the first node
  71 (either a package/import statement or a class/interface declaration) that
  72 should be recognized as part of a header and therefore removed. A size
  73 equal to zero, means <span class="emphasis"><em>Smart Mode</em></span> will be disabled.
  74 </p></li></ul></div></div><div class="sect4" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="header-delete"></a>4.3.10.1.2.&nbsp;Delete Headers</h5></div></div><div></div></div><p>
  75 To avoid header duplication, you have to specify at least one identify key
  76 that can be used to uniquely recognize your header template. That way an
  77 existing header can be removed before a new one is inserted.
  78 </p><p>
  79 A good key for the template mentioned above would be
  80 <i class="firstterm">Sun Public License Notice</i>.
  81 Most typically this will be your company's name.
  82 </p><p>
  83 You can specify several keys to make it easy to switch between headers. Specify
  84 both a key for the old header that is to be removed and for your new header that
  85 should be inserted. This way, you are sure that even new additions that happens
  86 to contain the old header (maybe checked out from some SCM) are
  87 treated correctly.
  88 </p><div class="itemizedlist"><ul type="disc"><li><p>
  89 Add...
  90 </p><p>
  91 Adds a new identify key to the list of keys.
  92 </p></li><li><p>
  93 Remove
  94 </p><p>
  95 Removes the currently selected key from the list.
  96 </p></li></ul></div></div><div class="sect4" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="header-blank-lines"></a>4.3.10.1.3.&nbsp;Blank lines</h5></div></div><div></div></div><p>
  97 To separate the header from the rest of the source code, you may want to
  98 specify the blank lines before and after the header.
  99 </p><div class="itemizedlist"><ul type="disc"><li><p>
 100 Before
 101 </p><p>
 102 Number of blank lines to insert before the header template.
 103 </p></li><li><p>
 104 After
 105 </p><p>
 106 Number of blank lines to insert after the header template.
 107 </p></li></ul></div></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4821"></a>4.3.10.2.&nbsp;
 108 Text
 109 </h4></div></div><div></div></div><p>
 110 Insert your header template here.
 111 </p><p>
 112 You can use variable expressions throughout the header text. Read
 113 <a href="environment.html" title="4.3.8.&nbsp;Environment">Section&nbsp;4.3.8, &#8220;Environment&#8221;</a> for more information about this feature.
 114 </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="javadoc.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="printer.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="footer.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.3.9.&nbsp;Javadoc&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.3.11.&nbsp;Footer</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">
 115             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>