Wiki source code of Documentation for XWiki Standard & Extensions
Last modified by Thiago Krieck on 2026/08/10 15:19
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
58.1 | 1 | == Where to find Documentation? == |
| 2 | |||
| |
61.1 | 3 | You'll find below two documentation systems: |
 |
62.6 | 4 | |
| |
61.1 | 5 | * The current one. |
| 6 | * The new one, that we're currently working on and that is supposed to replace the current one in the future. | ||
| |
58.1 | 7 | |
 |
62.1 | 8 | Both documentation systems are valid sources of information during this transition period. If you cannot find what you are looking for in one system, please check the other. Migrated pages and sections contain links to their new location in the new documentation. Follow these links to access the updated content. |
| |
58.1 | 9 | |
| |
58.2 | 10 | Additionally, we are gathering feedback to improve the documentation experience. You can share your thoughts by filling in the [[XWiki.org Website Survey>>Survey.XWikiOrgFeedback]]. |
| 11 | |||
| |
62.6 | 12 | ---- |
| 13 | |||
| |
62.2 | 14 | {{include reference="XWiki.SearchCode"/}} |
| 15 | |||
| 16 | {{velocity output="false"}} | ||
| 17 | #if ($searchEngine == 'solr') | ||
| 18 | ## Customize the Solr Search UI for the DocApp application. | ||
| 19 | #set ($solrConfig = { | ||
| 20 | 'filterQuery': [ | ||
| 21 | 'type:DOCUMENT', | ||
| 22 | "wiki:$xcontext.database", | ||
| |
62.5 | 23 | '(class:DocApp.Code.DocumentationClass) OR space_prefix:Documentation OR space_prefix:FAQ OR (wiki:extensions AND space_prefix:Extension)' |
| |
62.2 | 24 | ] |
| 25 | }) | ||
| 26 | #end | ||
| 27 | {{/velocity}} | ||
| 28 | |||
| 29 | {{velocity}} | ||
| |
62.4 | 30 | Search all documentation (current and new): |
| |
62.3 | 31 | |
| |
62.2 | 32 | {{include reference="$searchPage"/}} |
| 33 | {{/velocity}} | ||
| 34 | |||
| |
61.1 | 35 | == New Documentation (Work in Progress) == |
| |
58.1 | 36 | |
 |
