Search: concept

The XWiki Model is made of Entities, such as: * A Wiki contains Spaces * A Space contains Documents * A Document contains Attachments and Objects (a.k.a XObjects), and can also contain one Class definition (XClass) * {{info}}since 10.6{{/info}} A Page is another way to represent Space/Document hierarchy * An Object contains Object Properties * A Class contain Class Properties == Entity Reference API == There are 3 concepts to understand: * The notion of **{{scm path="xwiki-platform-core/xwiki-platform-model/src/main/java/org/xwiki/model/reference/EntityReference.java"}}EntityReference{{/scm}}** (or Reference for short). ** A Reference points to an Entity from the Model (wiki, space, document, object, etc). ** A Reference can have a parent Reference (e.g. a Document Reference's parent is a Space Reference) ** A Reference can be absolute (i.e. all its parent references are defined till the wiki Reference) or relative. ** To make it easy to construct References, a typed API exists.

. === State Management A state represents all the content of a replicated XWiki. This concept derives from the fact that XWoot and XWiki do not share the same data on an implementation level and, before being able to start to function properly, XWoot needs to have its data initialized.

. (% style="font-family: sans-serif; font-size: 14px; font-style: normal; text-align: left; line-height: 19px; " %) [[http:~~/~~/dev.xwiki.org/xwiki/bin/view/Design/ResponsiveSkin>>url:http://dev.xwiki.org/xwiki/bin/view/Design/ResponsiveSkin]] (% style="font-family: sans-serif; font-style: normal; margin-top: 0px; text-align: left; overflow: hidden; " %) ==== (% style="font-size: 23px; line-height: 27px;" %)**Timeline & Milestones**(%%) ==== |=Week|=Days |=Description | 1|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19px; text-align: left; " %)21 May - 25 May |(% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19px; text-align: left; " %)Design explorations: holistic view (UI wireframe) | 2|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19px; text-align: left; " %)[28 May - 1 June|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19px; text-align: left; " %)Design explorations: common widgets/extensions (UI wireframe) (It seemed to be more useful to develop this after the hollistic design has been explored and implemented to be tailored to the final design) **MILESTONE 1 ~-~- Clear concept of what is to be coded/written ** | 3|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19px; text-align: left; " %)4 June - 8 June|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19px; text-align: left; " %) Raw Semantics that work cross platform | 4|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19px; text-align: left; " %)11 June - 15 June |(% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19px; text-align: left; " %)Desktop implementation (holistic) (css & js) [opera, chrome, safari, ie] | 5|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19px; text-align: left; " %)18 June - 22 June|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19px; text-align: left; " %) Desktop implementation (holistic) (css & js) [opera, chrome, safari, ie] (this weeks specifically watered down browser (eg. ie7, ie6?).

| |20 Aug|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; text-align: left; font-family: sans-serif; font-size: 14px; font-style: normal; text-align: left" %)**MILESTONE 5 ~-~- Create distributable version** (% style="font-family: sans-serif; font-style: normal; margin-top: 0px; text-align: left; line-height: 1.2em; overflow: hidden; " %) ==== (% style="font-size: 23px; line-height: 27px; " %)**Deliverables**(%%) ==== |=Milestone |=Description |=Link | 1|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; text-align: left; " %)Clear concept of what is to be coded/written |[[http:~~/~~/sdrv.ms/LZ1iWl>>url:http://sdrv.ms/LZ1iWl]] | 2|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; text-align: left; " %)Codes are written and ready to be implemented into XWiki |[[https:~~/~~/github.com/jssolichin/xorange>>url:https://github.com/jssolichin/xorange]] | 3|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; text-align: left; " %)Codes are implemented, and usable|source: [[https:~~/~~/github.com/jssolichin/xo5>>url:https://github.com/jssolichin/xo5]] [[http:~~/~~/23.21.87.183:8080/xwiki/bin/view/Main/WebHome>>url:http://23.21.87.183:8080/xwiki/bin/view/Main/WebHome]] | 4|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; text-align: left; " %)(% style="font-family: sans-serif; font-size: 14px; font-style: normal; text-align: left; font-family: sans-serif; font-size: 14px; font-style: normal; text-align: left" %)Chosen features are working and responsive(%%) | search suggest, livetables, blog, color themes, print styling, ie compatibility | 5|(% style="font-family: sans-serif; font-size: 14px; font-style: normal; text-align: left; " %)Distributable version created| [[https:~~/~~/github.com/jssolichin/xo5>>url:https://github.com/jssolichin/xo5||style="font-family: sans-serif; font-size: 14px; font-style: normal; text-align: start; "]]; [[http:~~/~~/extensions.xwiki.org/xwiki/bin/view/Extension/xorange>>url:http://extensions.xwiki.org/xwiki/bin/view/Extension/xorange]] (% style="font-family: sans-serif; font-style: normal; margin-top: 0px; text-align: left; line-height: 1.2em; overflow: hidden; " %) ==== (% style="font-size: 19px; line-height: 1.2em; font-size: 19px; line-height: 1.2em; font-size: 23px; line-height: 1.2em" %)**Progess**(%%) ==== |=Time|= Description | May 5| First design exploration.

It provides: * automatic configuration and prefix management; * a conversion mechanism centered around the concept of URL mappers. See the example above for basic usage.

See the [[Model>>path:http://extensions.xwiki.org/xwiki/bin/view/Extension/Model%20Module]] module to understand the concept of references. Available since XWiki 3.4M1.

. == Namespaces == Component API comes with "namespace" concept. The format of the namespaces is ##<type>:<id>##.

It's instantiated in the ##XWikiServletContextListener## class (in the ##xwiki-platform-container-servlet## module). == Accessing components in legacy code == The XWiki project is older that this component concept and sometimes you can find yourself in code which cannot really inject components, you should ideally try to convert it to the components world.

= Users {{info}}Since 12.2{{/info}} Concepts: * This API is independent from where the users are stored (in wiki pages, etc).

In addition, there are also some [[extra Configuration APIs using platform concepts>>Extension.PlatformConfigurationAPI.WebHome]]. == Configuration Source API == {{code language='java'}} @Role public interface ConfigurationSource { /** * @param <T> the value type * @param key the property key for which we want the value * @param defaultValue the value to use if the key isn't found * @return the property value is found or the default value if the key wasn't found * @since 2.0M1 */ <T> T getProperty(String key, T defaultValue); /** * @param <T> the value type * @param key the property key for which we want the value * @param valueClass the type of object that should be returned.

XWiki doesn't have a concept of archived document. This parameter lets you optionally import archived documents as regular XWiki documents instead of ignoring them.| |false |Import archived spaces.

XWiki doesn't have a concept of archived space. This parameter lets you optionally import archived spaces  as regular XWiki spaces instead of ignoring them.| |false |Import attachments|If you don't want to import document attachments, set this to false.| |true |Base URLs|((( The list of base URLs leading to the Confluence instance.