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".
2011-02-14
Revision History | ||
---|---|---|
Revision 1.7 | 2011-07-20 | DN |
Aggiornamento per rilascio jAPS 2.0 entando versione 2.2.2 | ||
Revision 1.6 | 2011-02-14 | MEM |
Aggiornamento per rilascio jAPS 2.0 entando versione 2.2.0 | ||
Revision 1.5 | 2010-02-17 | ES |
Aggiornamento per rilascio jAPS 2.0 versione 2.0.10 | ||
Revision 1.4 | 2009-10-15 | ES |
Aggiornamento per rilascio jAPS 2.0 versione 2.0.8 | ||
Revision 1.3 | 2009-07-29 | ES |
Aggiornamento per rilascio jAPS 2.0 versione 2.0.6 | ||
Revision 1.2 | 2009-06-16 | ES |
Piccole modifiche al testo | ||
Revision 1.1 | 2009-05-02 | ES |
Modifica | ||
Revision 1.0 | 2009-04-21 | ES |
Prima versione pubblica |
Abstract
Lo scopo di questo documento è quello di fornire una descrizione completa della struttura del Plugin User Profile
.
Table of Contents
List of Tables
Table of Contents
Lo scopo di questo documento è quello di fornire una descrizione completa della struttura del Plugin User Profile
.
Questo documento è destinato a chi intende conoscere le funzionalità del jAPS Plugin User Profile
,
e sta prendendo in considerazione la eventuale integrazione in un Ambiente di Produzione già funzionante
o nel proprio Ambiente di Sviluppo (Progetto in IDE Eclipse).
Il documento è indirizzato sia a Sistemisti (responsabili di installazioni di Applicazioni su base jAPS 2.0 entando) che a Java Developers (con una conoscenza base del Framework jAPS 2.0 entando).
Per poter utilizzare efficacemente le informazioni contenute in questo documento, occorre un po' di esperienza su alcune tecnologie del web base: la piattaforma Java, gli strumenti di sviluppo Eclipse, il servlet container Apache Tomcat, il database PostgreSQL, e del Framework jAPS 2.0 entando. E' inoltre necessario aver letto il documento jAPS 2.0 - Plugin Pattern.
Ulteriori informazioni possono essere richieste attraverso la mailing list ufficiale Google Group "japs-platform".
Per mandare un messaggio ai membri della lista, invia una mail a <japs-platform@googlegroups.com>
.
È inoltre possibile consultare la documentazione presente in:
Table of Contents
Il Plugin User Profile
consente di associare agli utenti definiti nel sistema, un profilo composto da un insieme di informazioni/attributi definiti nella configurazione del Plugin.
Il plugin è strutturato in maniera da essere inserito sia in una istanza di jAPS che usa esclusivamente le utenze locali,
che in una istanza che fa uso anche di utenze remote provenienti da una Directory Ldap (e gestite attraverso il jAPS Plugin LDAP
).
Table 2.1. Riassunto delle caratteristiche
Codice | Nome | Tipo | Versione del Plugin | Versione di jAPS 2.0 entando |
---|---|---|---|---|
jpuserprofile | User Profile | PurePlugin | 1.7 | 2.2.2 - |
jpuserprofile | User Profile | PurePlugin | 1.6 | 2.2.0 - |
jpuserprofile | User Profile | PurePlugin | 1.5 | 2.0.10 |
jpuserprofile | User Profile | PurePlugin | 1.4 | 2.0.8 |
jpuserprofile | User Profile | PurePlugin | 1.3 | 2.0.6 |
jpuserprofile | User Profile | PurePlugin | 1.2 | 2.0.4 |
jpuserprofile | User Profile | PurePlugin | 1.0 | 2.0.2 |
Il modulo presenta:
Interfacce del Back-End per Profilo dell'Utente corrente, profili degli Utenti del Portale, Tipi di profilo definiti. Tali interfacce aderiscono perfettamente alla grafica ed impostazione del Back-End e sono accessibili attraverso le voci del menù Plugin.
Nell'interfaccia Il tuo profilo
è possibile editare il profilo dell'utente corrente. Nell'interfaccia Profili
si ha la lista degli utenti
che hanno configurato il proprio profilo, vi è la possibilità di modificare tale profilo, con gli opportuni permessi, e
anche la lista degli utenti iscritti al portale ma che non hanno ancora un profilo associato. Nell'interfaccia Tipi di Profilo
si possono
gestire gli Attributi che compongono ogni profilo.
Una serie di Showlet Logiche (preconfigurate su base showlet Invocazione Servlet Interna), tramite cui l'utente corrente può valorizzare e modificare il proprio Profilo e modificare la propria password. Le interfacce utente di queste Showlet non presentano nessun elemento di presentazione per consentirne la vestizione in una qualunque istanza specifica di jAPS 2.0 entando.
Il Plugin ha la funzione principale di fornire la possibilità di allegare ad ogni utente definito nel sistema una caratterizzazione attraverso il Profilo associato, ma può essere utilizzato anche a supporto di terze funzionalità (come ad esempio un modulo di Newsletter, che necessita da parte dell'utente una richiesta esplicita attraverso la valorizzazione di un elemento di profilo utente).
Table of Contents
Il plugin ha la caratteristica di Pure-Plugin, la sua installazione non modifica nessuna funzionalità presente nel sistema. Il plugin inoltre fa uso di due tecnologie, una interna alla piattaforma jAPS 2.0 entando, ed una esterna:
Il motore delle ApsEntity
(a cui fa riferimento anche il motore di Gestione Contenuti del CMS).
Il motore viene utilizzato per definire in maniera libera la struttura del Tipo di Profilo, come composizione di Attributi (sia semplici che complessi).
Le @Aspect
di Spring Framework. La Programmazione per Aspetti viene utilizzata per poter inserire il Profilo all'interno dell'oggetto Utente senza dover modificare il gestore degli utenti, e senza neanche prendersi carico del tipo di gestore utenti correntemente utilizzato (se fa riferimento all'archivio locale di Utenti, o se le utenze vengono estratte da una Directory esterna).
In particolare, l'AOP consente di far si che il Plugin sia un Pure-Plugin.
Il pacchetto del Plugin contiene l'insieme delle cartelle (cartelle doc
ed src
più il file README
)
definite nel documento di descrizione generale del jAPSPlugin Pattern.
In particolare, la directory src
è strutturata come di seguito descritto:
Directory java
. Contiene le sorgenti java complete e i test jUnit del Plugin.
Directory sql
. Contiene gli script da eseguire nei db Port
e Serv
principali e di test.
Directory webapp
. La directory contiene tutti i file necessari alla webapp. In particolare, la directory contiene i file (jsp)
relativi alla interfacce utente ed i file di configurazione delle stesse, i file di definizione dei bean a servizio
(sia del layer di Business del Modello di jAPS 2.0 entando, che nelle action di Struts 2 relative al Layer di Presentation),
le librerie (compresa la libreria ricavata dalle sorgenti java date in dotazione), le risorse statiche necessarie (css, immagini, e js).
Per eseguire l'installazione in una applicazione Web in produzione basata sulla versione di jAPS 2.0 entando dichiarata compatibile con il plugin, i passi da eseguire sono i seguenti:
Copiare il contenuto della directory src/webapp/WEB-INF/lib
del pacchetto dato in dotazione, all'interno
della directory mioportale/WEB-INF/lib/
in produzione.
Copiare il contenuto della directory src/webapp/WEB-INF/plugins
del pacchetto dato in dotazione, all'interno
della directory mioportale/WEB-INF/plugins/
in produzione. Creare la directory plugins
se non è presente.
Copiare il contenuto della directory src/webapp/resources/plugins
del pacchetto dato in dotazione,
all'interno della directory mioportale/resources/plugins/
in produzione.
Eseguire i task contenuti nel file portScript.sql
(contenuto nella directory src/sql
del pacchetto dato in dotazione) nel db port
in produzione.
Lo script è strutturato ipotizzando il version production
(variare se il version dell'ambiente di produzione è diverso).
Eseguire i task contenuti nel file servScript.sql
(contenuto nella directory src/sql
del pacchetto dato in dotazione)
nel db serv
in produzione.
Le precedenti attività sono da eseguire nell'applicazione a freddo, successivamente all'arresto del container.
Per eseguire l'installazione in un progetto Eclipse basato sulla versione di jAPS 2.0 entando dichiarata compatibile con il plugin, i passi da eseguire sono i seguenti:
Copiare il contenuto della directory src/webapp/WEB-INF/lib
del pacchetto dato in dotazione, all'interno
della directory mioprogetto/WebContent/WEB-INF/lib/
, con l'esclusione del file jar del plugin.
Copiare il contenuto della directory src/webapp/WEB-INF/plugins
del pacchetto dato in dotazione, all'interno
della directory mioprogetto/WebContent/WEB-INF/plugins/
. Creare la directory plugins
se non è presente.
Copiare il contenuto della directory src/webapp/resources/plugins
del pacchetto dato in dotazione,
all'interno della directory mioprogetto/WebContent/resources/plugins/
. Creare la directory plugins
se non è presente.
Eseguire i task contenuti nel file portScript.sql
(contenuto nella directory src/sql
del pacchetto dato in dotazione) nel proprio db port
.
Lo script è strutturato ipotizzando il version production
(variare se il version dell'ambiente di produzione è diverso).
Modificare la struttura del modello del profilo secondo le necessità.
Eseguire i task contenuti nel file servScript.sql
(contenuto nella directory src/sql
del pacchetto dato in dotazione) nel proprio db serv
.
Eseguire i task contenuti nel file portTestScript.sql
(contenuto nella directory src/sql
del pacchetto dato in dotazione) nel proprio db port
di test.
Eseguire i task contenuti nel file servTestScript.sql
(contenuto nella directory src/sql
del pacchetto dato in dotazione) nel proprio db serv
di test.
Copiare il contenuto della directory src/java/main/com
nella directory mioprogetto/src/com
del proprio progetto.
Copiare il contenuto della directory src/java/test/test
nella directory mioprogetto/src/test
del proprio progetto.
Copiare nella directory mioprogetto/src/
del proprio progetto il file contenuto della directory src/java/main
di nome jpuserprofile_japs-struts-plugin.xml
.
Nel caso che nella directory src
del progetto Eclipse sia già presente un file di nome japs-struts-plugin.xml
, copiare il contenuto del tag <struts> del file jpuserprofile_japs-struts-plugin.xml
all'interno del file japs-struts-plugin.xml
esistente e cancellare il file jpuserprofile_japs-struts-plugin.xml
.
Nel caso che nella directory src
del progetto Eclipse non sia presente un file di nome japs-struts-plugin.xml
, rinominare il file jpuserprofile_japs-struts-plugin.xml
in japs-struts-plugin.xml
.
Eliminare o commentare (attraverso un commento java) il metodo getConfigUtils()
della
classe JpUserprofileBaseTestCase.java
nel package test.com.agiletec.plugins.jpuserprofile.aps
ed i metodi getConfigUtils()
e setInitParameters(Properties params)
della
classe JpUserprofileApsAdminBaseTestCase.java
nel package test.com.agiletec.plugins.jpuserprofile.apsadmin
.
Una volta eseguiti i passi sopra descritti, far partire il progetto da Eclipse e verificare la presenza della voce specifica voce di menù nell'area di amministrazione del progetto.
Table of Contents
Il Profilo Utente rappresenta un insieme di informazioni (Attributi) organizzate secondo una struttura definita dal Tipo di Profilo.
La struttura del Profilo Utente viene definito attraverso la configurazione di un xml
(inserito nel db Port
dell'istanza di jAPS 2.0 entando) nel quale sono definiti gli Attributi componenti il Tipo del Profilo dell'utente.
A partire da jAPS 2.0 versione 2.0.10, la configurazione dei Tipi profili può essere effettuata direttamente attraverso una apposita interfaccia utente resa a disposizione nel Back End.
Si possono definire diversi tipi di profilo a seconda delle tipologie di utenze del portale, ad esempio si potrebbe voler distinguere
utenti privati da aziende, inserendo attributi differenti come ad esempio la partita iva che ha senso per un azienda ma non per un privato.
Gli Utenti potranno scegliere all'atto dell'iscrizione al Portale quale tipo di profilo li caratterizza, grazie alla select con la lista dei profili disponibili,
erogata tramite la showlet del plugin jpuserreg User Registration - with profile choice
Di seguito un esempio della configurazione necessaria:
<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>
Il Tipo di Profilo è dato da un'insieme di Attributi che ne determinano numero e tipo di informazioni elementari.
Gli Attributi sono considerati come una informazione minima, un mattone elementare costituente il profilo.
Ogni Attributo è identificato, all'interno del profilo, da un nome univoco definito a piacere in configurazione.
La configurazione del Tipo di Profilo viene configurata nella stessa maniera con la quale vengono configurati i Tipi di Contenuto gestiti dal jACMS.
Nel sistema sono disponibili tutti i Tipi di Attributo (per esempio attributi di tipo Date
, Number
, etc...) utili per soddisfare
le diverse necessità. Attualmente i Tipi di Attributo disponibili nel sistema sono definiti in particolari file di configurazione del sistema (definiti come Beans di Spring).
Quando si configura il modello del Profilo Utente, la porzione di XML che specifica il singolo Attributo del Profilo deve obbligatoriamente contenere gli attributi XML name e attributetype;
<attribute|list|table name="CODICEATTRIBUTO" attributetype="CODICETIPOATTRIBUTO" />
Oltre a questi due attributi XML possono esserne presenti altri, caratteristici del particolare Tipo di Attributo (vedasi per esempio l'Attributo di tipo “Monolista”):
Configurazione aggiuntiva per l'obbligatorietà: required="true|false"
(valore di default: false) utilizzabile quando si vuole rendere obbligatoria la valorizzazione dell'Attributo in occasione della redazione da interfaccia di amministrazione.
Durante la redazione, l'imposizione dell'obbligatorietà comporta diversi effetti a seconda del Tipo di Attributo considerato.
Configurazione aggiuntiva per la ricercabilità: searcheable="true|false"
(valore di default false) utilizzabile quando si vuole utilizzare l'attributo per selezionare, ricercare, filtrare ed ordinare i profili (operazioni necessarie quando si intende ricercare Utenti in base ad elementi del Profilo Utente).
Indicando true
il valore dell'attributo è replicato in una apposita tabella su cui è possibile eseguire ricerche SQL.
Di seguito viene descritta la configurazione di ogni tipologia di attributo di contenuto. Gli attributi vengono suddivisi in due tipologie: gli attributi semplici (monolingua e multilingua) e gli attributi composti. La documentazione seguente è corrispondente alla descrizione degli Attributi utilizzabili per strutturare i Tipi di Contenuto gestiti dal jACMS.
Gli Attributi Semplici sono i tipi di mattoni atomici componenti i Tipi di Contenuto. Essi sono quei tipi caratterizzanti da una specifica caratteristica ben definita; esempio il testo, il numero, il Link, e così via. Gli Attributi Semplici si possono dividere in attributi Monolingua e Multilingua: il primo presenta il proprio valore caratterizzante unico per tutte le lingue, il secondo presenta (o può presentare) un valore diverso per ciascuna delle lingue di sistema.
L'attributo consta di un testo semplice unico per tutte le lingue inserite nel sistema. Il testo viene inserito in una casella di input Testo posizionata all'interno del tab relativo alla redazione del contenuto nella lingua di default. Non vi sono limiti nella lunghezza del testo immeso. Esempio di utilizzo: Nome, Cognome, Indirizzo, etc...
Configurazione base su xml:
<attribute name="CODICEATTRIBUTO" attributetype="Monotext" />
Possibili configurazioni aggiuntive: required
, searcheable
, minlength
, maxlength
.
L'attributo consta di un testo semplice per ogni lingua inserita nel sistema. Il testo viene inserito in una casella di input Testo. Non vi sono limiti nella lunghezza del testo immeso. Esempio di utilizzo: Titolo di studio, Professione, etc..
Configurazione base su xml:
<attribute name="CODICEATTRIBUTO" attributetype="Text" />
Possibili configurazioni aggiuntive: required
, searcheable
, minlength
, maxlength
.
L'attributo consta di un testo semplice per ogni lingua inserita nel sistema. Il testo viene inserito in una textarea di input Testo. Non vi sono limiti nella lunghezza del testo immesso. Esempio di utilizzo: Note, Descrizione, etc..
Configurazione base su xml:
<attribute name="CODICEATTRIBUTO" attributetype="Longtext" />
Possibili configurazioni aggiuntive: required
, searcheable
, minlength
, maxlength
.
L'attributo consta di un Ipertesto per ogni lingua inserita nel sistema. Il testo viene inserito (ed eventualmente editato con grassetto, sottolineature, carattere corsivo, link interni) in una textarea trasformata in editor di ipertesti. Non vi sono limiti nella lunghezza del testo immeso. Esempio di utilizzo: Note, Descrizione, etc..
Configurazione base su xml:
<attribute name="CODICEATTRIBUTO" attributetype="Hypertext" />
Possibili configurazioni aggiuntive: required
, searcheable
.
L'attributo consta di un testo semplice (nel formato gg/MM/aaaa - esempio 23/06/1993) unico per tutte le lingue inserite nel sistema. Il testo viene inserito direttamente in una casella di input di Testo oppure con l'ausilio di un calendarietto. La casella è posizionata all'interno del tab relativo alla redazione del contenuto nella lingua di default. Il testo immesso è soggetto a controllo di validazione del sistema, qualunque immissione di data scorretta viene individuata dal sistema. Esempio di utilizzo: data di nascita, data Matrimonio, etc etc.
Configurazione base su xml:
<attribute name="CODICEATTRIBUTO" attributetype="Date" />
Possibili configurazioni aggiuntive: required
, searcheable
.
L'attributo consta di un testo semplice unico per tutte le lingue inserite nel sistema. Il testo viene scelto tra una lista di testi resi a disposizione dall'attributo stesso; la scelta del testo da associare all'attributo viene fatta attraverso una select posizionata all'interno del tab relativo alla redazione del contenuto nella lingua di default. Esempio di utilizzo: Nazione, Città, etc...
Configurazione base su xml:
<attribute name="CODICEATTRIBUTO" attributetype="Enumerator"> <![CDATA[LISTA_ITEMS]]> </attribute>
La lista di items viene inserita all'interno del tag CDATA
con un adeguato separatore; il separatore di default è il carattere virgola ”,”.
Un eventuale separatore diverso può essere specificato attraverso la configurazione aggiuntiva separator
.
Possibili configurazioni aggiuntive: required
, searcheable
, separator
(carattere/stringa separatore negli item inseriti all'interno del corpo CDATA, di default è “,”) extractorBean (nome del bean definito in Spring Framework estrattore degli items da rendere disponibili nella select).
L'attributo consta di un numero unico per tutte le lingue inserite nel sistema. Il numero viene inserito direttamente in una casella di input di Testo posizionata all'interno del tab relativo alla redazione del contenuto nella lingua di default. Il numero immesso è soggetto a controllo di validazione del sistema, qualunque immissione scorretta viene individuata dal sistema. Esempio di utilizzo: Numero Civico Indirizzo, Anno di nascita, etc...
Configurazione base su xml:
<attribute name="CODICEATTRIBUTO" attributetype="Number" />
Possibili configurazioni aggiuntive: required
, searcheable
.
L'attributo permette la scelta tra le opzioni si e no rese disponibili attraverso due radiobutton
.
Esempio di utilizzo: Date provvisorie, bagno in camera in contenuto Scheda Camera Albergo, etc...
Configurazione base su xml:
<attribute name="CODICEATTRIBUTO" attributetype="Boolean" />
Possibili configurazioni aggiuntive: nessuna.
L'attributo consta di un semplice checkbox. Esempio di utilizzo: Date provvisorie, bagno in camera in contenuto Scheda Camera Albergo, etc...
Configurazione base su xml:
<attribute name="CODICEATTRIBUTO" attributetype="CheckBox" />
Possibili configurazioni aggiuntive: nessuna.
Gli attributi composti sono gli attributi caratterizzati dalla aggregazione (sotto diverse forme) di attributi semplici.
Gli attributi di questi tipo sono composti da una lista unica (comune a tutte le lingue del sistema) composta da attributi semplici i quali possono essere sia monolingua o multilingua. Le operazioni di aggiunta di un attributo alla lista, la rimozione di un'attributo e lo spostamento di un'attributo nella lista sono operazioni disponibili nel tab relativo all redazione del contenuto nella lingua di default. All'interno dell'area relativa ad ogni attributo elemento della lista semplici, sono presenti le eventuali operazioni proprie della tipologia dell'attributo semplice (ricerca immagine, selezione link, ecc..).
Il sistema prevede le seguenti combinazioni:
Monolista di testi semplici monolingua
Configurazione base su xml:
<list name="CODICEATTRIBUTO" attributetype="Monolist" nestedtype="Monotext" />
Monolista di testi semplici multilingua
Configurazione base su xml:
<list name="CODICEATTRIBUTO" attributetype="Monolist" nestedtype="Text" />
Monolista di attributo composito
Configurazione base su xml:
<list name="CODICEATTRIBUTO" listtype="Monolist" attributetype="Composite" > <attribute name="CODICEATTRIBUTO1" attributetype="<TIPO_ATTRIBUTO_1>" /> <attribute name="CODICEATTRIBUTO2" attributetype="<TIPO_ATTRIBUTO_2>" /> . . . . <attribute name="CODICEATTRIBUTON" attributetype="<TIPO_ATTRIBUTO_N>" /> </list>
In ogni attributo è possibile la configurazione aggiuntiva l'obbligatorietà: required="true"
.
Essa implica che deve essere presente almeno un elemento della lista.
Gli attributi di questi tipo sono composti da una lista per ogni lingua inserita nel sistema, composta da attributi semplici i quali possono essere solo monolingua. Ogni lista di ogni lingua è indipendente dalle altre per cui ogni operazione su di essa per cui le operazioni su di essa (aggiunta di un attributo alla lista, la rimozione di un attributo e lo spostamento di un attributo nella lista) sono operazioni disponibili nel tab relativo ad ogni lingua.
Il sistema prevede l'attributo Lista di testi semplici monolingua.
<list name="CODICEATTRIBUTO" attributetype="List" nestedtype="Monotext" />
Nell'attributo è possibile la configurazione aggiuntiva per l'obbligatorietà: required="true". Essa implica che deve essere presente almeno un elemento per ciascuna delle liste di lingua.
Gli attributi di questi tipo sono composti da un’insieme di attributi elementari tra di loro disomogenei i quali possono essere sia monolingua o multilingua. L’attributo singolo composito è possibile ma la sua più utile collocazione la trova come elemento di una monolista (in quanto gli attributi elementari componenti possono essere multilingua). All'interno dell'area relativa ad ogni attributo elemento della lista semplici, sono presenti le eventuali operazioni proprie della tipologia dell'attributo semplice (ricerca immagine, selezione link, ecc..).
Configurazione base su xml (dell’attributo elementare):
<composite name="CODICEATTRIBUTO" attributetype="Composite" > <attribute name="CODICEATTRIBUTO1" attributetype="<TIPO_ATTRIBUTO_1>" /> <attribute name="CODICEATTRIBUTO2" attributetype="<TIPO_ATTRIBUTO_2>" /> . . . . <attribute name="CODICEATTRIBUTON" attributetype="<TIPO_ATTRIBUTO_N>" /> </composite>
Sono possibili le configurazioni aggiuntive proprie di ogni attributo elementare incluso con l’eccezione della configurazione aggiuntiva per la ricercabilità.
Il plugin fornisce una serie di Showlet che consente la modifica sia del proprio Profilo Utente che della propria Password.
Le showlet disponibili sono:
Edita Utente Corrente - Interfaccia di aggiornamento profilo e cambio password
Edita Password Utente Corrente - Interfaccia di cambio password
Edita Profilo Utente Corrente - Interfaccia di aggiornamento profilo
Le interfacce presentano la funzionalità pura, senza nessun elemento di Presentation, la cui gestione è in carico agli sviluppatori di Front-End responsabili del portale dove il Plugin viene inserito.
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.