Compilo, Marco LOMBARDO, Italy

Title: Compilo
  The name araise from the word Compiere. In italian 'Compilo'
  means "do it" and "I compile", it depends on how you stress
  the word.

Licence:
    Copyright (c) 2004 Marco LOMBARDO.
    Permission is granted to copy, distribute and/or modify this document
    under the terms of the GNU Free Documentation License, Version 1.2
    or any later version published by the Free Software Foundation;
    with the Invariant Sections being: Introduction, First 10 historical topics,
    Final Note.
    With the Front-Cover Texts being: "Compilo, Marco LOMBARDO, Italy",
    and with no Back-Cover Texts.
    A copy of the license is included in the section entitled "GNU
    Free Documentation License".

		Introduction

Title: Compilo
  The name araise from the word Compiere. In italian 'Compilo'
  means "do it" and "I compile", it depends on how you stress
  the word.

Origin of Compilo:
  There is an online italian GNU/Linux manual called manualinux, you can find it at
  http://www.tivedotonico.it/manualinux/index.php, that borns the same way:
  as an howto of few points. Adding topic after topic it is now
  quite usefull.
  Some part of this document could have "condensed informations", I
  apologise. You can ask to me or add topics. Or write a version better
  than mine. I reserve the first 10 points for me but the section "New Topics"
  is not an Invariant Section so everyone is free to add topics here.
  Contact: marco.lombardo@enneenne.com
  Marco LOMBARDO, 2004-03-14, Lucca, Italy.

Version:
  0.0.4

Note:
  This is my first document under the GNU Free Documentation License.
  It's dedicated to RMS.
  The Master.


		First 10 historical topics.

