WebDocWf JDBC-2-JDBC Loader Manual

Igor Raicevic

Alfred Madl


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


Table of Contents

0. Introduction
1. Starting the loader
1. Starting as application
2. Starting from Java
2. Loader jobs
1. The <loaderJob> root element
2. The <restartCounter> element
3. The <variables> element
4. The <jdbcDefaultParameters> element
5. The <sql> element
6. The <definitionInclude> element
7. The <importDefinition> element
A. GNU Free Documentation License
How to use this License for your documents


Did you ever want to transfer data from one JDBC source to another and do some kind of transformation during copy, like: normalize unnormalized data / create artificial keys / execute SQL statements during / before / after transfer ?

Did you ever want to create a database like the following in one step: create the tables, load initial data, create indexes, create primary keys, create foreign keys ?

If your answer is yes, you need this loader !


The WebDocWf JDBC-2-JDBC Loader copies data from one JDBC source database into another JDBC target database. It can work on different types of database vendors. Possible source/target databases are: MSSQL, MySql, Access, Excel, CSV (using a CSV JDBC driver),...

The loader offers many possibilities: creating databases, creating tables, inserting data into an empty database, inserting data in to an existing database, updating columns with constant values, updating relations, updating columns with system-date/time, updating columns with a current user ID, executing every possible SQL statement, creating artificial keys using the Enhydra DODS objectid logic, ...

The transformation commands are based on a special XML DTD/schema. The number of transformations in one XML loadJob file is not limited.

The loader supports commit counts and restartable jobs using a separate table to store restart information.

Loader output is written to a log file according to a logmode parameter (none, normal or full).

Data columns are written to the target table using several modes: Key (value used to identify the row), Overwrite (value is written to the row no matter which value was there before or what is the new value), Update (value is only written if the current value is NULL), SetIfCreated (value is only written if the row is newly created) and SetNull (value is only written if the new value is NULL).

The loader can be started as a standalone application using them main-method or can be used from within another Java application using the public API.

Starting the loader

Starting as application

Using native Java VM commands you can start the loader with the following syntax:

java org.webdocwf.util.loader.Loader [options] loadJob_xml_filename

"loadJob_xml_filename" is the name of the XML file which is based on the Loader DTD/schema an contains all processing instructions.

Table Options. Options are:

-mdefines the default logmode. Possible values are "none", "normal" (is the default) and "full". Is "normal" otherwise-m none
-rstarts the Loader in restart mode after abnormal termination in a prior execution.-r
-udefines the current UserID used in UserID value columns.-u r004d\meier
-vdefines variables used in variable columns.-v varname1=varval1;varname2=varval2
-ldefines the logfile directory. The default is the current working directory.-l c:\my_directory_for_logfiles
-fdefines the logfile name. The default is "LoaderLog-YYYY-MM-DD-HH-mm-SS.txt".-f c:\somewhere\down\..\mydir2\mylog.txt
-dthe filename of the XML DB-vendor configuration file. The default is "LoaderDBVendors.xml".-d MyVendor.xml
-edefines to set the default of "onErrorContinue" to "true". Is false otherwise.-e
-pExtend the classpath with additional paths.-p c:\webdocwf\webdocwf310\lib\csvjdbc.jar;c:\webdocwf\webdocwf310\lib\JTurbo.jar
-cSets the default commit count. System default is "100".-c 1000

The order of the options is not relevant.

A complete start command example:

java -cp c:\webdocwf\webdocwf310\lib\wdw.jar;c:\webdocwf\webdocwf310\lib\webdocwf.jar org.webdocwf.util.loader.Loader -m none -r -u myID -v myvar1=value1;myvar2=value2;myvar3=value3 -l c:\mylogs -f loadlogs\mylog.txt -d MyDB.xml -e -p c:\webdocwf\webdocwf310\lib\csvjdbc.jar -c 1000 MyLoadJob.xml

Another one:

load -u myID MyLoadJob.xml

WebDocWf contains startup scripts under the "bin" directory to start the loader. Under Windows 2000 simply use the "load" command.

