<!--
* Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
*
* This file is part of Jalview.
*
*
* You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
-->
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+ <html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>4.3.10. 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. Printer"><link rel="previous" href="javadoc.html" title="4.3.9. Javadoc"><link rel="next" href="footer.html" title="4.3.11. 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 I. Jalopy core"><link rel="chapter" href="installation.html" title="Chapter 1. Installation"><link rel="chapter" href="build.html" title="Chapter 2. Building"><link rel="chapter" href="usage.html" title="Chapter 3. Usage"><link rel="chapter" href="settings.html" title="Chapter 4. Settings"><link rel="part" href="part-plugins.html" title="Part II. Plug-ins"><link rel="chapter" href="plugin-ant.html" title="Chapter 5. Ant Plug-in task"><link rel="chapter" href="plugin-console.html" title="Chapter 6. Console Application"><link rel="chapter" href="plugin-eclipse.html" title="Chapter 7. Eclipse Plug-in"><link rel="chapter" href="plugin-jbuilder.html" title="Chapter 8. JBuilder OpenTool"><link rel="chapter" href="plugin-jdev.html" title="Chapter 9. JDeveloper Extension"><link rel="chapter" href="plugin-jedit.html" title="Chapter 10. jEdit Plug-in"><link rel="chapter" href="plugin-netbeans.html" title="Chapter 11. NetBeans/Sun ONE Studio module"><link rel="appendix" href="dependencies.html" title="Appendix A. Library Dependencies"><link rel="appendix" href="license-bsd.html" title="Appendix B. The Jalopy BSD License"><link rel="appendix" href="license-antlr.html" title="Appendix C. ANTLR SOFTWARE RIGHTS"><link rel="appendix" href="license-apache.html" title="Appendix D. The Apache Software License, Version 1.1"><link rel="appendix" href="license-gnu.html" title="Appendix E. GNU GENERAL PUBLIC LICENSE Version 2, June 1991"><link rel="appendix" href="license-gnu-doc.html" title="Appendix F. GNU Free Documentation License Version 1.1, March 2000"><link rel="appendix" href="license-common-public.html" title="Appendix G. Common Public License Version 1.0"><link rel="appendix" href="license-sun-public.html" title="Appendix H. 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. 
Options
"><link rel="subsection" href="header.html#d0e4821" title="4.3.10.2. 
Text
">
+ <meta name="description" content="Jalopy Java Source Code Formatter Beautifier Pretty Printer">
+ <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))'>
+ </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> •
+ <a href="./download.html" class="navlink">Download</a> •
+ <a href="./docs.html" class="navlink">Documentation</a> •
+ <a href="./plugins.html" class="navlink">Plug-ins</a> •
+ <a href="./links.html" class="navlink">Links</a> •
+ <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> |
+ <a href="./history.html" class="navlink2">History</a> |
+ <a href="./manual.html" class="navlink2">Manual</a> |
+ <a href="./faq.html" class="navlink2">FAQ</a> |
+ <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">
+ 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. Header</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="javadoc.html">Prev</a> </td><th width="60%" align="center">4.3. Printer</th><td width="20%" align="right"> <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. Header</h3></div></div><div></div></div><p>
+Controls the printing of headers. It is always a good idea (and often a
+recommendation) to include a copyright notice at the top of every source file
+for a given project.
+</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 4.148. Typical header template</b></p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="screen">
+/*
+ * Sun Public License Notice
+ *
+ * The contents of this file are subject to the Sun Public License
+ * Version 1.0 (the "License"). You may not use this file except in
+ * compliance with the License. A copy of the License is available at
+ * http://www.sun.com/
+ *
+ * The Original Code is NetBeans. The Initial Developer of the Original
+ * Code is Sun Microsystems, Inc. Portions Copyright 1997-2000 Sun
+ * Microsystems, Inc. All Rights Reserved.
+ */
+</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>
+Be aware that Jalopy currently does not treat the header comments any special.
+If you're going to use a Javadoc comment (see <a href="javadoc.html" title="4.3.9. Javadoc">Section 4.3.9, “Javadoc”</a>) for
+your header and have the Javadoc parsing enabled, you will see your header
+reformatted. Therefore, you should only use multi-line comments
+(like in the example above).
+</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.
+Options
+</h4></div></div><div></div></div><p>
+Lets you control the different header options.
+</p><div class="sect4" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="header-general"></a>4.3.10.1.1. General</h5></div></div><div></div></div><div class="itemizedlist"><ul type="disc"><li><p>
+Use Header
+</p><p>
+Enables or disables the insertion of a header template at the top of every
+processed source file.
+</p></li><li><p><a name="header-smart-mode"></a>
+Smart Mode
+</p><a class="indexterm" name="d0e4772"></a><p>
+Lets you specify the number of single-line comments before the first node
+(either a package/import statement or a class/interface declaration) that
+should be recognized as part of a header and therefore removed. A size
+equal to zero, means <span class="emphasis"><em>Smart Mode</em></span> will be disabled.
+</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. Delete Headers</h5></div></div><div></div></div><p>
+To avoid header duplication, you have to specify at least one identify key
+that can be used to uniquely recognize your header template. That way an
+existing header can be removed before a new one is inserted.
+</p><p>
+A good key for the template mentioned above would be
+<i class="firstterm">Sun Public License Notice</i>.
+Most typically this will be your company's name.
+</p><p>
+You can specify several keys to make it easy to switch between headers. Specify
+both a key for the old header that is to be removed and for your new header that
+should be inserted. This way, you are sure that even new additions that happens
+to contain the old header (maybe checked out from some SCM) are
+treated correctly.
+</p><div class="itemizedlist"><ul type="disc"><li><p>
+Add...
+</p><p>
+Adds a new identify key to the list of keys.
+</p></li><li><p>
+Remove
+</p><p>
+Removes the currently selected key from the list.
+</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. Blank lines</h5></div></div><div></div></div><p>
+To separate the header from the rest of the source code, you may want to
+specify the blank lines before and after the header.
+</p><div class="itemizedlist"><ul type="disc"><li><p>
+Before
+</p><p>
+Number of blank lines to insert before the header template.
+</p></li><li><p>
+After
+</p><p>
+Number of blank lines to insert after the header template.
+</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.
+Text
+</h4></div></div><div></div></div><p>
+Insert your header template here.
+</p><p>
+You can use variable expressions throughout the header text. Read
+<a href="environment.html" title="4.3.8. Environment">Section 4.3.8, “Environment”</a> for more information about this feature.
+</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> </td><td width="20%" align="center"><a accesskey="u" href="printer.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="footer.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.3.9. Javadoc </td><td width="20%" align="center"><a accesskey="h" href="manual.html">Home</a></td><td width="40%" align="right" valign="top"> 4.3.11. 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">
+ Copyright © 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&type=1" width="1" height="1" border="0" hspace="0" vspace="0" alt=""></body></html>
git://source.jalview.org / jalview.git / blobdiff