000. Howto add a PL/SQL procedure and execute it.

   1. Let's consider you have a new or an existing Window/Tab and you want to add
      a button that execute the procedure myproc if pressed.
      Obviously there is a GUI part, adding the button and a PL/SQL part,
      creating the right PL/SQL procedure.
   2. GUI part.
      Open the Report & Process Window and create a new Process. Decide:
      - The name, description and help. Name is not important but I usually
	choose something that I think will not conflict with Compiere in the future.
	Description and Help are displayed to the user when he or she press the button so
	they are relatively importants.
      - "User can start process" can be unchecked.
      - In the Procedure Name field write myproc.
      - Obviously "Is Report" field should be unchecked.
      - Parameters: you have a Tab for setup Parameters. The only thing to keep in mind
	is that what you write in the Column Name field is used for the column ParameterName
	of AD_PInstance_Para were java code pass parameters to PL/SQL code, see the example below.
      After this alter the table referenced by the Tab in which you want to add the button:
	alter table mytable add(
	  NewButton	char(1));
      Modify the Compiere AD adding this Column to mytable (Table & Column Tab). For
      the newly created Column set reference to Button and Process with the name of the
      Process you create above. In the Procedure Name write the name of the procedure you
      are going to create at point 3.
      Let this new Column shows in one or more Tab (Window, Tab and Field window).
   3. PL/SQL part.
      To explain how you have to write your PL/SQL code let's comment an existing Procedure:
      CREATE OR REPLACE PROCEDURE M_Product_BOM_Check
      (
      PInstance_ID IN NUMBER
      )
      Every procedure you create should looks this way, with an IN parameters of type Number.
      As you have a row for each defined Process in the AD_Process you have a new row every
      time you call a Process in the AD_PInstance table (Process Instance).
      - You have to comunicate to the java code that the procedure is running. For this reason
	at the beginning of each Procedure you should do this:
	  UPDATE AD_PInstance
	  SET Created = SysDate,
	  IsProcessing = 'Y'
	  WHERE AD_PInstance_ID=PInstance_ID;
	  COMMIT;
      - "Well, but how to know the record's ID the user want to Process?":
	In the same table, AD_PInstance, there is the column Record_ID, so is sufficent
	you read the column for your PInstance_ID.
	  select Record_ID into yuor_preferred_var_name
	  from AD_PInstance WHERE AD_PInstance_ID = PInstance_ID;
	The table the user is working on depend is identified by the Tab from where you 
	are calling the Procedure. In this example is a M_Product_ID. If the call generate from the Order Tab
	Record_ID is an C_Order_ID, if it generate from the Production Tab is an M_Production_ID and so on.
      - Parameters: if you setup some parameters in the GUI they are passed to the procedure in the AD_PInstance_Para.
	Each Process Instance have a complete set of parameters. What you wrote in the Column Name field
	of the Parameter Tab is passed in the ParameterName column. The value the user enter for this Process Instance
	is in the P_Number, P_Date, P_String depending on the parameter's type.
	Usually Compiere PL/SQL procedures have a cursor on AD_PInstance_Para and as their very first task
	each procedure runs through is parameters and setup variables.
      - After this you can do your business logic.
      - The Procedure ends OK.
	In this case comunicate to java that there was a success, together with the message you want
	Compiere shows in the status bar:
	  update AD_PInstance
	  set Updated = sysdate,
	  IsProcessing = 'N',
	  Result = 1, -- Success
	  ErrorMsg = 'Everything OK!'
	  where AD_PInstance_ID = PInstance_ID;
	  commit;
	  return;
      - There was an error.
	The update statement is similar to the one above, but Result should be 0 (Error), and ErrorMsg should be 
	your error message. If you want to use the Compiere standard add at the end error number and error message
	returned by Oracle.
	  update AD_PInstance
	  set Updated = sysdate,
	  IsProcessing = 'N',
	  Result = 0, -- Error
	  ErrorMsg = 'Sorry there was an error!!!'
	  where AD_PInstance_ID = PInstance_ID;
	  commit;
	  return;
   4. Last thing: the log.
      Have you process a shipment some time? Or import new Columns into Compiere AD
      after adding new columns to a db table? At the end Compiere shows the list of Columns
      created.
      For example the procedure that Verify a BOM of a product do not shows nothing, edit it
      and add this after the first begin statement
      BEGIN
      INSERT INTO AD_PInstance_Log (AD_PInstance_ID, Log_ID, P_ID, P_Msg)
				  VALUES (PInstance_ID, 1, 2, 'Hello from Bom check!');
      INSERT INTO AD_PInstance_Log (AD_PInstance_ID, Log_ID, P_ID, P_Msg, P_Number, P_Date)
				  VALUES (PInstance_ID, 3, 4, 'This is msg with 123 number and date of tomorrow...', 123, sysdate+1);
      Then try the procedure...

