jAPS 2.0 - Plugin User Reg

Do It The jAPS Way

Elia Mezzano

Redattore della versione italiana in formato odt

AgileTec s.r.l.

<e.mezzano@agiletec.it>

Rinaldo Bonazzo

Porting in DocBook 4.5

AgileTec s.r.l.

<r.bonazzo@agiletec.it>

Giovanni Cocco

Revisione e traduzione in inglese

AgileTec s.r.l.

<g.cocco@agiletec.it>

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

The copyright holders make no representation about the suitability of this Document for any purpose. It is provided “as is” without expressed or implied warranty. If you modify this Document in any way, identify your resulting Document as a variant of this Document.

2009-10-15

Revision History
Revision 0.2	2009-10-15	GC
Revision for jAPS version 2.0.8
Revision 0.1	2009-09-18	GC
English version

Abstract

The purpose of this document is to provide a complete description of the Plugin "jpuserreg" structure.

List of Tables

2.1. Summary of features
3.1. Pages configuration

List of Examples

3.1. Example of configuration for plugin User Profile
3.2. Example of configuration for jpmail plugin
3.3. Example of definition for parameter pageCode for account activation
3.4. Example of configuration for parameter pageCode for account activation or recover

Chapter 1. Scope of the document

Table of Contents

Introduction

Target audience
Prerequisites
Resources

Introduction

The purpose of this document is to provide a complete description of the Plugin "jpuserreg" structure.

Chapter 2. Plugin features `User Reg`

Table of Contents

Plugin features User Reg

Features
Prerequisites

The jAPS Plugin User Reg allows to a portal visitor the following actions:

registration of data mandatory to access reserved areas on portal
recover credential to portal access (username and/or password)
account reactivation to access reserved areas on portal, after disactivation
the account disactivation to avoid user access to reserved areas on portal, is possible to reactivate the account

Table 2.1. Summary of features

Code	Name	Type	Plugin Version	jAPS 2.0 Version
jpuserreg	User Reg	PurePlugin	1.1	2.0.8

Plugin features `User Reg`

Features

The module presents a set of interfaces for the Front-End, payable through Showlet Internal Servlet. These interfaces do not contain any graphical element. In this way it's possible to decorate it in any specific instance of jAPS 2.0. The actions of the registration and the reactivation of an account happens with an email sending, these mail contains a link to complete operation.

The registration procedure require the insertion of fields name, surname, language and email. When user provides required data, he receives an email with a link with a ticket valid for account activation. Clicking on the link the user accessed to a page to complete the registration procedure. During this procedure the user have to define his password. If user successfully defined his password the user has an account to access reserved areas on portal.

The reactivation process allows you to recover your password if lost or to reactivate your account, previously deactivated, redefining the password. The password recovery procedure requires that user provide his username or his email address from his profile on the portal. If the data provided are correct the user receives an email containing a link with a valid ticket to redefine the password for your account.

The procedure allows the user to disable his account. Once suspended the account you can not use it to log into the portal until the reactivation process is not completed. An user for suspend his account must be logged and must provide his password.

Prerequisites

the module require the installation of the plugins:

jpmail version 1.1
jpuserprofile version 1.4

for details on those plugins see respective manuals.

Chapter 3. Plugin installation and integration

Table of Contents

Plugin installation and integration

Tecnical Features
Package Description
Prerequisites for the integration and installation
Integration in a Production Environment
Installation in a Development Environment
Configuration of plugins Mail and User Profile
Plugin configuration User Reg
Pages configuration

Plugin installation and integration

Tecnical Features

The plugin has the characteristic of PurePlugin, its installation does not change any functionality in the system. The module presents a set of interfaces for the Front-End. These interfaces do not contain any graphical element. In this way it's possible to decorate it in any specific instance of jAPS 2.0.

Package Description

The package contains the folders doc, src and the file README as defined on jAPSPlugin Pattern documentation.

The src folder is structired as following:

The java folder contains complete java sources and the jUnit tests for the Plugin.
The sql folder contains scripts to execute on Port and Serv db, for production and for test.
The webapp folder contains all file needed by the webapp. In details, the folders contains jsp files (user interfaces) and config files, files for bean definition used by business layer of the jAPS 2.0 model and also by Struts 2 actions from the layer of presentation, the libraries (including the jar from sources of the plugin) and statics resources (css, images, js).

