Wiki source code of Developer Guide

Version 41.1 by Vincent Massol on 2017/09/05

version	line-number	content
39.2	1	{{velocity output="false"}}
39.14	2	$xwiki.ssx.use('Documentation.WebHome')
39.2	3	{{/velocity}}
1.1	4
39.2	5	(% class="row cards" %)
	6	(((
	7	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	8	(((
39.20	9	(% class="card card1" %)
	10	(((
	11	(% class="card-body" %)
	12	(((
39.21	13	==== (% class="card-title" %)[[API Guide>>platform:DevGuide.APIGuide]](%%) ====
39.20	14
	15	(% class="card-text" %)
	16	(((
	17	Guide that explains the main XWiki APIs.
39.16	18	)))
39.2	19	)))
39.20	20	)))
	21	)))
2.1	22
39.2	23	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	24	(((
39.20	25	(% class="card card1" %)
	26	(((
	27	(% class="card-body" %)
	28	(((
39.21	29	==== (% class="card-title" %)[[API Reference>>platform:DevGuide.API]](%%) ====
39.20	30
	31	(% class="card-text" %)
	32	(((
	33	The API is available as a JavaDoc. It presents the objects and properties that you can access with scripting.
39.16	34	)))
39.2	35	)))
39.20	36	)))
	37	)))
1.1	38
39.2	39	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	40	(((
39.20	41	(% class="card card1" %)
	42	(((
	43	(% class="card-body" %)
	44	(((
39.21	45	==== (% class="card-title" %)[[Scripting>>platform:DevGuide.Scripting]](%%) ====
39.20	46
	47	(% class="card-text" %)
	48	(((
	49	Classes and Scripting will allow you to create basic to complex web applications at the XWiki document layer without the need for compiling code or deploying software components.
39.16	50	)))
39.2	51	)))
	52	)))
39.20	53	)))
	54	)))
28.1	55
39.2	56	== Reference ==
30.1	57
19.1	58
39.2	59	(% class="row cards" %)
	60	(((
	61	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	62	(((
39.20	63	(% class="card card2" %)
	64	(((
	65	(% class="card-body" %)
	66	(((
39.21	67	===== (% class="card-title" %)[[Architecture>>platform:DevGuide.Architecture]](%%) =====
39.20	68
	69	(% class="card-subtitle mb-2" %)
	70	(((
	71	====== Understanding how XWiki is architected and how to extend it. ======
39.16	72	)))
39.2	73	)))
39.20	74	)))
	75	)))
19.1	76
39.2	77	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	78	(((
39.20	79	(% class="card card2" %)
	80	(((
	81	(% class="card-body" %)
	82	(((
39.21	83	===== (% class="card-title" %)[[Data Model>>platform:DevGuide.DataModel]](%%) =====
39.20	84
	85	(% class="card-subtitle mb-2" %)
	86	(((
	87	====== Describes XWiki's data model of Classes, Properties, and Objects. They'll be needed to build applications at the presentation (document) level. ======
39.16	88	)))
39.2	89	)))
39.20	90	)))
	91	)))
19.1	92
39.2	93	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	94	(((
39.20	95	(% class="card card2" %)
	96	(((
	97	(% class="card-body" %)
	98	(((
	99	===== (% class="card-title" %)[[Database Schema>>platform:DevGuide.DatabaseSchema]](%%) =====
	100
	101	(% class="card-subtitle mb-2" %)
	102	(((
	103	====== For advanced users who like to know everything, check out the database tables created by XWiki. ======
39.16	104	)))
39.2	105	)))
	106	)))
39.20	107	)))
	108	)))
19.1	109
39.2	110	----
24.1	111
39.2	112	{{box cssClass="floatinginfobox col-xs-4"}}
	113	If you are interested in participating to the XWiki project development itself or in building it from sources, you should refer to the [[Community wiki>>dev:Main.WebHome]].
	114	You still have a question?
39.22	115	[[Post on the forum!>>dev:Community.Discuss]]
39.2	116	{{/box}}
	117
17.1	118	; [[Front-end Resources>>platform:DevGuide.FrontendResources]]
39.20	119	: A description of the tools and frameworks used in XWiki. You'll find information about how you can use external libraries such asYUI and SmartClient and internal XWiki libraries for your the development of your in-wiki applications or for the development of XWiki products themselves. You'll also find the documentation of StyleSheet resources created specifically for the XWiki project.
19.1	120
39.2	121	; [[Extension Points List>>platform:ExtensionPoint.WebHome]]
	122	: List all available Extension Points.