36.1 | 37 | {{velocity}} |
| 38 | $xwiki.ssx.use('Download.WebHome') | ||
| |
61.1 | 39 | {{/velocity}} |
| |
1.1 | 40 | |
| |
62.6 | 41 | (% class="download-options" %) |
| 42 | ((( | ||
| 43 | (% class="col-xs-12 download-container download-option version-option border-cyan" %) | ||
| 44 | ((( | ||
| |
61.1 | 45 | === [[Documentation>>documentation.WebHome]] === |
| |
62.6 | 46 | |
| |
61.1 | 47 | Top level documentation page for the new documentation. |
| |
62.6 | 48 | |
| 49 | (% class="version-footer" %) | ||
| 50 | ((( | ||
| 51 | [[Learn>>documentation.xs.WebHome||class="btn btn-info"]] | ||
| |
61.1 | 52 | ))) |
| 53 | ))) | ||
| |
62.6 | 54 | |
| 55 | (% class="col-xs-12 download-container download-option version-option border-blue" %) | ||
| 56 | ((( | ||
| |
61.1 | 57 | === [[XWiki Standard>>documentation.xs.WebHome]] === |
| |
62.6 | 58 | |
| |
61.1 | 59 | Direct access to the documentation for XWiki Standard. |
| |
62.6 | 60 | |
| 61 | (% class="version-footer" %) | ||
| 62 | ((( | ||
| 63 | [[Learn>>documentation.xs.WebHome||class="btn btn-info"]] | ||
| |
61.1 | 64 | ))) |
| 65 | ))) | ||
| |
62.6 | 66 | |
| 67 | (% class="col-xs-12 download-container download-option version-option border-green" %) | ||
| 68 | ((( | ||
| |
61.1 | 69 | === [[Extensions>>documentation.extensions.WebHome]] === |
| |
62.6 | 70 | |
| |
61.1 | 71 | Direct access to the documentation for XWiki Extensions. |
| |
62.6 | 72 | |
| 73 | (% class="version-footer" %) | ||
| 74 | ((( | ||
| 75 | [[Learn>>documentation.extensions.WebHome||class="btn btn-info"]] | ||
| |
61.1 | 76 | ))) |
| 77 | ))) | ||
| 78 | ))) | ||
| 79 | |||
| 80 | == Current Documentation == | ||
| 81 | |||
| |
62.6 | 82 | (% class="download-options" %) |
| 83 | ((( | ||
| 84 | (% class="col-xs-12 download-container download-option version-option border-cyan fa-icon fa-user" %) | ||
| 85 | ((( | ||
 |
56.1 | 86 | === [[User Guide>>xwiki:Documentation.UserGuide.WebHome]] === |
| |
62.6 | 87 | |
| |
56.1 | 88 | Dedicated for standard users of the wiki. It contains a Getting Started Guide and a reference to the [[Features>>xwiki:Documentation.UserGuide.Features.WebHome]], in addition to videos and tutorials. |
| |
62.6 | 89 | |
| 90 | (% class="version-footer" %) | ||
| 91 | ((( | ||
| 92 | [[Learn>>Documentation.UserGuide.WebHome||class="btn btn-info"]] | ||
| |
40.1 | 93 | ))) |
| 94 | ))) | ||
| |
62.6 | 95 | |
| 96 | (% class="col-xs-12 download-container download-option version-option border-blue fa-icon fa-cogs" %) | ||
| 97 | ((( | ||
| |
56.1 | 98 | === [[Admin Guide>>xwiki:Documentation.AdminGuide.WebHome]] === |
| |
62.6 | 99 | |
| |
39.7 | 100 | Provides general information for administrators that need to customize and administer their XWiki installation (authentication, DB, performance tuning, etc.) |
| |
62.6 | 101 | |
| 102 | (% class="version-footer" %) | ||
| 103 | ((( | ||
| 104 | [[Administer>>Documentation.AdminGuide.WebHome||class="btn btn-primary"]] | ||
| |
39.6 | 105 | ))) |
| 106 | ))) | ||
| |
62.6 | 107 | |
| 108 | (% class="col-xs-12 download-container download-option version-option border-green fa-icon fa-code" %) | ||
| 109 | ((( | ||
| |
56.1 | 110 | === [[Developer Guide>>xwiki:Documentation.DevGuide.WebHome]] === |
| |
62.6 | 111 | |
| |
39.7 | 112 | Details how to develop in-wiki applications or how to integrate other software with XWiki. Contains details on how to insert scripts into XWiki pages. |
| |
62.6 | 113 | |
| 114 | (% class="version-footer" %) | ||
| 115 | ((( | ||
| 116 | [[Develop>>Documentation.DevGuide.WebHome||class="btn btn-success"]] | ||
| |
39.6 | 117 | ))) |
| 118 | ))) | ||
| 119 | ))) | ||
 |
13.1 | 120 | |
| |
62.6 | 121 | (% class="noitems" %)If you need more help with your wiki or you'd like to get in touch with the community please visit the [[Support>>xwiki:Main.Support]] for more information. |
| |
43.3 | 122 | |
| |
61.1 | 123 | === FAQ === |
| |
43.6 | 124 | |
| |
57.2 | 125 | If you still have a question after reading these guides, check our [[FAQ>>xwiki:FAQ.WebHome]], which provides answers to common questions, for users, developers and administrators. |
| |
57.1 | 126 | |
| |
61.1 | 127 | === Projects and Extensions === |
 |
2.1 | 128 | |
| |
36.1 | 129 | The XWiki.org web site is organized by [[projects and extensions>>xwiki:Main.Forge]], each having their own site. Every site holds the documentation for its projects: |
| |
62.6 | 130 | |
| |
36.1 | 131 | * [[Documentation for Extensions>>extensions:Main.WebHome]] |
| |
42.2 | 132 | * [[Documentation for Snippets>>snippets:Main.WebHome]] |
| |
22.2 | 133 | * [[Documentation for XWiki Rendering>>rendering:Main.WebHome]] |
 |
22.1 | 134 | * [[Documentation for XWiki Commons>>commons:Main.WebHome]] |
 |
14.1 | 135 | |
| |
43.2 | 136 | You can also check [[external articles and documentation about XWiki>>Main.ExternalLinks]]. |
| |
43.1 | 137 | |
| |
36.1 | 138 | Information regarding the Open Source development of the XWiki Platform itself or to XWiki related projects and extensions can be found on the [[Development>>dev:Main.WebHome]] wiki and on the [[Contrib>>contrib:Main.WebHome]] wiki. |