Prerequisites for the integration and installation

For integrate and install successfully the plugin of user registration the installation of plugins jpmail and jpuserprofile is mandatory. For integration/installation of this plugins see relative documentation.

Integration in a Production Environment

The following steps are for the installation of the plugin on a web application, in production state, based on the jAPS version declared compatible with the plugin.

The following activities are to be carried out after the stop of the Web Application.

Install the plugins jpmail and jpuserprofile in the production environment (see relative documentation), customize properly plugin configuration following the next paragraphs instructions.
Copy the contents of the folder src/webapp/WEB-INF/lib of the package as supplied within the folder <WEB_APP_NAME>/WEB-INF/lib/ in production.
Copy the contents of the folder src/webapp/WEB-INF/plugins of the package as supplied within the folder <WEB_APP_NAME>/WEB-INF/plugins/ in production. Create folder plugins if not exists.
Copy the contents of the folder src/webapp/resources/plugins of the package as supplied within the folder <WEB_APP_NAME>/resources/plugins/ in production.
Perform tasks detailed in the file portScript.sql (present in the folder src/sql) in the production db port.
The script is written for a version production (edit if the version of the environment is different). Edit the structure of the profile model if needed.
Perform tasks detailed in the file servScript.sql (present in the folder src/sql) in the production db serv.

Installation in a Development Environment

To install the plugin in an Eclipse project based on jAPS 2.0 and declared compatible with the plugin, Perform the following steps (From this point on, we will assume that your new project is called <PROJECT_NAME>):

Install the plugins jpmail and jpuserprofile in the development environment (see relative documentation), customize properly plugin configuration following the next paragraphs instructions.
Copy the contents of the folder src/webapp/WEB-INF/lib of the package as supplied within the folder <PROJECT_NAME>/WebContent/WEB-INF/lib/, excluding file jAPSPlugin-jpuserreg-1.1.jar.
Copy the contents of the folder src/webapp/WEB-INF/plugins of the package as supplied within the folder <PROJECT_NAME>/WebContent/WEB-INF/plugins/. Create folder plugins if not exists.
Copy the contents of the folder src/webapp/resources/plugins of the package as supplied within the folder <PROJECT_NAME>/WebContent/resources/plugins/.
Perform tasks detailed in the file portScript.sql (present in the folder src/sql) in the development db port. The script is written for a version production (edit if the version of the environment is different). Edit the structure of the profile model if needed.
Perform tasks detailed in the file servScript.sql (present in the folder src/sql) in the development db serv.
Perform tasks detailed in the file portTestScript.sql (present in the folder src/sql) in the test db port.
Perform tasks detailed in the file servTestScript.sql (present in the folder src/sql) in the test db serv.
Copy the contents of the folder src/java/main/com in the folder <PROJECT_NAME>/src/com of your project.
Copy the contents of the folder src/java/test/test in the folder <PROJECT_NAME>/src/test of your project.
Copy in the folder <PROJECT_NAME>/src/ of your project the file named jpuserreg_japs-struts-plugin.xml contained in the folder src/java/main. If in the folder src of the Eclipse project is already present one file with named japs-struts-plugin.xml, copy the content of the tag <struts> of the file jpuserreg_japs-struts-plugin.xml into the existing file japs-struts-plugin.xml and delete the file jpuserreg_japs-struts-plugin.xml. If the folder src of the Eclipse project there is not a file named japs-struts-plugin.xml, rename the file jpuserreg_japs-struts-plugin.xml to japs-struts-plugin.xml.
To verify the correct send of emails in the jUnit tests, change the constant EMAIL of th class JpUserRegTestHelper.java in the package test.com.agiletec.plugins.jpuserreg.

After performing the steps above, start the project from Eclipse and configure using the administrative interface, pages needed to run the plugin, as described in the following paragraphs. Yuo need also to customize the jsp.

Configuration of plugins `Mail` and `User Profile`

In your configuration for the plugin User Profile need to be presents 4 attributes Name, Surname, email and Language , configured as in the example:

Example 3.1. Example of configuration for plugin User Profile

<profiles>
	<profile typecode="PFL" typedescr="Profilo utente/cittadino tipo" >
		<attributes>
			<attribute name="Nome" attributetype="Monotext" 
				required="true"/>
			<attribute name="Cognome" attributetype="Monotext" 
				required="true"/>
			<attribute name="email" attributetype="Monotext" 
				required="true" searcheable="true" />
			<attribute name="language" attributetype="Monotext" />
		</attributes>
	</profile>
</profiles>

	important: attribute email must be declared searchable
	The email attribute must be, , searcheable this to be able to recover user information by email. Such as occurs in the password recovery feature via email request. To successfully run JUnit tests verify the configuration of email attribute in the profile configuration in the test database.

Note the name assigned to these attributes, as will be necessary to the configuration of the plugin Reg User.

The jpmail plugin need to be configured at least of one sender whit a valid email address. This will be used for comunication with the user during the registration procedure and the reactivation procedure.

Example 3.2. Example of configuration for jpmail plugin

<mailConfig>
	<senders>
		<sender code="CODE1">EMAIL1@EMAIL.COM</sender>
		<sender code="CODE2">EMAIL2@EMAIL.COM</sender>
	</senders>
	<smtp debug="true" >
		<host>out.virgilio.it</host>
		<user></user>
		<password></password>
	</smtp>
</mailConfig>

Note the code attribute used for email send.

Check, and if need edit, the parameter applicationBaseURL into file /WebContent/META-INF/context.xml, it must be setted to the full URL of the portal. Example:

<Environment name="applicationBaseURL"  
					value="http://localhost:8080/PortalExample/"  
					type="java.lang.String" 
					override="false" />

Plugin configuration `User Reg`

The plugin configuration is defined on a xml file (loaded into Port database of jAPS 2.0 ). In that file are defined elements of configuration needed for user generation and user profile generation and also configuration for emails for registratione and reactivation procedures.

An example of required configurations:

<userRegConfig>
	<!-- Matching between plugin jpuserreg attributes and attributes 
	Nome, Cognome, language and email mapped 
	on user profile config -->
	<profileEntity nameAttr="Nome" surnameAttr="Cognome"
		eMailAttr="email" langAttr="language" />
	
	<!-- Token validity in minutes -->
	<tokenValidity minutes="60"/>
	
	<!-- Sender code, as in mailConfig -->
	<sender code="CODE1" />
	
	<!-- Authorities to load on user request profile [OPTIONAL] -->
	<userAuthDefaults>
		<role name="userrole" />
		<group name="usergroup" />
	</userAuthDefaults>
	
	<!-- Activation page name -->
	<activation pageCode="activation">
		<template lang="it">
			<subject>[jAPS] : Attivazione utente</subject>
			<body>
Gentile {name} {surname}, 
grazie per esserti registrato.
Per attivare il tuo account è necessario seguire il seguente link: 
{link}
Cordiali Saluti.
			</body>
		</template>
	</activation>
	
	<!-- Re-Activation page name -->
	<reactivation pageCode="recover">
		<template lang="it">
			<subject>[jAPS] : Riattivazione utente</subject>
			<body>
Gentile {name} {surname}, 
il tuo userName è {userName}.
Per riattivare il tuo account è necessario seguire il seguente link: 
{link}
Cordiali Saluti.
			</body>
		</template>
	</reactivation>
</userRegConfig>

Details and meanings for the configuration params

Parameter profileEntity - this param contains attribute's names to make the matching with User Profile plugin for attributes name, surname, language and email
Parameter tokenValidity - this is the expiration time for the token of activation, sended to the user with an email. Spent this time the token will be invalidated and will not be more usable for activation.
Parameter sender - This param contains the email sender for matching with the plugin Mail.
Parameter userAuthDefaults - this optional param allow to define roles and groups that will be assigned to the new account created during registration to portal.
Parameter activation - this param contains the configuration for the email of confirm message for account activation. It contains also the code of the page for activation, the value is setted into the attribute pageCode. Within the parameter activation is present at the least one element template corresponding to the default language of the portal. In the optimal situation is preferable to create a template for each language defined within the portal. Each element template contains one element subject and one element body . The body element can be customized with params that will be replaced at runtime. There are the following params:
Parameter reactivation - this param contains the configuration for email of confirmation of account reactivation. It contains also the page code for the page of reactivation into the attribute pageCode . In addition to that specified in the preceding paragraph for the elements subject and body You can insert an element inside the body so defined:
- {userName}: the username of the user.

