Copyright © 2009 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".
2011-04-14
Revision History | ||
---|---|---|
Revision 0.6 | 2011-07-20 | DN |
Update due to the jAPS 2.0 entando version 2.2.2 release | ||
Revision 0.5 | 2011-04-14 | EM |
Revision for version 1.2 | ||
Revision 0.4 | 2011-02-14 | MEM |
Revision for jAPS 2.0 entando version 2.2.0 | ||
Revision 0.3 | 2010-03-10 | GC |
Revision for jAPS version 2.0.10 | ||
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.
Table of Contents
List of Tables
Table of Contents
The purpose of this document is to provide a complete description of the Plugin "jpuserreg" structure.
This document is intended for those who wish to know the capabilities of the jAPSPlugin "jpuserreg" and are considering the possible integration into a running production environment or in its Development Environment (IDE Eclipse Project).
The document is addressed to both System Administrators and java Developers.
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 engine, the PosgreSQL DBMS.
Additional informations may be obtained through the official mailing-lists:
<japs-platform@googlegroups.com>
, "japs-platform" Google Group, the jAPS 2.0 entando official Mailing ListIs it also possible to refer to the documentation found in the:
Table of Contents
The jAPS Plugin
User Registration
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 deactivation 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 entando Version |
---|---|---|---|---|
jpuserreg | User Registration | PurePlugin | 1.3 | 2.2.2 - |
jpuserreg | User Registration | PurePlugin | 1.2 | 2.2.0 - |
jpuserreg | User Registration | PurePlugin | 1.1 | 2.0.8 - 2.0.10 |
jpuserreg | User Registration | PurePlugin | 1.0 | 2.0.2 |
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 entando. 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 requires to configure the User Profile with fields containing name, surname, email and language. 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.
Table of Contents
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 entando.
The package contains the folders doc
, src
and the file README
as defined on jAPSPlugin Pattern documentation.
The src
folder is structured as follows:
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 entando 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).
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.
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 (for a standard configuration the database has name <WEB_APP_NAME>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 (for a standard configuration the database has name <WEB_APP_NAME>Serv
).
To install the plugin in an Eclipse project based on jAPS 2.0 entando 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 the jar of the plugin.
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 (for a standard configuration the database has name <PROJECT_NAME>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 (for a standard configuration the database has name <PROJECT_NAME>Serv
).
Perform tasks detailed in the file portTestScript.sql
(present in the folder src/sql
)
in the test db port (for a standard configuration the database has name <PROJECT_NAME>testPort
).
Perform tasks detailed in the file servTestScript.sql
(present in the folder src/sql
)
in the test db serv (for a standard configuration the database has name <PROJECT_NAME>testServ
).
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 does not contain 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.
Table of Contents
The system parameter applicationBaseURL
, contained in the context.xml
file,
must be configured with the full url of the application (ex: http://www.mywebsite.com/mywebapp/)
You must configure the Mail
service with a sender for the mail of registration and re-activation.
You must configure each type of User Profile
with the following type of fields:
Name
: a Monotext
, marked as required, configured with the jpuserprofile:firstname
role
Surname
: a Monotext
, marked as required, configured with the jpuserprofile:surname
role
email address
: a Monotext
, marked as required and searchable
, configured with the jpuserprofile:mail
role
Language
: an Enumerator
, optional, configured with the jpuserreg:language
role.
This field should be configure to take the values from the jpuserregLangItemsExtractor
bean.
If you configure the language field as described, the system will be able to send the email in the desired language.
If you want to set some fields as not configurable in the registration phase, you can assign the disable code jpuserreg:onEdit
.
An administrator can configure the service following the menù Components->Plugins->User Registration->Configure
This feature allows to configure:
Token Validity
: the validity, in days, of the links in the mail of registration and re-activation.
Sender
: the sender of the mails, as previously configured in the Mail
service.
Groups
: a list of groups assigned to each new user.
Roles
: a list of roles assigned to each new user.
Activation mail
: the configuration of the mail sent after the registration.
Confirm Page
: the page to conclude the registration procedure.
Must be configured to contains the User Activation
Showlet
(code jpuserreg_Activation
Email Subject:
: The subject for the activation email, configured in each system language
Email Body:
: The body for the activation email, configured in each system language.
The system provides to replace the special words {name}, {surname}, {userName} and {link} with the respective values.
The link will serve to complete the procedure.
Reactivation mail
: the configuration of the mail sent to complete the reactivation.
Confirm Page
: the page to conclude the reactivation procedure.
Must be configured to contains the User Reactivation
Showlet
(code jpuserreg_Reactivation
Email Subject:
: The subject for the reactivation email, configured in each system language
Email Body:
: The body for the reactivation email, configured in each system language.
The system provides to replace the special words {name}, {surname}, {userName} and {link} with the respective values.
The link will serve to complete the procedure.
The User Registration
plugin needs some pages to work correctly.
These pages need to be created.
Each created pages contains one of the showlets of the plugin.
The plugin provides a series of showlets. The main is jpuserreg_loginUserReg
,
providing a login form and links to the pages, for registration, user recover, deactivation, editing of the profile.
Later you need to change the name of the pages linked in the showlet.
You can find the showlet in the folder /WEB-INF/plugins/jpuserreg/aps/jsp/showlets/
A page containing the registration form. You can use, alternately, 2 different showlets.
jpuserreg_Registration
: User Registration, providing the form for a pre-defined User Profile
jpuserreg_profile_choice
: User Registration - with profile choice,
used if there are more than a Profile type, allows the user to select the profile type from a list.
You need to customize the following jsp[1]:
registration/profile-choose.jsp
:
allows an user to choose the profile from a given list.
registration/registerUser.jsp
:
the form new account registration.
registration/confirmedUserRegistration.jsp
:
shows a message to confirm the request for registration and the sending of an email to complete the procedure.
The page to complete the user registration. It isn't a visible page, but an user can access here with a link in the mail sent after the registration.
This page must be configured with the showlet User Activation
(code jpuserreg_Activation
).
You need to customize the following jsp[1]:
activation/activateUser.jsp
:
contains the form to complete an user activation.
activation/activateUserError.jsp
:
contains the error message for activation of account with invalid or expired ticket.
activation/confirmedUserActivation.jsp
:
shows a message to confirm the account activation.
The page with the form to recover credentials for an User from username or email address. This page allows also to re-activate a disabled user.
This page must be configured with the showlet User Recover
(code jpuserreg_Recover
).
You need to customize the following jsp[1]:
recover/recoverUser.jsp
:
this is the form for recovering the account from email or from username.
recover/confirmedRecoverRequest.jsp
:
shows a message to confirm the request for user recover and the sending of an email to complete the procedure.
The page to complete the user recover. Allows the user to set a new password. It isn't a visible page, but an user can access here with a link in the mail sent after the recover request.
This page must be configured with the showlet User Reactivation
(code jpuserreg_Reactivation
).
You need to customize the following jsp[1]:
activation/reactivateUser.jsp
:
contains form to complete an user reactivation with password definition.
activation/reactivateUserError.jsp
:
shows the error message for riactivation of an account with invalid or expired ticket.
activation/confirmedUserReactivation.jsp
:
shows the message for successfully happened reactivation of account
The page to disable an user.
This page must be configured with the showlet User Suspension
(code jpuserreg_Suspension
).
You need to customize the following jsp[1]:
suspension/confirmSuspend.jsp
:
form for account suspension request.
[1]
the files are all under the folder /WEB-INF/plugins/jpuserreg/aps/jsp/externalFramework/userreg/
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.