Copyright © 2010 AgileTec 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-02-17
Revision History | ||
---|---|---|
Revision 1.1 | 2010-02-17 | ES |
Update due to jAPS 2.0 version 2.0.10 | ||
Revision 1.0 | 2009-11-10 | MEM |
Translation and adaptation of the Italian documentation |
Abstract
The aim of this document is to fully describe the structure of the User Profile
plugin.
Table of Contents
List of Tables
Table of Contents
The aim of this document is to fully describe the structure of the User Profile
plugin.
This document is for those who want to know more about the User Profile plugin functionalities and are considering to install it in a production or development environment with the Eclipse IDE. This document is aimed at system administrators (responsible for jAPS 2.0 installations) and Java developers (with a basic comprehension of the jAPS 2.0 framework).
In order to take maximum advantage from the present document, it is necessary to have basic knowledge about: the Java platform, the Eclipse IDE, the Apache Tomcat servlet container, the PosgreSQL DBMS.
Additional informations may be obtained through the following mailing-lists:
<japs-devs@lists.sourceforge.net>
, focused on developers<japs-users@lists.sourceforge.net>
, focused on final usersIs it also possible to refer to the documentation found in the:
Table of Contents
This plugin allows to associate to the users a profile composed by a variety of informations, or Attributes, defined in the configuration of the plugin itself.
Jpuserprofile is designed with the goal of flexibility in mind: it can be installed in a jAPS installation
where all the users are local as well as remote, eg. coming from a Ldap directory (in this case the LDAP
plugin may be used).
Table 2.1. Riassunto delle caratteristiche
Code | Name | Type | Plugin version | Versione of jAPS 2.0 |
---|---|---|---|---|
jpuserprofile | User Profile | PurePlugin | 1.5 | 2.0.10 |
This module offers:
A management interface in the Back-End where the current user can edit his profile.
This interfcae strictly adheres to the existing graphic and layout and it is accessed from the
Plugin
menu.
Many logical showlets served by the so-called Internal servlet used by the users to modify their profile and passwords. These showlets present no decorative elements, they only expose the basic functionalities so that they can be later adjusted to fit the layout of the jAPS 2.0 installation where the plugin is to be installed.
This plugin is used to add to every user of the system a characterization given by the associated Profile, but it
can be also used to give support to other functionalities as well (eg. the Newsletter
plugin which
needs the approval of the signing user in order to work, is switched on through an attribute of the User Profile).
Table of Contents
The plugin is a Pure Plugin since its installation neither modifies nor alters any system functionality. Furthermore, this plugin takes advantage of two technologies, one belonging to jAPS 2.0 itself, the other requiring external libraries to be installed:
The ApsEntity
engine, invoked by the jACMS engine too, is used to freely define
the structure of the User Profile as a mix of simple and complex Attributes.
The @Aspect
of the Spring Framework. The Aspect Oriented Programming is used
to inject the Profile into the existing user object without the need to alter in any
manner the user manager. This happens to be completely transparent to the user engine also, which may use the standard
users database as well an external Directory to get the system users.
UserProfile is a pure plugin thanks to the AOP programming.
The jpuserprofile package is structured following the jAPSPlugin Pattern
specifications. So it contains the directories doc
, src
and the README file as expected.
Moreover, the src
is structured as follows:
java
directory. It contains the source files and the test suites of the plugin.
sql
directory. It contains the sql scripts to execute in the
port
and serv
database, for the production, development and
test environment.
The webapp
directory. This directory contains all the files needed by the web
application. More specifically we have the jsp
files of the user
interfaces and the related configuration files, the xml
declaring the beans of the various services (both belonging to the jAPS 2.0 business logic layer and
the Struts2 presentation layer), all the required jar
libraries (including the
plugin itself!) and, finally, the static resources (css
, images, js and so on).
From now on we refer to the application in the production environment where the plugin is going to be
deployed as myportal
.
We also refer to the compressed file containing the all the plugin elements as 'package' or 'plugin package',
and 'system' is always referred to the jAPS 2.0 framework installation and not to the
hosting operating system.
To perform the installation in a production environment based on the jAPS 2.0 compatible with this plugin, please follow this procedure carefully:
Copy the content of the directory src/webapp/WEB-INF/lib
of the plugin package into myportal/WEB-INF/lib/
within the server container.
Make sure that the directory myportal/webapp/WEB-INF/plugins
exists,
otherwise create it.
Copy the content of the src/webapp/WEB-INF/plugins
of the plugin package into myportal/WEB-INF/plugins/
Copy the content of the directory src/webapp/resources/plugins
of the package into myportal/resources/plugins/
within the servlet container.
Locate the SQL scripts in the src/sql
directory inside the plugin package.
Execute the script portScript.sql
(eg. using the free program PgAdmin) to
update the port
database in production.
The script has the parameter version
set to production
,
change it accordingly to your needs.
In the src/sql
directory, locate and execute the script servScript.sql
to update the serv
database in production.
The steps above must be executed after the server container has been stopped.
As a convention, we call the project where the plugin is about to be installed myproject
; all the directories
inside myproject are local to your Eclipse project.
To perform the installation of jpuserprofile in an Eclipse IDE, on a version of jAPS 2.0 compatible with the plugin, follow these steps:
Copy the content of the directory src/webapp/WEB-INF/lib
of the plugin package into myproject/WebContent/WEB-INF/lib/
,
with the exclusion of the jAPSPlugin-jpuserprofile-1.5.jar
.
Copy the content of then directory src/webapp/WEB-INF/plugins
of the plugin package into myproject/WebContent/WEB-INF/plugins/
.
Create the directory plugins
if needed.
Make sure that the directory myproject/webapp/WEB-INF/plugins
exists,
otherwise create it.
Copy the content of the src/webapp/WEB-INF/plugins
of the plugin package into myproject/WEB-INF/plugins/
Execute the script portScript.sql
(found in the src/sql
directory of the plugin package) to update the local port
database.
The script has the parameter version set to production
, modify it if needed.
In the same way you can change the structure of the model accordingly to your needs.
Excute the script servScript.sql
(found in the src/sql
directory of the plugin package) to update your local serv
database.
Excute the script portTestScript.sql
(found in the src/sql
directory of the plugin package) to update your local port
database used for tests.
Excute the script servTestScript.sql
(found in the src/sql
directory of the plugin package) to update your local serv
database used for tests.
Copy the content of the directory src/java/main/com
into
myproject/src/com
.
Copy the content of the directory src/java/test/test
into
myproject/src/test
Copy the file jpuserprofile_japs-struts-plugin.xml
in
myproject/src/
. Look for a file named
japs-struts-plugin.xml
under the src
directory of your Eclipse project: if it exists copy the content of the tag <struts>
of the file jpuserprofile_japs-struts-plugin.xml
inside the existing
japs-struts-plugin.xml
file, then delete
jpuserprofile_japs-struts-plugin.xml
. If the
japs-struts-plugin.xml
does not exist rename the file
jpuserprofile_japs-struts-plugin.xml
in
japs-struts-plugin.xml
.
Delete or comment out (using a java comment) the method getConfigUtils()
of the class
JpUserprofileBaseTestCase.java
belonging to the package
test.com.agiletec.plugins.jpuserprofile.aps
and the methods getConfigUtils()
and
setInitParameters(Properties params)
in the class JpUserprofileApsAdminBaseTestCase.java
belonging to the package test.com.agiletec.plugins.jpuserprofile.apsadmin
.
Once the following steps are performed, restart your project and verify the presence of the
appropriate menu item under the Plugin
menu in the back-end interface.
Table of Contents
The profile of the user is an aggregate of informations (Attributes) structured as specified in the
Profile Type. The profile structure is declared in a XML (located in the database Port
of jAPS 2.0)
where all the attributes composing the user profile are declared with their relative constraints.
Profile Type.
From jAPS 2.0 version 2.0.10, the configuration of the profile types can be set on the specific GUI on the Back Office.
An example of a possible configuration follows:
<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"/> <attribute name="language" attributetype="Monotext" searcheable="true" /> <attribute name="data" attributetype="Date" searcheable="true" /> <attribute name="newsletter" attributetype="Boolean" searcheable="true" /> </attributes> </profile> </profiles>
The Profile Type is a group of attributes which determine the number and the type of the basic informations.
The Attributes are the basic informations which constitute the profile in its entirety.
Each Attribute within a profile is identified by an unique name freely defined at configuration time.
The configuration of the Profile Type recalls in mant ways the Content Types are handled by the jACMS plugin.
The system offers all the Attributes Types (eg. Date
, Number
, etc...) which can
satisfy a variety of needs.
Actually the Attributes Types available are defined in some configuration files (defined like / as beans of Spring).
When a model of an User Profile is configured, the XML portion which specifies the single profile attribute must always contain the types name and attributetype;
<attribute|list|table name="ATTRIBUTE_CODE" attributetype="ATTRIBUTE_CODE_TYPE" />
Name and attributetype apart, a number of other attributes, related to the Attribute Type used, may be present as well (think of the "Monolist" attribute, for example)
To make an attribute mandatory just use the required="true|false"
constraint.
This will force the user to explicitly set the corresponding Attribute in the back-end interface.
Setting the required=true constraint has different consequences depending on the attribute chosen.
The default value is false.
If you want to make an attribute indexable so that it can be used to select, search or filter among the profiles
just use the searcheable="true|false"
constraint (this comes in hand when there is the need
to search for users by their profile attributes).
When this constraint is set to true the value of the attribute is copied in an appropriate table provided to
perform SQL queries.
The default value is false.
WARNING: this plugin is structured by design to handle a single User Profile (identified by the code PFL
)
and the interfaces provided support mono-language elements (though is possible to use multi-language attributes in the
definition of the User Type).
With that said, the plugin can be easily extended and improved by programmers with little experience of jASP 2.0
so to manage different kinds of User Profiles and support contemporaneously multiple localizations.
The next paragraph will focus on the various attributes; they are divided in two categories: simple (mono and multi-language) and composed. The following documentation, with minor modifications, corresponds to the description of the attributes used to build the Content Types managed by the jACMS plugin.
Simple attributes are the atomic elements which form a Content Type. Text, numbers, links are example of simple attributes. Simple attributes in turn are of two types: mono language and multi-language. The former is always presented ignoring the system language, the latter changes or, more precisely, may change for every language defined in the system.
This attribute represent a simple text, unique for all the system languages, present in the system. The text is inserted in a Text input box located in the proper content editing tab for the default language. If not otherwise specified, the text can be of any length; the typical usage of the mono-text attribute is for: Name, Surname, Address etc.
XML configuration:
<attribute name="ATTRIBUTE_CODE" attributetype="Monotext" />
The following additional constraints can be used with this attribute: required
, searcheable
, minlength
, maxlength
.
This attribute behaves like to mono-language counterpart, but its value is declined depending on the current language; A typical usage of this attribute is for: Title, Job etc.
XML configuration:
<attribute name="ATTRIBUTE_CODE" attributetype="Text" />
The following additional constraints can be used with this attribute: required
, searcheable
, minlength
, maxlength
.
This attribute works in the same manner of the multi-language text, but it's inserted in a textarea. This attribute can be used for: Note, Description etc.
XML configuration:
<attribute name="ATTRIBUTE_CODE" attributetype="Longtext" />
The following additional constraints can be used with this attribute: required
, searcheable
, minlength
, maxlength
.
This attributes shows a Hypertext for every language defined in jAPS. The text is inserted in a textarea, transformed in a hypertext editor, so that it can be formatted, underlined and so on. The text can be of any length; a typical usage of this attribute is for: Note, Description etc.
XML configuration:
<attribute name="ATTRIBUTE_CODE" attributetype="Hypertext" />
The following additional constraints can be used with this attribute: required
, searcheable
.
This attribute is a simple text (in the format dd/MM/yyyy eg. 25/12/2009) unique for all the languages. The date is directly typed in a text box or selected using a small calendar. Being a mono-language attribute the date input box is contained in the tab for the default language of the content editing interface. Note that the date is always checked by the system so that every error is caught and properly reported. This attribute can be used for: birth date and similar
XML configuration:
<attribute name="ATTRIBUTE_CODE" attributetype="Date" />
The following additional constraints can be used with this attribute: required
, searcheable
.
This attribute if formed by a unique text for all the languages. This text is picked among a list made previously available for the attribute; the choice of the text to associate to the attribute is done through a select located in the tab for the default language of the content editing interface. A typical usage is for: Country, City etc.
XML configuration:
<attribute name="ATTRIBUTE_CODE" attributetype="Enumerator"> <![CDATA[LISTA_ITEMS]]> </attribute>
The list of the available items for the Enumerator attribute is specified in the tag CDATA
with
a proper separator - the comma "," by default.
The separator itself may be changed with the explicit declaration of the element separator
.
The following additional constraints can be used with this attribute: required
, searcheable
,
separator
(the explicit declaration of the separator) and extractorBean
(name of the
Spring Bean used to extract the items to show in the select).
The attribute is a unique number inserted directly in a Text box in the tab for the default language of the content editing interface. The number is always checked so to catch and report any error. Typical usege is: Address number, Year of birth etc.
XML configuration:
<attribute name="ATTRIBUTE_CODE" attributetype="Number" />
The following constraints can be used: required
, searcheable
.
This attribute, typically rendered in the form of two radiobuttons, allows the user to choose between one option of the two available. A typical example is: gender: female/male" or similar.
XML configuration:
<attribute name="ATTRIBUTE_CODE" attributetype="Boolean" />
No addictional contraints are available for the boolean attribute.
As the name suggests, this attribute displays a single checkbox. Example: you can create fields like "Warn me when updates are available"
XML configuration:
<attribute name="ATTRIBUTE_CODE" attributetype="CheckBox" />
No addictional contraints are available for the checkbox attribute.
This attribute is very similar to Boolean - you can say that ThreeState includes Boolean -
but it behaves in a slightly different manner since the undefined
(or none
if you prefer)
status is contemplated. That is, while the Boolean attribute imposes a choice to the user (like 'Gender', male or female) the
ThreeState can be not specified.
XML configuration
<attribute name="ATTRIBUTE_CODE" attributetype="ThreeState" />
The ThreeState attribute has not addictional constraints.
Composed attributes are composed by the aggregation, in different forms, of several simple attributes.
This kind of attribute is a list, unique for all the system languages, of simple attributes which, in turn, may be mono or multi-language. The addition, removal or the shift-position operations of the listed elements are made available in the tab for the default language of the content editing interface. The management operations, when present, for each attribute of the list are positioned in the area where the attribute itself is rendered (eg. search for image, link selection etc.).
You can use one of the following combinations:
Monolist of mono-language simple text elements:
XML configuration required:
<list name="ATTRIBUTE_CODE" attributetype="Monolist" nestedtype="Monotext" />
Monolist of multi-language simple text elements
XML configuration required:
<list name="ATTRIBUTE_CODE" attributetype="Monolist" nestedtype="Text" />
Monolist of composed attributes
XML configuration required:
<list name="ATTRIBUTE_CODE" listtype="Monolist" attributetype="Composite" > <attribute name="ATTRIBUTE_CODE_1" attributetype="<ATTRIBUTE_TYPE_1>" /> <attribute name="ATTRIBUTE_CODE_2" attributetype="<ATTRIBUTE_TYPE_2>" /> . . . . <attribute name="ATTRIBUTE_CODE_N" attributetype="<ATTRIBUTE_TYPE_N>" /> </list>
For every attribute the constraint required="true"
can by applied. This means that the list
must contain at least one element.
The elements of this kind of attribute change depending on the current system language; the elements of this list are simple mono-language attributes. This list is independent from the others so the addition, removal, shift position operations are available for every language tab in the content editing interface.
The system allows lists of simple, mono-language, text elements.
<list name="ATTRIBUTE_CODE" attributetype="List" nestedtype="Monotext" />
The required=true
constraint can be used when declaring the attribute: this implies
that every list must contain at least one element.
This type of attributes are composed of several simple attributes; these can be a mixed variety of type and can be mono or multi-language. The single composed attribute can exist stand alone, but it is best used as an element of a monolist (since the attributes -and not the monolist itself can support multi-language). The management operations, if any, for each attribute of the list are positioned in the area where the attribute itself is rendered (eg. search for image, link selection etc.).
XML configuration of the basic attribute:
<composite name="ATTRIBUTE_CODE" attributetype="Composite" > <attribute name="ATTRIBUTE_CODE_1" attributetype="<ATTRIBUTE_TYPE_1>" /> <attribute name="ATTRIBUTE_CODE_2" attributetype="<ATTRIBUTE_TYPE_2>" /> . . . . <attribute name="ATTRIBUTE_CODE_N" attributetype="<ATTRIBUTE_TYPE_N>" /> </composite>
You can use all the constraints supported by each attribute, with the solely exclusion of the searcheable
one.
This plugin come with several showlets which allow the modification of both the User Profile and password.
The available showlets are:
Edit Current User - Interface used to update the profile and the password.
Edit Current User Password - Change password interface
Edit Current User Profile - Interface used to update the profile of the current user
Note that the interface above show only the basic functionalities with no presentation elements: that is because the presentation or decorative layout must be designed and developed by the front-end programmers of the local jAPS installation.
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.