Pages configuration

The User Reg plugin needs some pages to work correctly. These pages need to be created. Each created pages contains one of the showlets of the plugin. If you use the recommended names given in the next table will not need to change codes of the pages in the showlet.

For simplify page management is recommended to create all of them like childs of one page, at example called "User Management", not visible on menu. Appropriately customize the showlet of login from the plugin jpuserreg_loginUserReg (/WEB-INF/plugins/jpuserreg/aps/jsp/showlets/jpuserreg_loginUserReg.jsp) or customize login showlet of the portal with new links for registration and account management.

In the showlet Nella showlet jpuserreg_loginUserReg there are links for pages: registr, passwordrecover and disactiv. This codes must match the codes of: the page for registration, the page for the password recover and the page for account disactivation. hese pages must be configured with showlets like in the following table. In the showlet there is a link for page for editing profile/password (the default page code is editprof_page_code, customize if necessary). If there isn't on portal page for editng profile/password remove the link. For details on configuration of page for editing profile/password refer to documentation of plugin jpuserprofile.

Table 3.1. Pages configuration

Page code	Showlet name
registr	User Registration - Registrazione Utente (`jpuserreg_Registration`)
activation	User Activation - Attivazione Utente (`jpuserreg_Activation`)
passwordrecover	Password Recover - Recupero Password (`jpuserreg_Recover`)
recover	User Reactivation - Riattivazione Utente (`jpuserreg_Reactivation`)
disactiv	User Suspension - Sospensione Utente (`jpuserreg_Suspension`)

The code of the page activation must be equal to that one into the xml configuration of the plugin in table sysconfig into the Port database.

Example 3.3. Example of definition for parameter pageCode for account activation

<activation pageCode="activation">
	<template lang="it">
		.........
	</template>
</activation>

The page code recover must be equal to that one inserted into the plugin configuration.

Example 3.4. Example of configuration for parameter pageCode for account activation or recover

<reactivation pageCode="recover">
	<template lang="it">
		.........
	</template>
</reactivation>

The presentation layer need to be customized to portal style. The resources are: those in the folder: /WEB-INF/plugins/jpuserreg/aps/jsp/externalFramework/userreg/ and the showlet in /WEB-INF/plugins/jpuserreg/aps/jsp/showlets/ next description for the jsp files:

activation/activateUser.jsp contains the form for users registration.
activation/activateUserError.jsp contains the error message for activation of account with invalid or expired ticket.
activation/confirmedUserActivation.jsp contains the confirm that the request for registration was received and the sending of an email for end the procedure.
activation/reactivateUser.jsp contains form for end registration with password definition.
activation/reactivateUserError.jsp contains the error message for riactivation of account with invalid or expired ticket.
activation/confirmedUserReactivation.jsp contains message for successfully happened reactivation of account
recover/recoverUser.jsp this is the form for recovering the account from email or from username.
recover/confirmedRecoverRequest.jsp message of confirmation for receipt of request for account recover.
registration/registerUser.jsp the form new account registration.
registration/confirmedUserRegistration.jsp message of confirmation for receipt of request for account registration.
suspension/confirmSuspend.jsp form for account suspension request.
error.jsp contains the error message for failed attempt of account suspension (administration user or user that is not from the local user database).

Probably you need also to customize labels for the JSPs, used with tag wp:i18n .

Appendix A. GNU Free Documentation License

Version 1.3, 3 November 2008

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.

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.

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:

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.
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.
State on the Title page the name of the publisher of the Modified Version, as the publisher.
Preserve all the copyright notices of the Document.
Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
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.
Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
Include an unaltered copy of this License.
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.
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.
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.
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.
Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
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 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.

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

11. RELICENSING

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

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