Be sure to include necessary entries in the classpath for extra JDBC drivers which are used in your loader jobs or simply use the -p Parameter !

Starting from Java

The Loader can be used from every Java application by its public constructor.

public Loader(String loadJobFileName, String mode, String userID, String logDirName, 
String logFileName, boolean restartIndicator, Map variableValues, String vendorFileName, 
boolean onErrorContinue, String additionalPaths, int commitCount)

To start the load process simply do the following:

Loader myLoader=new Loader("MyLoadJob.xml", Loader.LOGMODE_NONE, "myID", null, null, 
false, null, null, true, null, 0);

The logmodes are defined as public String constants in the Loader class. Their names are: Loader.LOGMODE_NONE, Loader.LOGMODE_NORMAL, Loader.LOGMODE_FULL.

There is a second public constructor using defaults for all options:

public Loader(String loadJobFileName)

You can also use the "getxxx" and "setxxx" methods for the additional options as defined in the API documentation.

Loader jobs

A Loader job is a XML file correspondig to the Loader DTD/schema. The root element is <loaderJob>...</loaderJob>

The <loaderJob> root element

The root tag of the XML file is <loaderJob>, all other tags are children of this element and there can be just one <loaderJob>. The element <loaderJob> may have several attributes. These attributes are default values for the attributes with the same name in the <importDefinition> and <sql> elements. If those attributes are not specified in an <importDefinition> or <sql> element, the Loader takes the default values from <loaderJob> element.

Example 1. Example of a <loaderJob> element:

<loaderJob logMode="full" objectIDIncrement="5" objectIDTableName="myAdminObjectID"
objectIDColumnName="myNext" onErrorContinue="false" commit="true" userID="r004d\meier" 
logDir="c:\mylogs" logFile="myFile.txt" vendorConfig="MyVendorConfig.xml" objectIDAutoCreate="true" 
objectIDStartValue="150000" commitCount="1000" oidLogic="false" tableMode="Cache">

Table 2. <loaderJob> attributes:

attributedefault fordescriptionparam
logMode<importDefinition> and <sql>defines the default logmode. Possible values are: "normal", "none" and "full". The system default is "normal".-m
objectIDIncrement<importDefinition>Defines the incremental value for global unique objectID's as used by Enhydra DODS. Default is 20.none
objectIDTableName<importDefinition>Defines the table name for global unique objectID's as used by Enhydra DODS. Default is "objectid".none
objectIDColumnName<importDefinition>Defines the column name for global unique objectID's as used by Enhydra DODS. Default is "next".none
onErrorContinue<sql>Defines if the load job should continue if an error in a SQL statement occurs. Default is "false"-e
commit<sql>Defines if SQL statement blocks should be commited separately. Default is "false"none
userIDnoneDefines the value for userID columns.-u
logDirnoneDefines the target directory for the logfile. Default is the current working directory-l
logFilenoneDefines the logfile name. Default is "LoaderLog-YYYY-MM-DD-HH-mm-ss.txt"-f
vendorConfignoneDefines the name of the DB vendor configuration XML file. Default is "LoaderDBVendors.xml"-d
objectIDAutoCreate<importDefinition>Defines if the objectID table should be created automatically if not present. Default is "false".none
objectIDStartValue<importDefinition>Defines the start value for objectIDs ONLY if the objectID table is created automatically. Default is "1"none
commitCount<importDefinition>Defines the default commit count. System default is "100"-c
oidLogic<importDefinition> <table>Defines the default if tables use the DODS oid logic. The system default is "true".none
tableMode<importDefinition> <table>Defines the default access method for tables. The system default is "Query".none

Attributes of the loaderJob element are overridden by the corresponding parameters of the application/constructor !

Example 2. Subelements

<loaderJob ...>

The <restartCounter> element

This element defines a restart-table for storing restart information. This is an optional element/feature of the Loader. Jobs are only restartable if this element is specified. Additionally importDefinitions must have a defined value sort order to be able to restart.

Example 3. Example of a restartCounter

<loaderJob ...>
   <restartCounter tableName="MyRestart" importDefinitionColumnName="MyName" 
      restartCounterColumnName="MyCounter" restartAutoCreate="true"/>

The default attributes are: "LOADERRESTART" as the tablename, "IMPORTDEFINITION" and "RESTARTCOUNTER" as columnnames and "false" for the AutoCreate attribute.

If a loaderJob is started without the "-r" parameter all entries in this table are deleted !

The <variables> element

This element together with it's subelements defines logical variables to be used in constantColumns, SQL-statements, source-data and JDBC parameters.

Example 4. Example of variables

<loaderJob ...>
   <variables prefix="!" suffix="!" override="false" replaceInConstants="true" replaceInSQL="false" 
      replaceInData="true" replaceInJDBC="true">
      <variable name="myvar1" value="myVal1" prefix="$" suffix="$" override="true" replaceInConstants="false" 
         replaceInSQL="true" replaceInData="false" replaceInJDBC="false"/>
      <variable name="myvar2" prefix="§" suffix="§"/>
      <variable name="myvar3" value="myVal3"/>

In this example the following will be done:

All occurences of "$myvar1$" will be replaced by "myVal1" or the override value specified in the application/constructor parameters. The replace will take place in SQL statements only.

All occurences of "§myvar2§" will be replaced by the value specified in the application/constructor parameters. The replace will take place in constant columns, source data and JDBC parameters. If there is no value specified in the application/constructor parameters for this variable name an exception will occur. A NULL value for myvar2 can be specified by "-v myvar2=;myvar3=myval3"

All occurences of "!myvar3!" will be replaced by the value "myVal3" which can NOT be overridden by parameters. Conflicts between variable definitions and parameters lead to a runtime exception ! The replace will take place in constant columns, source data and JDBC parameters.

The system defaults are: prefix="%" suffix="%" override="true" replaceInConstants="false" replaceInSQL="false" replaceInData="false" replaceInJDBC="false"

The <jdbcDefaultParameters> element

This element together with it's subelements defines the default JDBC parameters for import definitions and SQL statements.

Example 5. Example of JDBC default parameters

<loaderJob ...>
         <jdbcSourceParameter name="JdbcDriver" value="org.myDriver.JDBCDriver"/>
         <jdbcSourceParameter name="Connection.Url" value="jdbc:myDriver:MySourceDatabase"/>
         <jdbcSourceParameter name="User" value="myDBUserName"/>
         <jdbcSourceParameter name="Password" value="myDBPassword"/>
         <jdbcTargetParameter name="JdbcDriver" value="org.myDriver2.JDBCDriver2"/>
         <jdbcTargetParameter name="Connection.Url" value="jdbc:myDriver2:MyTargetDatabase"/>
         <jdbcTargetParameter name="User" value="myDBUserName2"/>
         <jdbcTargetParameter name="debug" value="on"/>

If there is no specified password you will be asked during runtime.

All values can use the variable-replace functionality defined in the variables element.

The <sql> element

This element together with it's subelements executes SQL statements on a target database.

Example 6. Example of the sql element

<loaderJob ...>
   <sql logMode="none" onErrorContinue="true" commit="true">
         <jdbcTargetParameter name="JdbcDriver" value="org.myDriver2.JDBCDriver2"/>
         <jdbcTargetParameter name="Connection.Url" value="jdbc:myDriver2:MyTargetDatabase"/>
         <jdbcTargetParameter name="User" value="myDBUserName2"/>
         <jdbcTargetParameter name="debug" value="off"/>
         CREATE DATABASE Together;
         CREATE TABLE tab1 (col1 varchar(250));
   <sql logMode="full" onErrorContinue="false" commit="false">
         <jdbcTargetParameter name="JdbcDriver" value="org.myDriver2.JDBCDriver2"/>
         <jdbcTargetParameter name="Connection.Url" value="jdbc:myDriver2:MyTargetDatabase"/>
         <jdbcTargetParameter name="User" value="myDBUserName2"/>
         <jdbcTargetParameter name="debug" value="off"/>
         <include href="c:\mySQLFile1" parse="text"/>

The <definitionInclude> element

This element includes another xml file with import definitions.

Example 7. Example of the definitionInclude element

<loaderJob ...>
      <include href="c:\MyImportDefinitions1" parse="xml"/>

The included file must have the following structure/content:

Example 8. Example of an included definition file


The <importDefinition> element

This element imports and transforms data of a source table into a target database.

Example 9. Example of the importDefinition element

<loaderJob ...>
   <importDefinition name="MyDef1" tableName="MySourceTable1" logMode="full" objectIDIncrement="2" objectIDTableName="Myoid" 
      objectIDColumnName="MyNext" objectIDAutoCreate="true" objectIDStartValue="500" commitCount="10000">
         <sortColumn entry="ColName1"/>
         <sortColumn entry="ColName2"/>
            <jdbcSourceParameter name="JdbcDriver" value="org.myDriver.JDBCDriver"/>
            <jdbcSourceParameter name="Connection.Url" value="jdbc:myDriver:MySourceDatabase"/>
            <jdbcSourceParameter name="User" value="myDBUserName"/>
            <jdbcSourceParameter name="Password" value="myDBPassword"/>
            <jdbcTargetParameter name="JdbcDriver" value="org.myDriver2.JDBCDriver2"/>
            <jdbcTargetParameter name="Connection.Url" value="jdbc:myDriver2:MyTargetDatabase"/>
            <jdbcTargetParameter name="User" value="myDBUserName2"/>
            <jdbcTargetParameter name="debug" value="on"/>
         <valueColumn sourceColumnName="Col19" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col17" valueMode="Key"/>
         <valueColumn sourceColumnName="Col20" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col18" valueMode="Update"/>
         <valueColumn sourceColumnName="Col21" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col19" valueMode="Overwrite"/>
         <valueColumn sourceColumnName="Col22" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col20" valueMode="SetIfCreated"/>
         <valueColumn sourceColumnName="Col22" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col21" valueMode="SetNull"/>
         <valueColumn sourceColumnName="Col31" targetTableName="TargetTab2" targetTableID="0" 
            targetColumnName"Col17" valueMode="Key"/>
         <valueColumn sourceColumnName="Col32" targetTableName="TargetTab3" targetTableID="0" 
            targetColumnName"Col18" valueMode="Key"/>
         <valueColumn sourceColumnName="Col33" targetTableName="TargetTab4" targetTableID="0" 
            targetColumnName"Col19" valueMode="Key"/>
         <valueColumn sourceColumnName="Col34" targetTableName="TargetTab5" targetTableID="0" 
            targetColumnName"Col20" valueMode="Key"/>
         <valueColumn sourceColumnName="Col35" targetTableName="TargetTab5" targetTableID="1" 
            targetColumnName"Col21" valueMode="Key"/>
         <variableColumn name="var1" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col11" valueMode="Key"/>
         <variableColumn name="var2" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col12" valueMode="Update"/>
         <variableColumn name="var3" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col13" valueMode="Overwrite"/>
         <variableColumn name="var4" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col14" valueMode="SetIfCreated"/>
         <variableColumn name="var5" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col15" valueMode="SetNull"/>
         <userIDColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col22" 
         <userIDColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col23" 
         <userIDColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col24" 
         <userIDColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col25" 
         <userIDColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col26" 
         <timeStampColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col32" 
         <timeStampColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col33" 
         <timeStampColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col34" 
         <timeStampColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col35" 
         <constantColumn constantValue="myVal%var12345%" targetTableName="TargetTab1" 
            targetTableID="0" targetColumnName"Col47" valueMode="Key"/>
         <constantColumn constantValue="myVal2" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col48" valueMode="Update"/>
         <constantColumn constantValue="myVal3" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col49" valueMode="Overwrite"/>
         <constantColumn constantValue="myVal4" targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col50" valueMode="SetIfCreated"/>
         <constantColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col51" 
         <constantColumn targetTableName="TargetTab1" targetTableID="0" targetColumnName"Col52" 
         <relationColumn relationSourceTableName="TargetTab2" relationSourceTableID="0" 
            relationSourceColumnName="Key21"  targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col61" valueMode="Key"/>
         <relationColumn relationSourceTableName="TargetTab2" relationSourceTableID="0" 
            relationSourceColumnName="Key22"  targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col62" valueMode="Key"/>
         <relationColumn relationSourceTableName="TargetTab3" relationSourceTableID="0" 
            targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col63" valueMode="Update"/>
         <relationColumn relationSourceTableName="TargetTab4" relationSourceTableID="0" 
            targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col64" valueMode="Overwrite"/>
         <relationColumn relationSourceTableName="TargetTab5" relationSourceTableID="0" 
            targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col65" valueMode="SetIfCreated"/>
         <relationColumn relationSourceTableName="TargetTab5" relationSourceTableID="1" 
            targetTableName="TargetTab1" targetTableID="0" 
            targetColumnName"Col66" valueMode="SetNull"/>
         <table tableName="TargetTab1" tableID="0" insert="true" tableMode="Query" oidLogic="true"/>
         <table tableName="TargetTab2" tableID="0" insert="false" tableMode="Cache" oidLogic="false"/>
         <table tableName="TargetTab3" tableID="0" insert="false" tableMode="Cache" oidLogic="true"/>
         <table tableName="TargetTab4" tableID="0" insert="false" tableMode="Cache" oidLogic="true"/>
         <table tableName="TargetTab5" tableID="0" insert="false" tableMode="Cache" oidLogic="true"/>
         <table tableName="TargetTab5" tableID="1" insert="false" tableMode="Cache" oidLogic="true"/>

The "name" attribute of importDefinitions must be unique within one loaderJob in order to make the restart functionality work correctly.

If a constantColumn has no constantValue attribute the value is NULL.

A. GNU Free Documentation License

Version 1.1, March 2000

Copyright (C) 2000 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.


The purpose of this License is to make a manual, textbook, or other written 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.


This License applies to any manual or other work that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you".

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. (For example, 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.

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 "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, whose contents can be viewed and edited directly and 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 has been designed to thwart or discourage subsequent modification by readers is not Transparent. 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-orming simple HTML designed for human modification. Opaque formats include PostScript, PDF, 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 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.


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.


If you publish printed copies 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 publicly-accessible computer-network location containing a complete Transparent copy of the Document, free of added material, which the general network-using public has access to download anonymously at no charge using public-standard network protocols. 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.


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:

  1. 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.

  2. 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 less than five).

  3. State on the Title page the name of the publisher of the Modified Version, as the publisher.

  4. Preserve all the copyright notices of the Document.

  5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.

  6. 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.

  7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.

  8. Include an unaltered copy of this License.

  9. Preserve the section entitled "History", and 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.

  10. 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.

  11. In any section entitled "Acknowledgements" or "Dedications", preserve the section's title, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.

  12. 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.

  13. Delete any section entitled "Endorsements". Such a section may not be included in the Modified Version.

  14. Do not retitle any existing section as "Endorsements" or to lict in title with any Invariant Section.

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.


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.

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."


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.


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, does not as a whole count as a Modified Version of the Document, provided no compilation copyright is claimed for the compilation. Such a compilation is called an "aggregate", and this License does not apply to the other self-contained works thus compiled with the Document, on account of their being thus compiled, if they 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 quarter of the entire aggregate, the Document's Cover Texts may be placed on covers that surround only the Document within the aggregate. Otherwise they must appear on covers around the whole aggregate.


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 provided that you also include the original English version of this License. In case of a disagreement between the translation and the original English version of this License, the original English version will prevail.


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.


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.

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.1 or any later version published by the Free Software Foundation; with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. A copy of the license is included in the section entitled "GNU Free Documentation License".

If you have no Invariant Sections, write "with no Invariant Sections" instead of saying which ones are invariant. If you have no Front-Cover Texts, write "no Front-Cover Texts" instead of "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.

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.