001. Using your java code and jars. For example using Jasper Reports.
   Recently Andre' Legendre publish a patch to Jasper Reports to include barcode.
   He and people from Compiere Mfg&Scm were very kind helping me to include their version of Jasper Report
   and setup the functioning example.
   Under NNCompiereJR/lib I include the patched version of Jasper Reports together with a modified
   version of barbecue (library for generating barcode) and others jars needed by JR.
   Everything is available at
     http://compiere-mfgscm.sourceforge.net
   Here you have the modified version of JR in jar and 
   source code, a modified version of iReport to design with barcode (download section).
   Under the "more docs" section there is an Howto about iReport.
   1. We want to use Jasper Reports so we are going first to design a report. Who wants use others classes/jars
      can go to the next point of this topic.
      What kind of Jasper Report can we test? I choose a Report with a parameter to do it in a whole.
      Let's design a Report that shows the Orders a Bussines Partner have,
      were our parameter is the Bussines Partner ID.
      First we create a view with the information we need:

	create or replace view NN_BPartnerOrder_V
	as
	select C_BPartner_ID, Name, GrandTotal, DateOrdered
	from C_Order join C_BPartner using (C_BPartner_ID);

      Then create a Jasper Report on this view with your preferred tool, I used iReport.
      The Report should look, more or less, as the file 001/JRBPartnerOrder.xml . You can use this
      file directly if the dir. /tmp is accessible in your system. Barbecue needs a temporary dir.
      in order to create here the jpg of the barcode. You should modify it if /tmp is not accessible 
      on your system or you will see the report without the barcode.
      Here you can find the .jasper too, infact you need the xml or the jasper file for the next step.
   2. The java part.
      Usually you have some .java file that uses .jar, directly or indirectly (jars used by others jars).
      Where are we going to put the jars? We have 2 solutions:
      - Don't want to unjar anything. This is the case of oracle.jar used by Compiere. These jars are then
	included in the classpath everywhere, when compiling and when running Server or Client or WebStart application.
	If you want to add a jar of this type you have to modify some build.xml, some .jnlp, some .sh
      - The second possibility is to include the classes you want to use in a jar already present
	in the build/run script classpaths. If you look at the creation of CTools.jar the build.xml logic
	compile some code and unjar some jars in the same build directory then jar everything together.
	The build/run scripts need to include only CTools.jar to use new classes created compiling
	java code and classes simply expanded in the build directory before packing CTools.jar
      We are going to use the ladder method: our compiled classes will be packed together with the expanded
      version of jasperreports-0.5.2.jar and every jar used by Jasper Reports or by java code.
      This will result in a NNCompiereJR.jar and build/run scripts will be modified to let Compiere
      use this new jar. You can find this work in the NNCompiereJR module on the CVS.
      The final step of this point is to generate the NNCompiereJR.jar: download the module
      go to the NNCompiereJR dir. and type ant (ant 1.6.1 is required). At the end the jar will be ready.
      Note: if you want to upgrade/downgrade Jasper Reports or any other jar just update the lib
	    dir. and the new jar present here will be used during jar creation and packed together
	    in the final jar.
   3. Modify build/run scripts.
      - utils_dev/build.xml
	I added my dir here so NNJasperReport get compiled when I compile Compiere. I add this line:
	<ant inheritAll="false" dir="NNCompiereJR">
	and similar information in the clean section.
      - client/build.xml
	Here we have to add the unjar of one jar more before to create CClient.jar .
	The line I added is:
	<unjar src="..\NNCompiereJR\dist\NNCompiereJR.jar" dest="${build.dir}" />
      - utils/compiereDirectTemplate.jnlp
	The precedent modifications are important at compile time. This and the one that follow
	is important at run time. Add the following line to the file indicated in the
	<resources> section:
      	  <property name="ru.compiere.report.path" value="/tmp"/>
	/tmp is a directory on the client, you can use a network path
	and is were Compiere will look for .xml and .jasper files
      - serverRoot/src/web/compiere.jnlp
	Same modification as above.
   4. Modify the Application Dictionary.
      As you can imagine, if you are not new to JasperReport our Reports will be generated
      always by the same class, that will read different .xml or .jasper from Report to Report.
      So we need to add a Column/Field in the Process tab. Add a column:
	SQL> alter table AD_Process add (JasperReport VARCHAR2(200));
      load the column inside Compiere:
	SQL> @ db/maintain/Maintenance/0_Add_New_Column.sql
      create the new field:
	SQL> get db/maintain/Maintenance/0_Add_New_Field.sql
	SQL> /
   5. Specify a new Process.
      As you can see when you go to specify a new Process there is a new Field.
      Create a Process with:
	classname: ru.compiere.report.RusReportStarter
	JasperReport: JRBPartnerOrder.xml
      with a Parameter with:
	ColumnName: C_BPartner_ID
	Type: TableDir
      This class internally looks first in the ru.compiere.report.path property for path.
      Then it uses $COMPIERE_HOME/russian/reports when searching for xml . 
      If you are lazy probably put reports under $COMPIERE_HOME/russian/reports is faster.
      Now you can try the Process: when you run it the ru.compiere.report.RusReportStarter class
      will be executed. This class will read from AD_Process which Jasper Report file to use,
      and look for it in the path inside ru.compiere.report.path (/tmp in our case).
      Will read the C_BPartner_ID from AD_PInstance_Para
      and shows you the Sales Orders this B.Partner has.