14.1	123
19.1	124	; [[Saving Data>>platform:DevGuide.SavingData]]
	125	: Description of all the possibilities you have to save Data from within the XWiki Platform
	126
39.13	127	; [[URL Architecture>>platform:DevGuide.URL Architecture]]
	128	: Explains how XWiki URLs work, the format of the [[Standard URL Scheme>>platform:DevGuide.Standard URL Format]] and how to configure them.
31.1	129
39.21	130	; [[Module Reference>>extensions:Main.WebHome]]
39.2	131	: Reference documentation for the various Modules of XWiki.
14.1	132
39.2	133	(% class="row cards" %)
	134	(((
37.1	135
39.2	136	)))
25.2	137
39.2	138	== Tutorials ==
25.2	139
	140
39.2	141	(% class="row cards" %)
	142	(((
	143	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	144	(((
39.20	145	(% class="card card2" %)
	146	(((
	147	(% class="card-body" %)
	148	(((
40.1	149	===== (% class="card-title" %)[[Creating a FAQ application>>Documentation.DevGuide.Tutorials.FAQTutorial.WebHome]](%%) =====
39.20	150
	151	(% class="card-subtitle mb-2" %)
	152	(((
	153	====== Demonstrates how to create a FAQ application, either using Classes/Objects/Sheets/Templates and Scripting or using the App Within Minutes. Completing this tutorial is a recommended prerequisite for anyone who wants to build custom applications on the XWiki engine at the document or presentation layer. ======
39.16	154	)))
39.2	155	)))
39.20	156	)))
	157	)))
25.2	158
39.2	159	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	160	(((
39.20	161	(% class="card card2" %)
	162	(((
	163	(% class="card-body" %)
	164	(((
	165	===== (% class="card-title" %)[[Creating a TODO application in XWiki>>http://www.theserverside.com/tt/articles/article.tss?l=XWiki]](%%) =====
	166
	167	(% class="card-subtitle mb-2" %)
	168	(((
	169	====== Another helpful tutorial to using XWiki's classes, velocity scripts, hibernate queries for a dashboard. ======
39.16	170	)))
39.2	171	)))
39.20	172	)))
	173	)))
25.2	174
39.2	175	(% class="col-xs-12 col-sm-6 col-md-4 cards-container" %)
	176	(((
39.20	177	(% class="card card2" %)
	178	(((
	179	(% class="card-body" %)
	180	(((
41.1	181	===== (% class="card-title" %)[[Creating an Extension>>Documentation.DevGuide.Tutorials.CreatingExtensions.WebHome]](%%) =====
39.20	182
	183	(% class="card-subtitle mb-2" %)
	184	(((
	185	====== Explains how to create an XWiki Extension ======
39.16	186	)))
39.2	187	)))
	188	)))
39.20	189	)))
	190	)))
39.2	191
	192	----
	193
39.21	194	; [[Creating Rendering Macros>>platform:DevGuide.WritingMacros]]
39.2	195	: How to develop XWiki Rendering macros (available in XWiki Syntax 2.0 only)
	196
	197	; [[Creating New XClass Property Types>>platform:DevGuide.CreatingNewXClassPropertyTypes]]
39.6	198	: See how you can easily extend the [[class editor>>platform:Features.PageEditing\|\|anchor="HClasseseditingmode"]] with new custom property types.
39.2	199
17.1	200	; [[Creating a form with validation and tooltips>>platform:DevGuide.Creating a form with validation and tooltips]]
	201	: Quick and efficient tutorial to set-up validation using regular expression and groovy scripts, as well as tooltips
25.2	202
39.13	203	; [[Creating a Tree View>>platform:DevGuide.CreatingATreeView]]
39.2	204	: A tutorial on how to create a tree view for any tree structure you may have in XWiki, using the [[Tree Macro>>extensions:Extension.Tree Macro]].
25.2	205
39.13	206	; [[Creating a custom SOLR search for an AppWithinMinutes application>>platform:DevGuide.WritingCustomSolrSearchForAWM]]
39.8	207	: Tutorial to show how to write a customized SOLR search screen in XWiki for an [[AWM application>>extensions:Extension.App Within Minutes Application]]. For this example we have used the [[Expense Report application>>https://github.com/xwiki-contrib/application-expensereport]].
39.2	208
	209	; [[Creating a Master-Detail view>>platform:DevGuide.MasterDetailTutorial]]
	210	: Shows how to implement a Master-Details view
	211
	212	; [[Creating an Event Listener>>platform:DevGuide.WritingEventListenerTutorial]]
	213	: Explains how to write an [[Event Listener>>extensions:Extension.Observation Module]] in order to perform some action when an event happens in the wiki. Examples of events are Document changed, Object modified, and more.
	214
	215	; [[Creating a Groovy Class>>platform:DevGuide.GroovyClassHelloWorldTutorial]]
	216	: Demonstrates how to put Groovy code in one page and then reuse it by importing it from another page.
	217
	218	; [[Creating an XWiki Component>>platform:DevGuide.WritingComponents]]
17.1	219	: Getting started with the new XWiki components architecture: introduction to this new design, a step-by-step guide to writing an XWiki component (the recommended way of creating XWiki plugins) and some guidelines and development good practices in this area.
25.2	220
39.2	221	; [[Creating a Plugin>>platform:DevGuide.CreatingPlugins]]
	222	: After you've learnt how to write applications at the document level you may want to go further and program plugins in Java to extend XWiki's view engine, as well as add hooks into different parts of the core engine.
	223
	224	(% class="row cards" %)
	225	(((
	226
	227	)))
	228
	229	== Guides ==
	230
	231
39.21	232	; [[How to use Velocity in wiki pages>>platform:DevGuide.XWikiVelocityTraining]]
39.2	233	: A presentation that explains how to write applications in XWiki (using Velocity, the XWiki Class system, and the API...).
	234
17.1	235	; [[Skin eXtensions>>platform:DevGuide.SkinExtensionsTutorial]]
39.9	236	: Illustrate XWiki's [[Skin eXtensions>>platform:Features.Skins\|\|anchor="HSkinseXtensions"]] mechanism that allows developers to pull extra Javascript and stylesheet files on demand or for all wiki pages without modifying the wiki templates and skin. The tutorial guides through the creation of minimal stylesheet and Javascript extensions, and continues with a complete exemple of a real-world extension to demonstrate the power of XWiki's skin eXtensions!
25.2	237
17.1	238	; [[Internationalizing Applications>>platform:DevGuide.InternationalizingApplications]]
	239	: Learn how to write internationalized applications.
25.2	240
18.2	241	; [[Custom Mapping>>platform:DevGuide.CustomMapping]]
	242	: Learn how to use Custom Mapping when you need to map XWiki Classes to your own database tables or when you need extra performance for complex data.
25.2	243
39.13	244	; [[Integrating JavaScript Libraries>>platform:DevGuide.IntegratingJavaScriptLibraries]]
35.1	245	: A tutorial on how we can use [[WebJars>>extensions:Extension.WebJars Integration]] and [[RequireJS>>http://requirejs.org/]] to integrate JavaScript libraries in XWiki. Moreover, you'll see how you can package your own JavaScript code as a WebJar in order to benefit from various code quality tools (static code analysis with [[jshint>>http://jshint.com/]], integration testing with [[Jasmine>>http://jasmine.github.io/]]).
	246
39.13	247	; [[Performing Asynchronous Tasks>>platform:DevGuide.PerformingAsynchronousTasks]]
33.1	248	: A tutorial on how to perform long-running and expensive operations in XWiki from a background thread using the [[Job Module>>extensions:Extension.Job Module]].
	249
39.2	250	; [[AJAX and JSON calls>>snippets:Extension.AJAX example]]
	251	: How to perform AJAX calls, retrieve JSON results from a Velocity page and to update your application's UI.
34.1	252
17.1	253	; [[Best Practices>>platform:DevGuide.BestPractices]]
	254	: A set of best practices for developing applications with XWiki.
1.1	255
39.2	256	(% class="row cards" %)
	257	(((
1.1	258
39.2	259	)))
25.2	260
39.2	261	== Drafts ==
1.1	262
1.5	263
39.2	264	See the [[Drafts>>dev:Drafts.WebHome]] for other topics that are still under review.

Wiki source code of Developer Guide

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected