Copyright © 2010 Tzente s.r.l.
Legal Notice
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 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 Appendix entitled "GNU Free Documentation License".
2010-03-23
Revision History | ||
---|---|---|
Revision 1.5 | 2010-03-17 | MEM |
Update for jAPS 2.0, version 2.0.10 | ||
Revision 1.4 | 2009-11-11 | WG |
Update for jAPS 2.0, version 2.0.8 | ||
Revision 1.3 | 2009-03-13 | WG |
English and docbook adoption This revision is a Release Candidate | ||
Revision 1.2 | 2009-01-03 | ES, MD, WG |
First public release |
Abstract
The scope of this document is to introduce the development environment and to provide the guidelines for the extraction of a new instance of jAPS 2.0 from the source code hosted at SourceForge; thus obtaining the proper skeleton for the configuration of a new portal, ready to be developed.
Table of Contents
List of Examples
Table of Contents
The scope of this document is to introduce the development environment and to provide the guidelines for the extraction of a new instance of jAPS 2.0 from the source code hosted at SourceForge; thus obtaining the proper skeleton for the configuration of a new portal, ready to be developed.
This document is for the ones who are going to develop a new portal using jAPS 2.0, or at least are pondering about. Thus the preferred target audience are specialists of the presentation layer of web development, and Java developers.
In order to take the maximum advantage of the present document, it is necessary to have basic knowledge about: the Java platform, the Eclipse IDE, the Apache Tomcat servlet engine, the PosgreSQL DBMS.
Additional informations may be obtained through the following mailing-lists and website:
<japs-devs@lists.sourceforge.net>
, focused on developers<japs-users@lists.sourceforge.net>
, focused on final usersjAPS 2.0 is an Open Source, professional "Enterprise Accessible Information Platform" that makes easier aggregation, publishing, access, customization and integration of information, services, processes and resources, complying with accessibility requirements of W3C WCAG standards.
jAPS 2.0 Platform provides performance, reliability and scalability features typical of enterprise software (“Enterprise”), allows users with disabilities to access and manage information and services ("Accessible"), seeks to simplify content management ("Information") and it can be used as a framework ("Platform") to build vertical applications based on contents (Content Enabled Vertical Application).
Table of Contents
The development environment for jAPS 2.0 needs some previously installed software. In this chapter you will find the proper instructions.
The development environment for jAPS 2.0 can be installed in different OSes. In this document we will mainly refer to:
pointing out the differences where needed. It will be rather easy to apply the concepts to different OSes. Before starting the installation under the chosen OS, you should check the existence of the right versions of the following needed software:
Other versions may also work well with jAPS 2.0. Later in this chapter you will find quick installation procedures for all the software requirements.
jAPS 2.0 has been reported of being successfully installed also on Application Server jBOSS 4.2.3 and the following Database Servers: MySql, Oracle 10g, and Hypersonic. In jAPS 2.0 (but this is true since version 0.1) you will find only ANSI SQL, so the compatibility with other DBMSes (which of course respect the standard) is expected and promoted.
The JDK - Java Development Kit - provides a compiler and other tools for the development in Java, and also the execution environment. The JDK can be downloaded from the SUN website. Please take note of the installation path for later use. After a successful installation you need to perform some configurations, described in the following paragraphs.
For Ubuntu 8.10 it is highly recommended to use the package sun-java6-jdk
included
in the multiverse repository.
You need to configure the JAVA_HOME
environment variable, setting the installation path saved as suggested in the
previous paragraph.
The setting of the JAVA_HOME
environment variable
My Computer
, then choose Properties
Advanced
tab and press the Environment Variables
buttonSystem variables
box, press the New
button and set the variable as showed
in the FigureIn order to instruct the system to use the right Java subsystem, you have to run the following shell command:
wiz@id:~$ sudo update-alternatives --config java [sudo] password for wiz: There are 2 alternatives for 'java'. Selection Alternative ----------------------------------------------- + 1 /usr/lib/jvm/java-6-openjdk/jre/bin/java * 2 /usr/lib/jvm/java-6-sun/jre/bin/java Press return for default[*] value, or insert the selection number
and choose the right version from the available ones (which as said before is the SUN one). You can then check the configuration with the command:
wiz@id:~$ java -version java version "1.6.0_10" Java(TM) SE Runtime Environment (build 1.6.0_10-b33) Java HotSpot(TM) Server VM (build 11.0-b15, mixed mode)
Eclipse is an open source integrated development environment, which you can download from the official site. The required version is the one called [Eclipse IDE for Java EE Developers], version 3.4 Ganymede or later.
To install Eclipse you just have to extract the package in the preferred directory and run the eclipse
executable.
Ubuntu 9.10 comes with a working Eclipse 3.5 Galileo. You will need to manually add the software repositories and install the plugins needed for J2EE development, though.
Starting for the first time, Eclipse will ask you to create a directory called workspace
. Accept; that will be the directory under which Eclipse
will store all of your projects.
You can download PostgreSQL from the official site. The suggested version is
8.3. It is available an installer (pgInstaller
) wich provides an installation wizard.
During the installation you will be asked to choose a characted encoding: choose UTF8
. Please also take carefully note of the
chosen credentials (username and password).
Usually the installer for Windows comes with pgAdmin III. If it doesn't seem to be installed after the wizard finishes its job, you can download pgAdmin III from its official site.
After the installation, do all the configurations explained in a proper paragraph later in this document.
Installing under Ubuntu 8.10 is just a matter of doing an:
wiz@id:~$ sudo apt-get install postgresql postgresql-client postgresql-contrib pgadmin3
PostgreSQL is in the main repository, and pgAdmin III in the universe one.
After the installation, run the following commands in order to assign password to the postgres
user,
and then do all the configurations explained in a proper paragraph later in this document.
wiz@id:~$ sudo su - postgres postgres@id:~$ psql Welcome to psql 8.3.6, the PostgreSQL interactive terminal. Type: \copyright for distribution terms \h for help with SQL commands \? for help with psql commands \g or terminate with semicolon to execute query \q to quit postgres=# alter user postgres with password 'postgres'; ALTER ROLE postgres=# \q postgres@id:~$ exit logout wiz@id:~$
Now it's time to add an user to the database, which you will use for jAPS 2.0. Launch pgAdmin III and follow these instructions:
postgres
and password postgres
(you may
have to add a connection using File
then Add server...
)
Login Roles
, choose New Role
agile
, check the Can create databases
privilege setting, confirm with Ok
.
You can download Apache Tomcat from the official site. The suggested version is 6.0.18. We recommend you to download Apache Tomcat in the form of a compressed archive.
To install Tomcat you just have to extract the package in the preferred directory and run the startup.sh
(Linux)
or startup.bat
(Windows) executable.
Please notice that for our chosen development environment and best practices, we only need Tomcat correctly installed in our system but we need it not to run except for the cases you will find later in this document.
You have to setup URI encoding for the Tomcat Connectors and enable the automatic trimmer for the JspServlet
You have to edit this file: server.xml
Looking for the tag Connector
, you'll find something like this for port 8080:
<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />
and something like this for port 8443
<Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" />
You have to add a new attribute URIEncoding="UTF-8"
to the connector tags.
So you'll have in your file server.xml
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443"
URIEncoding="UTF-8"/>
and for port 8443
<Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true"
maxThreads="150" scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS"
URIEncoding="UTF-8"/>
Edit the file web.xml
in your tomcat installation directory.
Search for <servlet-name>jsp</servlet-name>
, and write inside the tag servlet
new init param. See example below.
Example 3.3. Enable trimSpaces
<servlet> <servlet-name>jsp</servlet-name> <servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class> <init-param> <param-name>fork</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>xpoweredBy</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>trimSpaces</param-name> <param-value>true</param-value> </init-param> <load-on-startup>3</load-on-startup> </servlet>
The suggested driver is JDBC 3 for PostgreSQL 8.3, and you have to
put it under the lib
directory of your Tomcat installation.
Table of Contents
Now we can proceed creating in Eclipse the project for the new Portal.
Some of the required steps are automagically performed, thanks to the build files for Ant. The previously installed Eclipse environment comes with all the necessary to run an Ant build. You can run Ant using the Eclipse GUI and the instructions in this document, even if it is the very first time for you with Ant and Eclipse.
Later on this chapter, you will find detailed instructions for creating the new Project. It will be a Dynamic Web Project. We will discuss later about the Dynamic Web Projects, and give some tips and best practices. At the moment, the goal is to create a development environment also including a local execution environment, to be able to immediately check the progresses during the development.
First of all, we need the package jAPS2.0-2.0.10-src
(or newer) from SourceForge.
Once donwloaded, choose a temporary location and extract the package.
Launch Eclipse and take the following steps in order to import jAPS 2.0 in the workspace:
File
, then Import...
Choose General
, then Existing Projects into Workspace
, and press the Next
button
Browse and select the directory from which import the project. Obviously, the right directory is the temporary one where you
previously extracted the jAPS2.0-2.0.8-src
package downloaded from SourceForge
Check the Copy projects into workspace
box
Press Finish
When Eclipse finishes to import, in the Project Explore
view of Eclipse will be a new project called jAPS2
.
This project contains all the necessary to instantiate a new Portal project, as we are going to explain. Later you can delete
it, if you want.
From the Project Explorer
, browse the project jAPS2
and open admin/build_newPortal.xml
.
This file contains the instructions which Ant can use to create the new project. First of all, it is necessary to customize the
name of the source project and the name of the project to create. Find the following two rows:
<property name="newportal.name" value="myPortalName" /> <property name="newportal.source.name" value="jAPS2" />
Now insert the desired project name in place of myPortalName
, and optionally the name of the source project which defaults
to jAPS2
. Save the file.
Example 4.1. build_newPortal.xml
: a correct setting
<property name="newportal.name" value="myportal" /> <property name="newportal.source.name" value="jAPS2" />
From this point on, we will assume that your new project is called myportal
. Now extract the new project from jAPS 2.0:
Open the Ant view: Window
, Show View
, Ant
, Ant
Drag the file build_newPortal.xml
and drop it in the Ant view
Expand the node jAPS2 - Extract New Portal
Launch (i.e. with a double-click) the task Create New Portal
Ant will extract the new project from the source project, and will place it in your workspace directory. Now you have to import it
into Eclipse, just as you previously did with jAPS2.0-2.0.8-src
:
File
, then Import...
Choose General
, then Existing Projects into Workspace
, and press the Next
button
Browse and select the directory from which import the project myportal
.
Check the Copy projects into workspace
box
Press Finish
When Eclipse finishes to import, in the Project Explore
view of Eclipse there will be a new project called myportal
.
In order to avoid any mistake or misunderstanding, now you should better close or delete the jAPS2
project.
Now it's time for some configurations.
Open the file buildProperties.xml
, located in the root directory of the project. First of all properly comment
or uncomment the blocks of properties suited for Microsoft Windows or Linux, following the XML syntax for comments:
<!-- This sentence is commented out -->
I.e. if you are using Windows, you have to comment out the Linux block and uncomment the Windows one. And so on...
Then edit the following properties accordingly with your system settings:
<property name="webappname" value="myportal" />
<property name="postgres.username" value="agile" />
<property name="postgres.password" value="agile" />
Windows: <property name="postgres.bin.path" location="C:\Programmi\PostgreSQL\8.3\bin" />
Linux: <property name="postgres.bin.path" location="/usr/bin" />
Now edit some properties for the execution phase. Open the file /jAPS2/WebContent/META-INF/context.xml
.
Edit the paths, URLs, and values.
Example 4.2. context.xml
on Linux
<?xml version='1.0' encoding='utf-8'?> <Context path="/myportal" docBase="./myportal" debug="1" reloadable="true"> <Environment name="logName" value="japs" type="java.lang.String" override="false" /> <Environment name="logFilePrefix" value="/home/wiz/workspace/myportal/build/temp/japs_log" type="java.lang.String" override="false" /> <Environment name="logLevel" value="ALL" type="java.lang.String" override="false" /> <Environment name="logFileSize" value="200000" type="java.lang.String" override="false" /> <Environment name="logFilesCount" value="10" type="java.lang.String" override="false" /> <Environment name="configVersion" value="production" type="java.lang.String" override="false" /> <Environment name="applicationBaseURL" value="http://localhost:8080/myportal/" type="java.lang.String" override="false" /> <Environment name="resourceRootURL" value="/myportal/resources/" type="java.lang.String" override="false" /> <Environment name="protectedResourceRootURL" value="/myportal/protected/" type="java.lang.String" override="false" /> <Environment name="resourceDiskRootFolder" value="/home/wiz/workspace/myportal/WebContent/resources/" type="java.lang.String" override="false" /> <Environment name="protectedResourceDiskRootFolder" value="/home/wiz/workspace/myportal/WebContent/protected/" type="java.lang.String" override="false" /> <Environment name="indexDiskRootFolder" value="/home/wiz/workspace/myportal/build/temp/indexdir" type="java.lang.String" override="false" /> <Environment name="cacheDiskRootFolder" value="/home/wiz/workspace/myportal/build/temp/cache" type="java.lang.String" override="false" /> <Resource name="jdbc/portDataSource" auth="Container" type="javax.sql.DataSource" driverClassName="org.postgresql.Driver" maxActive="8" maxIdle="4" username="agile" password="agile" url="jdbc:postgresql://localhost:5432/myportalPort" /> <Resource name="jdbc/servDataSource" auth="Container" type="javax.sql.DataSource" driverClassName="org.postgresql.Driver" maxActive="8" maxIdle="4" username="agile" password="agile" url="jdbc:postgresql://localhost:5432/myportalServ" /> </Context>
jAPS 2.0 needs two databases, whose names are prefixed by the name of the project
and suffixed respectively by Port
and Serv
.
Ant can automagically create and populate the two databases for you:
![]() | Warning |
---|---|
The next procedure drops the two databases if already present. Please consider doing a backup before proceeding further. |
Drag the file build.xml
and drop it in the Ant view.
Expand the main node and launch (i.e. with a double-click) the Pg db full update
task
Having created a dynamic web project the next step is to configure the servlet container that is going to host the web application during the development stage.
Choose File
, New
, Other
, Server
to launch the wizard
Select Apache - Tomcat v6.0 server
, then press the Next
button
In the window Tomcat Server
set the Tomcat installation directory (i.e. the directory where you installed
Apache Tomcat in [Chapter 3. Software Requirements]), the press the Next
button again
Add myportal
to the list of projects configured on this server, then press the Finish
button
If everything works fine, Eclipse compiles and deploys the web application in a directory of its own (which we are not interested
in knowing at the moment). From now on, you can launch the web application with right mouse button on the project then choosing Run As...
,
Run on Server
.
If a server selection window appears, select the server you just created. You can also get rid of this window checking the
Always use this server when running this project
setting.
If everything is ok, you can see the homepage of your brand new portal pointing your preferred browser to http://localhost:8080/myportal/.
As hinted before, the project you have just created is a Dynamic Web Project. Eclipse allows you to incrementally deploy (and almost in real time)
the application as you progress during the development. That is, in order to see the results of the editing of Java class, or of a JSP page
or of a CSS you don't have to copy the modified objects into the execution environment (i.e. the webapps
directory
of the Apache Tomcat installation path) nor to perform a restart of the server: Eclipse does it all in your place, and very well.
Another (hopefully) useful digression. Given a certain dimension of the project, a Portal is built by a team of developers each providing various skills, from Java to the information architecture. Usually, the work group shares the Portal components using a project repository (i.e. CVS or SVN). This requires order and organization. Each developer works in a local area (the Eclipse workspace) which is a replica, periodically synchronized, of the shared repository. In order to be able to share all the components of the project, it is required that they are located in the same working area.
From this, derive some other tips.
The big picture is the following:
workspace/myportal
DeployArea
DeployArea
workspace/myportal
, Eclipse copies it in DeployArea
and if it is necessary also restarts Tomcat
workspace/myportal
, using the browser he can
use the web application Tomcat is executing in the DeployArea
.
Let's see what happens when you upload a new Image resource using the CMS of jAPS 2.0:
workspace/myportal
DeployArea
As you can imagine all these tips regard exclusively the development environment and not the final production environments, where only the execution area does exist.
Version 1.3, 3 November 2008
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
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 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.
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.
The “publisher” means any person or entity that distributes copies of the Document to the public.
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.
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 (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.
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:
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, 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”.
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, 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.
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.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
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 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. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
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 © 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.3 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.