002. Compiere Application Dictionary. (To be continued...)

	AD_	Application dictionary
	A_	Asset Management
	C_	Core Functionality
	GL_	General Leder
	I_	Import
	K_	Knowledge Base
	M_	Material Management
	PA_	Performance Analysis
	R_	Request
	RV_	Report Viewer
	S_	Service Management
	T_	Temporary
	W_	Webstore
	X_	Generated Model

003. Using Attribute Set.
     First a summary:
     1. You can create Attribute, this can be:
        - instance Attribute or not.
        - list Attribute or not.
     2. Then you should create Attribute Set this can be Instance Attribute Set or not.
     3. Go on and assign the Attribute Set created to your Product.
     4. What you can do it is:
        - in the Product window you can specify the non-instance Attributes with the Attribute Set Instance field.
	- in windows like Sales Order or Shipment you can specify the Instance Attributes.
	- in the warehouse Products show their Attribute Set Instance if present.
     Note: You can not set Attribute in the Order Lines Tab.
     If you want to do it you have to change the code. See point 004.
     
     Now an example:
     1. Attributes
       - Take a look at the Attribute window.
       In the GardenWorld demo there are Attributes. "Color" is not an instance attribute:
       this means that you can specify it in the Product catalog (the Product window)
       and it's fixed so you cannot specify it when compiling an Sales Order. It is
       a list Attribute this means that when you go to choose it Compier pop-up
       a list of values.
       Description is an Instance Attribute so you can specify it for every Product
       movement and you cannot specify it in the Product window. It isn't e list Attribute
       so you should not specify a list of values, as for the Color Attribute,
       and Compiere pop-up a text field when requesting to you to input a value
       for this Attribute.
     2. Attribute Set
       - Look at the Attribute Set window.
       There are same examples in the GardenWorld demo.
       Go on and create a new one, let's say the ColorWDescription Attribute Set.
       For it check Instance Attribute.
       - Attribute Use.
       Now under the Attribute Use Tab, specify our two Attributes Color and Description.
     3. Product
       - Specify the Product Attribute Set.
       Open the Product window and take a demo Product. Let's say "Oak Tree".
       And for it specify Attribute Set as "ColorWDescription". Save.
       In the same window press the icon on the Attribute Set Instance field.
       Compiere will let you choose the color but not the description.
       Choose your favorite color and save.
     4. Material Receipt.
       - Open the Material Receipt window. Create a receipt with one line
       with a Oak Tree Red (i like red so I choose it, the Attribute selector is in the
       upper right corner of the Search Product window). In the receipt line you
       can choose Description but not the Color. Process the Material Receipt.
       - Open the warehouse. You can see an Oak Tree with your description.
       And the Color Attribute?? It does not show, infact the similar example
       you can find, that with T-Shirt, the color is putted together with the Product Name.
       But you can search the warehouse for "red product" because the Attribute selector
       let you filter Products by their Attribute Values.
     
     More examples:
     1. You sell T-Shirt with different size and color. The price is the same.
     In this case is better if you define this 2 as Instance Attributes.
     You create just one T-shirt Product with its price. Then choose Attributes
     when filling a Sales Order.

     2. You sell T-Shirt with different size and color. The price vary
     with respect to the T-shirt size. You should create a Product for
     each size. The Attribute Size should be non-instance attribute so you
     specify it in the Product window, e.g. for the "T-shirt M" product
     you choose M for the Size Attribute.
     And choose the color in the Sales Order Line. You have more Products
     in this case but when searching you can still search for a Size or 
     for a Color.
     Same decision if you have Product that differ in something.
     BOM or price or cost.. depending
     on Size or Material, etc, that force you to create more Products.
     non-Instance Attributes can still be used to group them.

