Content Models in jAPS2.0 mini-HOWTO

Do It The jAPS Way

Andrea Dessì

First draft 
AgileTec S.r.l.

Copyright © 2010 Tzente s.r.l.

Legal Notice

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the Appendix entitled "GNU Free Documentation License".

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

2010-03-15

Revision History
Revision 0.32010-03-15MEM

Revision for the jAPS 2.0.10 release

Revision 0.22009-05-19AD

English translation

Revision 0.12009-05-05AD

First public version

Abstract

This document will quickly illustrate Content Models concept.

Table of Contents

1. Scope of the document
Introduction
Target audience
Prerequisites
Resources
2. Content Model Theory
Content Model Theory
The Model
Conventions: Naming and Numbering
3. Examples
Examples
Generic Content
News
A. GNU Free Documentation License

List of Examples

2.1. Assign Id to Generic Default and News Default models
2.2. Assign Ids to List of Generic Content, List of News
2.3. Assign Ids to Generic Content and News Content Types
2.4. Descriptions Example
2.5. Description of a Red List Model

Chapter 1. Scope of the document

Table of Contents

Introduction
Target audience
Prerequisites
Resources

This document will explain what are Content Models in jAPS 2.0 and how to use them.

This document is intended for those willing to create or extend a web portal with jAPS 2.0

Examples and concepts reported in this guide will be useful to developers as a reference for the creation simple Content Models

In order to take the maximum advantage of the present document, it is necessary to have basic knowledge about:

Additional informations may be obtained through:

Is it also possible to refer to the documentation found in the:

jAPS 2.0 Project - Developer Website

Chapter 2. Content Model Theory

Table of Contents

Content Model Theory
The Model
Conventions: Naming and Numbering

The purpose of Content Models is to represent in the proper manner information, which are enclosed in Contents, inside jAPS pages.

For each Content Type there are at least one model for list and one default model, they will be used as reference by jAPS (these models are specified in the Content Types xml configuration)

Content Models can be created from CMS interface, in the left menu click on Misc, then in Customize and after in Content Models.

Here you will access to the models list where you can edit existing models or create new.

For each Content Model you have to specify:

[Note]Database

Content Models will be stored in the contentmodels table in the database Port.

The model will be interpreted by Velocity then you have the functionalities of the template engine such as variables, expressions and instructions.

The resulting model and the portal pages is to be a homogeneous structure, so if the page models are coded in xhtml also the il result of the rendered model should be xhtml.

You are going to write a mix of two different languages in Content Models: same markup language used in Pages and the Velocity language.

jAPS provides the following items in the Velocity Context:

$content, it's the object Content, you can read properties from the object using the standard notation: 

$content.NAMEOFTHEATTRIBUTE

Please refer to the JavaDoc documentation about Content Types if you want to know more about the Content object and its properties.

jAPS also provides the following Content properties:

$content.categories is a map (Map) containing the list of categories contenente the list of categories associated with the content.

$content.contentLink returns a string with the full link of the page where the content is published

$content.contentOnPageLink is a method accepting a page code as parameter and returns a the URL of a page with the current Content published inside.

[Note]Examples

See next chapters

There is a criterion for the assignment of Id, Description and Style Sheet when creating Content Models

Id values start from 1.

Every Content Type must have at least two models: default model and list model (defaultmodel and listmodel).

Proceed assigning Ids first to the default models, then to list models and after to others models.

Concerning default models proceed assigning incremental Ids starting from 1.

Then, assign Ids to list modelsusing the Id of the corresponding default model as a prefix

Example 2.1. Assign Id to Generic Default and News Default models

We will assign:

  • Id for Generic Default: 1
  • Id for Generic Default: 2

If there are also other Content Types proceed incrementing of 1 the value of the Id for each Default Model.


Example 2.2.  Assign Ids to List of Generic Content, List of News

We'll assign:

  • Id of List of Generic Content : 11
  • Id for List of News : 21

If there are also other Content Types proceed incrementing of 1 the value of the Id for each List Model

[Tip]More than ten Default Model

If you have ten Default Models, assign to tenth list model Id 101

  • Id for ninth List Model: 91
  • Id for tenth List Model: 101

Also for other models of same Content Type, assign Id using the Id of the corresponding Default Model as prefix and starting from 1 increment the value for each value.

Example 2.3. Assign Ids to Generic Content and News Content Types

  • Id of the Default Model for Generic Content: 1

  • Id of the List Model for Generic Content: 11

  • Id of the Alternative Model for Generic Content: 12

  • Id of the Default Model for News: 2

  • Id of the List Model for News: 21

  • Id of the Alternative Model for News: 22

and for the tenth Default Model...

  • Id of Default Model for the tenth Content Type: 10

  • Id of List Model for the tenth Content Type: 101

  • Id of Alternative Model for the tenth Content Type: 102


There aren't specific conventional Descriptions for Content Models

We suggest, as best practice, to write which information will appear.

Please read next example.

Example 2.4.  Descriptions Example

Refer to a content type called Generic Content with these Attributes:

  • Title
  • Abstract
  • Body
  • Links
  • Attachments
  • Image1
  • Image2
  • Image3

Description of a model that shows title, body, the links, the attachments and the picture 1 will be: 

Full (Title, Body, Links, Attach ,Pic1)

Description of a model that shows just the title and the picure 1 will be: 

Model for List (Title and Image1)

Also a good thing is to specify peculiarities the model has:

Example 2.5. Description of a Red List Model