004. Using Attribute Set from developers point of view.
     - I will refer some problems in Compiere 2.5.1b and explain
     some classes, resolving these problems.
     
     1. First of all the Attribute Set Field in the Order Line Tab
     is read only. So open the System Client go to the Window,Tab&Field
     Window and select the Sales_Order.Order_Line Tab.
     The field Attribute Set Instance should not be read only.
     
     2. Now if you go to the Order Line Tab and try to specify Attribute
     for a product that had been setted up correctly you receive a
     			"No Product attribute information."
     message.
     This is due to the client/Src/com/compiere/grid/ed/VPAttribute.java
     code. If you look at setField method you will find which Fields
     are enabled for Attribute Set. The Fields of the Sales Order Line
     is missing. Because the AD_Column_ID of the Attribute Set Instance Field
     of the Order Lines Tab is 8767 modify this:
     
     m_instanceWindow = AD_Column_ID == 8772 || AD_Column_ID == 8552;

     with
     
     m_instanceWindow = AD_Column_ID == 8772 || AD_Column_ID == 8552 || AD_Column_ID == 8767;

     Then recompile Compiere. Now if the Attribute Set setup is ok
     you would be able to insert Order Lines with Products and Attributes.

     3. The other problem is the New Record button in release 2.5.1b. In the
     old 2.5.0d was not possible to choose: always Compiere creates new
     record so InOut Lines were not summed in the warehouse.
     The same happen if user creates a new record for Red-Large when there is
     already a Product with that Attribute Set in the warehouse.
     You have to change the VPAttributeDialog.java class and probably
     MAttributeSetInstance.java class model.
     One solution could be add a method to the model to find Attribute
     Set Instance with same Description of itself.
     Then modify the dialog in the saveSelection method to check out
     for similar Attribute Set Instance before to return newly created
     record ID.
     
005. For release 0.0.5

006. For release 0.0.6

007. For release 0.0.7

008. For release 0.0.8

009. For release 0.0.9


		New Topics

010. Hope to reach this point soon.


		GNU Free Documentation License
		  Version 1.2, November 2002


 Copyright (C) 2000,2001,2002  Free Software Foundation, Inc.
     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.


0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other
functional and useful document "free" in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.

This License is a kind of "copyleft", which means that derivative
works of the document must themselves be free in the same sense.  It
complements the GNU General Public License, which is a copyleft
license designed for free software.

We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does.  But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book.  We recommend this License
principally for works whose purpose is instruction or reference.


1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License.  Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein.  The "Document", below,
refers to any such manual or work.  Any member of the public is a
licensee, and is addressed as "you".  You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.

A "Modified Version" of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of
the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall subject
(or to related matters) and contains nothing that could fall directly
within that overall subject.  (Thus, if the Document is in part a
textbook of mathematics, a Secondary Section may not explain any
mathematics.)  The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.

The "Invariant Sections" are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License.  If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant.  The Document may contain zero
Invariant Sections.  If the Document does not identify any Invariant
Sections then there are none.

The "Cover Texts" are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License.  A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters.  A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text.  A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input format, SGML
or XML using a publicly available DTD, and standard-conforming simple
HTML, PostScript or PDF designed for human modification.  Examples of
transparent image formats include PNG, XCF and JPG.  Opaque formats
include proprietary formats that can be read and edited only by
proprietary word processors, SGML or XML for which the DTD and/or
processing tools are not generally available, and the
machine-generated HTML, PostScript or PDF produced by some word
processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page.  For works in
formats which do not have any title page as such, "Title Page" means
the text near the most prominent appearance of the work's title,
preceding the beginning of the body of the text.