List Model - Red (Title, Image1)

Another good thing is to keep in different files CSS with different scope. Place Content Models CSS in contentmodels directory under resources/static/css

The name of the CSS file consist of the Content Type code and a brief description without spaces: CODE_description_with_no_spaces.css

Examples of Style Sheet names:

contentmodels/CNG_complete.css
contentmodels/CNG_green_box.css
contentmodels/NEW_red_list.css

Chapter 3. Examples

Table of Contents

Examples
Generic Content
News

In this chapter will be shown few examples of how create and use Content Models

Please refer to the following Content Type as Generic Content

<contenttype 
    typecode="CNG" 
    typedescr="Generic Content" 
    viewpage="contentview" 
    listmodel="11" 
    defaultmodel="1">
        <attributes>
            <attribute name="Title" attributetype="Text" required="true" />
            <attribute name="Abstract" attributetype="Longtext" />
            <attribute name="Body" attributetype="Hypertext" />
            <attribute name="Image_1" attributetype="Image" />
            <attribute name="Image_2" attributetype="Image" />
            <list name="Links" attributetype="Monolist" nestedtype="Link" />
            <list name="Attachments" attributetype="Monolist" nestedtype="Attach" />
        </attributes>
    </contenttype>

If we want show all the Attributes (except for the Abstract, it will be used only in lists), the model could be:

jAPS will output something like: 

Test Content

<p>This is a test with images, links and attachments.</p>

My Logo: /myPortal/resources/cms/images/myImage_d1.jpg

Company Logo: /myPortal/resources/cms/images/anotherImage_d1.png

	jAPS Homepage - http://www.japsportal.org
	jAPS Developers Site - http://dev.japsportal.org

	Architecture - /myPortal/resources/cms/documents/articolo1.pdf
	Advantages - /myPortal/resources/cms/documents/vantaggi.pdf

Next step is trasform the model in html 

<div class="generic">
	<h3>$content.Title.text</h3>
	
	$content.Body.text
	
	<img src="$content.Image_1.imagePath("1") alt="$content.Image_1.text" /><br /> 
	<img src="$content.Image_2.imagePath("1")" alt="$content.Image_2.text" />
	
	<h4>Link</h4>
	<ul>
	#foreach ($link in $content.Links)
		<li>
			<a href="$link.destination">$link.text</a>
		</li> 
	#end	
	</ul>
	
	<h4>Attachments</h4>
	<ul>
	#foreach ($attach in $content.Attachments)
		<li>
			<a href="$attach.attachPath">$attach.text</a>
		</li> 
	#end
	</ul>
</div>

In the Generic Content configuration we described above there are few Attributes that are not required field

Control the rendering of not required Attributes using Velocity language:

<div class="generic">
	<h3>$content.Title.text</h3>
	
	#if ($content.Body.text != "")
		$content.Body.text
	#end
	
	#if ($content.Image_1.imagePath("1") != "") 
		<img src="$content.Image_1.imagePath("1") alt="$content.Image_1.text" /><br /> 
	#end
	
	#if ($content.Image_1.imagePath("2") != "")
		<img src="$content.Image_2.imagePath("1")" alt="$content.Image_2.text" />
	#end 
	
	#if ($content.Links && $content.Links.size() > 0)
		<h4>Links</h4>
		<ul>
		#foreach ($link in $content.Links)
			<li>
				<a href="$link.destination">$link.text</a>
			</li> 
		#end	
		</ul>
	#end
	
	#if ($content.Attachments && $content.Attachments.size() > 0)
		<h4>Attachments</h4>
		<ul>
		#foreach ($attach in $content.Attachments)
			<li>
				<a href="$attach.attachPath">$attach.text</a>
			</li> 
		#end
		</ul>
	#end
	
</div>

Example for rendering a list of Generic Content

<p>
	<a href="$content.contentLink">$content.Title.text</a>
	#if ($content.Abstract.text != "")
		<br />$content.Abstract.text
	#end
</p>

Please refer to the following Content Type as New

<contenttype 
	typecode="NEW" 
	typedescr="New" 
	viewpage="newsview" 
	listmodel="21" 
	defaultmodel="2">
        <attributes>
            <attribute name="Title" attributetype="Text" required="true" />
            <attribute name="Date" attributetype="Date" required="true"/>
            <attribute name="Abstract" attributetype="Longtext" />
            <attribute name="Body" attributetype="Hypertext" required="true" />
        </attributes>
    </contenttype>

Define the complete model with:

and its model

<div class="complete">
	
	<h3>$content.Title.text</h3>
	<p class="data">$content.Date.longDate</p>
	
	$content.Body.text  

</div>
<p>
	<a href="$content.contentLink">$content.Title.text &ndash; $content.Date.shortDate</a>
	#if ($content.Abstract.text != "")
		<br />$content.Abstract.text
	#end
</p>

Appendix A. GNU Free Documentation License

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.

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other functional and useful document “free” in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

The “publisher” means any person or entity that distributes copies of the Document to the public.

A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

  1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
  2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
  3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
  4. Preserve all the copyright notices of the Document.
  5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
  6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
  7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
  8. Include an unaltered copy of this License.
  9. Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
  10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
  11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
  12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
  13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
  14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
  15. Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties — for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements”.

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See Copyleft.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.

11. RELICENSING

“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.

“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.

An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: 

Copyright © YEAR YOUR NAME

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.3 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in
the section entitled “GNU Free Documentation License”.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with… Texts.” line with this: 

with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts
being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.