A section "Entitled XYZ" means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language.  (Here XYZ stands for a
specific section name mentioned below, such as "Acknowledgements",
"Dedications", "Endorsements", or "History".)  To "Preserve the Title"
of such a section when you modify the Document means that it remains a
section "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document.  These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.


2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License.  You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute.  However, you may accept
compensation in exchange for copies.  If you distribute a large enough
number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and
you may publicly display copies.


3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document's license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover.  Both covers must also clearly and legibly identify
you as the publisher of these copies.  The front cover must present
the full title with all words of the title equally prominent and
visible.  You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.

If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
public has access to download using public-standard network protocols
a complete Transparent copy of the Document, free of added material.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.

It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.


4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it.  In addition, you must do these things in the Modified Version:

A. Use in the Title Page (and on the covers, if any) a title distinct
   from that of the Document, and from those of previous versions
   (which should, if there were any, be listed in the History section
   of the Document).  You may use the same title as a previous version
   if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities
   responsible for authorship of the modifications in the Modified
   Version, together with at least five of the principal authors of the
   Document (all of its principal authors, if it has fewer than five),
   unless they release you from this requirement.
C. State on the Title page the name of the publisher of the
   Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications
   adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a license notice
   giving the public permission to use the Modified Version under the
   terms of this License, in the form shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections
   and required Cover Texts given in the Document's license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled "History", Preserve its Title, and add
   to it an item stating at least the title, year, new authors, and
   publisher of the Modified Version as given on the Title Page.  If
   there is no section Entitled "History" in the Document, create one
   stating the title, year, authors, and publisher of the Document as
   given on its Title Page, then add an item describing the Modified
   Version as stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for
   public access to a Transparent copy of the Document, and likewise
   the network locations given in the Document for previous versions
   it was based on.  These may be placed in the "History" section.
   You may omit a network location for a work that was published at
   least four years before the Document itself, or if the original
   publisher of the version it refers to gives permission.
K. For any section Entitled "Acknowledgements" or "Dedications",
   Preserve the Title of the section, and preserve in the section all
   the substance and tone of each of the contributor acknowledgements
   and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document,
   unaltered in their text and in their titles.  Section numbers
   or the equivalent are not considered part of the section titles.
M. Delete any section Entitled "Endorsements".  Such a section
   may not be included in the Modified Version.
N. Do not retitle any existing section to be Entitled "Endorsements"
   or to conflict in title with any Invariant Section.
O. Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant.  To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it contains
nothing but endorsements of your Modified Version by various
parties--for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.

You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version.  Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity.  If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.


5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy.  If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History"
in the various original documents, forming one section Entitled
"History"; likewise combine any sections Entitled "Acknowledgements",
and any sections Entitled "Dedications".  You must delete all sections
Entitled "Endorsements".


6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.


7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an "aggregate" if the copyright
resulting from the compilation is not used to limit the legal rights
of the compilation's users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
the entire aggregate, the Document's Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.


8. TRANSLATION

Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections.  You may include a
translation of this License, and all the license notices in the
Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions
of those notices and disclaimers.  In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements",
"Dedications", or "History", the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual
title.


9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except
as expressly provided for under this License.  Any other attempt to
copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License.  However,
parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such
parties remain in full compliance.


10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time.  Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.  See
http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License "or any later version" applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation.  If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation.


ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:

    Copyright (c)  YEAR  YOUR NAME.
    Permission is granted to copy, distribute and/or modify this document
    under the terms of the GNU Free Documentation License, Version 1.2
    or any later version published by the Free Software Foundation;
    with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
    A copy of the license is included in the section entitled "GNU
    Free Documentation License".

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the "with...Texts." line with this:

    with the Invariant Sections being LIST THEIR TITLES, with the
    Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.

If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.


		Final Note

The original version of this HowTo was completely written using emacs.
Marco LOMBARDO, 2004-05-06, Lucca, Italy.
marco.lombardo@enneenne.com